v1alpha1

Documentation

Overview

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

Index

• Variables
• type ComponentCondition
  • func (in *ComponentCondition) DeepCopy() *ComponentCondition
  • func (in *ComponentCondition) DeepCopyInto(out *ComponentCondition)
• type MultiClusterEngine
  • func (in *MultiClusterEngine) DeepCopy() *MultiClusterEngine
  • func (in *MultiClusterEngine) DeepCopyInto(out *MultiClusterEngine)
  • func (in *MultiClusterEngine) DeepCopyObject() runtime.Object
  • func (r *MultiClusterEngine) Default()
  • func (r *MultiClusterEngine) SetupWebhookWithManager(mgr ctrl.Manager) error
  • func (r *MultiClusterEngine) ValidateCreate() error
  • func (r *MultiClusterEngine) ValidateDelete() error
  • func (r *MultiClusterEngine) ValidateUpdate(old runtime.Object) error
• type MultiClusterEngineCondition
  • func (in *MultiClusterEngineCondition) DeepCopy() *MultiClusterEngineCondition
  • func (in *MultiClusterEngineCondition) DeepCopyInto(out *MultiClusterEngineCondition)
• type MultiClusterEngineConditionType
• type MultiClusterEngineList
  • func (in *MultiClusterEngineList) DeepCopy() *MultiClusterEngineList
  • func (in *MultiClusterEngineList) DeepCopyInto(out *MultiClusterEngineList)
  • func (in *MultiClusterEngineList) DeepCopyObject() runtime.Object
• type MultiClusterEngineSpec
  • func (in *MultiClusterEngineSpec) DeepCopy() *MultiClusterEngineSpec
  • func (in *MultiClusterEngineSpec) DeepCopyInto(out *MultiClusterEngineSpec)
• type MultiClusterEngineStatus
  • func (in *MultiClusterEngineStatus) DeepCopy() *MultiClusterEngineStatus
  • func (in *MultiClusterEngineStatus) DeepCopyInto(out *MultiClusterEngineStatus)
• type PhaseType

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "multicluster.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
)

var (
	Client cl.Client
)

log is for logging in this package.

Types

type ComponentCondition

type ComponentCondition struct {
	// The component name
	Name string `json:"name,omitempty"`

	// The resource kind this condition represents
	Kind string `json:"kind,omitempty"`

	// Available indicates whether this component is considered properly running
	Available bool `json:"-"`

	// Type is the type of the cluster condition.
	// +required
	Type string `json:"type,omitempty"`

	// Status is the status of the condition. One of True, False, Unknown.
	// +required
	Status metav1.ConditionStatus `json:"status,omitempty"`

	// The last time this condition was updated.
	LastUpdateTime metav1.Time `json:"-"`

	// LastTransitionTime is the last time the condition changed from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// Reason is a (brief) reason for the condition's last status change.
	// +required
	Reason string `json:"reason,omitempty"`

	// Message is a human-readable message indicating details about the last status change.
	// +required
	Message string `json:"message,omitempty"`
}

ComponentCondition contains condition information for tracked components

func (*ComponentCondition) DeepCopy

func (in *ComponentCondition) DeepCopy() *ComponentCondition

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

func (*ComponentCondition) DeepCopyInto

func (in *ComponentCondition) DeepCopyInto(out *ComponentCondition)

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

type MultiClusterEngine

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

	Spec   MultiClusterEngineSpec   `json:"spec,omitempty"`
	Status MultiClusterEngineStatus `json:"status,omitempty"`
}

MultiClusterEngine is the Schema for the multiclusterengines API +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.phase",description="The overall state of the MultiClusterEngine" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +operator-sdk:csv:customresourcedefinitions:displayName="MultiCluster Engine"

func (*MultiClusterEngine) DeepCopy

func (in *MultiClusterEngine) DeepCopy() *MultiClusterEngine

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

func (*MultiClusterEngine) DeepCopyInto

func (in *MultiClusterEngine) DeepCopyInto(out *MultiClusterEngine)

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

func (*MultiClusterEngine) DeepCopyObject

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

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

func (*MultiClusterEngine) Default

func (r *MultiClusterEngine) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*MultiClusterEngine) SetupWebhookWithManager

func (r *MultiClusterEngine) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*MultiClusterEngine) ValidateCreate

func (r *MultiClusterEngine) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*MultiClusterEngine) ValidateDelete

func (r *MultiClusterEngine) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*MultiClusterEngine) ValidateUpdate

func (r *MultiClusterEngine) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type MultiClusterEngineCondition

