v1

package
v1.0.0-2021-10-...-363b110 Latest Latest
Warning

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

 Go to latest Published: Mar 16, 2022 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source 
const (
	ManagedServiceAccount string = "managed-service-account"
	ConsoleMCE            string = "console-mce"
	Discovery             string = "discovery"
	Hive                  string = "hive"
	AssistedService       string = "assisted-service"
	ClusterLifecycle      string = "cluster-lifecycle"
	ClusterManager        string = "cluster-manager"
	ServerFoundation      string = "server-foundation"
	HyperShift            string = "hypershift-preview"
)
View Source 
const (
	DefaultTargetNamespace = "multicluster-engine"
)

Variables

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

	// 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
)
View Source 
var (
	Client cl.Client
)

log is for logging in this package.

Functions

This section is empty.

Types

type AvailabilityType 

type AvailabilityType string

AvailabilityType ... 

const (
	// HABasic stands up most app subscriptions with a replicaCount of 1
	HABasic AvailabilityType = "Basic"
	// HAHigh stands up most app subscriptions with a replicaCount of 2
	HAHigh AvailabilityType = "High"
)

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 ComponentConfig 

type ComponentConfig struct {
	Name    string `json:"name"`
	Enabled bool   `json:"enabled"`
}

ComponentConfig provides optional configuration items for individual components

func (*ComponentConfig) DeepCopy 

func (in *ComponentConfig) DeepCopy() *ComponentConfig

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

func (*ComponentConfig) DeepCopyInto 

func (in *ComponentConfig) DeepCopyInto(out *ComponentConfig)

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

func (mce *MultiClusterEngine) ComponentPresent(s string) bool

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

func (mce *MultiClusterEngine) Disable(s string)

func (*MultiClusterEngine) Enable 

func (mce *MultiClusterEngine) Enable(s string)

func (*MultiClusterEngine) Enabled 

func (mce *MultiClusterEngine) Enabled(s string) bool

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 {

	// Specifies deployment replication for improved availability. Options are: Basic and High (default)
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Availability Configuration",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:advanced","urn:alm:descriptor:com.tectonic.ui:select:High","urn:alm:descriptor:com.tectonic.ui:select:Basic"}
	AvailabilityConfig AvailabilityType `json:"availabilityConfig,omitempty"`

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

	// Developer Overrides
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Developer Overrides",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:hidden"}
	Overrides *Overrides `json:"overrides,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 Overrides 

type Overrides struct {
	// Pull policy for the MCE images
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`

	// Provides optional configuration for components
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Component Configuration",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:hidden"}
	// +optional
	Components []ComponentConfig `json:"components,omitempty"`
}

Overrides provides developer overrides for MCE installation

func (*Overrides) DeepCopy 

func (in *Overrides) DeepCopy() *Overrides

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

func (*Overrides) DeepCopyInto 

func (in *Overrides) DeepCopyInto(out *Overrides)

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

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.