v1

package
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 12, 2022 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

+groupName=console.openshift.io Package v1 is the v1 version of the API.

Index

Constants

This section is empty.

Variables

View Source 
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
)

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 ApplicationMenuSpec 

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"`
}

ApplicationMenuSpec is the specification of the desired section and icon used for the link in the application menu.

func (*ApplicationMenuSpec) DeepCopy 

func (in *ApplicationMenuSpec) DeepCopy() *ApplicationMenuSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApplicationMenuSpec.

func (*ApplicationMenuSpec) DeepCopyInto 

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 

func (ApplicationMenuSpec) SwaggerDoc() map[string]string
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 (*CLIDownloadLink) DeepCopy 

func (in *CLIDownloadLink) DeepCopy() *CLIDownloadLink

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CLIDownloadLink.

func (*CLIDownloadLink) DeepCopyInto 

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 

func (CLIDownloadLink) SwaggerDoc() map[string]string

type ConsoleCLIDownload 

type ConsoleCLIDownload struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec ConsoleCLIDownloadSpec `json:"spec"`
}

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

func (*ConsoleCLIDownload) DeepCopy 

func (in *ConsoleCLIDownload) DeepCopy() *ConsoleCLIDownload

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleCLIDownload.

func (*ConsoleCLIDownload) DeepCopyInto 

func (in *ConsoleCLIDownload) DeepCopyInto(out *ConsoleCLIDownload)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsoleCLIDownload) DeepCopyObject 

func (in *ConsoleCLIDownload) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ConsoleCLIDownload) SwaggerDoc 

func (ConsoleCLIDownload) SwaggerDoc() map[string]string

type ConsoleCLIDownloadList 

type ConsoleCLIDownloadList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ConsoleCLIDownload `json:"items"`
}

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

func (*ConsoleCLIDownloadList) DeepCopy 

func (in *ConsoleCLIDownloadList) DeepCopy() *ConsoleCLIDownloadList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleCLIDownloadList.

func (*ConsoleCLIDownloadList) DeepCopyInto 

func (in *ConsoleCLIDownloadList) DeepCopyInto(out *ConsoleCLIDownloadList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsoleCLIDownloadList) DeepCopyObject 

func (in *ConsoleCLIDownloadList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ConsoleCLIDownloadList) SwaggerDoc 

func (ConsoleCLIDownloadList) SwaggerDoc() map[string]string

type ConsoleCLIDownloadSpec 

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"`
}

ConsoleCLIDownloadSpec is the desired cli download configuration.

func (*ConsoleCLIDownloadSpec) DeepCopy 

func (in *ConsoleCLIDownloadSpec) DeepCopy() *ConsoleCLIDownloadSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleCLIDownloadSpec.

func (*ConsoleCLIDownloadSpec) DeepCopyInto 

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 

func (ConsoleCLIDownloadSpec) SwaggerDoc() map[string]string
type ConsoleExternalLogLink struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec ConsoleExternalLogLinkSpec `json:"spec"`
}

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

func (*ConsoleExternalLogLink) DeepCopy 

func (in *ConsoleExternalLogLink) DeepCopy() *ConsoleExternalLogLink

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleExternalLogLink.

func (*ConsoleExternalLogLink) DeepCopyInto 

func (in *ConsoleExternalLogLink) DeepCopyInto(out *ConsoleExternalLogLink)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsoleExternalLogLink) DeepCopyObject 

func (in *ConsoleExternalLogLink) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ConsoleExternalLogLink) SwaggerDoc 

func (ConsoleExternalLogLink) SwaggerDoc() map[string]string
type ConsoleExternalLogLinkList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ConsoleExternalLogLink `json:"items"`
}

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

func (*ConsoleExternalLogLinkList) DeepCopy 

func (in *ConsoleExternalLogLinkList) DeepCopy() *ConsoleExternalLogLinkList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleExternalLogLinkList.

func (*ConsoleExternalLogLinkList) DeepCopyInto 

func (in *ConsoleExternalLogLinkList) DeepCopyInto(out *ConsoleExternalLogLinkList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsoleExternalLogLinkList) DeepCopyObject 

func (in *ConsoleExternalLogLinkList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ConsoleExternalLogLinkList) SwaggerDoc 

func (ConsoleExternalLogLinkList) SwaggerDoc() map[string]string

type ConsoleExternalLogLinkSpec 

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"`
}

ConsoleExternalLogLinkSpec is the desired log link configuration. The log link will appear on the logs tab of the pod details page.

func (*ConsoleExternalLogLinkSpec) DeepCopy 

func (in *ConsoleExternalLogLinkSpec) DeepCopy() *ConsoleExternalLogLinkSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleExternalLogLinkSpec.

func (*ConsoleExternalLogLinkSpec) DeepCopyInto 

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 

func (ConsoleExternalLogLinkSpec) SwaggerDoc() map[string]string
type ConsoleLink struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec ConsoleLinkSpec `json:"spec"`
}

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

func (*ConsoleLink) DeepCopy 

func (in *ConsoleLink) DeepCopy() *ConsoleLink

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleLink.

