v1alpha1

Documentation

Overview

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

Index

• Constants
• Variables
• type Module
  • func (in *Module) DeepCopy() *Module
  • func (in *Module) DeepCopyInto(out *Module)
  • func (in *Module) DeepCopyObject() runtime.Object
• type ModuleClassType
• type ModuleCondition
  • func (in *ModuleCondition) DeepCopy() *ModuleCondition
  • func (in *ModuleCondition) DeepCopyInto(out *ModuleCondition)
• type ModuleConditionReason
• type ModuleConditionType
• type ModuleList
  • func (in *ModuleList) DeepCopy() *ModuleList
  • func (in *ModuleList) DeepCopyInto(out *ModuleList)
  • func (in *ModuleList) DeepCopyObject() runtime.Object
• type ModuleSpec
  • func (in *ModuleSpec) DeepCopy() *ModuleSpec
  • func (in *ModuleSpec) DeepCopyInto(out *ModuleSpec)
• type ModuleStatus
  • func (in *ModuleStatus) DeepCopy() *ModuleStatus
  • func (in *ModuleStatus) DeepCopyInto(out *ModuleStatus)
• type ValuesFromSource
  • func (in *ValuesFromSource) DeepCopy() *ValuesFromSource
  • func (in *ValuesFromSource) DeepCopyInto(out *ValuesFromSource)

Constants

const (
	// ModuleConditionReady is the Ready condition type
	ModuleConditionReady = "Ready"
)

Variables

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

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

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

Types

type Module

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

	Spec   ModuleSpec   `json:"spec,omitempty"`
	Status ModuleStatus `json:"status,omitempty"`
}

Module specifies a Verrazzano Module instance.

func (*Module) DeepCopy

func (in *Module) DeepCopy() *Module

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

func (*Module) DeepCopyInto

func (in *Module) DeepCopyInto(out *Module)

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

func (*Module) DeepCopyObject

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

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

type ModuleClassType

type ModuleClassType string

ModuleClassType Identifies the class used to manage a set of Module types.

const (
	// HelmModuleClass defines the class type used by the Helm operator.
	HelmModuleClass ModuleClassType = "helm"

	// CalicoModuleClass defines the class type used by the Calico operator.
	CalicoModuleClass ModuleClassType = "calico"

	// CCMModuleClass defines the class type used by the oci-ccm operator.
	CCMModuleClass ModuleClassType = "oci-ccm"

	// MultusModuleClass defines the class type used by the multus operator.
	MultusModuleClass ModuleClassType = "multus"

	// MetallbModuleClass defines the class type used by the Metallb operator.
	MetallbModuleClass ModuleClassType = "metallb"

	// KubevirtModuleClass defines the class type used by the kubevirt operator.
	KubevirtModuleClass ModuleClassType = "kubevirt"

	// RookModuleClass defines the class type used by the rook operator.
	RookModuleClass ModuleClassType = "rook"
)

type ModuleCondition

type ModuleCondition struct {
	// LastTransitionTime is the last time the condition transitioned from one status to another.
	LastTransitionTime string `json:"lastTransitionTime"`

	// Message is a human-readable message indicating details about the last transition.
	Message string `json:"message,omitempty"`

	// Status of the condition: one of `True`, `False`, or `Unknown`.
	Status corev1.ConditionStatus `json:"status"`

	// Type of condition.
	Type ModuleConditionType `json:"type"`

	// Reason for the condition.  This is a machine-readable one word value.
	Reason ModuleConditionReason `json:"reason"`
}

ModuleCondition describes the current condition of the Module.

func (*ModuleCondition) DeepCopy

func (in *ModuleCondition) DeepCopy() *ModuleCondition

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

func (*ModuleCondition) DeepCopyInto

func (in *ModuleCondition) DeepCopyInto(out *ModuleCondition)

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

type ModuleConditionReason

type ModuleConditionReason string

ModuleConditionReason is the reason for the condition type.

