var (
GroupName = "console.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
)
func Resource(resource string) schema.GroupResource
Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED
ApplicationMenuSpec is the specification of the desired section and icon used for the link in the application menu.
type ApplicationMenuSpec struct {
// section is the section of the application menu in which the link should appear.
// This can be any text that will appear as a subheading in the application menu dropdown.
// A new section will be created if the text does not match text of an existing section.
Section string `json:"section"`
// imageUrl is the URL for the icon used in front of the link in the application menu.
// The URL must be an HTTPS URL or a Data URI. The image should be square and will be shown at 24x24 pixels.
// +optional
ImageURL string `json:"imageURL,omitempty"`
}
func (in *ApplicationMenuSpec) DeepCopy() *ApplicationMenuSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApplicationMenuSpec.
func (in *ApplicationMenuSpec) DeepCopyInto(out *ApplicationMenuSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ApplicationMenuSpec) SwaggerDoc() map[string]string
AuthorizationType is an enumerate of available authorization types +kubebuilder:validation:Enum:=UserToken;None
type AuthorizationType string
const (
// UserToken indicates that the proxied request should contain the logged-in user's
// OpenShift access token in the "Authorization" request header. For example:
//
// Authorization: Bearer sha256~kV46hPnEYhCWFnB85r5NrprAxggzgb6GOeLbgcKNsH0
//
UserToken AuthorizationType = "UserToken"
// None indicates that proxied request wont contain authorization of any type.
None AuthorizationType = "None"
)
type CLIDownloadLink struct {
// text is the display text for the link
// +optional
Text string `json:"text"`
// href is the absolute secure URL for the link (must use https)
// +kubebuilder:validation:Pattern=`^https://`
Href string `json:"href"`
}
func (in *CLIDownloadLink) DeepCopy() *CLIDownloadLink
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CLIDownloadLink.
func (in *CLIDownloadLink) DeepCopyInto(out *CLIDownloadLink)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (CLIDownloadLink) SwaggerDoc() map[string]string
ConsoleCLIDownload is an extension for configuring openshift web console command line interface (CLI) downloads.
Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=2
type ConsoleCLIDownload struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ConsoleCLIDownloadSpec `json:"spec"`
}
func (in *ConsoleCLIDownload) DeepCopy() *ConsoleCLIDownload
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleCLIDownload.
func (in *ConsoleCLIDownload) DeepCopyInto(out *ConsoleCLIDownload)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsoleCLIDownload) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleCLIDownload) SwaggerDoc() map[string]string
Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=2
type ConsoleCLIDownloadList struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard list's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ListMeta `json:"metadata"`
Items []ConsoleCLIDownload `json:"items"`
}
func (in *ConsoleCLIDownloadList) DeepCopy() *ConsoleCLIDownloadList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleCLIDownloadList.
func (in *ConsoleCLIDownloadList) DeepCopyInto(out *ConsoleCLIDownloadList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsoleCLIDownloadList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleCLIDownloadList) SwaggerDoc() map[string]string
ConsoleCLIDownloadSpec is the desired cli download configuration.
type ConsoleCLIDownloadSpec struct {
// displayName is the display name of the CLI download.
DisplayName string `json:"displayName"`
// description is the description of the CLI download (can include markdown).
Description string `json:"description"`
// links is a list of objects that provide CLI download link details.
Links []CLIDownloadLink `json:"links"`
}
func (in *ConsoleCLIDownloadSpec) DeepCopy() *ConsoleCLIDownloadSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleCLIDownloadSpec.
func (in *ConsoleCLIDownloadSpec) DeepCopyInto(out *ConsoleCLIDownloadSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleCLIDownloadSpec) SwaggerDoc() map[string]string
ConsoleExternalLogLink is an extension for customizing OpenShift web console log links.
Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=2
type ConsoleExternalLogLink struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ConsoleExternalLogLinkSpec `json:"spec"`
}
func (in *ConsoleExternalLogLink) DeepCopy() *ConsoleExternalLogLink
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleExternalLogLink.
func (in *ConsoleExternalLogLink) DeepCopyInto(out *ConsoleExternalLogLink)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsoleExternalLogLink) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleExternalLogLink) SwaggerDoc() map[string]string
Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=2
type ConsoleExternalLogLinkList struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard list's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ListMeta `json:"metadata"`
Items []ConsoleExternalLogLink `json:"items"`
}
func (in *ConsoleExternalLogLinkList) DeepCopy() *ConsoleExternalLogLinkList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleExternalLogLinkList.
func (in *ConsoleExternalLogLinkList) DeepCopyInto(out *ConsoleExternalLogLinkList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsoleExternalLogLinkList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleExternalLogLinkList) SwaggerDoc() map[string]string
ConsoleExternalLogLinkSpec is the desired log link configuration. The log link will appear on the logs tab of the pod details page.
type ConsoleExternalLogLinkSpec struct {
// text is the display text for the link
Text string `json:"text"`
// hrefTemplate is an absolute secure URL (must use https) for the log link including
// variables to be replaced. Variables are specified in the URL with the format ${variableName},
// for instance, ${containerName} and will be replaced with the corresponding values
// from the resource. Resource is a pod.
// Supported variables are:
// - ${resourceName} - name of the resource which containes the logs
// - ${resourceUID} - UID of the resource which contains the logs
// - e.g. `11111111-2222-3333-4444-555555555555`
// - ${containerName} - name of the resource's container that contains the logs
// - ${resourceNamespace} - namespace of the resource that contains the logs
// - ${resourceNamespaceUID} - namespace UID of the resource that contains the logs
// - ${podLabels} - JSON representation of labels matching the pod with the logs
// - e.g. `{"key1":"value1","key2":"value2"}`
//
// e.g., https://example.com/logs?resourceName=${resourceName}&containerName=${containerName}&resourceNamespace=${resourceNamespace}&podLabels=${podLabels}
// +kubebuilder:validation:Pattern=`^https://`
HrefTemplate string `json:"hrefTemplate"`
// namespaceFilter is a regular expression used to restrict a log link to a
// matching set of namespaces (e.g., `^openshift-`). The string is converted
// into a regular expression using the JavaScript RegExp constructor.
// If not specified, links will be displayed for all the namespaces.
// +optional
NamespaceFilter string `json:"namespaceFilter,omitempty"`
}
func (in *ConsoleExternalLogLinkSpec) DeepCopy() *ConsoleExternalLogLinkSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleExternalLogLinkSpec.
func (in *ConsoleExternalLogLinkSpec) DeepCopyInto(out *ConsoleExternalLogLinkSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleExternalLogLinkSpec) SwaggerDoc() map[string]string
ConsoleLink is an extension for customizing OpenShift web console links.
Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=2
type ConsoleLink struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ConsoleLinkSpec `json:"spec"`
}
func (in *ConsoleLink) DeepCopy() *ConsoleLink
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleLink.
func (in *ConsoleLink) DeepCopyInto(out *ConsoleLink)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsoleLink) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleLink) SwaggerDoc() map[string]string
Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=2
type ConsoleLinkList struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard list's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ListMeta `json:"metadata"`
Items []ConsoleLink `json:"items"`
}
func (in *ConsoleLinkList) DeepCopy() *ConsoleLinkList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleLinkList.
func (in *ConsoleLinkList) DeepCopyInto(out *ConsoleLinkList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsoleLinkList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleLinkList) SwaggerDoc() map[string]string
ConsoleLinkLocationSelector is a set of possible menu targets to which a link may be appended. +kubebuilder:validation:Pattern=`^(ApplicationMenu|HelpMenu|UserMenu|NamespaceDashboard)$`
type ConsoleLinkLocation string
const (
// HelpMenu indicates that the link should appear in the help menu in the console.
HelpMenu ConsoleLinkLocation = "HelpMenu"
// UserMenu indicates that the link should appear in the user menu in the console.
UserMenu ConsoleLinkLocation = "UserMenu"
// ApplicationMenu indicates that the link should appear inside the application menu of the console.
ApplicationMenu ConsoleLinkLocation = "ApplicationMenu"
// NamespaceDashboard indicates that the link should appear in the namespaced dashboard of the console.
NamespaceDashboard ConsoleLinkLocation = "NamespaceDashboard"
)
ConsoleLinkSpec is the desired console link configuration.
type ConsoleLinkSpec struct {
Link `json:",inline"`
// location determines which location in the console the link will be appended to (ApplicationMenu, HelpMenu, UserMenu, NamespaceDashboard).
Location ConsoleLinkLocation `json:"location"`
// applicationMenu holds information about section and icon used for the link in the
// application menu, and it is applicable only when location is set to ApplicationMenu.
//
// +optional
ApplicationMenu *ApplicationMenuSpec `json:"applicationMenu,omitempty"`
// namespaceDashboard holds information about namespaces in which the dashboard link should
// appear, and it is applicable only when location is set to NamespaceDashboard.
// If not specified, the link will appear in all namespaces.
//
// +optional
NamespaceDashboard *NamespaceDashboardSpec `json:"namespaceDashboard,omitempty"`
}
func (in *ConsoleLinkSpec) DeepCopy() *ConsoleLinkSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleLinkSpec.
func (in *ConsoleLinkSpec) DeepCopyInto(out *ConsoleLinkSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleLinkSpec) SwaggerDoc() map[string]string
ConsoleNotification is the extension for configuring openshift web console notifications.
Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=2
type ConsoleNotification struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ConsoleNotificationSpec `json:"spec"`
}
func (in *ConsoleNotification) DeepCopy() *ConsoleNotification
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleNotification.
func (in *ConsoleNotification) DeepCopyInto(out *ConsoleNotification)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsoleNotification) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleNotification) SwaggerDoc() map[string]string
Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=2
type ConsoleNotificationList struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard list's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ListMeta `json:"metadata"`
Items []ConsoleNotification `json:"items"`
}
func (in *ConsoleNotificationList) DeepCopy() *ConsoleNotificationList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleNotificationList.
func (in *ConsoleNotificationList) DeepCopyInto(out *ConsoleNotificationList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsoleNotificationList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleNotificationList) SwaggerDoc() map[string]string
ConsoleNotificationLocationSelector is a set of possible notification targets to which a notification may be appended. +kubebuilder:validation:Pattern=`^(BannerTop|BannerBottom|BannerTopBottom)$`
type ConsoleNotificationLocation string
const (
// BannerTop indicates that the notification should appear at the top of the console.
BannerTop ConsoleNotificationLocation = "BannerTop"
// BannerBottom indicates that the notification should appear at the bottom of the console.
BannerBottom ConsoleNotificationLocation = "BannerBottom"
// BannerTopBottom indicates that the notification should appear both at the top and at the bottom of the console.
BannerTopBottom ConsoleNotificationLocation = "BannerTopBottom"
)
ConsoleNotificationSpec is the desired console notification configuration.
type ConsoleNotificationSpec struct {
// text is the visible text of the notification.
Text string `json:"text"`
// location is the location of the notification in the console.
// Valid values are: "BannerTop", "BannerBottom", "BannerTopBottom".
// +optional
Location ConsoleNotificationLocation `json:"location,omitempty"`
// link is an object that holds notification link details.
// +optional
Link *Link `json:"link,omitempty"`
// color is the color of the text for the notification as CSS data type color.
// +optional
Color string `json:"color,omitempty"`
// backgroundColor is the color of the background for the notification as CSS data type color.
// +optional
BackgroundColor string `json:"backgroundColor,omitempty"`
}
func (in *ConsoleNotificationSpec) DeepCopy() *ConsoleNotificationSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleNotificationSpec.
func (in *ConsoleNotificationSpec) DeepCopyInto(out *ConsoleNotificationSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleNotificationSpec) SwaggerDoc() map[string]string
ConsolePlugin is an extension for customizing OpenShift web console by dynamically loading code from another service running on the cluster.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
type ConsolePlugin struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta `json:"metadata"`
// +kubebuilder:validation:Required
Spec ConsolePluginSpec `json:"spec"`
}
func (in *ConsolePlugin) DeepCopy() *ConsolePlugin
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsolePlugin.
func (in *ConsolePlugin) DeepCopyInto(out *ConsolePlugin)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsolePlugin) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsolePlugin) SwaggerDoc() map[string]string
ConsolePluginBackend holds information about the endpoint which serves the console's plugin +union
type ConsolePluginBackend struct {
// type is the backend type which servers the console's plugin. Currently only "Service" is supported.
//
// ---
// + When handling unknown values, consumers should report an error and stop processing the plugin.
//
// +kubebuilder:validation:Required
// +unionDiscriminator
Type ConsolePluginBackendType `json:"type"`
// service is a Kubernetes Service that exposes the plugin using a
// deployment with an HTTP server. The Service must use HTTPS and
// Service serving certificate. The console backend will proxy the
// plugins assets from the Service using the service CA bundle.
// +optional
Service *ConsolePluginService `json:"service"`
}
func (in *ConsolePluginBackend) DeepCopy() *ConsolePluginBackend
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsolePluginBackend.
func (in *ConsolePluginBackend) DeepCopyInto(out *ConsolePluginBackend)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsolePluginBackend) SwaggerDoc() map[string]string
ConsolePluginBackendType is an enumeration of available backend types +kubebuilder:validation:Enum:=Service
type ConsolePluginBackendType string
const (
// Service is used when plugin's backend is served by a Kubernetes Service
Service ConsolePluginBackendType = "Service"
)
ConsolePluginI18n holds information on localization resources that are served by the dynamic plugin.
type ConsolePluginI18n struct {
// loadType indicates how the plugin's localization resource should be loaded.
// Valid values are Preload, Lazy and the empty string.
// When set to Preload, all localization resources are fetched when the plugin is loaded.
// When set to Lazy, localization resources are lazily loaded as and when they are required by the console.
// When omitted or set to the empty string, the behaviour is equivalent to Lazy type.
// +kubebuilder:validation:Required
LoadType LoadType `json:"loadType"`
}
func (in *ConsolePluginI18n) DeepCopy() *ConsolePluginI18n
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsolePluginI18n.
func (in *ConsolePluginI18n) DeepCopyInto(out *ConsolePluginI18n)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsolePluginI18n) SwaggerDoc() map[string]string
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
type ConsolePluginList struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard list's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ListMeta `json:"metadata"`
Items []ConsolePlugin `json:"items"`
}
func (in *ConsolePluginList) DeepCopy() *ConsolePluginList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsolePluginList.
func (in *ConsolePluginList) DeepCopyInto(out *ConsolePluginList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsolePluginList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsolePluginList) SwaggerDoc() map[string]string
ConsolePluginProxy holds information on various service types to which console's backend will proxy the plugin's requests.
type ConsolePluginProxy struct {
// endpoint provides information about endpoint to which the request is proxied to.
// +kubebuilder:validation:Required
Endpoint ConsolePluginProxyEndpoint `json:"endpoint"`
// alias is a proxy name that identifies the plugin's proxy. An alias name
// should be unique per plugin. The console backend exposes following
// proxy endpoint:
//
// /api/proxy/plugin/<plugin-name>/<proxy-alias>/<request-path>?<optional-query-parameters>
//
// Request example path:
//
// /api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver
//
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=128
// +kubebuilder:validation:Pattern=`^[A-Za-z0-9-_]+$`
Alias string `json:"alias"`
// caCertificate provides the cert authority certificate contents,
// in case the proxied Service is using custom service CA.
// By default, the service CA bundle provided by the service-ca operator is used.
// +kubebuilder:validation:Pattern=`^-----BEGIN CERTIFICATE-----([\s\S]*)-----END CERTIFICATE-----\s?$`
// +optional
CACertificate string `json:"caCertificate,omitempty"`
// authorization provides information about authorization type,
// which the proxied request should contain
// +kubebuilder:default:="None"
// +optional
Authorization AuthorizationType `json:"authorization,omitempty"`
}
func (in *ConsolePluginProxy) DeepCopy() *ConsolePluginProxy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsolePluginProxy.
func (in *ConsolePluginProxy) DeepCopyInto(out *ConsolePluginProxy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsolePluginProxy) SwaggerDoc() map[string]string
ConsolePluginProxyEndpoint holds information about the endpoint to which request will be proxied to. +union
type ConsolePluginProxyEndpoint struct {
// type is the type of the console plugin's proxy. Currently only "Service" is supported.
//
// ---
// + When handling unknown values, consumers should report an error and stop processing the plugin.
//
// +kubebuilder:validation:Required
// +unionDiscriminator
Type ConsolePluginProxyType `json:"type"`
// service is an in-cluster Service that the plugin will connect to.
// The Service must use HTTPS. The console backend exposes an endpoint
// in order to proxy communication between the plugin and the Service.
// Note: service field is required for now, since currently only "Service"
// type is supported.
// +optional
Service *ConsolePluginProxyServiceConfig `json:"service,omitempty"`
}
func (in *ConsolePluginProxyEndpoint) DeepCopy() *ConsolePluginProxyEndpoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsolePluginProxyEndpoint.
func (in *ConsolePluginProxyEndpoint) DeepCopyInto(out *ConsolePluginProxyEndpoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsolePluginProxyEndpoint) SwaggerDoc() map[string]string
ProxyTypeServiceConfig holds information on Service to which console's backend will proxy the plugin's requests.
type ConsolePluginProxyServiceConfig struct {
// name of Service that the plugin needs to connect to.
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=128
Name string `json:"name"`
// namespace of Service that the plugin needs to connect to
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=128
Namespace string `json:"namespace"`
// port on which the Service that the plugin needs to connect to
// is listening on.
// +kubebuilder:validation:Required
// +kubebuilder:validation:Maximum:=65535
// +kubebuilder:validation:Minimum:=1
Port int32 `json:"port"`
}
func (in *ConsolePluginProxyServiceConfig) DeepCopy() *ConsolePluginProxyServiceConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsolePluginProxyServiceConfig.
func (in *ConsolePluginProxyServiceConfig) DeepCopyInto(out *ConsolePluginProxyServiceConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsolePluginProxyServiceConfig) SwaggerDoc() map[string]string
ProxyType is an enumeration of available proxy types +kubebuilder:validation:Enum:=Service
type ConsolePluginProxyType string
const (
// ProxyTypeService is used when proxying communication to a Service
ProxyTypeService ConsolePluginProxyType = "Service"
)
ConsolePluginService holds information on Service that is serving console dynamic plugin assets.
type ConsolePluginService struct {
// name of Service that is serving the plugin assets.
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=128
Name string `json:"name"`
// namespace of Service that is serving the plugin assets.
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=128
Namespace string `json:"namespace"`
// port on which the Service that is serving the plugin is listening to.
// +kubebuilder:validation:Required
// +kubebuilder:validation:Maximum:=65535
// +kubebuilder:validation:Minimum:=1
Port int32 `json:"port"`
// basePath is the path to the plugin's assets. The primary asset it the
// manifest file called `plugin-manifest.json`, which is a JSON document
// that contains metadata about the plugin and the extensions.
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=256
// +kubebuilder:validation:Pattern=`^[a-zA-Z0-9.\-_~!$&'()*+,;=:@\/]*$`
// +kubebuilder:default:="/"
// +optional
BasePath string `json:"basePath"`
}
func (in *ConsolePluginService) DeepCopy() *ConsolePluginService
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsolePluginService.
func (in *ConsolePluginService) DeepCopyInto(out *ConsolePluginService)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsolePluginService) SwaggerDoc() map[string]string
ConsolePluginSpec is the desired plugin configuration.
type ConsolePluginSpec struct {
// displayName is the display name of the plugin.
// The dispalyName should be between 1 and 128 characters.
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=128
DisplayName string `json:"displayName"`
// backend holds the configuration of backend which is serving console's plugin .
// +kubebuilder:validation:Required
Backend ConsolePluginBackend `json:"backend"`
// proxy is a list of proxies that describe various service type
// to which the plugin needs to connect to.
// +optional
Proxy []ConsolePluginProxy `json:"proxy,omitempty"`
// i18n is the configuration of plugin's localization resources.
// +optional
I18n ConsolePluginI18n `json:"i18n"`
}
func (in *ConsolePluginSpec) DeepCopy() *ConsolePluginSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsolePluginSpec.
func (in *ConsolePluginSpec) DeepCopyInto(out *ConsolePluginSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsolePluginSpec) SwaggerDoc() map[string]string
ConsoleQuickStart is an extension for guiding user through various workflows in the OpenShift web console.
Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=2
type ConsoleQuickStart struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta `json:"metadata,omitempty"`
// +kubebuilder:validation:Required
// +required
Spec ConsoleQuickStartSpec `json:"spec"`
}
func (in *ConsoleQuickStart) DeepCopy() *ConsoleQuickStart
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleQuickStart.
func (in *ConsoleQuickStart) DeepCopyInto(out *ConsoleQuickStart)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsoleQuickStart) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleQuickStart) SwaggerDoc() map[string]string
Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=2
type ConsoleQuickStartList struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard list's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ListMeta `json:"metadata"`
Items []ConsoleQuickStart `json:"items"`
}
func (in *ConsoleQuickStartList) DeepCopy() *ConsoleQuickStartList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleQuickStartList.
func (in *ConsoleQuickStartList) DeepCopyInto(out *ConsoleQuickStartList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsoleQuickStartList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleQuickStartList) SwaggerDoc() map[string]string
ConsoleQuickStartSpec is the desired quick start configuration.
type ConsoleQuickStartSpec struct {
// displayName is the display name of the Quick Start.
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +required
DisplayName string `json:"displayName"`
// icon is a base64 encoded image that will be displayed beside the Quick Start display name.
// The icon should be an vector image for easy scaling. The size of the icon should be 40x40.
// +optional
Icon string `json:"icon,omitempty"`
// tags is a list of strings that describe the Quick Start.
// +optional
Tags []string `json:"tags,omitempty"`
// durationMinutes describes approximately how many minutes it will take to complete the Quick Start.
// +kubebuilder:validation:Required
// +kubebuilder:validation:Minimum=1
// +required
DurationMinutes int `json:"durationMinutes"`
// description is the description of the Quick Start. (includes markdown)
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=256
// +required
Description string `json:"description"`
// prerequisites contains all prerequisites that need to be met before taking a Quick Start. (includes markdown)
// +optional
Prerequisites []string `json:"prerequisites,omitempty"`
// introduction describes the purpose of the Quick Start. (includes markdown)
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +required
Introduction string `json:"introduction"`
// tasks is the list of steps the user has to perform to complete the Quick Start.
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinItems=1
// +required
Tasks []ConsoleQuickStartTask `json:"tasks"`
// conclusion sums up the Quick Start and suggests the possible next steps. (includes markdown)
// +optional
Conclusion string `json:"conclusion,omitempty"`
// nextQuickStart is a list of the following Quick Starts, suggested for the user to try.
// +optional
NextQuickStart []string `json:"nextQuickStart,omitempty"`
// accessReviewResources contains a list of resources that the user's access
// will be reviewed against in order for the user to complete the Quick Start.
// The Quick Start will be hidden if any of the access reviews fail.
// +optional
AccessReviewResources []authorizationv1.ResourceAttributes `json:"accessReviewResources,omitempty"`
}
func (in *ConsoleQuickStartSpec) DeepCopy() *ConsoleQuickStartSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleQuickStartSpec.
func (in *ConsoleQuickStartSpec) DeepCopyInto(out *ConsoleQuickStartSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleQuickStartSpec) SwaggerDoc() map[string]string
ConsoleQuickStartTask is a single step in a Quick Start.
type ConsoleQuickStartTask struct {
// title describes the task and is displayed as a step heading.
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +required
Title string `json:"title"`
// description describes the steps needed to complete the task. (includes markdown)
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +required
Description string `json:"description"`
// review contains instructions to validate the task is complete. The user will select 'Yes' or 'No'.
// using a radio button, which indicates whether the step was completed successfully.
// +optional
Review *ConsoleQuickStartTaskReview `json:"review,omitempty"`
// summary contains information about the passed step.
// +optional
Summary *ConsoleQuickStartTaskSummary `json:"summary,omitempty"`
}
func (in *ConsoleQuickStartTask) DeepCopy() *ConsoleQuickStartTask
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleQuickStartTask.
func (in *ConsoleQuickStartTask) DeepCopyInto(out *ConsoleQuickStartTask)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleQuickStartTask) SwaggerDoc() map[string]string
ConsoleQuickStartTaskReview contains instructions that validate a task was completed successfully.
type ConsoleQuickStartTaskReview struct {
// instructions contains steps that user needs to take in order
// to validate his work after going through a task. (includes markdown)
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +required
Instructions string `json:"instructions"`
// failedTaskHelp contains suggestions for a failed task review and is shown at the end of task. (includes markdown)
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +required
FailedTaskHelp string `json:"failedTaskHelp"`
}
func (in *ConsoleQuickStartTaskReview) DeepCopy() *ConsoleQuickStartTaskReview
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleQuickStartTaskReview.
func (in *ConsoleQuickStartTaskReview) DeepCopyInto(out *ConsoleQuickStartTaskReview)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleQuickStartTaskReview) SwaggerDoc() map[string]string
ConsoleQuickStartTaskSummary contains information about a passed step.
type ConsoleQuickStartTaskSummary struct {
// success describes the succesfully passed task.
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +required
Success string `json:"success"`
// failed briefly describes the unsuccessfully passed task. (includes markdown)
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=128
// +required
Failed string `json:"failed"`
}
func (in *ConsoleQuickStartTaskSummary) DeepCopy() *ConsoleQuickStartTaskSummary
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleQuickStartTaskSummary.
func (in *ConsoleQuickStartTaskSummary) DeepCopyInto(out *ConsoleQuickStartTaskSummary)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleQuickStartTaskSummary) SwaggerDoc() map[string]string
ConsoleYAMLSample is an extension for customizing OpenShift web console YAML samples.
Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=2
type ConsoleYAMLSample struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta `json:"metadata"`
Spec ConsoleYAMLSampleSpec `json:"spec"`
}
func (in *ConsoleYAMLSample) DeepCopy() *ConsoleYAMLSample
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleYAMLSample.
func (in *ConsoleYAMLSample) DeepCopyInto(out *ConsoleYAMLSample)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsoleYAMLSample) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleYAMLSample) SwaggerDoc() map[string]string
ConsoleYAMLSampleDescription of the YAML sample. +kubebuilder:validation:Pattern=`^(.|\s)*\S(.|\s)*$`
type ConsoleYAMLSampleDescription string
Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=2
type ConsoleYAMLSampleList struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard list's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ListMeta `json:"metadata"`
Items []ConsoleYAMLSample `json:"items"`
}
func (in *ConsoleYAMLSampleList) DeepCopy() *ConsoleYAMLSampleList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleYAMLSampleList.
func (in *ConsoleYAMLSampleList) DeepCopyInto(out *ConsoleYAMLSampleList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ConsoleYAMLSampleList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ConsoleYAMLSampleList) SwaggerDoc() map[string]string
ConsoleYAMLSampleSpec is the desired YAML sample configuration. Samples will appear with their descriptions in a samples sidebar when creating a resources in the web console.
type ConsoleYAMLSampleSpec struct {
// targetResource contains apiVersion and kind of the resource
// YAML sample is representating.
TargetResource metav1.TypeMeta `json:"targetResource"`
// title of the YAML sample.
Title ConsoleYAMLSampleTitle `json:"title"`
// description of the YAML sample.
Description ConsoleYAMLSampleDescription `json:"description"`
// yaml is the YAML sample to display.
YAML ConsoleYAMLSampleYAML `json:"yaml"`
// snippet indicates that the YAML sample is not the full YAML resource
// definition, but a fragment that can be inserted into the existing
// YAML document at the user's cursor.
// +optional
Snippet bool `json:"snippet"`
}
func (in *ConsoleYAMLSampleSpec) DeepCopy() *ConsoleYAMLSampleSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleYAMLSampleSpec.
func (in *ConsoleYAMLSampleSpec) DeepCopyInto(out *ConsoleYAMLSampleSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleYAMLSampleSpec) SwaggerDoc() map[string]string
ConsoleYAMLSampleTitle of the YAML sample. +kubebuilder:validation:Pattern=`^(.|\s)*\S(.|\s)*$`
type ConsoleYAMLSampleTitle string
ConsoleYAMLSampleYAML is the YAML sample to display. +kubebuilder:validation:Pattern=`^(.|\s)*\S(.|\s)*$`
type ConsoleYAMLSampleYAML string
Represents a standard link that could be generated in HTML
type Link struct {
// text is the display text for the link
Text string `json:"text"`
// href is the absolute secure URL for the link (must use https)
// +kubebuilder:validation:Pattern=`^https://`
Href string `json:"href"`
}
func (in *Link) DeepCopy() *Link
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Link.
func (in *Link) DeepCopyInto(out *Link)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Link) SwaggerDoc() map[string]string
LoadType is an enumeration of i18n loading types +kubebuilder:validation:Enum:=Preload;Lazy;""
type LoadType string
const (
// Preload will load all plugin's localization resources during
// loading of the plugin.
Preload LoadType = "Preload"
// Lazy wont preload any plugin's localization resources, instead
// will leave thier loading to runtime's lazy-loading.
Lazy LoadType = "Lazy"
// Empty is the default value of the LoadType field and it's
// purpose is to improve discoverability of the field. The
// the behaviour is equivalent to Lazy type.
Empty LoadType = ""
)
NamespaceDashboardSpec is a specification of namespaces in which the dashboard link should appear. If both namespaces and namespaceSelector are specified, the link will appear in namespaces that match either
type NamespaceDashboardSpec struct {
// namespaces is an array of namespace names in which the dashboard link should appear.
//
// +optional
Namespaces []string `json:"namespaces,omitempty"`
// namespaceSelector is used to select the Namespaces that should contain dashboard link by label.
// If the namespace labels match, dashboard link will be shown for the namespaces.
//
// +optional
NamespaceSelector *metav1.LabelSelector `json:"namespaceSelector,omitempty"`
}
func (in *NamespaceDashboardSpec) DeepCopy() *NamespaceDashboardSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamespaceDashboardSpec.
func (in *NamespaceDashboardSpec) DeepCopyInto(out *NamespaceDashboardSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NamespaceDashboardSpec) SwaggerDoc() map[string]string