func (*ConsoleLink) DeepCopyInto 

func (in *ConsoleLink) DeepCopyInto(out *ConsoleLink)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsoleLink) DeepCopyObject 

func (in *ConsoleLink) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ConsoleLink) SwaggerDoc 

func (ConsoleLink) SwaggerDoc() map[string]string
type ConsoleLinkList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ConsoleLink `json:"items"`
}

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

func (*ConsoleLinkList) DeepCopy 

func (in *ConsoleLinkList) DeepCopy() *ConsoleLinkList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleLinkList.

func (*ConsoleLinkList) DeepCopyInto 

func (in *ConsoleLinkList) DeepCopyInto(out *ConsoleLinkList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsoleLinkList) DeepCopyObject 

func (in *ConsoleLinkList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ConsoleLinkList) SwaggerDoc 

func (ConsoleLinkList) SwaggerDoc() map[string]string

type ConsoleLinkLocation 

type ConsoleLinkLocation string

ConsoleLinkLocationSelector is a set of possible menu targets to which a link may be appended. +kubebuilder:validation:Pattern=`^(ApplicationMenu|HelpMenu|UserMenu|NamespaceDashboard)$` 

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"
)

type ConsoleLinkSpec 

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"`
}

ConsoleLinkSpec is the desired console link configuration.

func (*ConsoleLinkSpec) DeepCopy 

func (in *ConsoleLinkSpec) DeepCopy() *ConsoleLinkSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleLinkSpec.

func (*ConsoleLinkSpec) DeepCopyInto 

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 

func (ConsoleLinkSpec) SwaggerDoc() map[string]string

type ConsoleNotification 

type ConsoleNotification struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec ConsoleNotificationSpec `json:"spec"`
}

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

func (*ConsoleNotification) DeepCopy 

func (in *ConsoleNotification) DeepCopy() *ConsoleNotification

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleNotification.

func (*ConsoleNotification) DeepCopyInto 

func (in *ConsoleNotification) DeepCopyInto(out *ConsoleNotification)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsoleNotification) DeepCopyObject 

func (in *ConsoleNotification) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ConsoleNotification) SwaggerDoc 

func (ConsoleNotification) SwaggerDoc() map[string]string

type ConsoleNotificationList 

type ConsoleNotificationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ConsoleNotification `json:"items"`
}

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

func (*ConsoleNotificationList) DeepCopy 

func (in *ConsoleNotificationList) DeepCopy() *ConsoleNotificationList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleNotificationList.

func (*ConsoleNotificationList) DeepCopyInto 

func (in *ConsoleNotificationList) DeepCopyInto(out *ConsoleNotificationList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsoleNotificationList) DeepCopyObject 

func (in *ConsoleNotificationList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ConsoleNotificationList) SwaggerDoc 

func (ConsoleNotificationList) SwaggerDoc() map[string]string

type ConsoleNotificationLocation 

type ConsoleNotificationLocation string

ConsoleNotificationLocationSelector is a set of possible notification targets to which a notification may be appended. +kubebuilder:validation:Pattern=`^(BannerTop|BannerBottom|BannerTopBottom)$` 

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"
)

type ConsoleNotificationSpec 

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"`
}

ConsoleNotificationSpec is the desired console notification configuration.

func (*ConsoleNotificationSpec) DeepCopy 

func (in *ConsoleNotificationSpec) DeepCopy() *ConsoleNotificationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleNotificationSpec.

func (*ConsoleNotificationSpec) DeepCopyInto 

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 

func (ConsoleNotificationSpec) SwaggerDoc() map[string]string

type ConsoleQuickStart 

type ConsoleQuickStart struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// +kubebuilder:validation:Required
	// +required
	Spec ConsoleQuickStartSpec `json:"spec"`
}

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

func (*ConsoleQuickStart) DeepCopy 

func (in *ConsoleQuickStart) DeepCopy() *ConsoleQuickStart

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleQuickStart.

func (*ConsoleQuickStart) DeepCopyInto 

func (in *ConsoleQuickStart) DeepCopyInto(out *ConsoleQuickStart)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsoleQuickStart) DeepCopyObject 

func (in *ConsoleQuickStart) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ConsoleQuickStart) SwaggerDoc 

func (ConsoleQuickStart) SwaggerDoc() map[string]string

type ConsoleQuickStartList 

type ConsoleQuickStartList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ConsoleQuickStart `json:"items"`
}

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

func (*ConsoleQuickStartList) DeepCopy 

func (in *ConsoleQuickStartList) DeepCopy() *ConsoleQuickStartList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleQuickStartList.

func (*ConsoleQuickStartList) DeepCopyInto 

func (in *ConsoleQuickStartList) DeepCopyInto(out *ConsoleQuickStartList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsoleQuickStartList) DeepCopyObject 

func (in *ConsoleQuickStartList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ConsoleQuickStartList) SwaggerDoc 

func (ConsoleQuickStartList) SwaggerDoc() map[string]string

type ConsoleQuickStartSpec 

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"`
}

ConsoleQuickStartSpec is the desired quick start configuration.

