Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "infrastructure.cluster.x-k8s.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 )
Functions ¶
This section is empty.
Types ¶
type Condition ¶
type Condition struct {
// Type of condition in CamelCase or in foo.example.com/CamelCase.
// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions
// can be useful (see .node.status.conditions), the ability to deconflict is important.
// +required
Type ConditionType `json:"type"`
// Status of the condition, one of True, False, Unknown.
// +required
Status corev1.ConditionStatus `json:"status"`
// Severity provides an explicit classification of Reason code, so the users or machines can immediately
// understand the current situation and act accordingly.
// The Severity field MUST be set only when Status=False.
// +optional
Severity ConditionSeverity `json:"severity,omitempty"`
// Last time the condition transitioned from one status to another.
// This should be when the underlying condition changed. If that is not known, then using the time when
// the API field changed is acceptable.
// +required
LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
// The reason for the condition's last transition in CamelCase.
// The specific API may choose whether this field is considered a guaranteed API.
// This field may not be empty.
// +optional
Reason string `json:"reason,omitempty"`
// A human readable message indicating details about the transition.
// This field may be empty.
// +optional
Message string `json:"message,omitempty"`
}
Condition defines an observation of a Cluster API resource operational state.
func (*Condition) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Condition.
func (*Condition) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConditionSeverity ¶
type ConditionSeverity string
ConditionSeverity expresses the severity of a Condition Type failing.
const ( // ConditionSeverityError specifies that a condition with `Status=False` is an error. ConditionSeverityError ConditionSeverity = "Error" // ConditionSeverityWarning specifies that a condition with `Status=False` is a warning. ConditionSeverityWarning ConditionSeverity = "Warning" // ConditionSeverityInfo specifies that a condition with `Status=False` is informative. ConditionSeverityInfo ConditionSeverity = "Info" // ConditionSeverityNone should apply only to conditions with `Status=True`. ConditionSeverityNone ConditionSeverity = "" )
type ConditionType ¶
type ConditionType string
ConditionType is a valid value for Condition.Type.
const ( // ReadyCondition defines the Ready condition type that summarizes the operational state of the vcluster API object. ReadyCondition ConditionType = "Ready" // ControlPlaneInitializedCondition defines the initialized condition type if the vcluster is reachable. ControlPlaneInitializedCondition ConditionType = "ControlPlaneInitialized" // KubeconfigReadyCondition defines the ready condition type if the vcluster kubeconfig was written. KubeconfigReadyCondition ConditionType = "KubeconfigReady" // HelmChartDeployedCondition defines the helm chart deployed condition type that defines if the helm chart was deployed correctly. HelmChartDeployedCondition ConditionType = "HelmChartDeployed" )
Common ConditionTypes used by Cluster API objects.
type Conditions ¶
type Conditions []Condition
Conditions is an array of conditions
func (Conditions) DeepCopy ¶
func (in Conditions) DeepCopy() Conditions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Conditions.
func (Conditions) DeepCopyInto ¶
func (in Conditions) DeepCopyInto(out *Conditions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VCluster ¶
type VCluster struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec VClusterSpec `json:"spec,omitempty"`
Status VClusterStatus `json:"status,omitempty"`
}
VCluster is the Schema for the vclusters API
func (*VCluster) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VCluster.
func (*VCluster) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*VCluster) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*VCluster) GetConditions ¶
func (in *VCluster) GetConditions() Conditions
GetConditions returns the set of conditions for this object.
func (*VCluster) SetConditions ¶
func (in *VCluster) SetConditions(conditions Conditions)
SetConditions sets the conditions on this object.
type VClusterList ¶
type VClusterList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []VCluster `json:"items"`
}
VClusterList contains a list of VCluster
func (*VClusterList) DeepCopy ¶
func (in *VClusterList) DeepCopy() *VClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VClusterList.
func (*VClusterList) DeepCopyInto ¶
func (in *VClusterList) DeepCopyInto(out *VClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*VClusterList) DeepCopyObject ¶
func (in *VClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type VClusterSpec ¶
type VClusterSpec struct {
// ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
// +optional
ControlPlaneEndpoint clusterv1beta1.APIEndpoint `json:"controlPlaneEndpoint"`
// The helm release configuration for the virtual cluster. This is optional, but
// when filled, specified chart will be deployed.
// +optional
HelmRelease *VirtualClusterHelmRelease `json:"helmRelease,omitempty"`
}
VClusterSpec defines the desired state of VCluster
func (*VClusterSpec) DeepCopy ¶
func (in *VClusterSpec) DeepCopy() *VClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VClusterSpec.
func (*VClusterSpec) DeepCopyInto ¶
func (in *VClusterSpec) DeepCopyInto(out *VClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VClusterStatus ¶
type VClusterStatus struct {
// Ready defines if the virtual cluster control plane is ready.
// +optional
Ready bool `json:"ready"`
// Initialized defines if the virtual cluster control plane was initialized.
// +optional
Initialized bool `json:"initialized"`
// Phase describes the current phase the virtual cluster is in
// +optional
Phase VirtualClusterPhase `json:"phase,omitempty"`
// Reason describes the reason in machine readable form why the cluster is in the current
// phase
// +optional
Reason string `json:"reason,omitempty"`
// Message describes the reason in human readable form why the cluster is in the currrent
// phase
// +optional
Message string `json:"message,omitempty"`
// Conditions holds several conditions the vcluster might be in
// +optional
Conditions Conditions `json:"conditions,omitempty"`
// ObservedGeneration is the latest generation observed by the controller.
// +optional
ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}
VClusterStatus defines the observed state of VCluster
func (*VClusterStatus) DeepCopy ¶
func (in *VClusterStatus) DeepCopy() *VClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VClusterStatus.
func (*VClusterStatus) DeepCopyInto ¶
func (in *VClusterStatus) DeepCopyInto(out *VClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VirtualClusterHelmChart ¶
type VirtualClusterHelmChart struct {
// the name of the helm chart
// +optional
Name string `json:"name,omitempty"`
// the repo of the helm chart
// +optional
Repo string `json:"repo,omitempty"`
// the version of the helm chart to use
// +optional
Version string `json:"version,omitempty"`
}
func (*VirtualClusterHelmChart) DeepCopy ¶
func (in *VirtualClusterHelmChart) DeepCopy() *VirtualClusterHelmChart
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VirtualClusterHelmChart.
func (*VirtualClusterHelmChart) DeepCopyInto ¶
func (in *VirtualClusterHelmChart) DeepCopyInto(out *VirtualClusterHelmChart)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VirtualClusterHelmRelease ¶
type VirtualClusterHelmRelease struct {
// infos about what chart to deploy
// +optional
Chart VirtualClusterHelmChart `json:"chart,omitempty"`
// the values for the given chart
// +optional
Values string `json:"values,omitempty"`
}
func (*VirtualClusterHelmRelease) DeepCopy ¶
func (in *VirtualClusterHelmRelease) DeepCopy() *VirtualClusterHelmRelease
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VirtualClusterHelmRelease.
func (*VirtualClusterHelmRelease) DeepCopyInto ¶
func (in *VirtualClusterHelmRelease) DeepCopyInto(out *VirtualClusterHelmRelease)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VirtualClusterPhase ¶
type VirtualClusterPhase string
VirtualClusterPhase describes the phase of a virtual cluster
const ( VirtualClusterUnknown VirtualClusterPhase = "" VirtualClusterPending VirtualClusterPhase = "Pending" VirtualClusterDeployed VirtualClusterPhase = "Deployed" VirtualClusterFailed VirtualClusterPhase = "Failed" )
These are the valid admin account types