Documentation
¶
Overview ¶
+groupName=webconsole.config.openshift.io Package v1 is the v1 version of the API.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( GroupName = "webconsole.config.openshift.io" GroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"} // Install is a function which adds this version to a scheme Install = schemeBuilder.AddToScheme // SchemeGroupVersion generated code relies on this name // Deprecated SchemeGroupVersion = GroupVersion // AddToScheme exists solely to keep the old generators creating valid code // DEPRECATED AddToScheme = schemeBuilder.AddToScheme )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED
Types ¶
type ClusterInfo ¶
type ClusterInfo struct {
// ConsolePublicURL is where you can find the web console server (TODO do we really need this?)
ConsolePublicURL string `json:"consolePublicURL"`
// MasterPublicURL is how the web console can access the OpenShift v1 server
MasterPublicURL string `json:"masterPublicURL"`
// LoggingPublicURL is the public endpoint for logging (optional)
LoggingPublicURL string `json:"loggingPublicURL"`
// MetricsPublicURL is the public endpoint for metrics (optional)
MetricsPublicURL string `json:"metricsPublicURL"`
// LogoutPublicURL is an optional, absolute URL to redirect web browsers to after logging out of the web
// console. If not specified, the built-in logout page is shown.
LogoutPublicURL string `json:"logoutPublicURL"`
// AdminConsolePublicURL is an optional, public URL of the OpenShift admin console. If specified, the web
// console will add a link to the admin console in a context selector in its masthead.
AdminConsolePublicURL string `json:"adminConsolePublicURL"`
}
ClusterInfo holds information the web console needs to talk to the cluster such as master public URL and metrics public URL
func (*ClusterInfo) DeepCopy ¶
func (in *ClusterInfo) DeepCopy() *ClusterInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterInfo.
func (*ClusterInfo) DeepCopyInto ¶
func (in *ClusterInfo) DeepCopyInto(out *ClusterInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ClusterInfo) SwaggerDoc ¶
func (ClusterInfo) SwaggerDoc() map[string]string
type ExtensionsConfiguration ¶
type ExtensionsConfiguration struct {
// ScriptURLs are URLs to load as scripts when the Web Console loads. The URLs must be accessible from
// the browser.
ScriptURLs []string `json:"scriptURLs"`
// StylesheetURLs are URLs to load as stylesheets when the Web Console loads. The URLs must be accessible
// from the browser.
StylesheetURLs []string `json:"stylesheetURLs"`
// Properties are key(string) and value(string) pairs that will be injected into the console under the
// global variable OPENSHIFT_EXTENSION_PROPERTIES
Properties map[string]string `json:"properties"`
}
ExtensionsConfiguration holds custom script, stylesheets, and properties used for web console customization
func (*ExtensionsConfiguration) DeepCopy ¶
func (in *ExtensionsConfiguration) DeepCopy() *ExtensionsConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExtensionsConfiguration.
func (*ExtensionsConfiguration) DeepCopyInto ¶
func (in *ExtensionsConfiguration) DeepCopyInto(out *ExtensionsConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ExtensionsConfiguration) SwaggerDoc ¶
func (ExtensionsConfiguration) SwaggerDoc() map[string]string
type FeaturesConfiguration ¶
type FeaturesConfiguration struct {
// InactivityTimeoutMinutes is the number of minutes of inactivity before you are automatically logged out of
// the web console (optional). If set to 0, inactivity timeout is disabled.
InactivityTimeoutMinutes int64 `json:"inactivityTimeoutMinutes"`
// ClusterResourceOverridesEnabled indicates that the cluster is configured for overcommit. When set to
// true, the web console will hide the CPU request, CPU limit, and memory request fields in its editors
// and skip validation on those fields. The memory limit field will still be displayed.
ClusterResourceOverridesEnabled bool `json:"clusterResourceOverridesEnabled"`
}
FeaturesConfiguration defines various feature gates for the web console
func (*FeaturesConfiguration) DeepCopy ¶
func (in *FeaturesConfiguration) DeepCopy() *FeaturesConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeaturesConfiguration.
func (*FeaturesConfiguration) DeepCopyInto ¶
func (in *FeaturesConfiguration) DeepCopyInto(out *FeaturesConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (FeaturesConfiguration) SwaggerDoc ¶
func (FeaturesConfiguration) SwaggerDoc() map[string]string
type WebConsoleConfiguration ¶
type WebConsoleConfiguration struct {
metav1.TypeMeta `json:",inline"`
// ServingInfo is the HTTP serving information for these assets
ServingInfo configv1.HTTPServingInfo `json:"servingInfo"`
// ClusterInfo holds information the web console needs to talk to the cluster such as master public URL
// and metrics public URL
ClusterInfo ClusterInfo `json:"clusterInfo"`
// Features define various feature gates for the web console
Features FeaturesConfiguration `json:"features"`
// Extensions define custom scripts, stylesheets, and properties used for web console customization
Extensions ExtensionsConfiguration `json:"extensions"`
}
WebConsoleConfiguration holds the necessary configuration options for serving the web console
func (*WebConsoleConfiguration) DeepCopy ¶
func (in *WebConsoleConfiguration) DeepCopy() *WebConsoleConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebConsoleConfiguration.
func (*WebConsoleConfiguration) DeepCopyInto ¶
func (in *WebConsoleConfiguration) DeepCopyInto(out *WebConsoleConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WebConsoleConfiguration) DeepCopyObject ¶
func (in *WebConsoleConfiguration) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (WebConsoleConfiguration) SwaggerDoc ¶
func (WebConsoleConfiguration) SwaggerDoc() map[string]string