v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group +kubebuilder:object:generate=true +groupName=operator.openshift.io

Index

• Constants
• Variables
• type OpenShiftBuild
  • func (in *OpenShiftBuild) DeepCopy() *OpenShiftBuild
  • func (in *OpenShiftBuild) DeepCopyInto(out *OpenShiftBuild)
  • func (in *OpenShiftBuild) DeepCopyObject() runtime.Object
• type OpenShiftBuildList
  • func (in *OpenShiftBuildList) DeepCopy() *OpenShiftBuildList
  • func (in *OpenShiftBuildList) DeepCopyInto(out *OpenShiftBuildList)
  • func (in *OpenShiftBuildList) DeepCopyObject() runtime.Object
• type OpenShiftBuildSpec
  • func (in *OpenShiftBuildSpec) DeepCopy() *OpenShiftBuildSpec
  • func (in *OpenShiftBuildSpec) DeepCopyInto(out *OpenShiftBuildSpec)
• type OpenShiftBuildStatus
  • func (in *OpenShiftBuildStatus) DeepCopy() *OpenShiftBuildStatus
  • func (in *OpenShiftBuildStatus) DeepCopyInto(out *OpenShiftBuildStatus)
  • func (status *OpenShiftBuildStatus) IsReady() bool
• type SharedResource
  • func (in *SharedResource) DeepCopy() *SharedResource
  • func (in *SharedResource) DeepCopyInto(out *SharedResource)
• type Shipwright
  • func (in *Shipwright) DeepCopy() *Shipwright
  • func (in *Shipwright) DeepCopyInto(out *Shipwright)
• type ShipwrightBuild
  • func (in *ShipwrightBuild) DeepCopy() *ShipwrightBuild
  • func (in *ShipwrightBuild) DeepCopyInto(out *ShipwrightBuild)
• type State

Constants

const (
	// ConditionReady object is providing service.
	ConditionReady = "Ready"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "operator.openshift.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type OpenShiftBuild

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

	Spec   OpenShiftBuildSpec   `json:"spec,omitempty"`
	Status OpenShiftBuildStatus `json:"status,omitempty"`
}

OpenShiftBuild describes the desired state of Builds for OpenShift, and the status of all deployed components.

func (*OpenShiftBuild) DeepCopy

func (in *OpenShiftBuild) DeepCopy() *OpenShiftBuild

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

func (*OpenShiftBuild) DeepCopyInto

func (in *OpenShiftBuild) DeepCopyInto(out *OpenShiftBuild)

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

func (*OpenShiftBuild) DeepCopyObject

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

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

type OpenShiftBuildList

type OpenShiftBuildList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []OpenShiftBuild `json:"items"`
}

OpenShiftBuildList contains a list of OpenShiftBuild

func (*OpenShiftBuildList) DeepCopy

func (in *OpenShiftBuildList) DeepCopy() *OpenShiftBuildList

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

func (*OpenShiftBuildList) DeepCopyInto

func (in *OpenShiftBuildList) DeepCopyInto(out *OpenShiftBuildList)

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

func (*OpenShiftBuildList) DeepCopyObject

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

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

type OpenShiftBuildSpec

type OpenShiftBuildSpec struct {

	// Shipwright defines the desired state of Shipwright components.
	//
	// +kubebuilder:validation:Optional
	// +optional
	Shipwright *Shipwright `json:"shipwright,omitempty"`

	// SharedResource defines the desired state of the Shared Resource CSI Driver components.
	//
	// +kubebuilder:validation:Optional
	// +optional
	SharedResource *SharedResource `json:"sharedResource,omitempty"`
}

OpenShiftBuildSpec defines the desired state of Builds for OpenShift components.

func (*OpenShiftBuildSpec) DeepCopy

func (in *OpenShiftBuildSpec) DeepCopy() *OpenShiftBuildSpec

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

func (*OpenShiftBuildSpec) DeepCopyInto

func (in *OpenShiftBuildSpec) DeepCopyInto(out *OpenShiftBuildSpec)

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

type OpenShiftBuildStatus

type OpenShiftBuildStatus struct {

	// Conditions holds the latest available observations of a resource's current state.
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

OpenShiftBuildStatus defines the observed state of OpenShiftBuild

func (*OpenShiftBuildStatus) DeepCopy

func (in *OpenShiftBuildStatus) DeepCopy() *OpenShiftBuildStatus

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

func (*OpenShiftBuildStatus) DeepCopyInto

func (in *OpenShiftBuildStatus) DeepCopyInto(out *OpenShiftBuildStatus)

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

func (*OpenShiftBuildStatus) IsReady

func (status *OpenShiftBuildStatus) IsReady() bool

IsReady returns true the Ready condition status is True

type SharedResource

type SharedResource struct {

	// State defines the desired state of SharedResource CSI Driver, APIs, and related components.
	// Must be one of Enabled or Disabled.
	//
	// +kubebuilder:default="Enabled"
	State `json:"state"`
}

SharedResource defines the desired state of Shared Resource CSI Driver and components.

func (*SharedResource) DeepCopy

func (in *SharedResource) DeepCopy() *SharedResource

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

func (*SharedResource) DeepCopyInto

func (in *SharedResource) DeepCopyInto(out *SharedResource)

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

type Shipwright

type Shipwright struct {

	// Build defines the desired state of Shipwright Build APIs, controllers, and related components.
	//
	// +kubebuilder:validation:Optional
	// +optional
	Build *ShipwrightBuild `json:"build,omitempty"`
}

Shipwright defines the desired state of Shipwright components

func (*Shipwright) DeepCopy

func (in *Shipwright) DeepCopy() *Shipwright

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

func (*Shipwright) DeepCopyInto

func (in *Shipwright) DeepCopyInto(out *Shipwright)

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

type ShipwrightBuild

type ShipwrightBuild struct {

	// State defines the desired state of the Shipwright Build controller, APIs, and related
	// components. Must be one of Enabled or Disabled.
	//
	// +kubebuilder:default="Enabled"
	State `json:"state"`
}

ShipwrightBuild defines the desired state of Shipwright Builds

func (*ShipwrightBuild) DeepCopy

func (in *ShipwrightBuild) DeepCopy() *ShipwrightBuild

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

func (*ShipwrightBuild) DeepCopyInto

func (in *ShipwrightBuild) DeepCopyInto(out *ShipwrightBuild)

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

type State

type State string

State defines the desired state of a component +kubebuilder:validation:Enum="Enabled";"Disabled"

const (
	// Enabled will install the component, including any additional custom resource definitions.
	Enabled State = "Enabled"

	// Disabled will remove the component, but may leave behind any custom resource definitions.
	Disabled State = "Disabled"
)