func (*ConsoleQuickStartSpec) DeepCopy 

func (in *ConsoleQuickStartSpec) DeepCopy() *ConsoleQuickStartSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleQuickStartSpec.

func (*ConsoleQuickStartSpec) DeepCopyInto 

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 

func (ConsoleQuickStartSpec) SwaggerDoc() map[string]string

type ConsoleQuickStartTask 

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"`
}

ConsoleQuickStartTask is a single step in a Quick Start.

func (*ConsoleQuickStartTask) DeepCopy 

func (in *ConsoleQuickStartTask) DeepCopy() *ConsoleQuickStartTask

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleQuickStartTask.

func (*ConsoleQuickStartTask) DeepCopyInto 

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 

func (ConsoleQuickStartTask) SwaggerDoc() map[string]string

type ConsoleQuickStartTaskReview 

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"`
}

ConsoleQuickStartTaskReview contains instructions that validate a task was completed successfully.

func (*ConsoleQuickStartTaskReview) DeepCopy 

func (in *ConsoleQuickStartTaskReview) DeepCopy() *ConsoleQuickStartTaskReview

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleQuickStartTaskReview.

func (*ConsoleQuickStartTaskReview) DeepCopyInto 

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 

func (ConsoleQuickStartTaskReview) SwaggerDoc() map[string]string

type ConsoleQuickStartTaskSummary 

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"`
}

ConsoleQuickStartTaskSummary contains information about a passed step.

func (*ConsoleQuickStartTaskSummary) DeepCopy 

func (in *ConsoleQuickStartTaskSummary) DeepCopy() *ConsoleQuickStartTaskSummary

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleQuickStartTaskSummary.

func (*ConsoleQuickStartTaskSummary) DeepCopyInto 

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 

func (ConsoleQuickStartTaskSummary) SwaggerDoc() map[string]string

type ConsoleYAMLSample 

type ConsoleYAMLSample struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec ConsoleYAMLSampleSpec `json:"spec"`
}

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

func (*ConsoleYAMLSample) DeepCopy 

func (in *ConsoleYAMLSample) DeepCopy() *ConsoleYAMLSample

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleYAMLSample.

func (*ConsoleYAMLSample) DeepCopyInto 

func (in *ConsoleYAMLSample) DeepCopyInto(out *ConsoleYAMLSample)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsoleYAMLSample) DeepCopyObject 

func (in *ConsoleYAMLSample) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ConsoleYAMLSample) SwaggerDoc 

func (ConsoleYAMLSample) SwaggerDoc() map[string]string

type ConsoleYAMLSampleDescription 

type ConsoleYAMLSampleDescription string

ConsoleYAMLSampleDescription of the YAML sample. +kubebuilder:validation:Pattern=`^(.|\s)*\S(.|\s)*$`

type ConsoleYAMLSampleList 

type ConsoleYAMLSampleList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ConsoleYAMLSample `json:"items"`
}

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

func (*ConsoleYAMLSampleList) DeepCopy 

func (in *ConsoleYAMLSampleList) DeepCopy() *ConsoleYAMLSampleList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleYAMLSampleList.

func (*ConsoleYAMLSampleList) DeepCopyInto 

func (in *ConsoleYAMLSampleList) DeepCopyInto(out *ConsoleYAMLSampleList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsoleYAMLSampleList) DeepCopyObject 

func (in *ConsoleYAMLSampleList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ConsoleYAMLSampleList) SwaggerDoc 

func (ConsoleYAMLSampleList) SwaggerDoc() map[string]string

type ConsoleYAMLSampleSpec 

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"`
}

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.

func (*ConsoleYAMLSampleSpec) DeepCopy 

func (in *ConsoleYAMLSampleSpec) DeepCopy() *ConsoleYAMLSampleSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleYAMLSampleSpec.

func (*ConsoleYAMLSampleSpec) DeepCopyInto 

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 

func (ConsoleYAMLSampleSpec) SwaggerDoc() map[string]string

type ConsoleYAMLSampleTitle 

type ConsoleYAMLSampleTitle string

ConsoleYAMLSampleTitle of the YAML sample. +kubebuilder:validation:Pattern=`^(.|\s)*\S(.|\s)*$`

type ConsoleYAMLSampleYAML 

type ConsoleYAMLSampleYAML string

ConsoleYAMLSampleYAML is the YAML sample to display. +kubebuilder:validation:Pattern=`^(.|\s)*\S(.|\s)*$` 

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"`
}

Represents a standard link that could be generated in HTML

func (*Link) DeepCopy 

func (in *Link) DeepCopy() *Link

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Link.

func (*Link) DeepCopyInto 

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 

func (Link) SwaggerDoc() map[string]string

type NamespaceDashboardSpec 

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"`
}

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

func (*NamespaceDashboardSpec) DeepCopy 

func (in *NamespaceDashboardSpec) DeepCopy() *NamespaceDashboardSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamespaceDashboardSpec.

func (*NamespaceDashboardSpec) DeepCopyInto 

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 

func (NamespaceDashboardSpec) SwaggerDoc() map[string]string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.