type MultiClusterEngineCondition struct {
	// Type is the type of the cluster condition.
	// +required
	Type MultiClusterEngineConditionType `json:"type,omitempty"`

	// Status is the status of the condition. One of True, False, Unknown.
	// +required
	Status metav1.ConditionStatus `json:"status,omitempty"`

	// The last time this condition was updated.
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"`

	// LastTransitionTime is the last time the condition changed from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// Reason is a (brief) reason for the condition's last status change.
	// +required
	Reason string `json:"reason,omitempty"`

	// Message is a human-readable message indicating details about the last status change.
	// +required
	Message string `json:"message,omitempty"`
}

func (*MultiClusterEngineCondition) DeepCopy

func (in *MultiClusterEngineCondition) DeepCopy() *MultiClusterEngineCondition

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

func (*MultiClusterEngineCondition) DeepCopyInto

func (in *MultiClusterEngineCondition) DeepCopyInto(out *MultiClusterEngineCondition)

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

type MultiClusterEngineConditionType

type MultiClusterEngineConditionType string

const (
	// Available means the deployment is available, ie. at least the minimum available
	// replicas required are up and running for at least minReadySeconds.
	MultiClusterEngineAvailable MultiClusterEngineConditionType = "Available"
	// Progressing means the deployment is progressing. Progress for a deployment is
	// considered when a new replica set is created or adopted, and when new pods scale
	// up or old pods scale down. Progress is not estimated for paused deployments or
	// when progressDeadlineSeconds is not specified.
	MultiClusterEngineProgressing MultiClusterEngineConditionType = "Progressing"
	// Failure is added in a deployment when one of its pods fails to be created
	// or deleted.
	MultiClusterEngineFailure MultiClusterEngineConditionType = "MultiClusterEngineFailure"
)

These are valid conditions of the multiclusterengine.

type MultiClusterEngineList

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

MultiClusterEngineList contains a list of MultiClusterEngine

func (*MultiClusterEngineList) DeepCopy

func (in *MultiClusterEngineList) DeepCopy() *MultiClusterEngineList

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

func (*MultiClusterEngineList) DeepCopyInto

func (in *MultiClusterEngineList) DeepCopyInto(out *MultiClusterEngineList)

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

func (*MultiClusterEngineList) DeepCopyObject

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

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

type MultiClusterEngineSpec

type MultiClusterEngineSpec struct {
	// Set the nodeselectors
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`

	// Override pull secret for accessing MultiClusterEngine operand and endpoint images
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Image Pull Secret",xDescriptors={"urn:alm:descriptor:io.kubernetes:Secret","urn:alm:descriptor:com.tectonic.ui:advanced"}
	ImagePullSecret string `json:"imagePullSecret,omitempty"`

	// Tolerations causes all components to tolerate any taints.
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`

	// Location where MCE resources will be placed
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Target Namespace",xDescriptors={"urn:alm:descriptor:io.kubernetes:text","urn:alm:descriptor:com.tectonic.ui:advanced"}
	TargetNamespace string `json:"targetNamespace,omitempty"`
}

MultiClusterEngineSpec defines the desired state of MultiClusterEngine

func (*MultiClusterEngineSpec) DeepCopy

func (in *MultiClusterEngineSpec) DeepCopy() *MultiClusterEngineSpec

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

func (*MultiClusterEngineSpec) DeepCopyInto

func (in *MultiClusterEngineSpec) DeepCopyInto(out *MultiClusterEngineSpec)

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

type MultiClusterEngineStatus

type MultiClusterEngineStatus struct {
	// Latest observed overall state
	Phase PhaseType `json:"phase,omitempty"`

	Components []ComponentCondition `json:"components,omitempty"`

	Conditions []MultiClusterEngineCondition `json:"conditions,omitempty"`
}

MultiClusterEngineStatus defines the observed state of MultiClusterEngine

func (*MultiClusterEngineStatus) DeepCopy

func (in *MultiClusterEngineStatus) DeepCopy() *MultiClusterEngineStatus

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

func (*MultiClusterEngineStatus) DeepCopyInto

func (in *MultiClusterEngineStatus) DeepCopyInto(out *MultiClusterEngineStatus)

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

type PhaseType

type PhaseType string

PhaseType is a summary of the current state of the MultiClusterEngine in its lifecycle

const (
	MultiClusterEnginePhaseProgressing  PhaseType = "Progressing"
	MultiClusterEnginePhaseAvailable    PhaseType = "Available"
	MultiClusterEnginePhaseUninstalling PhaseType = "Uninstalling"
	MultiClusterEnginePhaseError        PhaseType = "Error"
)