Documentation ¶
Overview ¶
Package v1beta1 contains API Schema definitions for the controlplane v1beta1 API group +kubebuilder:object:generate=true +groupName=controlplane.cluster.x-k8s.io
Index ¶
- Constants
- Variables
- type Addon
- type CAPTControlPlane
- type CAPTControlPlaneList
- type CAPTControlPlaneSpec
- type CAPTControlPlaneStatus
- type CaptControlPlaneTemplate
- type CaptControlPlaneTemplateList
- type CaptControlPlaneTemplateResource
- type CaptControlPlaneTemplateSpec
- type ControlPlaneConfig
- type EndpointAccess
- type TimeoutConfig
- type WorkspaceStatus
- type WorkspaceTemplateReference
- type WorkspaceTemplateStatus
Constants ¶
const ( // ControlPlaneReadyCondition indicates the control plane is ready ControlPlaneReadyCondition = "Ready" // ControlPlaneInitializedCondition indicates the control plane has been initialized ControlPlaneInitializedCondition = "Initialized" // ControlPlaneFailedCondition indicates the control plane has failed ControlPlaneFailedCondition = "Failed" // ControlPlaneCreatingCondition indicates the control plane is being created ControlPlaneCreatingCondition = "Creating" )
Condition Types
const ( // DefaultControlPlaneTimeout is the default timeout for control plane creation DefaultControlPlaneTimeout = 30 // DefaultVPCReadyTimeout is the default timeout for VPC ready check DefaultVPCReadyTimeout = 15 )
Default timeout values
const ( // ReasonCreating indicates the control plane is being created ReasonCreating = "Creating" // ReasonReady indicates the control plane is ready ReasonReady = "Ready" // ReasonFailed indicates the control plane has failed ReasonFailed = "Failed" // ReasonWaitingForVPC indicates waiting for VPC to be ready ReasonWaitingForVPC = "WaitingForVPC" // ReasonVPCReadyTimeout indicates VPC ready check timed out ReasonVPCReadyTimeout = "VPCReadyTimeout" // ReasonControlPlaneTimeout indicates control plane creation timed out ReasonControlPlaneTimeout = "ControlPlaneTimeout" // ReasonWorkspaceError indicates an error with the workspace ReasonWorkspaceError = "WorkspaceError" )
Condition Reasons
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "controlplane.cluster.x-k8s.io", Version: "v1beta1"} // 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 Addon ¶
type Addon struct { // Name is the name of the addon // +kubebuilder:validation:Required Name string `json:"name"` // Version is the version of the addon // +optional Version string `json:"version,omitempty"` // ConfigurationValues is a string containing configuration values // +optional ConfigurationValues string `json:"configurationValues,omitempty"` }
Addon represents an EKS addon
func (*Addon) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Addon.
func (*Addon) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CAPTControlPlane ¶
type CAPTControlPlane struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec CAPTControlPlaneSpec `json:"spec,omitempty"` Status CAPTControlPlaneStatus `json:"status,omitempty"` }
CAPTControlPlane is the Schema for the captcontrolplanes API
func (*CAPTControlPlane) DeepCopy ¶
func (in *CAPTControlPlane) DeepCopy() *CAPTControlPlane
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CAPTControlPlane.
func (*CAPTControlPlane) DeepCopyInto ¶
func (in *CAPTControlPlane) DeepCopyInto(out *CAPTControlPlane)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CAPTControlPlane) DeepCopyObject ¶
func (in *CAPTControlPlane) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CAPTControlPlaneList ¶
type CAPTControlPlaneList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []CAPTControlPlane `json:"items"` }
CAPTControlPlaneList contains a list of CAPTControlPlane
func (*CAPTControlPlaneList) DeepCopy ¶
func (in *CAPTControlPlaneList) DeepCopy() *CAPTControlPlaneList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CAPTControlPlaneList.
func (*CAPTControlPlaneList) DeepCopyInto ¶
func (in *CAPTControlPlaneList) DeepCopyInto(out *CAPTControlPlaneList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CAPTControlPlaneList) DeepCopyObject ¶
func (in *CAPTControlPlaneList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CAPTControlPlaneSpec ¶
type CAPTControlPlaneSpec struct { // Version defines the desired Kubernetes version. // +kubebuilder:validation:Required Version string `json:"version"` // WorkspaceTemplateRef is a reference to the WorkspaceTemplate used for creating the control plane. // +kubebuilder:validation:Required WorkspaceTemplateRef WorkspaceTemplateReference `json:"workspaceTemplateRef"` // ControlPlaneConfig contains additional configuration for the EKS control plane. // +optional ControlPlaneConfig *ControlPlaneConfig `json:"controlPlaneConfig,omitempty"` // AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider. // +optional AdditionalTags map[string]string `json:"additionalTags,omitempty"` // ControlPlaneEndpoint represents the endpoint used to communicate with the control plane. // +optional ControlPlaneEndpoint clusterv1.APIEndpoint `json:"controlPlaneEndpoint,omitempty"` // WorkspaceTemplateApplyName is the name of the WorkspaceTemplateApply used for this control plane. // This field is managed by the controller and should not be modified manually. // +optional WorkspaceTemplateApplyName string `json:"workspaceTemplateApplyName,omitempty"` }
CAPTControlPlaneSpec defines the desired state of CAPTControlPlane
func (*CAPTControlPlaneSpec) DeepCopy ¶
func (in *CAPTControlPlaneSpec) DeepCopy() *CAPTControlPlaneSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CAPTControlPlaneSpec.
func (*CAPTControlPlaneSpec) DeepCopyInto ¶
func (in *CAPTControlPlaneSpec) DeepCopyInto(out *CAPTControlPlaneSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CAPTControlPlaneStatus ¶
type CAPTControlPlaneStatus struct { // Ready denotes that the control plane is ready // +optional Ready bool `json:"ready"` // Initialized denotes if the control plane has been initialized // +optional Initialized bool `json:"initialized"` // SecretsReady denotes that all required secrets have been created and are ready // +optional // +kubebuilder:default=false SecretsReady bool `json:"secretsReady"` // WorkspaceTemplateStatus contains the status of the WorkspaceTemplate // +optional WorkspaceTemplateStatus *WorkspaceTemplateStatus `json:"workspaceTemplateStatus,omitempty"` // WorkspaceStatus contains the status of the associated Workspace // +optional WorkspaceStatus *WorkspaceStatus `json:"workspaceStatus,omitempty"` // FailureReason indicates that there is a terminal problem reconciling the // state, and will be set to a token value suitable for programmatic // interpretation. // +optional FailureReason *string `json:"failureReason,omitempty"` // FailureMessage indicates that there is a terminal problem reconciling the // state, and will be set to a descriptive error message. // +optional FailureMessage *string `json:"failureMessage,omitempty"` // Phase represents the current phase of the control plane // Valid values are: "Creating", "Ready", "Failed" // +optional // +kubebuilder:validation:Enum=Creating;Ready;Failed Phase string `json:"phase,omitempty"` // Conditions defines current service state of the CAPTControlPlane. // +optional Conditions []metav1.Condition `json:"conditions,omitempty"` }
CAPTControlPlaneStatus defines the observed state of CAPTControlPlane
func (*CAPTControlPlaneStatus) DeepCopy ¶
func (in *CAPTControlPlaneStatus) DeepCopy() *CAPTControlPlaneStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CAPTControlPlaneStatus.
func (*CAPTControlPlaneStatus) DeepCopyInto ¶
func (in *CAPTControlPlaneStatus) DeepCopyInto(out *CAPTControlPlaneStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CaptControlPlaneTemplate ¶
type CaptControlPlaneTemplate struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec CaptControlPlaneTemplateSpec `json:"spec,omitempty"` }
CaptControlPlaneTemplate is the Schema for the captcontrolplanetemplates API
func (*CaptControlPlaneTemplate) DeepCopy ¶
func (in *CaptControlPlaneTemplate) DeepCopy() *CaptControlPlaneTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CaptControlPlaneTemplate.
func (*CaptControlPlaneTemplate) DeepCopyInto ¶
func (in *CaptControlPlaneTemplate) DeepCopyInto(out *CaptControlPlaneTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CaptControlPlaneTemplate) DeepCopyObject ¶
func (in *CaptControlPlaneTemplate) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CaptControlPlaneTemplateList ¶
type CaptControlPlaneTemplateList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []CaptControlPlaneTemplate `json:"items"` }
CaptControlPlaneTemplateList contains a list of CaptControlPlaneTemplate
func (*CaptControlPlaneTemplateList) DeepCopy ¶
func (in *CaptControlPlaneTemplateList) DeepCopy() *CaptControlPlaneTemplateList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CaptControlPlaneTemplateList.
func (*CaptControlPlaneTemplateList) DeepCopyInto ¶
func (in *CaptControlPlaneTemplateList) DeepCopyInto(out *CaptControlPlaneTemplateList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CaptControlPlaneTemplateList) DeepCopyObject ¶
func (in *CaptControlPlaneTemplateList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CaptControlPlaneTemplateResource ¶
type CaptControlPlaneTemplateResource struct { // Standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // +optional ObjectMeta metav1.ObjectMeta `json:"metadata,omitempty"` // Spec is the specification of the desired behavior of the CaptControlPlane. // This spec allows for all the same configuration as CaptControlPlane. // +optional Spec CAPTControlPlaneSpec `json:"spec"` }
CaptControlPlaneTemplateResource describes the data needed to create a CaptControlPlane from a template
func (*CaptControlPlaneTemplateResource) DeepCopy ¶
func (in *CaptControlPlaneTemplateResource) DeepCopy() *CaptControlPlaneTemplateResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CaptControlPlaneTemplateResource.
func (*CaptControlPlaneTemplateResource) DeepCopyInto ¶
func (in *CaptControlPlaneTemplateResource) DeepCopyInto(out *CaptControlPlaneTemplateResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CaptControlPlaneTemplateSpec ¶
type CaptControlPlaneTemplateSpec struct { // Template is the template for the CaptControlPlane Template CaptControlPlaneTemplateResource `json:"template"` }
CaptControlPlaneTemplateSpec defines the desired state of CaptControlPlaneTemplate
func (*CaptControlPlaneTemplateSpec) DeepCopy ¶
func (in *CaptControlPlaneTemplateSpec) DeepCopy() *CaptControlPlaneTemplateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CaptControlPlaneTemplateSpec.
func (*CaptControlPlaneTemplateSpec) DeepCopyInto ¶
func (in *CaptControlPlaneTemplateSpec) DeepCopyInto(out *CaptControlPlaneTemplateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ControlPlaneConfig ¶
type ControlPlaneConfig struct { // Region specifies the AWS region where the control plane will be created // +kubebuilder:validation:Required // +kubebuilder:validation:Pattern="^[a-z]{2}-[a-z]+-[0-9]$" Region string `json:"region"` // EndpointAccess defines the access configuration for the API server endpoint // +optional EndpointAccess *EndpointAccess `json:"endpointAccess,omitempty"` // Addons defines the EKS addons to be installed // +optional Addons []Addon `json:"addons,omitempty"` // Timeouts defines timeout settings for various operations // +optional Timeouts *TimeoutConfig `json:"timeouts,omitempty"` }
ControlPlaneConfig contains EKS-specific configuration
func (*ControlPlaneConfig) DeepCopy ¶
func (in *ControlPlaneConfig) DeepCopy() *ControlPlaneConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ControlPlaneConfig.
func (*ControlPlaneConfig) DeepCopyInto ¶
func (in *ControlPlaneConfig) DeepCopyInto(out *ControlPlaneConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EndpointAccess ¶
type EndpointAccess struct { // Public controls whether the API server has public access // +optional Public bool `json:"public,omitempty"` // Private controls whether the API server has private access // +optional Private bool `json:"private,omitempty"` // PublicCIDRs is a list of CIDR blocks that can access the API server // +optional PublicCIDRs []string `json:"publicCIDRs,omitempty"` }
EndpointAccess defines the access configuration for the API server endpoint
func (*EndpointAccess) DeepCopy ¶
func (in *EndpointAccess) DeepCopy() *EndpointAccess
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EndpointAccess.
func (*EndpointAccess) DeepCopyInto ¶
func (in *EndpointAccess) DeepCopyInto(out *EndpointAccess)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TimeoutConfig ¶
type TimeoutConfig struct { // ControlPlaneTimeout is the timeout in minutes for control plane creation // +optional // +kubebuilder:validation:Minimum=1 // +kubebuilder:default=30 ControlPlaneTimeout *int `json:"controlPlaneTimeout,omitempty"` // VPCReadyTimeout is the timeout in minutes for VPC ready check // +optional // +kubebuilder:validation:Minimum=1 // +kubebuilder:default=15 VPCReadyTimeout *int `json:"vpcReadyTimeout,omitempty"` }
TimeoutConfig defines timeout settings for various operations
func (*TimeoutConfig) DeepCopy ¶
func (in *TimeoutConfig) DeepCopy() *TimeoutConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TimeoutConfig.
func (*TimeoutConfig) DeepCopyInto ¶
func (in *TimeoutConfig) DeepCopyInto(out *TimeoutConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkspaceStatus ¶ added in v0.2.0
type WorkspaceStatus struct { // Ready indicates if the Workspace is ready // +optional Ready bool `json:"ready"` // State represents the current state of the Workspace // +optional State string `json:"state,omitempty"` // AtProvider contains the observed state of the provider // +optional AtProvider *runtime.RawExtension `json:"atProvider,omitempty"` }
WorkspaceStatus contains the status of the associated Workspace
func (*WorkspaceStatus) DeepCopy ¶ added in v0.2.0
func (in *WorkspaceStatus) DeepCopy() *WorkspaceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspaceStatus.
func (*WorkspaceStatus) DeepCopyInto ¶ added in v0.2.0
func (in *WorkspaceStatus) DeepCopyInto(out *WorkspaceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkspaceTemplateReference ¶
type WorkspaceTemplateReference struct { // Name is the name of the WorkspaceTemplate. // +kubebuilder:validation:Required Name string `json:"name"` // Namespace is the namespace of the WorkspaceTemplate. // +optional Namespace string `json:"namespace,omitempty"` }
WorkspaceTemplateReference contains the reference to WorkspaceTemplate
func (*WorkspaceTemplateReference) DeepCopy ¶
func (in *WorkspaceTemplateReference) DeepCopy() *WorkspaceTemplateReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspaceTemplateReference.
func (*WorkspaceTemplateReference) DeepCopyInto ¶
func (in *WorkspaceTemplateReference) DeepCopyInto(out *WorkspaceTemplateReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkspaceTemplateStatus ¶
type WorkspaceTemplateStatus struct { // Ready indicates if the WorkspaceTemplate is ready // +optional Ready bool `json:"ready"` // State represents the current state of the WorkspaceTemplate // +optional State string `json:"state,omitempty"` // LastAppliedRevision is the revision of the WorkspaceTemplate that was last applied // +optional LastAppliedRevision string `json:"lastAppliedRevision,omitempty"` // Outputs contains the outputs from the WorkspaceTemplate // +optional Outputs map[string]string `json:"outputs,omitempty"` // LastFailedRevision is the revision of the WorkspaceTemplate that last failed // +optional LastFailedRevision string `json:"lastFailedRevision,omitempty"` // LastFailureMessage contains the error message from the last failure // +optional LastFailureMessage string `json:"lastFailureMessage,omitempty"` }
WorkspaceTemplateStatus contains the status of the WorkspaceTemplate
func (*WorkspaceTemplateStatus) DeepCopy ¶
func (in *WorkspaceTemplateStatus) DeepCopy() *WorkspaceTemplateStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspaceTemplateStatus.
func (*WorkspaceTemplateStatus) DeepCopyInto ¶
func (in *WorkspaceTemplateStatus) DeepCopyInto(out *WorkspaceTemplateStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.