const (
	ReadyReasonInstallStarted     ModuleConditionReason = "InstallStarted"
	ReadyReasonInstallSucceeded   ModuleConditionReason = "InstallSucceeded"
	ReadyReasonInstallFailed      ModuleConditionReason = "InstallFailed"
	ReadyReasonUninstallStarted   ModuleConditionReason = "UninstallStarted"
	ReadyReasonUninstallSucceeded ModuleConditionReason = "UninstallSucceeded"
	ReadyReasonUninstallFailed    ModuleConditionReason = "UninstallFailed"
	ReadyReasonUpdateStarted      ModuleConditionReason = "UpdateStarted"
	ReadyReasonUpdateSucceeded    ModuleConditionReason = "UpdateSucceeded"
	ReadyReasonUpdateFailed       ModuleConditionReason = "UpdateFailed"
	ReadyReasonUpgradeStarted     ModuleConditionReason = "UpgradeStarted"
	ReadyReasonUpgradeSucceeded   ModuleConditionReason = "UpgradeSucceeded"
	ReadyReasonUpgradeFailed      ModuleConditionReason = "UpgradeFailed"
)

type ModuleConditionType

type ModuleConditionType string

ModuleConditionType is the condition type.

type ModuleList

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

ModuleList contains a list of Verrazzano Module instance resources.

func (*ModuleList) DeepCopy

func (in *ModuleList) DeepCopy() *ModuleList

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

func (*ModuleList) DeepCopyInto

func (in *ModuleList) DeepCopyInto(out *ModuleList)

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

func (*ModuleList) DeepCopyObject

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

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

type ModuleSpec

type ModuleSpec struct {
	// Module name is the well-known Module name.
	ModuleName string `json:"moduleName,omitempty"`

	// Version is the desired version of the Module.
	// +optional
	Version string `json:"version,omitempty"`

	// TargetNamespace is the namespace where the Module will be installed.
	// +optional
	TargetNamespace string `json:"targetNamespace,omitempty"`

	// Values specifies configuration values using inline YAML.
	// Values have precedence over ValuesFrom.
	// +optional
	Values *apiextensionsv1.JSON `json:"values,omitempty"`

	// ValuesFrom specifies the values from a Configmap or Secret.
	// Each entry in the list has precedence over all previous entries in the list.
	// +optional
	ValuesFrom []ValuesFromSource `json:"valuesFrom,omitempty"`
}

ModuleSpec defines the specification for a Verrazzano Module instance.

func (*ModuleSpec) DeepCopy

func (in *ModuleSpec) DeepCopy() *ModuleSpec

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

func (*ModuleSpec) DeepCopyInto

func (in *ModuleSpec) DeepCopyInto(out *ModuleSpec)

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

type ModuleStatus

type ModuleStatus struct {
	// Conditions are the list of conditions for the Module.
	Conditions []ModuleCondition `json:"conditions,omitempty"`

	// LastSuccessfulVersion is the last version of the Module that was successfully reconciled.
	// +optional
	LastSuccessfulVersion string `json:"lastSuccessfulVersion,omitempty"`

	// LastSuccessfulGeneration is the last generation of the Module that was successfully reconciled.
	// +optional
	LastSuccessfulGeneration int64 `json:"lastSuccessfulGeneration,omitempty"`
}

ModuleStatus defines the action state of the Module resource.

func (*ModuleStatus) DeepCopy

func (in *ModuleStatus) DeepCopy() *ModuleStatus

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

func (*ModuleStatus) DeepCopyInto

func (in *ModuleStatus) DeepCopyInto(out *ModuleStatus)

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

type ValuesFromSource

type ValuesFromSource struct {
	// ConfigMapRef is a selector for a ConfigMap containing values data.
	// +optional
	ConfigMapRef *corev1.ConfigMapKeySelector `json:"configMapRef,omitempty"`

	// SecretRef is a selector for a Secret containing values data.
	// +optional
	SecretRef *corev1.SecretKeySelector `json:"secretRef,omitempty"`
}

ValuesFromSource specifies value overrides for a Module.

func (*ValuesFromSource) DeepCopy

func (in *ValuesFromSource) DeepCopy() *ValuesFromSource

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

func (*ValuesFromSource) DeepCopyInto

func (in *ValuesFromSource) DeepCopyInto(out *ValuesFromSource)

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