diff --git a/api/v1beta1/cluster_types.go b/api/v1beta1/cluster_types.go index 7732d07d949e..82e3ec077b7e 100644 --- a/api/v1beta1/cluster_types.go +++ b/api/v1beta1/cluster_types.go @@ -44,7 +44,7 @@ const ( // ClusterSpec defines the desired state of Cluster. type ClusterSpec struct { - // Paused can be used to prevent controllers from processing the Cluster and all its associated objects. + // paused can be used to prevent controllers from processing the Cluster and all its associated objects. // +optional Paused bool `json:"paused,omitempty"` @@ -52,16 +52,16 @@ type ClusterSpec struct { // +optional ClusterNetwork *ClusterNetwork `json:"clusterNetwork,omitempty"` - // ControlPlaneEndpoint represents the endpoint used to communicate with the control plane. + // controlPlaneEndpoint represents the endpoint used to communicate with the control plane. // +optional ControlPlaneEndpoint APIEndpoint `json:"controlPlaneEndpoint,omitempty"` - // ControlPlaneRef is an optional reference to a provider-specific resource that holds + // controlPlaneRef is an optional reference to a provider-specific resource that holds // the details for provisioning the Control Plane for a Cluster. // +optional ControlPlaneRef *corev1.ObjectReference `json:"controlPlaneRef,omitempty"` - // InfrastructureRef is a reference to a provider-specific resource that holds the details + // infrastructureRef is a reference to a provider-specific resource that holds the details // for provisioning infrastructure for a cluster in said provider. // +optional InfrastructureRef *corev1.ObjectReference `json:"infrastructureRef,omitempty"` @@ -103,7 +103,7 @@ type Topology struct { // The Kubernetes version of the cluster. Version string `json:"version"` - // RolloutAfter performs a rollout of the entire cluster one component at a time, + // rolloutAfter performs a rollout of the entire cluster one component at a time, // control plane first and then machine deployments. // // Deprecated: This field has no function and is going to be removed in the next apiVersion. @@ -111,16 +111,16 @@ type Topology struct { // +optional RolloutAfter *metav1.Time `json:"rolloutAfter,omitempty"` - // ControlPlane describes the cluster control plane. + // controlPlane describes the cluster control plane. // +optional ControlPlane ControlPlaneTopology `json:"controlPlane,omitempty"` - // Workers encapsulates the different constructs that form the worker nodes + // workers encapsulates the different constructs that form the worker nodes // for the cluster. // +optional Workers *WorkersTopology `json:"workers,omitempty"` - // Variables can be used to customize the Cluster through + // variables can be used to customize the Cluster through // patches. They must comply to the corresponding // VariableClasses defined in the ClusterClass. // +optional @@ -131,56 +131,56 @@ type Topology struct { // ControlPlaneTopology specifies the parameters for the control plane nodes in the cluster. type ControlPlaneTopology struct { - // Metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane + // metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane // if the ControlPlaneTemplate referenced by the ClusterClass is machine based. If not, it // is applied only to the ControlPlane. // At runtime this metadata is merged with the corresponding metadata from the ClusterClass. // +optional Metadata ObjectMeta `json:"metadata,omitempty"` - // Replicas is the number of control plane nodes. + // replicas is the number of control plane nodes. // If the value is nil, the ControlPlane object is created without the number of Replicas // and it's assumed that the control plane controller does not implement support for this field. // When specified against a control plane provider that lacks support for this field, this value will be ignored. // +optional Replicas *int32 `json:"replicas,omitempty"` - // MachineHealthCheck allows to enable, disable and override + // machineHealthCheck allows to enable, disable and override // the MachineHealthCheck configuration in the ClusterClass for this control plane. // +optional MachineHealthCheck *MachineHealthCheckTopology `json:"machineHealthCheck,omitempty"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // +optional NodeDrainTimeout *metav1.Duration `json:"nodeDrainTimeout,omitempty"` - // NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + // nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes // to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. // +optional NodeVolumeDetachTimeout *metav1.Duration `json:"nodeVolumeDetachTimeout,omitempty"` - // NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + // nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine // hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. // Defaults to 10 seconds. // +optional NodeDeletionTimeout *metav1.Duration `json:"nodeDeletionTimeout,omitempty"` - // Variables can be used to customize the ControlPlane through patches. + // variables can be used to customize the ControlPlane through patches. // +optional Variables *ControlPlaneVariables `json:"variables,omitempty"` } // WorkersTopology represents the different sets of worker nodes in the cluster. type WorkersTopology struct { - // MachineDeployments is a list of machine deployments in the cluster. + // machineDeployments is a list of machine deployments in the cluster. // +optional // +listType=map // +listMapKey=name MachineDeployments []MachineDeploymentTopology `json:"machineDeployments,omitempty"` - // MachinePools is a list of machine pools in the cluster. + // machinePools is a list of machine pools in the cluster. // +optional // +listType=map // +listMapKey=name @@ -190,51 +190,51 @@ type WorkersTopology struct { // MachineDeploymentTopology specifies the different parameters for a set of worker nodes in the topology. // This set of nodes is managed by a MachineDeployment object whose lifecycle is managed by the Cluster controller. type MachineDeploymentTopology struct { - // Metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment. + // metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment. // At runtime this metadata is merged with the corresponding metadata from the ClusterClass. // +optional Metadata ObjectMeta `json:"metadata,omitempty"` - // Class is the name of the MachineDeploymentClass used to create the set of worker nodes. + // class is the name of the MachineDeploymentClass used to create the set of worker nodes. // This should match one of the deployment classes defined in the ClusterClass object // mentioned in the `Cluster.Spec.Class` field. Class string `json:"class"` - // Name is the unique identifier for this MachineDeploymentTopology. + // name is the unique identifier for this MachineDeploymentTopology. // The value is used with other unique identifiers to create a MachineDeployment's Name // (e.g. cluster's name, etc). In case the name is greater than the allowed maximum length, // the values are hashed together. Name string `json:"name"` - // FailureDomain is the failure domain the machines will be created in. + // failureDomain is the failure domain the machines will be created in. // Must match a key in the FailureDomains map stored on the cluster object. // +optional FailureDomain *string `json:"failureDomain,omitempty"` - // Replicas is the number of worker nodes belonging to this set. + // replicas is the number of worker nodes belonging to this set. // If the value is nil, the MachineDeployment is created without the number of Replicas (defaulting to 1) // and it's assumed that an external entity (like cluster autoscaler) is responsible for the management // of this value. // +optional Replicas *int32 `json:"replicas,omitempty"` - // MachineHealthCheck allows to enable, disable and override + // machineHealthCheck allows to enable, disable and override // the MachineHealthCheck configuration in the ClusterClass for this MachineDeployment. // +optional MachineHealthCheck *MachineHealthCheckTopology `json:"machineHealthCheck,omitempty"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // +optional NodeDrainTimeout *metav1.Duration `json:"nodeDrainTimeout,omitempty"` - // NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + // nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes // to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. // +optional NodeVolumeDetachTimeout *metav1.Duration `json:"nodeVolumeDetachTimeout,omitempty"` - // NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + // nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine // hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. // Defaults to 10 seconds. // +optional @@ -252,14 +252,14 @@ type MachineDeploymentTopology struct { // +optional Strategy *MachineDeploymentStrategy `json:"strategy,omitempty"` - // Variables can be used to customize the MachineDeployment through patches. + // variables can be used to customize the MachineDeployment through patches. // +optional Variables *MachineDeploymentVariables `json:"variables,omitempty"` } // MachineHealthCheckTopology defines a MachineHealthCheck for a group of machines. type MachineHealthCheckTopology struct { - // Enable controls if a MachineHealthCheck should be created for the target machines. + // enable controls if a MachineHealthCheck should be created for the target machines. // // If false: No MachineHealthCheck will be created. // @@ -279,39 +279,39 @@ type MachineHealthCheckTopology struct { // MachinePoolTopology specifies the different parameters for a pool of worker nodes in the topology. // This pool of nodes is managed by a MachinePool object whose lifecycle is managed by the Cluster controller. type MachinePoolTopology struct { - // Metadata is the metadata applied to the MachinePool. + // metadata is the metadata applied to the MachinePool. // At runtime this metadata is merged with the corresponding metadata from the ClusterClass. // +optional Metadata ObjectMeta `json:"metadata,omitempty"` - // Class is the name of the MachinePoolClass used to create the pool of worker nodes. + // class is the name of the MachinePoolClass used to create the pool of worker nodes. // This should match one of the deployment classes defined in the ClusterClass object // mentioned in the `Cluster.Spec.Class` field. Class string `json:"class"` - // Name is the unique identifier for this MachinePoolTopology. + // name is the unique identifier for this MachinePoolTopology. // The value is used with other unique identifiers to create a MachinePool's Name // (e.g. cluster's name, etc). In case the name is greater than the allowed maximum length, // the values are hashed together. Name string `json:"name"` - // FailureDomains is the list of failure domains the machine pool will be created in. + // failureDomains is the list of failure domains the machine pool will be created in. // Must match a key in the FailureDomains map stored on the cluster object. // +optional FailureDomains []string `json:"failureDomains,omitempty"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // +optional NodeDrainTimeout *metav1.Duration `json:"nodeDrainTimeout,omitempty"` - // NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + // nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes // to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. // +optional NodeVolumeDetachTimeout *metav1.Duration `json:"nodeVolumeDetachTimeout,omitempty"` - // NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the MachinePool + // nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the MachinePool // hosts after the MachinePool is marked for deletion. A duration of 0 will retry deletion indefinitely. // Defaults to 10 seconds. // +optional @@ -324,14 +324,14 @@ type MachinePoolTopology struct { // +optional MinReadySeconds *int32 `json:"minReadySeconds,omitempty"` - // Replicas is the number of nodes belonging to this pool. + // replicas is the number of nodes belonging to this pool. // If the value is nil, the MachinePool is created without the number of Replicas (defaulting to 1) // and it's assumed that an external entity (like cluster autoscaler) is responsible for the management // of this value. // +optional Replicas *int32 `json:"replicas,omitempty"` - // Variables can be used to customize the MachinePool through patches. + // variables can be used to customize the MachinePool through patches. // +optional Variables *MachinePoolVariables `json:"variables,omitempty"` } @@ -339,17 +339,17 @@ type MachinePoolTopology struct { // ClusterVariable can be used to customize the Cluster through patches. Each ClusterVariable is associated with a // Variable definition in the ClusterClass `status` variables. type ClusterVariable struct { - // Name of the variable. + // name of the variable. Name string `json:"name"` - // DefinitionFrom specifies where the definition of this Variable is from. + // definitionFrom specifies where the definition of this Variable is from. // // Deprecated: This field is deprecated, must not be set anymore and is going to be removed in the next apiVersion. // // +optional DefinitionFrom string `json:"definitionFrom,omitempty"` - // Value of the variable. + // value of the variable. // Note: the value will be validated against the schema of the corresponding ClusterClassVariable // from the ClusterClass. // Note: We have to use apiextensionsv1.JSON instead of a custom JSON type, because controller-tools has a @@ -361,7 +361,7 @@ type ClusterVariable struct { // ControlPlaneVariables can be used to provide variables for the ControlPlane. type ControlPlaneVariables struct { - // Overrides can be used to override Cluster level variables. + // overrides can be used to override Cluster level variables. // +optional // +listType=map // +listMapKey=name @@ -370,7 +370,7 @@ type ControlPlaneVariables struct { // MachineDeploymentVariables can be used to provide variables for a specific MachineDeployment. type MachineDeploymentVariables struct { - // Overrides can be used to override Cluster level variables. + // overrides can be used to override Cluster level variables. // +optional // +listType=map // +listMapKey=name @@ -379,7 +379,7 @@ type MachineDeploymentVariables struct { // MachinePoolVariables can be used to provide variables for a specific MachinePool. type MachinePoolVariables struct { - // Overrides can be used to override Cluster level variables. + // overrides can be used to override Cluster level variables. // +optional // +listType=map // +listMapKey=name @@ -393,7 +393,7 @@ type MachinePoolVariables struct { // ClusterNetwork specifies the different networking // parameters for a cluster. type ClusterNetwork struct { - // APIServerPort specifies the port the API Server should bind to. + // apiServerPort specifies the port the API Server should bind to. // Defaults to 6443. // +optional APIServerPort *int32 `json:"apiServerPort,omitempty"` @@ -433,11 +433,11 @@ func (n NetworkRanges) String() string { // ClusterStatus defines the observed state of Cluster. type ClusterStatus struct { - // FailureDomains is a slice of failure domain objects synced from the infrastructure provider. + // failureDomains is a slice of failure domain objects synced from the infrastructure provider. // +optional FailureDomains FailureDomains `json:"failureDomains,omitempty"` - // FailureReason indicates that there is a fatal problem reconciling the + // failureReason indicates that there is a fatal problem reconciling the // state, and will be set to a token value suitable for // programmatic interpretation. // @@ -446,7 +446,7 @@ type ClusterStatus struct { // +optional FailureReason *capierrors.ClusterStatusError `json:"failureReason,omitempty"` - // FailureMessage indicates that there is a fatal problem reconciling the + // failureMessage indicates that there is a fatal problem reconciling the // state, and will be set to a descriptive error message. // // Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details. @@ -454,16 +454,16 @@ type ClusterStatus struct { // +optional FailureMessage *string `json:"failureMessage,omitempty"` - // Phase represents the current phase of cluster actuation. + // phase represents the current phase of cluster actuation. // E.g. Pending, Running, Terminating, Failed etc. // +optional Phase string `json:"phase,omitempty"` - // InfrastructureReady is the state of the infrastructure provider. + // infrastructureReady is the state of the infrastructure provider. // +optional InfrastructureReady bool `json:"infrastructureReady"` - // ControlPlaneReady denotes if the control plane became ready during initial provisioning + // controlPlaneReady denotes if the control plane became ready during initial provisioning // to receive requests. // NOTE: this field is part of the Cluster API contract and it is used to orchestrate provisioning. // The value of this field is never updated after provisioning is completed. Please use conditions @@ -471,11 +471,11 @@ type ClusterStatus struct { // +optional ControlPlaneReady bool `json:"controlPlaneReady"` - // Conditions defines current service state of the cluster. + // conditions defines current service state of the cluster. // +optional Conditions Conditions `json:"conditions,omitempty"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` @@ -784,11 +784,11 @@ func (in FailureDomains) GetIDs() []*string { // FailureDomainSpec is the Schema for Cluster API failure domains. // It allows controllers to understand how many failure domains a cluster can optionally span across. type FailureDomainSpec struct { - // ControlPlane determines if this failure domain is suitable for use by control plane machines. + // controlPlane determines if this failure domain is suitable for use by control plane machines. // +optional ControlPlane bool `json:"controlPlane,omitempty"` - // Attributes is a free form map of attributes an infrastructure provider might use or require. + // attributes is a free form map of attributes an infrastructure provider might use or require. // +optional Attributes map[string]string `json:"attributes,omitempty"` } diff --git a/api/v1beta1/clusterclass_types.go b/api/v1beta1/clusterclass_types.go index 3f07614506df..4b1c5dba97b5 100644 --- a/api/v1beta1/clusterclass_types.go +++ b/api/v1beta1/clusterclass_types.go @@ -45,7 +45,7 @@ type ClusterClass struct { // ClusterClassSpec describes the desired state of the ClusterClass. type ClusterClassSpec struct { - // Infrastructure is a reference to a provider-specific template that holds + // infrastructure is a reference to a provider-specific template that holds // the details for provisioning infrastructure specific cluster // for the underlying provider. // The underlying provider is responsible for the implementation @@ -53,23 +53,23 @@ type ClusterClassSpec struct { // +optional Infrastructure LocalObjectTemplate `json:"infrastructure,omitempty"` - // ControlPlane is a reference to a local struct that holds the details + // controlPlane is a reference to a local struct that holds the details // for provisioning the Control Plane for the Cluster. // +optional ControlPlane ControlPlaneClass `json:"controlPlane,omitempty"` - // Workers describes the worker nodes for the cluster. + // workers describes the worker nodes for the cluster. // It is a collection of node types which can be used to create // the worker nodes of the cluster. // +optional Workers WorkersClass `json:"workers,omitempty"` - // Variables defines the variables which can be configured + // variables defines the variables which can be configured // in the Cluster topology and are then used in patches. // +optional Variables []ClusterClassVariable `json:"variables,omitempty"` - // Patches defines the patches which are applied to customize + // patches defines the patches which are applied to customize // referenced templates of a ClusterClass. // Note: Patches will be applied in the order of the array. // +optional @@ -78,7 +78,7 @@ type ClusterClassSpec struct { // ControlPlaneClass defines the class for the control plane. type ControlPlaneClass struct { - // Metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane + // metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane // if the ControlPlaneTemplate referenced is machine based. If not, it is applied only to the // ControlPlane. // At runtime this metadata is merged with the corresponding metadata from the topology. @@ -91,7 +91,7 @@ type ControlPlaneClass struct { // LocalObjectTemplate contains the reference to the control plane provider. LocalObjectTemplate `json:",inline"` - // MachineInfrastructure defines the metadata and infrastructure information + // machineInfrastructure defines the metadata and infrastructure information // for control plane machines. // // This field is supported if and only if the control plane provider template @@ -100,30 +100,30 @@ type ControlPlaneClass struct { // +optional MachineInfrastructure *LocalObjectTemplate `json:"machineInfrastructure,omitempty"` - // MachineHealthCheck defines a MachineHealthCheck for this ControlPlaneClass. + // machineHealthCheck defines a MachineHealthCheck for this ControlPlaneClass. // This field is supported if and only if the ControlPlane provider template // referenced above is Machine based and supports setting replicas. // +optional MachineHealthCheck *MachineHealthCheckClass `json:"machineHealthCheck,omitempty"` - // NamingStrategy allows changing the naming pattern used when creating the control plane provider object. + // namingStrategy allows changing the naming pattern used when creating the control plane provider object. // +optional NamingStrategy *ControlPlaneClassNamingStrategy `json:"namingStrategy,omitempty"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // NOTE: This value can be overridden while defining a Cluster.Topology. // +optional NodeDrainTimeout *metav1.Duration `json:"nodeDrainTimeout,omitempty"` - // NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + // nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes // to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. // NOTE: This value can be overridden while defining a Cluster.Topology. // +optional NodeVolumeDetachTimeout *metav1.Duration `json:"nodeVolumeDetachTimeout,omitempty"` - // NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + // nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine // hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. // Defaults to 10 seconds. // NOTE: This value can be overridden while defining a Cluster.Topology. @@ -133,7 +133,7 @@ type ControlPlaneClass struct { // ControlPlaneClassNamingStrategy defines the naming strategy for control plane objects. type ControlPlaneClassNamingStrategy struct { - // Template defines the template to use for generating the name of the ControlPlane object. + // template defines the template to use for generating the name of the ControlPlane object. // If not defined, it will fallback to `{{ .cluster.name }}-{{ .random }}`. // If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will // get concatenated with a random suffix of length 5. @@ -146,14 +146,14 @@ type ControlPlaneClassNamingStrategy struct { // WorkersClass is a collection of deployment classes. type WorkersClass struct { - // MachineDeployments is a list of machine deployment classes that can be used to create + // machineDeployments is a list of machine deployment classes that can be used to create // a set of worker nodes. // +optional // +listType=map // +listMapKey=class MachineDeployments []MachineDeploymentClass `json:"machineDeployments,omitempty"` - // MachinePools is a list of machine pool classes that can be used to create + // machinePools is a list of machine pool classes that can be used to create // a set of worker nodes. // +optional // +listType=map @@ -164,43 +164,43 @@ type WorkersClass struct { // MachineDeploymentClass serves as a template to define a set of worker nodes of the cluster // provisioned using the `ClusterClass`. type MachineDeploymentClass struct { - // Class denotes a type of worker node present in the cluster, + // class denotes a type of worker node present in the cluster, // this name MUST be unique within a ClusterClass and can be referenced // in the Cluster to create a managed MachineDeployment. Class string `json:"class"` - // Template is a local struct containing a collection of templates for creation of + // template is a local struct containing a collection of templates for creation of // MachineDeployment objects representing a set of worker nodes. Template MachineDeploymentClassTemplate `json:"template"` - // MachineHealthCheck defines a MachineHealthCheck for this MachineDeploymentClass. + // machineHealthCheck defines a MachineHealthCheck for this MachineDeploymentClass. // +optional MachineHealthCheck *MachineHealthCheckClass `json:"machineHealthCheck,omitempty"` - // FailureDomain is the failure domain the machines will be created in. + // failureDomain is the failure domain the machines will be created in. // Must match a key in the FailureDomains map stored on the cluster object. // NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass. // +optional FailureDomain *string `json:"failureDomain,omitempty"` - // NamingStrategy allows changing the naming pattern used when creating the MachineDeployment. + // namingStrategy allows changing the naming pattern used when creating the MachineDeployment. // +optional NamingStrategy *MachineDeploymentClassNamingStrategy `json:"namingStrategy,omitempty"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass. // +optional NodeDrainTimeout *metav1.Duration `json:"nodeDrainTimeout,omitempty"` - // NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + // nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes // to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. // NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass. // +optional NodeVolumeDetachTimeout *metav1.Duration `json:"nodeVolumeDetachTimeout,omitempty"` - // NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + // nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine // hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. // Defaults to 10 seconds. // NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass. @@ -223,23 +223,23 @@ type MachineDeploymentClass struct { // MachineDeploymentClassTemplate defines how a MachineDeployment generated from a MachineDeploymentClass // should look like. type MachineDeploymentClassTemplate struct { - // Metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment. + // metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment. // At runtime this metadata is merged with the corresponding metadata from the topology. // +optional Metadata ObjectMeta `json:"metadata,omitempty"` - // Bootstrap contains the bootstrap template reference to be used + // bootstrap contains the bootstrap template reference to be used // for the creation of worker Machines. Bootstrap LocalObjectTemplate `json:"bootstrap"` - // Infrastructure contains the infrastructure template reference to be used + // infrastructure contains the infrastructure template reference to be used // for the creation of worker Machines. Infrastructure LocalObjectTemplate `json:"infrastructure"` } // MachineDeploymentClassNamingStrategy defines the naming strategy for machine deployment objects. type MachineDeploymentClassNamingStrategy struct { - // Template defines the template to use for generating the name of the MachineDeployment object. + // template defines the template to use for generating the name of the MachineDeployment object. // If not defined, it will fallback to `{{ .cluster.name }}-{{ .machineDeployment.topologyName }}-{{ .random }}`. // If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will // get concatenated with a random suffix of length 5. @@ -253,7 +253,7 @@ type MachineDeploymentClassNamingStrategy struct { // MachineHealthCheckClass defines a MachineHealthCheck for a group of Machines. type MachineHealthCheckClass struct { - // UnhealthyConditions contains a list of the conditions that determine + // unhealthyConditions contains a list of the conditions that determine // whether a node is considered unhealthy. The conditions are combined in a // logical OR, i.e. if any of the conditions is met, the node is unhealthy. // @@ -274,7 +274,7 @@ type MachineHealthCheckClass struct { // +kubebuilder:validation:Pattern=^\[[0-9]+-[0-9]+\]$ UnhealthyRange *string `json:"unhealthyRange,omitempty"` - // NodeStartupTimeout allows to set the maximum time for MachineHealthCheck + // nodeStartupTimeout allows to set the maximum time for MachineHealthCheck // to consider a Machine unhealthy if a corresponding Node isn't associated // through a `Spec.ProviderID` field. // @@ -289,7 +289,7 @@ type MachineHealthCheckClass struct { // +optional NodeStartupTimeout *metav1.Duration `json:"nodeStartupTimeout,omitempty"` - // RemediationTemplate is a reference to a remediation template + // remediationTemplate is a reference to a remediation template // provided by an infrastructure provider. // // This field is completely optional, when filled, the MachineHealthCheck controller @@ -302,39 +302,39 @@ type MachineHealthCheckClass struct { // MachinePoolClass serves as a template to define a pool of worker nodes of the cluster // provisioned using `ClusterClass`. type MachinePoolClass struct { - // Class denotes a type of machine pool present in the cluster, + // class denotes a type of machine pool present in the cluster, // this name MUST be unique within a ClusterClass and can be referenced // in the Cluster to create a managed MachinePool. Class string `json:"class"` - // Template is a local struct containing a collection of templates for creation of + // template is a local struct containing a collection of templates for creation of // MachinePools objects representing a pool of worker nodes. Template MachinePoolClassTemplate `json:"template"` - // FailureDomains is the list of failure domains the MachinePool should be attached to. + // failureDomains is the list of failure domains the MachinePool should be attached to. // Must match a key in the FailureDomains map stored on the cluster object. // NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass. // +optional FailureDomains []string `json:"failureDomains,omitempty"` - // NamingStrategy allows changing the naming pattern used when creating the MachinePool. + // namingStrategy allows changing the naming pattern used when creating the MachinePool. // +optional NamingStrategy *MachinePoolClassNamingStrategy `json:"namingStrategy,omitempty"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass. // +optional NodeDrainTimeout *metav1.Duration `json:"nodeDrainTimeout,omitempty"` - // NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + // nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes // to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. // NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass. // +optional NodeVolumeDetachTimeout *metav1.Duration `json:"nodeVolumeDetachTimeout,omitempty"` - // NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + // nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine // hosts after the Machine Pool is marked for deletion. A duration of 0 will retry deletion indefinitely. // Defaults to 10 seconds. // NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass. @@ -352,23 +352,23 @@ type MachinePoolClass struct { // MachinePoolClassTemplate defines how a MachinePool generated from a MachinePoolClass // should look like. type MachinePoolClassTemplate struct { - // Metadata is the metadata applied to the MachinePool. + // metadata is the metadata applied to the MachinePool. // At runtime this metadata is merged with the corresponding metadata from the topology. // +optional Metadata ObjectMeta `json:"metadata,omitempty"` - // Bootstrap contains the bootstrap template reference to be used + // bootstrap contains the bootstrap template reference to be used // for the creation of the Machines in the MachinePool. Bootstrap LocalObjectTemplate `json:"bootstrap"` - // Infrastructure contains the infrastructure template reference to be used + // infrastructure contains the infrastructure template reference to be used // for the creation of the MachinePool. Infrastructure LocalObjectTemplate `json:"infrastructure"` } // MachinePoolClassNamingStrategy defines the naming strategy for machine pool objects. type MachinePoolClassNamingStrategy struct { - // Template defines the template to use for generating the name of the MachinePool object. + // template defines the template to use for generating the name of the MachinePool object. // If not defined, it will fallback to `{{ .cluster.name }}-{{ .machinePool.topologyName }}-{{ .random }}`. // If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will // get concatenated with a random suffix of length 5. @@ -388,16 +388,16 @@ func (m MachineHealthCheckClass) IsZero() bool { // ClusterClassVariable defines a variable which can // be configured in the Cluster topology and used in patches. type ClusterClassVariable struct { - // Name of the variable. + // name of the variable. Name string `json:"name"` - // Required specifies if the variable is required. + // required specifies if the variable is required. // Note: this applies to the variable as a whole and thus the // top-level object defined in the schema. If nested fields are // required, this will be specified inside the schema. Required bool `json:"required"` - // Metadata is the metadata of a variable. + // metadata is the metadata of a variable. // It can be used to add additional data for higher level tools to // a ClusterClassVariable. // @@ -406,7 +406,7 @@ type ClusterClassVariable struct { // +optional Metadata ClusterClassVariableMetadata `json:"metadata,omitempty"` - // Schema defines the schema of the variable. + // schema defines the schema of the variable. Schema VariableSchema `json:"schema"` } @@ -421,7 +421,7 @@ type ClusterClassVariableMetadata struct { // +optional Labels map[string]string `json:"labels,omitempty"` - // Annotations is an unstructured key value map that can be used to store and + // annotations is an unstructured key value map that can be used to store and // retrieve arbitrary metadata. // They are not queryable. // +optional @@ -430,7 +430,7 @@ type ClusterClassVariableMetadata struct { // VariableSchema defines the schema of a variable. type VariableSchema struct { - // OpenAPIV3Schema defines the schema of a variable via OpenAPI v3 + // openAPIV3Schema defines the schema of a variable via OpenAPI v3 // schema. The schema is a subset of the schema used in // Kubernetes CRDs. OpenAPIV3Schema JSONSchemaProps `json:"openAPIV3Schema"` @@ -442,18 +442,18 @@ type VariableSchema struct { // This struct has been initially copied from apiextensionsv1.JSONSchemaProps, but all fields // which are not supported in CAPI have been removed. type JSONSchemaProps struct { - // Description is a human-readable description of this variable. + // description is a human-readable description of this variable. Description string `json:"description,omitempty"` - // Example is an example for this variable. + // example is an example for this variable. Example *apiextensionsv1.JSON `json:"example,omitempty"` - // Type is the type of the variable. + // type is the type of the variable. // Valid values are: object, array, string, integer, number or boolean. // +optional Type string `json:"type,omitempty"` - // Properties specifies fields of an object. + // properties specifies fields of an object. // NOTE: Can only be set if type is object. // NOTE: Properties is mutually exclusive with AdditionalProperties. // NOTE: This field uses PreserveUnknownFields and Schemaless, @@ -463,7 +463,7 @@ type JSONSchemaProps struct { // +kubebuilder:validation:Schemaless Properties map[string]JSONSchemaProps `json:"properties,omitempty"` - // AdditionalProperties specifies the schema of values in a map (keys are always strings). + // additionalProperties specifies the schema of values in a map (keys are always strings). // NOTE: Can only be set if type is object. // NOTE: AdditionalProperties is mutually exclusive with Properties. // NOTE: This field uses PreserveUnknownFields and Schemaless, @@ -473,22 +473,22 @@ type JSONSchemaProps struct { // +kubebuilder:validation:Schemaless AdditionalProperties *JSONSchemaProps `json:"additionalProperties,omitempty"` - // MaxProperties is the maximum amount of entries in a map or properties in an object. + // maxProperties is the maximum amount of entries in a map or properties in an object. // NOTE: Can only be set if type is object. // +optional MaxProperties *int64 `json:"maxProperties,omitempty"` - // MinProperties is the minimum amount of entries in a map or properties in an object. + // minProperties is the minimum amount of entries in a map or properties in an object. // NOTE: Can only be set if type is object. // +optional MinProperties *int64 `json:"minProperties,omitempty"` - // Required specifies which fields of an object are required. + // required specifies which fields of an object are required. // NOTE: Can only be set if type is object. // +optional Required []string `json:"required,omitempty"` - // Items specifies fields of an array. + // items specifies fields of an array. // NOTE: Can only be set if type is array. // NOTE: This field uses PreserveUnknownFields and Schemaless, // because recursive validation is not possible. @@ -497,90 +497,90 @@ type JSONSchemaProps struct { // +kubebuilder:validation:Schemaless Items *JSONSchemaProps `json:"items,omitempty"` - // MaxItems is the max length of an array variable. + // maxItems is the max length of an array variable. // NOTE: Can only be set if type is array. // +optional MaxItems *int64 `json:"maxItems,omitempty"` - // MinItems is the min length of an array variable. + // minItems is the min length of an array variable. // NOTE: Can only be set if type is array. // +optional MinItems *int64 `json:"minItems,omitempty"` - // UniqueItems specifies if items in an array must be unique. + // uniqueItems specifies if items in an array must be unique. // NOTE: Can only be set if type is array. // +optional UniqueItems bool `json:"uniqueItems,omitempty"` - // Format is an OpenAPI v3 format string. Unknown formats are ignored. + // format is an OpenAPI v3 format string. Unknown formats are ignored. // For a list of supported formats please see: (of the k8s.io/apiextensions-apiserver version we're currently using) // https://github.com/kubernetes/apiextensions-apiserver/blob/master/pkg/apiserver/validation/formats.go // NOTE: Can only be set if type is string. // +optional Format string `json:"format,omitempty"` - // MaxLength is the max length of a string variable. + // maxLength is the max length of a string variable. // NOTE: Can only be set if type is string. // +optional MaxLength *int64 `json:"maxLength,omitempty"` - // MinLength is the min length of a string variable. + // minLength is the min length of a string variable. // NOTE: Can only be set if type is string. // +optional MinLength *int64 `json:"minLength,omitempty"` - // Pattern is the regex which a string variable must match. + // pattern is the regex which a string variable must match. // NOTE: Can only be set if type is string. // +optional Pattern string `json:"pattern,omitempty"` - // Maximum is the maximum of an integer or number variable. + // maximum is the maximum of an integer or number variable. // If ExclusiveMaximum is false, the variable is valid if it is lower than, or equal to, the value of Maximum. // If ExclusiveMaximum is true, the variable is valid if it is strictly lower than the value of Maximum. // NOTE: Can only be set if type is integer or number. // +optional Maximum *int64 `json:"maximum,omitempty"` - // ExclusiveMaximum specifies if the Maximum is exclusive. + // exclusiveMaximum specifies if the Maximum is exclusive. // NOTE: Can only be set if type is integer or number. // +optional ExclusiveMaximum bool `json:"exclusiveMaximum,omitempty"` - // Minimum is the minimum of an integer or number variable. + // minimum is the minimum of an integer or number variable. // If ExclusiveMinimum is false, the variable is valid if it is greater than, or equal to, the value of Minimum. // If ExclusiveMinimum is true, the variable is valid if it is strictly greater than the value of Minimum. // NOTE: Can only be set if type is integer or number. // +optional Minimum *int64 `json:"minimum,omitempty"` - // ExclusiveMinimum specifies if the Minimum is exclusive. + // exclusiveMinimum specifies if the Minimum is exclusive. // NOTE: Can only be set if type is integer or number. // +optional ExclusiveMinimum bool `json:"exclusiveMinimum,omitempty"` - // XPreserveUnknownFields allows setting fields in a variable object + // x-kubernetes-preserve-unknown-fields allows setting fields in a variable object // which are not defined in the variable schema. This affects fields recursively, // except if nested properties or additionalProperties are specified in the schema. // +optional XPreserveUnknownFields bool `json:"x-kubernetes-preserve-unknown-fields,omitempty"` - // Enum is the list of valid values of the variable. + // enum is the list of valid values of the variable. // NOTE: Can be set for all types. // +optional Enum []apiextensionsv1.JSON `json:"enum,omitempty"` - // Default is the default value of the variable. + // default is the default value of the variable. // NOTE: Can be set for all types. // +optional Default *apiextensionsv1.JSON `json:"default,omitempty"` - // XValidations describes a list of validation rules written in the CEL expression language. + // x-kubernetes-validations describes a list of validation rules written in the CEL expression language. // +optional // +listType=map // +listMapKey=rule XValidations []ValidationRule `json:"x-kubernetes-validations,omitempty"` - // XMetadata is the metadata of a variable or a nested field within a variable. + // x-metadata is the metadata of a variable or a nested field within a variable. // It can be used to add additional data for higher level tools. // +optional XMetadata *VariableSchemaMetadata `json:"x-metadata,omitempty"` @@ -601,7 +601,7 @@ type JSONSchemaProps struct { // +optional XIntOrString bool `json:"x-kubernetes-int-or-string,omitempty"` - // AllOf specifies that the variable must validate against all of the subschemas in the array. + // allOf specifies that the variable must validate against all of the subschemas in the array. // NOTE: This field uses PreserveUnknownFields and Schemaless, // because recursive validation is not possible. // +optional @@ -609,7 +609,7 @@ type JSONSchemaProps struct { // +kubebuilder:validation:Schemaless AllOf []JSONSchemaProps `json:"allOf,omitempty"` - // OneOf specifies that the variable must validate against exactly one of the subschemas in the array. + // oneOf specifies that the variable must validate against exactly one of the subschemas in the array. // NOTE: This field uses PreserveUnknownFields and Schemaless, // because recursive validation is not possible. // +optional @@ -617,7 +617,7 @@ type JSONSchemaProps struct { // +kubebuilder:validation:Schemaless OneOf []JSONSchemaProps `json:"oneOf,omitempty"` - // AnyOf specifies that the variable must validate against one or more of the subschemas in the array. + // anyOf specifies that the variable must validate against one or more of the subschemas in the array. // NOTE: This field uses PreserveUnknownFields and Schemaless, // because recursive validation is not possible. // +optional @@ -625,7 +625,7 @@ type JSONSchemaProps struct { // +kubebuilder:validation:Schemaless AnyOf []JSONSchemaProps `json:"anyOf,omitempty"` - // Not specifies that the variable must not validate against the subschema. + // not specifies that the variable must not validate against the subschema. // NOTE: This field uses PreserveUnknownFields and Schemaless, // because recursive validation is not possible. // +optional @@ -642,7 +642,7 @@ type VariableSchemaMetadata struct { // +optional Labels map[string]string `json:"labels,omitempty"` - // Annotations is an unstructured key value map that can be used to store and + // annotations is an unstructured key value map that can be used to store and // retrieve arbitrary metadata. // They are not queryable. // +optional @@ -651,7 +651,7 @@ type VariableSchemaMetadata struct { // ValidationRule describes a validation rule written in the CEL expression language. type ValidationRule struct { - // Rule represents the expression which will be evaluated by CEL. + // rule represents the expression which will be evaluated by CEL. // ref: https://github.com/google/cel-spec // The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. // The `self` variable in the CEL expression is bound to the scoped value. @@ -701,13 +701,13 @@ type ValidationRule struct { // // +kubebuilder:validation:Required Rule string `json:"rule"` - // Message represents the message displayed when validation fails. The message is required if the Rule contains + // message represents the message displayed when validation fails. The message is required if the Rule contains // line breaks. The message must not contain line breaks. // If unset, the message is "failed rule: {Rule}". // e.g. "must be a URL with the host matching spec.host" // +optional Message string `json:"message,omitempty"` - // MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. + // messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. // Since messageExpression is used as a failure message, it must evaluate to a string. // If both message and messageExpression are present on a rule, then messageExpression will be used if validation // fails. If messageExpression results in a runtime error, the validation failure message is produced @@ -718,7 +718,7 @@ type ValidationRule struct { // "x must be less than max ("+string(self.max)+")" // +optional MessageExpression string `json:"messageExpression,omitempty"` - // Reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. + // reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. // The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". // If not set, default to use "FieldValueInvalid". // All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid. @@ -727,7 +727,7 @@ type ValidationRule struct { // +kubebuilder:default=FieldValueInvalid // +default=ref(sigs.k8s.io/cluster-api/api/v1beta1.FieldValueInvalid) Reason FieldValueErrorReason `json:"reason,omitempty"` - // FieldPath represents the field path returned when the validation fails. + // fieldPath represents the field path returned when the validation fails. // It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. // e.g. when validation checks if a specific attribute `foo` under a map `testMap`, the fieldPath could be set to `.testMap.foo` // If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. `.testList` @@ -761,13 +761,13 @@ const ( // ClusterClassPatch defines a patch which is applied to customize the referenced templates. type ClusterClassPatch struct { - // Name of the patch. + // name of the patch. Name string `json:"name"` - // Description is a human-readable description of this patch. + // description is a human-readable description of this patch. Description string `json:"description,omitempty"` - // EnabledIf is a Go template to be used to calculate if a patch should be enabled. + // enabledIf is a Go template to be used to calculate if a patch should be enabled. // It can reference variables defined in .spec.variables and builtin variables. // The patch will be enabled if the template evaluates to `true`, otherwise it will // be disabled. @@ -775,13 +775,13 @@ type ClusterClassPatch struct { // +optional EnabledIf *string `json:"enabledIf,omitempty"` - // Definitions define inline patches. + // definitions define inline patches. // Note: Patches will be applied in the order of the array. // Note: Exactly one of Definitions or External must be set. // +optional Definitions []PatchDefinition `json:"definitions,omitempty"` - // External defines an external patch. + // external defines an external patch. // Note: Exactly one of Definitions or External must be set. // +optional External *ExternalPatchDefinition `json:"external,omitempty"` @@ -789,10 +789,10 @@ type ClusterClassPatch struct { // PatchDefinition defines a patch which is applied to customize the referenced templates. type PatchDefinition struct { - // Selector defines on which templates the patch should be applied. + // selector defines on which templates the patch should be applied. Selector PatchSelector `json:"selector"` - // JSONPatches defines the patches which should be applied on the templates + // jsonPatches defines the patches which should be applied on the templates // matching the selector. // Note: Patches will be applied in the order of the array. JSONPatches []JSONPatch `json:"jsonPatches"` @@ -804,13 +804,13 @@ type PatchDefinition struct { // be automatically updated during reconciliation if there is a newer version for the same contract. // Note: The results of selection based on the individual fields are ANDed. type PatchSelector struct { - // APIVersion filters templates by apiVersion. + // apiVersion filters templates by apiVersion. APIVersion string `json:"apiVersion"` - // Kind filters templates by kind. + // kind filters templates by kind. Kind string `json:"kind"` - // MatchResources selects templates based on where they are referenced. + // matchResources selects templates based on where they are referenced. MatchResources PatchSelectorMatch `json:"matchResources"` } @@ -818,22 +818,22 @@ type PatchSelector struct { // Note: The selector must match at least one template. // Note: The results of selection based on the individual fields are ORed. type PatchSelectorMatch struct { - // ControlPlane selects templates referenced in .spec.ControlPlane. + // controlPlane selects templates referenced in .spec.ControlPlane. // Note: this will match the controlPlane and also the controlPlane // machineInfrastructure (depending on the kind and apiVersion). // +optional ControlPlane bool `json:"controlPlane,omitempty"` - // InfrastructureCluster selects templates referenced in .spec.infrastructure. + // infrastructureCluster selects templates referenced in .spec.infrastructure. // +optional InfrastructureCluster bool `json:"infrastructureCluster,omitempty"` - // MachineDeploymentClass selects templates referenced in specific MachineDeploymentClasses in + // machineDeploymentClass selects templates referenced in specific MachineDeploymentClasses in // .spec.workers.machineDeployments. // +optional MachineDeploymentClass *PatchSelectorMatchMachineDeploymentClass `json:"machineDeploymentClass,omitempty"` - // MachinePoolClass selects templates referenced in specific MachinePoolClasses in + // machinePoolClass selects templates referenced in specific MachinePoolClasses in // .spec.workers.machinePools. // +optional MachinePoolClass *PatchSelectorMatchMachinePoolClass `json:"machinePoolClass,omitempty"` @@ -842,7 +842,7 @@ type PatchSelectorMatch struct { // PatchSelectorMatchMachineDeploymentClass selects templates referenced // in specific MachineDeploymentClasses in .spec.workers.machineDeployments. type PatchSelectorMatchMachineDeploymentClass struct { - // Names selects templates by class names. + // names selects templates by class names. // +optional Names []string `json:"names,omitempty"` } @@ -850,25 +850,25 @@ type PatchSelectorMatchMachineDeploymentClass struct { // PatchSelectorMatchMachinePoolClass selects templates referenced // in specific MachinePoolClasses in .spec.workers.machinePools. type PatchSelectorMatchMachinePoolClass struct { - // Names selects templates by class names. + // names selects templates by class names. // +optional Names []string `json:"names,omitempty"` } // JSONPatch defines a JSON patch. type JSONPatch struct { - // Op defines the operation of the patch. + // op defines the operation of the patch. // Note: Only `add`, `replace` and `remove` are supported. Op string `json:"op"` - // Path defines the path of the patch. + // path defines the path of the patch. // Note: Only the spec of a template can be patched, thus the path has to start with /spec/. // Note: For now the only allowed array modifications are `append` and `prepend`, i.e.: // * for op: `add`: only index 0 (prepend) and - (append) are allowed // * for op: `replace` or `remove`: no indexes are allowed Path string `json:"path"` - // Value defines the value of the patch. + // value defines the value of the patch. // Note: Either Value or ValueFrom is required for add and replace // operations. Only one of them is allowed to be set at the same time. // Note: We have to use apiextensionsv1.JSON instead of our JSON type, @@ -878,7 +878,7 @@ type JSONPatch struct { // +optional Value *apiextensionsv1.JSON `json:"value,omitempty"` - // ValueFrom defines the value of the patch. + // valueFrom defines the value of the patch. // Note: Either Value or ValueFrom is required for add and replace // operations. Only one of them is allowed to be set at the same time. // +optional @@ -888,12 +888,12 @@ type JSONPatch struct { // JSONPatchValue defines the value of a patch. // Note: Only one of the fields is allowed to be set at the same time. type JSONPatchValue struct { - // Variable is the variable to be used as value. + // variable is the variable to be used as value. // Variable can be one of the variables defined in .spec.variables or a builtin variable. // +optional Variable *string `json:"variable,omitempty"` - // Template is the Go template to be used to calculate the value. + // template is the Go template to be used to calculate the value. // A template can reference variables defined in .spec.variables and builtin variables. // Note: The template must evaluate to a valid YAML or JSON value. // +optional @@ -903,19 +903,19 @@ type JSONPatchValue struct { // ExternalPatchDefinition defines an external patch. // Note: At least one of GenerateExtension or ValidateExtension must be set. type ExternalPatchDefinition struct { - // GenerateExtension references an extension which is called to generate patches. + // generateExtension references an extension which is called to generate patches. // +optional GenerateExtension *string `json:"generateExtension,omitempty"` - // ValidateExtension references an extension which is called to validate the topology. + // validateExtension references an extension which is called to validate the topology. // +optional ValidateExtension *string `json:"validateExtension,omitempty"` - // DiscoverVariablesExtension references an extension which is called to discover variables. + // discoverVariablesExtension references an extension which is called to discover variables. // +optional DiscoverVariablesExtension *string `json:"discoverVariablesExtension,omitempty"` - // Settings defines key value pairs to be passed to the extensions. + // settings defines key value pairs to be passed to the extensions. // Values defined here take precedence over the values defined in the // corresponding ExtensionConfig. // +optional @@ -924,7 +924,7 @@ type ExternalPatchDefinition struct { // LocalObjectTemplate defines a template for a topology Class. type LocalObjectTemplate struct { - // Ref is a required reference to a custom resource + // ref is a required reference to a custom resource // offered by a provider. Ref *corev1.ObjectReference `json:"ref"` } @@ -933,15 +933,15 @@ type LocalObjectTemplate struct { // ClusterClassStatus defines the observed state of the ClusterClass. type ClusterClassStatus struct { - // Variables is a list of ClusterClassStatusVariable that are defined for the ClusterClass. + // variables is a list of ClusterClassStatusVariable that are defined for the ClusterClass. // +optional Variables []ClusterClassStatusVariable `json:"variables,omitempty"` - // Conditions defines current observed state of the ClusterClass. + // conditions defines current observed state of the ClusterClass. // +optional Conditions Conditions `json:"conditions,omitempty"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` @@ -964,31 +964,31 @@ type ClusterClassV1Beta2Status struct { // ClusterClassStatusVariable defines a variable which appears in the status of a ClusterClass. type ClusterClassStatusVariable struct { - // Name is the name of the variable. + // name is the name of the variable. Name string `json:"name"` - // DefinitionsConflict specifies whether or not there are conflicting definitions for a single variable name. + // definitionsConflict specifies whether or not there are conflicting definitions for a single variable name. // +optional DefinitionsConflict bool `json:"definitionsConflict"` - // Definitions is a list of definitions for a variable. + // definitions is a list of definitions for a variable. Definitions []ClusterClassStatusVariableDefinition `json:"definitions"` } // ClusterClassStatusVariableDefinition defines a variable which appears in the status of a ClusterClass. type ClusterClassStatusVariableDefinition struct { - // From specifies the origin of the variable definition. + // from specifies the origin of the variable definition. // This will be `inline` for variables defined in the ClusterClass or the name of a patch defined in the ClusterClass // for variables discovered from a DiscoverVariables runtime extensions. From string `json:"from"` - // Required specifies if the variable is required. + // required specifies if the variable is required. // Note: this applies to the variable as a whole and thus the // top-level object defined in the schema. If nested fields are // required, this will be specified inside the schema. Required bool `json:"required"` - // Metadata is the metadata of a variable. + // metadata is the metadata of a variable. // It can be used to add additional data for higher level tools to // a ClusterClassVariable. // @@ -997,7 +997,7 @@ type ClusterClassStatusVariableDefinition struct { // +optional Metadata ClusterClassVariableMetadata `json:"metadata,omitempty"` - // Schema defines the schema of the variable. + // schema defines the schema of the variable. Schema VariableSchema `json:"schema"` } diff --git a/api/v1beta1/common_types.go b/api/v1beta1/common_types.go index 860b8d28752e..f70b0f3e4a36 100644 --- a/api/v1beta1/common_types.go +++ b/api/v1beta1/common_types.go @@ -312,7 +312,7 @@ type ObjectMeta struct { // +optional Labels map[string]string `json:"labels,omitempty"` - // Annotations is an unstructured key value map stored with a resource that may be + // annotations is an unstructured key value map stored with a resource that may be // set by external tools to store and retrieve arbitrary metadata. They are not // queryable and should be preserved when modifying objects. // More info: http://kubernetes.io/docs/user-guide/annotations diff --git a/api/v1beta1/condition_types.go b/api/v1beta1/condition_types.go index a66cf9bc838c..e647f89a2d7b 100644 --- a/api/v1beta1/condition_types.go +++ b/api/v1beta1/condition_types.go @@ -53,15 +53,15 @@ type ConditionType string // Condition defines an observation of a Cluster API resource operational state. type Condition struct { - // Type of condition in CamelCase or in foo.example.com/CamelCase. + // 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. Type ConditionType `json:"type"` - // Status of the condition, one of True, False, Unknown. + // status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status"` - // Severity provides an explicit classification of Reason code, so the users or machines can immediately + // 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 diff --git a/api/v1beta1/machine_types.go b/api/v1beta1/machine_types.go index 3f74d096f700..bb1d0f31765f 100644 --- a/api/v1beta1/machine_types.go +++ b/api/v1beta1/machine_types.go @@ -335,24 +335,24 @@ const ( // MachineSpec defines the desired state of Machine. type MachineSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` - // Bootstrap is a reference to a local struct which encapsulates + // bootstrap is a reference to a local struct which encapsulates // fields to configure the Machine’s bootstrapping mechanism. Bootstrap Bootstrap `json:"bootstrap"` - // InfrastructureRef is a required reference to a custom resource + // infrastructureRef is a required reference to a custom resource // offered by an infrastructure provider. InfrastructureRef corev1.ObjectReference `json:"infrastructureRef"` - // Version defines the desired Kubernetes version. + // version defines the desired Kubernetes version. // This field is meant to be optionally used by bootstrap providers. // +optional Version *string `json:"version,omitempty"` - // ProviderID is the identification ID of the machine provided by the provider. + // providerID is the identification ID of the machine provided by the provider. // This field must match the provider ID as seen on the node object corresponding to this machine. // This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler // with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -365,7 +365,7 @@ type MachineSpec struct { // +optional ProviderID *string `json:"providerID,omitempty"` - // FailureDomain is the failure domain the machine will be created in. + // failureDomain is the failure domain the machine will be created in. // Must match a key in the FailureDomains map stored on the cluster object. // +optional FailureDomain *string `json:"failureDomain,omitempty"` @@ -394,18 +394,18 @@ type MachineSpec struct { // +kubebuilder:validation:MaxItems=32 ReadinessGates []MachineReadinessGate `json:"readinessGates,omitempty"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // +optional NodeDrainTimeout *metav1.Duration `json:"nodeDrainTimeout,omitempty"` - // NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + // nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes // to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. // +optional NodeVolumeDetachTimeout *metav1.Duration `json:"nodeVolumeDetachTimeout,omitempty"` - // NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + // nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine // hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. // Defaults to 10 seconds. // +optional @@ -430,20 +430,20 @@ type MachineReadinessGate struct { // MachineStatus defines the observed state of Machine. type MachineStatus struct { - // NodeRef will point to the corresponding Node if it exists. + // nodeRef will point to the corresponding Node if it exists. // +optional NodeRef *corev1.ObjectReference `json:"nodeRef,omitempty"` - // NodeInfo is a set of ids/uuids to uniquely identify the node. + // nodeInfo is a set of ids/uuids to uniquely identify the node. // More info: https://kubernetes.io/docs/concepts/nodes/node/#info // +optional NodeInfo *corev1.NodeSystemInfo `json:"nodeInfo,omitempty"` - // LastUpdated identifies when the phase of the Machine last transitioned. + // lastUpdated identifies when the phase of the Machine last transitioned. // +optional LastUpdated *metav1.Time `json:"lastUpdated,omitempty"` - // FailureReason will be set in the event that there is a terminal problem + // failureReason will be set in the event that there is a terminal problem // reconciling the Machine and will contain a succinct value suitable // for machine interpretation. // @@ -465,7 +465,7 @@ type MachineStatus struct { // +optional FailureReason *capierrors.MachineStatusError `json:"failureReason,omitempty"` - // FailureMessage will be set in the event that there is a terminal problem + // failureMessage will be set in the event that there is a terminal problem // reconciling the Machine and will contain a more verbose string suitable // for logging and human consumption. // @@ -487,34 +487,34 @@ type MachineStatus struct { // +optional FailureMessage *string `json:"failureMessage,omitempty"` - // Addresses is a list of addresses assigned to the machine. + // addresses is a list of addresses assigned to the machine. // This field is copied from the infrastructure provider reference. // +optional Addresses MachineAddresses `json:"addresses,omitempty"` - // Phase represents the current phase of machine actuation. + // phase represents the current phase of machine actuation. // E.g. Pending, Running, Terminating, Failed etc. // +optional Phase string `json:"phase,omitempty"` - // CertificatesExpiryDate is the expiry date of the machine certificates. + // certificatesExpiryDate is the expiry date of the machine certificates. // This value is only set for control plane machines. // +optional CertificatesExpiryDate *metav1.Time `json:"certificatesExpiryDate,omitempty"` - // BootstrapReady is the state of the bootstrap provider. + // bootstrapReady is the state of the bootstrap provider. // +optional BootstrapReady bool `json:"bootstrapReady"` - // InfrastructureReady is the state of the infrastructure provider. + // infrastructureReady is the state of the infrastructure provider. // +optional InfrastructureReady bool `json:"infrastructureReady"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions defines current service state of the Machine. + // conditions defines current service state of the Machine. // +optional Conditions Conditions `json:"conditions,omitempty"` @@ -590,14 +590,14 @@ func (m *MachineStatus) GetTypedPhase() MachinePhase { // Bootstrap encapsulates fields to configure the Machine’s bootstrapping mechanism. type Bootstrap struct { - // ConfigRef is a reference to a bootstrap provider-specific resource + // configRef is a reference to a bootstrap provider-specific resource // that holds configuration details. The reference is optional to // allow users/operators to specify Bootstrap.DataSecretName without // the need of a controller. // +optional ConfigRef *corev1.ObjectReference `json:"configRef,omitempty"` - // DataSecretName is the name of the secret that stores the bootstrap data script. + // dataSecretName is the name of the secret that stores the bootstrap data script. // If nil, the Machine should remain in the Pending state. // +optional DataSecretName *string `json:"dataSecretName,omitempty"` diff --git a/api/v1beta1/machinedeployment_types.go b/api/v1beta1/machinedeployment_types.go index b0111748755a..204576acfd0e 100644 --- a/api/v1beta1/machinedeployment_types.go +++ b/api/v1beta1/machinedeployment_types.go @@ -204,7 +204,7 @@ const ( // MachineDeploymentSpec defines the desired state of MachineDeployment. type MachineDeploymentSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` @@ -228,7 +228,7 @@ type MachineDeploymentSpec struct { // +optional Replicas *int32 `json:"replicas,omitempty"` - // RolloutAfter is a field to indicate a rollout should be performed + // rolloutAfter is a field to indicate a rollout should be performed // after the specified time even if no changes have been made to the // MachineDeployment. // Example: In the YAML the time can be specified in the RFC3339 format. @@ -242,7 +242,7 @@ type MachineDeploymentSpec struct { // It must match the machine template's labels. Selector metav1.LabelSelector `json:"selector"` - // Template describes the machines that will be created. + // template describes the machines that will be created. Template MachineTemplateSpec `json:"template"` // The deployment strategy to use to replace existing machines with @@ -250,7 +250,7 @@ type MachineDeploymentSpec struct { // +optional Strategy *MachineDeploymentStrategy `json:"strategy,omitempty"` - // MinReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. + // minReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. // Defaults to 0 (machine will be considered available as soon as the Node is ready) // +optional MinReadySeconds *int32 `json:"minReadySeconds,omitempty"` @@ -284,7 +284,7 @@ type MachineDeploymentSpec struct { // MachineDeploymentStrategy describes how to replace existing machines // with new ones. type MachineDeploymentStrategy struct { - // Type of deployment. Allowed values are RollingUpdate and OnDelete. + // type of deployment. Allowed values are RollingUpdate and OnDelete. // The default is RollingUpdate. // +kubebuilder:validation:Enum=RollingUpdate;OnDelete // +optional @@ -295,7 +295,7 @@ type MachineDeploymentStrategy struct { // +optional RollingUpdate *MachineRollingUpdateDeployment `json:"rollingUpdate,omitempty"` - // Remediation controls the strategy of remediating unhealthy machines + // remediation controls the strategy of remediating unhealthy machines // and how remediating operations should occur during the lifecycle of the dependant MachineSets. // +optional Remediation *RemediationStrategy `json:"remediation,omitempty"` @@ -338,7 +338,7 @@ type MachineRollingUpdateDeployment struct { // +optional MaxSurge *intstr.IntOrString `json:"maxSurge,omitempty"` - // DeletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. + // deletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. // Valid values are "Random, "Newest", "Oldest" // When no value is supplied, the default DeletePolicy of MachineSet is used // +kubebuilder:validation:Enum=Random;Newest;Oldest @@ -352,7 +352,7 @@ type MachineRollingUpdateDeployment struct { // RemediationStrategy allows to define how the MachineSet can control scaling operations. type RemediationStrategy struct { - // MaxInFlight determines how many in flight remediations should happen at the same time. + // maxInFlight determines how many in flight remediations should happen at the same time. // // Remediation only happens on the MachineSet with the most current revision, while // older MachineSets (usually present during rollout operations) aren't allowed to remediate. @@ -381,7 +381,7 @@ type MachineDeploymentStatus struct { // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Selector is the same as the label selector but in the string format to avoid introspection + // selector is the same as the label selector but in the string format to avoid introspection // by clients. The string will be in the same format as the query-param syntax. // More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors // +optional @@ -414,11 +414,11 @@ type MachineDeploymentStatus struct { // +optional UnavailableReplicas int32 `json:"unavailableReplicas"` - // Phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown). + // phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown). // +optional Phase string `json:"phase,omitempty"` - // Conditions defines current service state of the MachineDeployment. + // conditions defines current service state of the MachineDeployment. // +optional Conditions Conditions `json:"conditions,omitempty"` diff --git a/api/v1beta1/machinehealthcheck_types.go b/api/v1beta1/machinehealthcheck_types.go index 837ea0fe7678..e2b62c738ebf 100644 --- a/api/v1beta1/machinehealthcheck_types.go +++ b/api/v1beta1/machinehealthcheck_types.go @@ -51,14 +51,14 @@ var ( // MachineHealthCheckSpec defines the desired state of MachineHealthCheck. type MachineHealthCheckSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` // Label selector to match machines whose health will be exercised Selector metav1.LabelSelector `json:"selector"` - // UnhealthyConditions contains a list of the conditions that determine + // unhealthyConditions contains a list of the conditions that determine // whether a node is considered unhealthy. The conditions are combined in a // logical OR, i.e. if any of the conditions is met, the node is unhealthy. // @@ -85,7 +85,7 @@ type MachineHealthCheckSpec struct { // +kubebuilder:validation:Pattern=^\[[0-9]+-[0-9]+\]$ UnhealthyRange *string `json:"unhealthyRange,omitempty"` - // NodeStartupTimeout allows to set the maximum time for MachineHealthCheck + // nodeStartupTimeout allows to set the maximum time for MachineHealthCheck // to consider a Machine unhealthy if a corresponding Node isn't associated // through a `Spec.ProviderID` field. // @@ -100,7 +100,7 @@ type MachineHealthCheckSpec struct { // +optional NodeStartupTimeout *metav1.Duration `json:"nodeStartupTimeout,omitempty"` - // RemediationTemplate is a reference to a remediation template + // remediationTemplate is a reference to a remediation template // provided by an infrastructure provider. // // This field is completely optional, when filled, the MachineHealthCheck controller @@ -145,21 +145,21 @@ type MachineHealthCheckStatus struct { // +optional CurrentHealthy int32 `json:"currentHealthy"` - // RemediationsAllowed is the number of further remediations allowed by this machine health check before + // remediationsAllowed is the number of further remediations allowed by this machine health check before // maxUnhealthy short circuiting will be applied // +kubebuilder:validation:Minimum=0 // +optional RemediationsAllowed int32 `json:"remediationsAllowed"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Targets shows the current list of machines the machine health check is watching + // targets shows the current list of machines the machine health check is watching // +optional Targets []string `json:"targets,omitempty"` - // Conditions defines current service state of the MachineHealthCheck. + // conditions defines current service state of the MachineHealthCheck. // +optional Conditions Conditions `json:"conditions,omitempty"` diff --git a/api/v1beta1/machineset_types.go b/api/v1beta1/machineset_types.go index 27d566cc39f0..a20fd15f42f5 100644 --- a/api/v1beta1/machineset_types.go +++ b/api/v1beta1/machineset_types.go @@ -39,11 +39,11 @@ const ( // MachineSetSpec defines the desired state of MachineSet. type MachineSetSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` - // Replicas is the number of desired replicas. + // replicas is the number of desired replicas. // This is a pointer to distinguish between explicit zero and unspecified. // // Defaults to: @@ -63,24 +63,24 @@ type MachineSetSpec struct { // +optional Replicas *int32 `json:"replicas,omitempty"` - // MinReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. + // minReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. // Defaults to 0 (machine will be considered available as soon as the Node is ready) // +optional MinReadySeconds int32 `json:"minReadySeconds,omitempty"` - // DeletePolicy defines the policy used to identify nodes to delete when downscaling. + // deletePolicy defines the policy used to identify nodes to delete when downscaling. // Defaults to "Random". Valid values are "Random, "Newest", "Oldest" // +kubebuilder:validation:Enum=Random;Newest;Oldest // +optional DeletePolicy string `json:"deletePolicy,omitempty"` - // Selector is a label query over machines that should match the replica count. + // selector is a label query over machines that should match the replica count. // Label keys and values that must match in order to be controlled by this MachineSet. // It must match the machine template's labels. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors Selector metav1.LabelSelector `json:"selector"` - // Template is the object that describes the machine that will be created if + // template is the object that describes the machine that will be created if // insufficient replicas are detected. // Object references to custom resources are treated as templates. // +optional @@ -212,13 +212,13 @@ const ( // MachineSetStatus defines the observed state of MachineSet. type MachineSetStatus struct { - // Selector is the same as the label selector but in the string format to avoid introspection + // selector is the same as the label selector but in the string format to avoid introspection // by clients. The string will be in the same format as the query-param syntax. // More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors // +optional Selector string `json:"selector,omitempty"` - // Replicas is the most recently observed number of replicas. + // replicas is the most recently observed number of replicas. // +optional Replicas int32 `json:"replicas"` @@ -234,7 +234,7 @@ type MachineSetStatus struct { // +optional AvailableReplicas int32 `json:"availableReplicas"` - // ObservedGeneration reflects the generation of the most recently observed MachineSet. + // observedGeneration reflects the generation of the most recently observed MachineSet. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` @@ -265,7 +265,7 @@ type MachineSetStatus struct { // // +optional FailureMessage *string `json:"failureMessage,omitempty"` - // Conditions defines current service state of the MachineSet. + // conditions defines current service state of the MachineSet. // +optional Conditions Conditions `json:"conditions,omitempty"` diff --git a/api/v1beta1/zz_generated.openapi.go b/api/v1beta1/zz_generated.openapi.go index a7345be50029..3dfbc76e956f 100644 --- a/api/v1beta1/zz_generated.openapi.go +++ b/api/v1beta1/zz_generated.openapi.go @@ -156,13 +156,13 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_Bootstrap(ref common.ReferenceCall Properties: map[string]spec.Schema{ "configRef": { SchemaProps: spec.SchemaProps{ - Description: "ConfigRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.DataSecretName without the need of a controller.", + Description: "configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.DataSecretName without the need of a controller.", Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, "dataSecretName": { SchemaProps: spec.SchemaProps{ - Description: "DataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state.", + Description: "dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state.", Type: []string{"string"}, Format: "", }, @@ -349,7 +349,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassPatch(ref common.Refer Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the patch.", + Description: "name of the patch.", Default: "", Type: []string{"string"}, Format: "", @@ -357,21 +357,21 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassPatch(ref common.Refer }, "description": { SchemaProps: spec.SchemaProps{ - Description: "Description is a human-readable description of this patch.", + Description: "description is a human-readable description of this patch.", Type: []string{"string"}, Format: "", }, }, "enabledIf": { SchemaProps: spec.SchemaProps{ - Description: "EnabledIf is a Go template to be used to calculate if a patch should be enabled. It can reference variables defined in .spec.variables and builtin variables. The patch will be enabled if the template evaluates to `true`, otherwise it will be disabled. If EnabledIf is not set, the patch will be enabled per default.", + Description: "enabledIf is a Go template to be used to calculate if a patch should be enabled. It can reference variables defined in .spec.variables and builtin variables. The patch will be enabled if the template evaluates to `true`, otherwise it will be disabled. If EnabledIf is not set, the patch will be enabled per default.", Type: []string{"string"}, Format: "", }, }, "definitions": { SchemaProps: spec.SchemaProps{ - Description: "Definitions define inline patches. Note: Patches will be applied in the order of the array. Note: Exactly one of Definitions or External must be set.", + Description: "definitions define inline patches. Note: Patches will be applied in the order of the array. Note: Exactly one of Definitions or External must be set.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -385,7 +385,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassPatch(ref common.Refer }, "external": { SchemaProps: spec.SchemaProps{ - Description: "External defines an external patch. Note: Exactly one of Definitions or External must be set.", + Description: "external defines an external patch. Note: Exactly one of Definitions or External must be set.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ExternalPatchDefinition"), }, }, @@ -407,28 +407,28 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassSpec(ref common.Refere Properties: map[string]spec.Schema{ "infrastructure": { SchemaProps: spec.SchemaProps{ - Description: "Infrastructure is a reference to a provider-specific template that holds the details for provisioning infrastructure specific cluster for the underlying provider. The underlying provider is responsible for the implementation of the template to an infrastructure cluster.", + Description: "infrastructure is a reference to a provider-specific template that holds the details for provisioning infrastructure specific cluster for the underlying provider. The underlying provider is responsible for the implementation of the template to an infrastructure cluster.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.LocalObjectTemplate"), }, }, "controlPlane": { SchemaProps: spec.SchemaProps{ - Description: "ControlPlane is a reference to a local struct that holds the details for provisioning the Control Plane for the Cluster.", + Description: "controlPlane is a reference to a local struct that holds the details for provisioning the Control Plane for the Cluster.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ControlPlaneClass"), }, }, "workers": { SchemaProps: spec.SchemaProps{ - Description: "Workers describes the worker nodes for the cluster. It is a collection of node types which can be used to create the worker nodes of the cluster.", + Description: "workers describes the worker nodes for the cluster. It is a collection of node types which can be used to create the worker nodes of the cluster.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.WorkersClass"), }, }, "variables": { SchemaProps: spec.SchemaProps{ - Description: "Variables defines the variables which can be configured in the Cluster topology and are then used in patches.", + Description: "variables defines the variables which can be configured in the Cluster topology and are then used in patches.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -442,7 +442,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassSpec(ref common.Refere }, "patches": { SchemaProps: spec.SchemaProps{ - Description: "Patches defines the patches which are applied to customize referenced templates of a ClusterClass. Note: Patches will be applied in the order of the array.", + Description: "patches defines the patches which are applied to customize referenced templates of a ClusterClass. Note: Patches will be applied in the order of the array.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -471,7 +471,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassStatus(ref common.Refe Properties: map[string]spec.Schema{ "variables": { SchemaProps: spec.SchemaProps{ - Description: "Variables is a list of ClusterClassStatusVariable that are defined for the ClusterClass.", + Description: "variables is a list of ClusterClassStatusVariable that are defined for the ClusterClass.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -485,7 +485,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassStatus(ref common.Refe }, "conditions": { SchemaProps: spec.SchemaProps{ - Description: "Conditions defines current observed state of the ClusterClass.", + Description: "conditions defines current observed state of the ClusterClass.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -499,7 +499,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassStatus(ref common.Refe }, "observedGeneration": { SchemaProps: spec.SchemaProps{ - Description: "ObservedGeneration is the latest generation observed by the controller.", + Description: "observedGeneration is the latest generation observed by the controller.", Type: []string{"integer"}, Format: "int64", }, @@ -527,7 +527,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassStatusVariable(ref com Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the variable.", + Description: "name is the name of the variable.", Default: "", Type: []string{"string"}, Format: "", @@ -535,7 +535,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassStatusVariable(ref com }, "definitionsConflict": { SchemaProps: spec.SchemaProps{ - Description: "DefinitionsConflict specifies whether or not there are conflicting definitions for a single variable name.", + Description: "definitionsConflict specifies whether or not there are conflicting definitions for a single variable name.", Default: false, Type: []string{"boolean"}, Format: "", @@ -543,7 +543,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassStatusVariable(ref com }, "definitions": { SchemaProps: spec.SchemaProps{ - Description: "Definitions is a list of definitions for a variable.", + Description: "definitions is a list of definitions for a variable.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -573,7 +573,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassStatusVariableDefiniti Properties: map[string]spec.Schema{ "from": { SchemaProps: spec.SchemaProps{ - Description: "From specifies the origin of the variable definition. This will be `inline` for variables defined in the ClusterClass or the name of a patch defined in the ClusterClass for variables discovered from a DiscoverVariables runtime extensions.", + Description: "from specifies the origin of the variable definition. This will be `inline` for variables defined in the ClusterClass or the name of a patch defined in the ClusterClass for variables discovered from a DiscoverVariables runtime extensions.", Default: "", Type: []string{"string"}, Format: "", @@ -581,7 +581,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassStatusVariableDefiniti }, "required": { SchemaProps: spec.SchemaProps{ - Description: "Required specifies if the variable is required. Note: this applies to the variable as a whole and thus the top-level object defined in the schema. If nested fields are required, this will be specified inside the schema.", + Description: "required specifies if the variable is required. Note: this applies to the variable as a whole and thus the top-level object defined in the schema. If nested fields are required, this will be specified inside the schema.", Default: false, Type: []string{"boolean"}, Format: "", @@ -589,14 +589,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassStatusVariableDefiniti }, "metadata": { SchemaProps: spec.SchemaProps{ - Description: "Metadata is the metadata of a variable. It can be used to add additional data for higher level tools to a ClusterClassVariable.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion.", + Description: "metadata is the metadata of a variable. It can be used to add additional data for higher level tools to a ClusterClassVariable.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ClusterClassVariableMetadata"), }, }, "schema": { SchemaProps: spec.SchemaProps{ - Description: "Schema defines the schema of the variable.", + Description: "schema defines the schema of the variable.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.VariableSchema"), }, @@ -656,7 +656,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassVariable(ref common.Re Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the variable.", + Description: "name of the variable.", Default: "", Type: []string{"string"}, Format: "", @@ -664,7 +664,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassVariable(ref common.Re }, "required": { SchemaProps: spec.SchemaProps{ - Description: "Required specifies if the variable is required. Note: this applies to the variable as a whole and thus the top-level object defined in the schema. If nested fields are required, this will be specified inside the schema.", + Description: "required specifies if the variable is required. Note: this applies to the variable as a whole and thus the top-level object defined in the schema. If nested fields are required, this will be specified inside the schema.", Default: false, Type: []string{"boolean"}, Format: "", @@ -672,14 +672,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassVariable(ref common.Re }, "metadata": { SchemaProps: spec.SchemaProps{ - Description: "Metadata is the metadata of a variable. It can be used to add additional data for higher level tools to a ClusterClassVariable.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion. Please use XMetadata in JSONSchemaProps instead.", + Description: "metadata is the metadata of a variable. It can be used to add additional data for higher level tools to a ClusterClassVariable.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion. Please use XMetadata in JSONSchemaProps instead.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ClusterClassVariableMetadata"), }, }, "schema": { SchemaProps: spec.SchemaProps{ - Description: "Schema defines the schema of the variable.", + Description: "schema defines the schema of the variable.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.VariableSchema"), }, @@ -718,7 +718,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterClassVariableMetadata(ref c }, "annotations": { SchemaProps: spec.SchemaProps{ - Description: "Annotations is an unstructured key value map that can be used to store and retrieve arbitrary metadata. They are not queryable.", + Description: "annotations is an unstructured key value map that can be used to store and retrieve arbitrary metadata. They are not queryable.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -844,7 +844,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterNetwork(ref common.Referenc Properties: map[string]spec.Schema{ "apiServerPort": { SchemaProps: spec.SchemaProps{ - Description: "APIServerPort specifies the port the API Server should bind to. Defaults to 6443.", + Description: "apiServerPort specifies the port the API Server should bind to. Defaults to 6443.", Type: []string{"integer"}, Format: "int32", }, @@ -885,7 +885,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterSpec(ref common.ReferenceCa Properties: map[string]spec.Schema{ "paused": { SchemaProps: spec.SchemaProps{ - Description: "Paused can be used to prevent controllers from processing the Cluster and all its associated objects.", + Description: "paused can be used to prevent controllers from processing the Cluster and all its associated objects.", Type: []string{"boolean"}, Format: "", }, @@ -898,20 +898,20 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterSpec(ref common.ReferenceCa }, "controlPlaneEndpoint": { SchemaProps: spec.SchemaProps{ - Description: "ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.", + Description: "controlPlaneEndpoint represents the endpoint used to communicate with the control plane.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.APIEndpoint"), }, }, "controlPlaneRef": { SchemaProps: spec.SchemaProps{ - Description: "ControlPlaneRef is an optional reference to a provider-specific resource that holds the details for provisioning the Control Plane for a Cluster.", + Description: "controlPlaneRef is an optional reference to a provider-specific resource that holds the details for provisioning the Control Plane for a Cluster.", Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, "infrastructureRef": { SchemaProps: spec.SchemaProps{ - Description: "InfrastructureRef is a reference to a provider-specific resource that holds the details for provisioning infrastructure for a cluster in said provider.", + Description: "infrastructureRef is a reference to a provider-specific resource that holds the details for provisioning infrastructure for a cluster in said provider.", Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, @@ -960,7 +960,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterStatus(ref common.Reference Properties: map[string]spec.Schema{ "failureDomains": { SchemaProps: spec.SchemaProps{ - Description: "FailureDomains is a slice of failure domain objects synced from the infrastructure provider.", + Description: "failureDomains is a slice of failure domain objects synced from the infrastructure provider.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -975,28 +975,28 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterStatus(ref common.Reference }, "failureReason": { SchemaProps: spec.SchemaProps{ - Description: "FailureReason indicates that there is a fatal problem reconciling the state, and will be set to a token value suitable for programmatic interpretation.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.", + Description: "failureReason indicates that there is a fatal problem reconciling the state, and will be set to a token value suitable for programmatic interpretation.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.", Type: []string{"string"}, Format: "", }, }, "failureMessage": { SchemaProps: spec.SchemaProps{ - Description: "FailureMessage indicates that there is a fatal problem reconciling the state, and will be set to a descriptive error message.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.", + Description: "failureMessage indicates that there is a fatal problem reconciling the state, and will be set to a descriptive error message.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.", Type: []string{"string"}, Format: "", }, }, "phase": { SchemaProps: spec.SchemaProps{ - Description: "Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.", + Description: "phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.", Type: []string{"string"}, Format: "", }, }, "infrastructureReady": { SchemaProps: spec.SchemaProps{ - Description: "InfrastructureReady is the state of the infrastructure provider.", + Description: "infrastructureReady is the state of the infrastructure provider.", Default: false, Type: []string{"boolean"}, Format: "", @@ -1004,7 +1004,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterStatus(ref common.Reference }, "controlPlaneReady": { SchemaProps: spec.SchemaProps{ - Description: "ControlPlaneReady denotes if the control plane became ready during initial provisioning to receive requests. NOTE: this field is part of the Cluster API contract and it is used to orchestrate provisioning. The value of this field is never updated after provisioning is completed. Please use conditions to check the operational state of the control plane.", + Description: "controlPlaneReady denotes if the control plane became ready during initial provisioning to receive requests. NOTE: this field is part of the Cluster API contract and it is used to orchestrate provisioning. The value of this field is never updated after provisioning is completed. Please use conditions to check the operational state of the control plane.", Default: false, Type: []string{"boolean"}, Format: "", @@ -1012,7 +1012,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterStatus(ref common.Reference }, "conditions": { SchemaProps: spec.SchemaProps{ - Description: "Conditions defines current service state of the cluster.", + Description: "conditions defines current service state of the cluster.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1026,7 +1026,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterStatus(ref common.Reference }, "observedGeneration": { SchemaProps: spec.SchemaProps{ - Description: "ObservedGeneration is the latest generation observed by the controller.", + Description: "observedGeneration is the latest generation observed by the controller.", Type: []string{"integer"}, Format: "int64", }, @@ -1103,7 +1103,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterVariable(ref common.Referen Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the variable.", + Description: "name of the variable.", Default: "", Type: []string{"string"}, Format: "", @@ -1111,14 +1111,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ClusterVariable(ref common.Referen }, "definitionFrom": { SchemaProps: spec.SchemaProps{ - Description: "DefinitionFrom specifies where the definition of this Variable is from.\n\nDeprecated: This field is deprecated, must not be set anymore and is going to be removed in the next apiVersion.", + Description: "definitionFrom specifies where the definition of this Variable is from.\n\nDeprecated: This field is deprecated, must not be set anymore and is going to be removed in the next apiVersion.", Type: []string{"string"}, Format: "", }, }, "value": { SchemaProps: spec.SchemaProps{ - Description: "Value of the variable. Note: the value will be validated against the schema of the corresponding ClusterClassVariable from the ClusterClass. Note: We have to use apiextensionsv1.JSON instead of a custom JSON type, because controller-tools has a hard-coded schema for apiextensionsv1.JSON which cannot be produced by another type via controller-tools, i.e. it is not possible to have no type field. Ref: https://github.com/kubernetes-sigs/controller-tools/blob/d0e03a142d0ecdd5491593e941ee1d6b5d91dba6/pkg/crd/known_types.go#L106-L111", + Description: "value of the variable. Note: the value will be validated against the schema of the corresponding ClusterClassVariable from the ClusterClass. Note: We have to use apiextensionsv1.JSON instead of a custom JSON type, because controller-tools has a hard-coded schema for apiextensionsv1.JSON which cannot be produced by another type via controller-tools, i.e. it is not possible to have no type field. Ref: https://github.com/kubernetes-sigs/controller-tools/blob/d0e03a142d0ecdd5491593e941ee1d6b5d91dba6/pkg/crd/known_types.go#L106-L111", Ref: ref("k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON"), }, }, @@ -1140,7 +1140,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_Condition(ref common.ReferenceCall Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "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.", + Description: "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.", Default: "", Type: []string{"string"}, Format: "", @@ -1148,7 +1148,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_Condition(ref common.ReferenceCall }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the condition, one of True, False, Unknown.", + Description: "status of the condition, one of True, False, Unknown.", Default: "", Type: []string{"string"}, Format: "", @@ -1156,7 +1156,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_Condition(ref common.ReferenceCall }, "severity": { SchemaProps: spec.SchemaProps{ - Description: "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.", + Description: "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.", Type: []string{"string"}, Format: "", }, @@ -1199,50 +1199,50 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ControlPlaneClass(ref common.Refer Properties: map[string]spec.Schema{ "metadata": { SchemaProps: spec.SchemaProps{ - Description: "Metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane if the ControlPlaneTemplate referenced is machine based. If not, it is applied only to the ControlPlane. At runtime this metadata is merged with the corresponding metadata from the topology.\n\nThis field is supported if and only if the control plane provider template referenced is Machine based.", + Description: "metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane if the ControlPlaneTemplate referenced is machine based. If not, it is applied only to the ControlPlane. At runtime this metadata is merged with the corresponding metadata from the topology.\n\nThis field is supported if and only if the control plane provider template referenced is Machine based.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ObjectMeta"), }, }, "ref": { SchemaProps: spec.SchemaProps{ - Description: "Ref is a required reference to a custom resource offered by a provider.", + Description: "ref is a required reference to a custom resource offered by a provider.", Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, "machineInfrastructure": { SchemaProps: spec.SchemaProps{ - Description: "MachineInfrastructure defines the metadata and infrastructure information for control plane machines.\n\nThis field is supported if and only if the control plane provider template referenced above is Machine based and supports setting replicas.", + Description: "machineInfrastructure defines the metadata and infrastructure information for control plane machines.\n\nThis field is supported if and only if the control plane provider template referenced above is Machine based and supports setting replicas.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.LocalObjectTemplate"), }, }, "machineHealthCheck": { SchemaProps: spec.SchemaProps{ - Description: "MachineHealthCheck defines a MachineHealthCheck for this ControlPlaneClass. This field is supported if and only if the ControlPlane provider template referenced above is Machine based and supports setting replicas.", + Description: "machineHealthCheck defines a MachineHealthCheck for this ControlPlaneClass. This field is supported if and only if the ControlPlane provider template referenced above is Machine based and supports setting replicas.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineHealthCheckClass"), }, }, "namingStrategy": { SchemaProps: spec.SchemaProps{ - Description: "NamingStrategy allows changing the naming pattern used when creating the control plane provider object.", + Description: "namingStrategy allows changing the naming pattern used when creating the control plane provider object.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ControlPlaneClassNamingStrategy"), }, }, "nodeDrainTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` NOTE: This value can be overridden while defining a Cluster.Topology.", + Description: "nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` NOTE: This value can be overridden while defining a Cluster.Topology.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeVolumeDetachTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. NOTE: This value can be overridden while defining a Cluster.Topology.", + Description: "nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. NOTE: This value can be overridden while defining a Cluster.Topology.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeDeletionTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. NOTE: This value can be overridden while defining a Cluster.Topology.", + Description: "nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. NOTE: This value can be overridden while defining a Cluster.Topology.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, @@ -1264,7 +1264,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ControlPlaneClassNamingStrategy(re Properties: map[string]spec.Schema{ "template": { SchemaProps: spec.SchemaProps{ - Description: "Template defines the template to use for generating the name of the ControlPlane object. If not defined, it will fallback to `{{ .cluster.name }}-{{ .random }}`. If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will get concatenated with a random suffix of length 5. The templating mechanism provides the following arguments: * `.cluster.name`: The name of the cluster object. * `.random`: A random alphanumeric string, without vowels, of length 5.", + Description: "template defines the template to use for generating the name of the ControlPlane object. If not defined, it will fallback to `{{ .cluster.name }}-{{ .random }}`. If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will get concatenated with a random suffix of length 5. The templating mechanism provides the following arguments: * `.cluster.name`: The name of the cluster object. * `.random`: A random alphanumeric string, without vowels, of length 5.", Type: []string{"string"}, Format: "", }, @@ -1284,45 +1284,45 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ControlPlaneTopology(ref common.Re Properties: map[string]spec.Schema{ "metadata": { SchemaProps: spec.SchemaProps{ - Description: "Metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane if the ControlPlaneTemplate referenced by the ClusterClass is machine based. If not, it is applied only to the ControlPlane. At runtime this metadata is merged with the corresponding metadata from the ClusterClass.", + Description: "metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane if the ControlPlaneTemplate referenced by the ClusterClass is machine based. If not, it is applied only to the ControlPlane. At runtime this metadata is merged with the corresponding metadata from the ClusterClass.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ObjectMeta"), }, }, "replicas": { SchemaProps: spec.SchemaProps{ - Description: "Replicas is the number of control plane nodes. If the value is nil, the ControlPlane object is created without the number of Replicas and it's assumed that the control plane controller does not implement support for this field. When specified against a control plane provider that lacks support for this field, this value will be ignored.", + Description: "replicas is the number of control plane nodes. If the value is nil, the ControlPlane object is created without the number of Replicas and it's assumed that the control plane controller does not implement support for this field. When specified against a control plane provider that lacks support for this field, this value will be ignored.", Type: []string{"integer"}, Format: "int32", }, }, "machineHealthCheck": { SchemaProps: spec.SchemaProps{ - Description: "MachineHealthCheck allows to enable, disable and override the MachineHealthCheck configuration in the ClusterClass for this control plane.", + Description: "machineHealthCheck allows to enable, disable and override the MachineHealthCheck configuration in the ClusterClass for this control plane.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineHealthCheckTopology"), }, }, "nodeDrainTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout`", + Description: "nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout`", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeVolumeDetachTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.", + Description: "nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeDeletionTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds.", + Description: "nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "variables": { SchemaProps: spec.SchemaProps{ - Description: "Variables can be used to customize the ControlPlane through patches.", + Description: "variables can be used to customize the ControlPlane through patches.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ControlPlaneVariables"), }, }, @@ -1351,7 +1351,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ControlPlaneVariables(ref common.R }, }, SchemaProps: spec.SchemaProps{ - Description: "Overrides can be used to override Cluster level variables.", + Description: "overrides can be used to override Cluster level variables.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1380,28 +1380,28 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ExternalPatchDefinition(ref common Properties: map[string]spec.Schema{ "generateExtension": { SchemaProps: spec.SchemaProps{ - Description: "GenerateExtension references an extension which is called to generate patches.", + Description: "generateExtension references an extension which is called to generate patches.", Type: []string{"string"}, Format: "", }, }, "validateExtension": { SchemaProps: spec.SchemaProps{ - Description: "ValidateExtension references an extension which is called to validate the topology.", + Description: "validateExtension references an extension which is called to validate the topology.", Type: []string{"string"}, Format: "", }, }, "discoverVariablesExtension": { SchemaProps: spec.SchemaProps{ - Description: "DiscoverVariablesExtension references an extension which is called to discover variables.", + Description: "discoverVariablesExtension references an extension which is called to discover variables.", Type: []string{"string"}, Format: "", }, }, "settings": { SchemaProps: spec.SchemaProps{ - Description: "Settings defines key value pairs to be passed to the extensions. Values defined here take precedence over the values defined in the corresponding ExtensionConfig.", + Description: "settings defines key value pairs to be passed to the extensions. Values defined here take precedence over the values defined in the corresponding ExtensionConfig.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -1430,14 +1430,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_FailureDomainSpec(ref common.Refer Properties: map[string]spec.Schema{ "controlPlane": { SchemaProps: spec.SchemaProps{ - Description: "ControlPlane determines if this failure domain is suitable for use by control plane machines.", + Description: "controlPlane determines if this failure domain is suitable for use by control plane machines.", Type: []string{"boolean"}, Format: "", }, }, "attributes": { SchemaProps: spec.SchemaProps{ - Description: "Attributes is a free form map of attributes an infrastructure provider might use or require.", + Description: "attributes is a free form map of attributes an infrastructure provider might use or require.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -1466,7 +1466,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONPatch(ref common.ReferenceCall Properties: map[string]spec.Schema{ "op": { SchemaProps: spec.SchemaProps{ - Description: "Op defines the operation of the patch. Note: Only `add`, `replace` and `remove` are supported.", + Description: "op defines the operation of the patch. Note: Only `add`, `replace` and `remove` are supported.", Default: "", Type: []string{"string"}, Format: "", @@ -1474,7 +1474,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONPatch(ref common.ReferenceCall }, "path": { SchemaProps: spec.SchemaProps{ - Description: "Path defines the path of the patch. Note: Only the spec of a template can be patched, thus the path has to start with /spec/. Note: For now the only allowed array modifications are `append` and `prepend`, i.e.: * for op: `add`: only index 0 (prepend) and - (append) are allowed * for op: `replace` or `remove`: no indexes are allowed", + Description: "path defines the path of the patch. Note: Only the spec of a template can be patched, thus the path has to start with /spec/. Note: For now the only allowed array modifications are `append` and `prepend`, i.e.: * for op: `add`: only index 0 (prepend) and - (append) are allowed * for op: `replace` or `remove`: no indexes are allowed", Default: "", Type: []string{"string"}, Format: "", @@ -1482,13 +1482,13 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONPatch(ref common.ReferenceCall }, "value": { SchemaProps: spec.SchemaProps{ - Description: "Value defines the value of the patch. Note: Either Value or ValueFrom is required for add and replace operations. Only one of them is allowed to be set at the same time. Note: We have to use apiextensionsv1.JSON instead of our JSON type, because controller-tools has a hard-coded schema for apiextensionsv1.JSON which cannot be produced by another type (unset type field). Ref: https://github.com/kubernetes-sigs/controller-tools/blob/d0e03a142d0ecdd5491593e941ee1d6b5d91dba6/pkg/crd/known_types.go#L106-L111", + Description: "value defines the value of the patch. Note: Either Value or ValueFrom is required for add and replace operations. Only one of them is allowed to be set at the same time. Note: We have to use apiextensionsv1.JSON instead of our JSON type, because controller-tools has a hard-coded schema for apiextensionsv1.JSON which cannot be produced by another type (unset type field). Ref: https://github.com/kubernetes-sigs/controller-tools/blob/d0e03a142d0ecdd5491593e941ee1d6b5d91dba6/pkg/crd/known_types.go#L106-L111", Ref: ref("k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON"), }, }, "valueFrom": { SchemaProps: spec.SchemaProps{ - Description: "ValueFrom defines the value of the patch. Note: Either Value or ValueFrom is required for add and replace operations. Only one of them is allowed to be set at the same time.", + Description: "valueFrom defines the value of the patch. Note: Either Value or ValueFrom is required for add and replace operations. Only one of them is allowed to be set at the same time.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.JSONPatchValue"), }, }, @@ -1510,14 +1510,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONPatchValue(ref common.Referenc Properties: map[string]spec.Schema{ "variable": { SchemaProps: spec.SchemaProps{ - Description: "Variable is the variable to be used as value. Variable can be one of the variables defined in .spec.variables or a builtin variable.", + Description: "variable is the variable to be used as value. Variable can be one of the variables defined in .spec.variables or a builtin variable.", Type: []string{"string"}, Format: "", }, }, "template": { SchemaProps: spec.SchemaProps{ - Description: "Template is the Go template to be used to calculate the value. A template can reference variables defined in .spec.variables and builtin variables. Note: The template must evaluate to a valid YAML or JSON value.", + Description: "template is the Go template to be used to calculate the value. A template can reference variables defined in .spec.variables and builtin variables. Note: The template must evaluate to a valid YAML or JSON value.", Type: []string{"string"}, Format: "", }, @@ -1537,27 +1537,27 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONSchemaProps(ref common.Referen Properties: map[string]spec.Schema{ "description": { SchemaProps: spec.SchemaProps{ - Description: "Description is a human-readable description of this variable.", + Description: "description is a human-readable description of this variable.", Type: []string{"string"}, Format: "", }, }, "example": { SchemaProps: spec.SchemaProps{ - Description: "Example is an example for this variable.", + Description: "example is an example for this variable.", Ref: ref("k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON"), }, }, "type": { SchemaProps: spec.SchemaProps{ - Description: "Type is the type of the variable. Valid values are: object, array, string, integer, number or boolean.", + Description: "type is the type of the variable. Valid values are: object, array, string, integer, number or boolean.", Type: []string{"string"}, Format: "", }, }, "properties": { SchemaProps: spec.SchemaProps{ - Description: "Properties specifies fields of an object. NOTE: Can only be set if type is object. NOTE: Properties is mutually exclusive with AdditionalProperties. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", + Description: "properties specifies fields of an object. NOTE: Can only be set if type is object. NOTE: Properties is mutually exclusive with AdditionalProperties. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -1572,27 +1572,27 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONSchemaProps(ref common.Referen }, "additionalProperties": { SchemaProps: spec.SchemaProps{ - Description: "AdditionalProperties specifies the schema of values in a map (keys are always strings). NOTE: Can only be set if type is object. NOTE: AdditionalProperties is mutually exclusive with Properties. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", + Description: "additionalProperties specifies the schema of values in a map (keys are always strings). NOTE: Can only be set if type is object. NOTE: AdditionalProperties is mutually exclusive with Properties. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.JSONSchemaProps"), }, }, "maxProperties": { SchemaProps: spec.SchemaProps{ - Description: "MaxProperties is the maximum amount of entries in a map or properties in an object. NOTE: Can only be set if type is object.", + Description: "maxProperties is the maximum amount of entries in a map or properties in an object. NOTE: Can only be set if type is object.", Type: []string{"integer"}, Format: "int64", }, }, "minProperties": { SchemaProps: spec.SchemaProps{ - Description: "MinProperties is the minimum amount of entries in a map or properties in an object. NOTE: Can only be set if type is object.", + Description: "minProperties is the minimum amount of entries in a map or properties in an object. NOTE: Can only be set if type is object.", Type: []string{"integer"}, Format: "int64", }, }, "required": { SchemaProps: spec.SchemaProps{ - Description: "Required specifies which fields of an object are required. NOTE: Can only be set if type is object.", + Description: "required specifies which fields of an object are required. NOTE: Can only be set if type is object.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1607,97 +1607,97 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONSchemaProps(ref common.Referen }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items specifies fields of an array. NOTE: Can only be set if type is array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", + Description: "items specifies fields of an array. NOTE: Can only be set if type is array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.JSONSchemaProps"), }, }, "maxItems": { SchemaProps: spec.SchemaProps{ - Description: "MaxItems is the max length of an array variable. NOTE: Can only be set if type is array.", + Description: "maxItems is the max length of an array variable. NOTE: Can only be set if type is array.", Type: []string{"integer"}, Format: "int64", }, }, "minItems": { SchemaProps: spec.SchemaProps{ - Description: "MinItems is the min length of an array variable. NOTE: Can only be set if type is array.", + Description: "minItems is the min length of an array variable. NOTE: Can only be set if type is array.", Type: []string{"integer"}, Format: "int64", }, }, "uniqueItems": { SchemaProps: spec.SchemaProps{ - Description: "UniqueItems specifies if items in an array must be unique. NOTE: Can only be set if type is array.", + Description: "uniqueItems specifies if items in an array must be unique. NOTE: Can only be set if type is array.", Type: []string{"boolean"}, Format: "", }, }, "format": { SchemaProps: spec.SchemaProps{ - Description: "Format is an OpenAPI v3 format string. Unknown formats are ignored. For a list of supported formats please see: (of the k8s.io/apiextensions-apiserver version we're currently using) https://github.com/kubernetes/apiextensions-apiserver/blob/master/pkg/apiserver/validation/formats.go NOTE: Can only be set if type is string.", + Description: "format is an OpenAPI v3 format string. Unknown formats are ignored. For a list of supported formats please see: (of the k8s.io/apiextensions-apiserver version we're currently using) https://github.com/kubernetes/apiextensions-apiserver/blob/master/pkg/apiserver/validation/formats.go NOTE: Can only be set if type is string.", Type: []string{"string"}, Format: "", }, }, "maxLength": { SchemaProps: spec.SchemaProps{ - Description: "MaxLength is the max length of a string variable. NOTE: Can only be set if type is string.", + Description: "maxLength is the max length of a string variable. NOTE: Can only be set if type is string.", Type: []string{"integer"}, Format: "int64", }, }, "minLength": { SchemaProps: spec.SchemaProps{ - Description: "MinLength is the min length of a string variable. NOTE: Can only be set if type is string.", + Description: "minLength is the min length of a string variable. NOTE: Can only be set if type is string.", Type: []string{"integer"}, Format: "int64", }, }, "pattern": { SchemaProps: spec.SchemaProps{ - Description: "Pattern is the regex which a string variable must match. NOTE: Can only be set if type is string.", + Description: "pattern is the regex which a string variable must match. NOTE: Can only be set if type is string.", Type: []string{"string"}, Format: "", }, }, "maximum": { SchemaProps: spec.SchemaProps{ - Description: "Maximum is the maximum of an integer or number variable. If ExclusiveMaximum is false, the variable is valid if it is lower than, or equal to, the value of Maximum. If ExclusiveMaximum is true, the variable is valid if it is strictly lower than the value of Maximum. NOTE: Can only be set if type is integer or number.", + Description: "maximum is the maximum of an integer or number variable. If ExclusiveMaximum is false, the variable is valid if it is lower than, or equal to, the value of Maximum. If ExclusiveMaximum is true, the variable is valid if it is strictly lower than the value of Maximum. NOTE: Can only be set if type is integer or number.", Type: []string{"integer"}, Format: "int64", }, }, "exclusiveMaximum": { SchemaProps: spec.SchemaProps{ - Description: "ExclusiveMaximum specifies if the Maximum is exclusive. NOTE: Can only be set if type is integer or number.", + Description: "exclusiveMaximum specifies if the Maximum is exclusive. NOTE: Can only be set if type is integer or number.", Type: []string{"boolean"}, Format: "", }, }, "minimum": { SchemaProps: spec.SchemaProps{ - Description: "Minimum is the minimum of an integer or number variable. If ExclusiveMinimum is false, the variable is valid if it is greater than, or equal to, the value of Minimum. If ExclusiveMinimum is true, the variable is valid if it is strictly greater than the value of Minimum. NOTE: Can only be set if type is integer or number.", + Description: "minimum is the minimum of an integer or number variable. If ExclusiveMinimum is false, the variable is valid if it is greater than, or equal to, the value of Minimum. If ExclusiveMinimum is true, the variable is valid if it is strictly greater than the value of Minimum. NOTE: Can only be set if type is integer or number.", Type: []string{"integer"}, Format: "int64", }, }, "exclusiveMinimum": { SchemaProps: spec.SchemaProps{ - Description: "ExclusiveMinimum specifies if the Minimum is exclusive. NOTE: Can only be set if type is integer or number.", + Description: "exclusiveMinimum specifies if the Minimum is exclusive. NOTE: Can only be set if type is integer or number.", Type: []string{"boolean"}, Format: "", }, }, "x-kubernetes-preserve-unknown-fields": { SchemaProps: spec.SchemaProps{ - Description: "XPreserveUnknownFields allows setting fields in a variable object which are not defined in the variable schema. This affects fields recursively, except if nested properties or additionalProperties are specified in the schema.", + Description: "x-kubernetes-preserve-unknown-fields allows setting fields in a variable object which are not defined in the variable schema. This affects fields recursively, except if nested properties or additionalProperties are specified in the schema.", Type: []string{"boolean"}, Format: "", }, }, "enum": { SchemaProps: spec.SchemaProps{ - Description: "Enum is the list of valid values of the variable. NOTE: Can be set for all types.", + Description: "enum is the list of valid values of the variable. NOTE: Can be set for all types.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1710,7 +1710,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONSchemaProps(ref common.Referen }, "default": { SchemaProps: spec.SchemaProps{ - Description: "Default is the default value of the variable. NOTE: Can be set for all types.", + Description: "default is the default value of the variable. NOTE: Can be set for all types.", Ref: ref("k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON"), }, }, @@ -1724,7 +1724,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONSchemaProps(ref common.Referen }, }, SchemaProps: spec.SchemaProps{ - Description: "XValidations describes a list of validation rules written in the CEL expression language.", + Description: "x-kubernetes-validations describes a list of validation rules written in the CEL expression language.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1738,7 +1738,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONSchemaProps(ref common.Referen }, "x-metadata": { SchemaProps: spec.SchemaProps{ - Description: "XMetadata is the metadata of a variable or a nested field within a variable. It can be used to add additional data for higher level tools.", + Description: "x-metadata is the metadata of a variable or a nested field within a variable. It can be used to add additional data for higher level tools.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.VariableSchemaMetadata"), }, }, @@ -1751,7 +1751,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONSchemaProps(ref common.Referen }, "allOf": { SchemaProps: spec.SchemaProps{ - Description: "AllOf specifies that the variable must validate against all of the subschemas in the array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", + Description: "allOf specifies that the variable must validate against all of the subschemas in the array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1765,7 +1765,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONSchemaProps(ref common.Referen }, "oneOf": { SchemaProps: spec.SchemaProps{ - Description: "OneOf specifies that the variable must validate against exactly one of the subschemas in the array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", + Description: "oneOf specifies that the variable must validate against exactly one of the subschemas in the array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1779,7 +1779,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONSchemaProps(ref common.Referen }, "anyOf": { SchemaProps: spec.SchemaProps{ - Description: "AnyOf specifies that the variable must validate against one or more of the subschemas in the array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", + Description: "anyOf specifies that the variable must validate against one or more of the subschemas in the array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1793,7 +1793,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_JSONSchemaProps(ref common.Referen }, "not": { SchemaProps: spec.SchemaProps{ - Description: "Not specifies that the variable must not validate against the subschema. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", + Description: "not specifies that the variable must not validate against the subschema. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.JSONSchemaProps"), }, }, @@ -1814,7 +1814,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_LocalObjectTemplate(ref common.Ref Properties: map[string]spec.Schema{ "ref": { SchemaProps: spec.SchemaProps{ - Description: "Ref is a required reference to a custom resource offered by a provider.", + Description: "ref is a required reference to a custom resource offered by a provider.", Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, @@ -1987,7 +1987,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentClass(ref common. Properties: map[string]spec.Schema{ "class": { SchemaProps: spec.SchemaProps{ - Description: "Class denotes a type of worker node present in the cluster, this name MUST be unique within a ClusterClass and can be referenced in the Cluster to create a managed MachineDeployment.", + Description: "class denotes a type of worker node present in the cluster, this name MUST be unique within a ClusterClass and can be referenced in the Cluster to create a managed MachineDeployment.", Default: "", Type: []string{"string"}, Format: "", @@ -1995,45 +1995,45 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentClass(ref common. }, "template": { SchemaProps: spec.SchemaProps{ - Description: "Template is a local struct containing a collection of templates for creation of MachineDeployment objects representing a set of worker nodes.", + Description: "template is a local struct containing a collection of templates for creation of MachineDeployment objects representing a set of worker nodes.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineDeploymentClassTemplate"), }, }, "machineHealthCheck": { SchemaProps: spec.SchemaProps{ - Description: "MachineHealthCheck defines a MachineHealthCheck for this MachineDeploymentClass.", + Description: "machineHealthCheck defines a MachineHealthCheck for this MachineDeploymentClass.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineHealthCheckClass"), }, }, "failureDomain": { SchemaProps: spec.SchemaProps{ - Description: "FailureDomain is the failure domain the machines will be created in. Must match a key in the FailureDomains map stored on the cluster object. NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.", + Description: "failureDomain is the failure domain the machines will be created in. Must match a key in the FailureDomains map stored on the cluster object. NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.", Type: []string{"string"}, Format: "", }, }, "namingStrategy": { SchemaProps: spec.SchemaProps{ - Description: "NamingStrategy allows changing the naming pattern used when creating the MachineDeployment.", + Description: "namingStrategy allows changing the naming pattern used when creating the MachineDeployment.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineDeploymentClassNamingStrategy"), }, }, "nodeDrainTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.", + Description: "nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeVolumeDetachTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.", + Description: "nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeDeletionTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.", + Description: "nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, @@ -2068,7 +2068,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentClassNamingStrate Properties: map[string]spec.Schema{ "template": { SchemaProps: spec.SchemaProps{ - Description: "Template defines the template to use for generating the name of the MachineDeployment object. If not defined, it will fallback to `{{ .cluster.name }}-{{ .machineDeployment.topologyName }}-{{ .random }}`. If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will get concatenated with a random suffix of length 5. The templating mechanism provides the following arguments: * `.cluster.name`: The name of the cluster object. * `.random`: A random alphanumeric string, without vowels, of length 5. * `.machineDeployment.topologyName`: The name of the MachineDeployment topology (Cluster.spec.topology.workers.machineDeployments[].name).", + Description: "template defines the template to use for generating the name of the MachineDeployment object. If not defined, it will fallback to `{{ .cluster.name }}-{{ .machineDeployment.topologyName }}-{{ .random }}`. If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will get concatenated with a random suffix of length 5. The templating mechanism provides the following arguments: * `.cluster.name`: The name of the cluster object. * `.random`: A random alphanumeric string, without vowels, of length 5. * `.machineDeployment.topologyName`: The name of the MachineDeployment topology (Cluster.spec.topology.workers.machineDeployments[].name).", Type: []string{"string"}, Format: "", }, @@ -2088,21 +2088,21 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentClassTemplate(ref Properties: map[string]spec.Schema{ "metadata": { SchemaProps: spec.SchemaProps{ - Description: "Metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment. At runtime this metadata is merged with the corresponding metadata from the topology.", + Description: "metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment. At runtime this metadata is merged with the corresponding metadata from the topology.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ObjectMeta"), }, }, "bootstrap": { SchemaProps: spec.SchemaProps{ - Description: "Bootstrap contains the bootstrap template reference to be used for the creation of worker Machines.", + Description: "bootstrap contains the bootstrap template reference to be used for the creation of worker Machines.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.LocalObjectTemplate"), }, }, "infrastructure": { SchemaProps: spec.SchemaProps{ - Description: "Infrastructure contains the infrastructure template reference to be used for the creation of worker Machines.", + Description: "infrastructure contains the infrastructure template reference to be used for the creation of worker Machines.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.LocalObjectTemplate"), }, @@ -2174,7 +2174,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentSpec(ref common.R Properties: map[string]spec.Schema{ "clusterName": { SchemaProps: spec.SchemaProps{ - Description: "ClusterName is the name of the Cluster this object belongs to.", + Description: "clusterName is the name of the Cluster this object belongs to.", Default: "", Type: []string{"string"}, Format: "", @@ -2189,7 +2189,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentSpec(ref common.R }, "rolloutAfter": { SchemaProps: spec.SchemaProps{ - Description: "RolloutAfter is a field to indicate a rollout should be performed after the specified time even if no changes have been made to the MachineDeployment. Example: In the YAML the time can be specified in the RFC3339 format. To specify the rolloutAfter target as March 9, 2023, at 9 am UTC use \"2023-03-09T09:00:00Z\".", + Description: "rolloutAfter is a field to indicate a rollout should be performed after the specified time even if no changes have been made to the MachineDeployment. Example: In the YAML the time can be specified in the RFC3339 format. To specify the rolloutAfter target as March 9, 2023, at 9 am UTC use \"2023-03-09T09:00:00Z\".", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), }, }, @@ -2202,7 +2202,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentSpec(ref common.R }, "template": { SchemaProps: spec.SchemaProps{ - Description: "Template describes the machines that will be created.", + Description: "template describes the machines that will be created.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineTemplateSpec"), }, @@ -2215,7 +2215,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentSpec(ref common.R }, "minReadySeconds": { SchemaProps: spec.SchemaProps{ - Description: "MinReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. Defaults to 0 (machine will be considered available as soon as the Node is ready)", + Description: "minReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. Defaults to 0 (machine will be considered available as soon as the Node is ready)", Type: []string{"integer"}, Format: "int32", }, @@ -2266,7 +2266,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentStatus(ref common }, "selector": { SchemaProps: spec.SchemaProps{ - Description: "Selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors", + Description: "selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors", Type: []string{"string"}, Format: "", }, @@ -2313,14 +2313,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentStatus(ref common }, "phase": { SchemaProps: spec.SchemaProps{ - Description: "Phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown).", + Description: "phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown).", Type: []string{"string"}, Format: "", }, }, "conditions": { SchemaProps: spec.SchemaProps{ - Description: "Conditions defines current service state of the MachineDeployment.", + Description: "conditions defines current service state of the MachineDeployment.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2355,7 +2355,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentStrategy(ref comm Properties: map[string]spec.Schema{ "type": { SchemaProps: spec.SchemaProps{ - Description: "Type of deployment. Allowed values are RollingUpdate and OnDelete. The default is RollingUpdate.", + Description: "type of deployment. Allowed values are RollingUpdate and OnDelete. The default is RollingUpdate.", Type: []string{"string"}, Format: "", }, @@ -2368,7 +2368,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentStrategy(ref comm }, "remediation": { SchemaProps: spec.SchemaProps{ - Description: "Remediation controls the strategy of remediating unhealthy machines and how remediating operations should occur during the lifecycle of the dependant MachineSets.", + Description: "remediation controls the strategy of remediating unhealthy machines and how remediating operations should occur during the lifecycle of the dependant MachineSets.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.RemediationStrategy"), }, }, @@ -2389,14 +2389,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentTopology(ref comm Properties: map[string]spec.Schema{ "metadata": { SchemaProps: spec.SchemaProps{ - Description: "Metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment. At runtime this metadata is merged with the corresponding metadata from the ClusterClass.", + Description: "metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment. At runtime this metadata is merged with the corresponding metadata from the ClusterClass.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ObjectMeta"), }, }, "class": { SchemaProps: spec.SchemaProps{ - Description: "Class is the name of the MachineDeploymentClass used to create the set of worker nodes. This should match one of the deployment classes defined in the ClusterClass object mentioned in the `Cluster.Spec.Class` field.", + Description: "class is the name of the MachineDeploymentClass used to create the set of worker nodes. This should match one of the deployment classes defined in the ClusterClass object mentioned in the `Cluster.Spec.Class` field.", Default: "", Type: []string{"string"}, Format: "", @@ -2404,7 +2404,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentTopology(ref comm }, "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the unique identifier for this MachineDeploymentTopology. The value is used with other unique identifiers to create a MachineDeployment's Name (e.g. cluster's name, etc). In case the name is greater than the allowed maximum length, the values are hashed together.", + Description: "name is the unique identifier for this MachineDeploymentTopology. The value is used with other unique identifiers to create a MachineDeployment's Name (e.g. cluster's name, etc). In case the name is greater than the allowed maximum length, the values are hashed together.", Default: "", Type: []string{"string"}, Format: "", @@ -2412,39 +2412,39 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentTopology(ref comm }, "failureDomain": { SchemaProps: spec.SchemaProps{ - Description: "FailureDomain is the failure domain the machines will be created in. Must match a key in the FailureDomains map stored on the cluster object.", + Description: "failureDomain is the failure domain the machines will be created in. Must match a key in the FailureDomains map stored on the cluster object.", Type: []string{"string"}, Format: "", }, }, "replicas": { SchemaProps: spec.SchemaProps{ - Description: "Replicas is the number of worker nodes belonging to this set. If the value is nil, the MachineDeployment is created without the number of Replicas (defaulting to 1) and it's assumed that an external entity (like cluster autoscaler) is responsible for the management of this value.", + Description: "replicas is the number of worker nodes belonging to this set. If the value is nil, the MachineDeployment is created without the number of Replicas (defaulting to 1) and it's assumed that an external entity (like cluster autoscaler) is responsible for the management of this value.", Type: []string{"integer"}, Format: "int32", }, }, "machineHealthCheck": { SchemaProps: spec.SchemaProps{ - Description: "MachineHealthCheck allows to enable, disable and override the MachineHealthCheck configuration in the ClusterClass for this MachineDeployment.", + Description: "machineHealthCheck allows to enable, disable and override the MachineHealthCheck configuration in the ClusterClass for this MachineDeployment.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineHealthCheckTopology"), }, }, "nodeDrainTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout`", + Description: "nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout`", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeVolumeDetachTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.", + Description: "nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeDeletionTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds.", + Description: "nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, @@ -2463,7 +2463,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentTopology(ref comm }, "variables": { SchemaProps: spec.SchemaProps{ - Description: "Variables can be used to customize the MachineDeployment through patches.", + Description: "variables can be used to customize the MachineDeployment through patches.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineDeploymentVariables"), }, }, @@ -2551,7 +2551,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineDeploymentVariables(ref com }, }, SchemaProps: spec.SchemaProps{ - Description: "Overrides can be used to override Cluster level variables.", + Description: "overrides can be used to override Cluster level variables.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2629,7 +2629,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineHealthCheckClass(ref common Properties: map[string]spec.Schema{ "unhealthyConditions": { SchemaProps: spec.SchemaProps{ - Description: "UnhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.", + Description: "unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2656,13 +2656,13 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineHealthCheckClass(ref common }, "nodeStartupTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeStartupTimeout allows to set the maximum time for MachineHealthCheck to consider a Machine unhealthy if a corresponding Node isn't associated through a `Spec.ProviderID` field.\n\nThe duration set in this field is compared to the greatest of: - Cluster's infrastructure ready condition timestamp (if and when available) - Control Plane's initialized condition timestamp (if and when available) - Machine's infrastructure ready condition timestamp (if and when available) - Machine's metadata creation timestamp\n\nDefaults to 10 minutes. If you wish to disable this feature, set the value explicitly to 0.", + Description: "nodeStartupTimeout allows to set the maximum time for MachineHealthCheck to consider a Machine unhealthy if a corresponding Node isn't associated through a `Spec.ProviderID` field.\n\nThe duration set in this field is compared to the greatest of: - Cluster's infrastructure ready condition timestamp (if and when available) - Control Plane's initialized condition timestamp (if and when available) - Machine's infrastructure ready condition timestamp (if and when available) - Machine's metadata creation timestamp\n\nDefaults to 10 minutes. If you wish to disable this feature, set the value explicitly to 0.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "remediationTemplate": { SchemaProps: spec.SchemaProps{ - Description: "RemediationTemplate is a reference to a remediation template provided by an infrastructure provider.\n\nThis field is completely optional, when filled, the MachineHealthCheck controller creates a new object from the template referenced and hands off remediation of the machine to a controller that lives outside of Cluster API.", + Description: "remediationTemplate is a reference to a remediation template provided by an infrastructure provider.\n\nThis field is completely optional, when filled, the MachineHealthCheck controller creates a new object from the template referenced and hands off remediation of the machine to a controller that lives outside of Cluster API.", Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, @@ -2732,7 +2732,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineHealthCheckSpec(ref common. Properties: map[string]spec.Schema{ "clusterName": { SchemaProps: spec.SchemaProps{ - Description: "ClusterName is the name of the Cluster this object belongs to.", + Description: "clusterName is the name of the Cluster this object belongs to.", Default: "", Type: []string{"string"}, Format: "", @@ -2747,7 +2747,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineHealthCheckSpec(ref common. }, "unhealthyConditions": { SchemaProps: spec.SchemaProps{ - Description: "UnhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.", + Description: "unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2774,13 +2774,13 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineHealthCheckSpec(ref common. }, "nodeStartupTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeStartupTimeout allows to set the maximum time for MachineHealthCheck to consider a Machine unhealthy if a corresponding Node isn't associated through a `Spec.ProviderID` field.\n\nThe duration set in this field is compared to the greatest of: - Cluster's infrastructure ready condition timestamp (if and when available) - Control Plane's initialized condition timestamp (if and when available) - Machine's infrastructure ready condition timestamp (if and when available) - Machine's metadata creation timestamp\n\nDefaults to 10 minutes. If you wish to disable this feature, set the value explicitly to 0.", + Description: "nodeStartupTimeout allows to set the maximum time for MachineHealthCheck to consider a Machine unhealthy if a corresponding Node isn't associated through a `Spec.ProviderID` field.\n\nThe duration set in this field is compared to the greatest of: - Cluster's infrastructure ready condition timestamp (if and when available) - Control Plane's initialized condition timestamp (if and when available) - Machine's infrastructure ready condition timestamp (if and when available) - Machine's metadata creation timestamp\n\nDefaults to 10 minutes. If you wish to disable this feature, set the value explicitly to 0.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "remediationTemplate": { SchemaProps: spec.SchemaProps{ - Description: "RemediationTemplate is a reference to a remediation template provided by an infrastructure provider.\n\nThis field is completely optional, when filled, the MachineHealthCheck controller creates a new object from the template referenced and hands off remediation of the machine to a controller that lives outside of Cluster API.", + Description: "remediationTemplate is a reference to a remediation template provided by an infrastructure provider.\n\nThis field is completely optional, when filled, the MachineHealthCheck controller creates a new object from the template referenced and hands off remediation of the machine to a controller that lives outside of Cluster API.", Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, @@ -2818,7 +2818,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineHealthCheckStatus(ref commo }, "remediationsAllowed": { SchemaProps: spec.SchemaProps{ - Description: "RemediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied", + Description: "remediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -2826,14 +2826,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineHealthCheckStatus(ref commo }, "observedGeneration": { SchemaProps: spec.SchemaProps{ - Description: "ObservedGeneration is the latest generation observed by the controller.", + Description: "observedGeneration is the latest generation observed by the controller.", Type: []string{"integer"}, Format: "int64", }, }, "targets": { SchemaProps: spec.SchemaProps{ - Description: "Targets shows the current list of machines the machine health check is watching", + Description: "targets shows the current list of machines the machine health check is watching", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2848,7 +2848,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineHealthCheckStatus(ref commo }, "conditions": { SchemaProps: spec.SchemaProps{ - Description: "Conditions defines current service state of the MachineHealthCheck.", + Description: "conditions defines current service state of the MachineHealthCheck.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2883,14 +2883,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineHealthCheckTopology(ref com Properties: map[string]spec.Schema{ "enable": { SchemaProps: spec.SchemaProps{ - Description: "Enable controls if a MachineHealthCheck should be created for the target machines.\n\nIf false: No MachineHealthCheck will be created.\n\nIf not set(default): A MachineHealthCheck will be created if it is defined here or\n in the associated ClusterClass. If no MachineHealthCheck is defined then none will be created.\n\nIf true: A MachineHealthCheck is guaranteed to be created. Cluster validation will block if `enable` is true and no MachineHealthCheck definition is available.", + Description: "enable controls if a MachineHealthCheck should be created for the target machines.\n\nIf false: No MachineHealthCheck will be created.\n\nIf not set(default): A MachineHealthCheck will be created if it is defined here or\n in the associated ClusterClass. If no MachineHealthCheck is defined then none will be created.\n\nIf true: A MachineHealthCheck is guaranteed to be created. Cluster validation will block if `enable` is true and no MachineHealthCheck definition is available.", Type: []string{"boolean"}, Format: "", }, }, "unhealthyConditions": { SchemaProps: spec.SchemaProps{ - Description: "UnhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.", + Description: "unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -2917,13 +2917,13 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineHealthCheckTopology(ref com }, "nodeStartupTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeStartupTimeout allows to set the maximum time for MachineHealthCheck to consider a Machine unhealthy if a corresponding Node isn't associated through a `Spec.ProviderID` field.\n\nThe duration set in this field is compared to the greatest of: - Cluster's infrastructure ready condition timestamp (if and when available) - Control Plane's initialized condition timestamp (if and when available) - Machine's infrastructure ready condition timestamp (if and when available) - Machine's metadata creation timestamp\n\nDefaults to 10 minutes. If you wish to disable this feature, set the value explicitly to 0.", + Description: "nodeStartupTimeout allows to set the maximum time for MachineHealthCheck to consider a Machine unhealthy if a corresponding Node isn't associated through a `Spec.ProviderID` field.\n\nThe duration set in this field is compared to the greatest of: - Cluster's infrastructure ready condition timestamp (if and when available) - Control Plane's initialized condition timestamp (if and when available) - Machine's infrastructure ready condition timestamp (if and when available) - Machine's metadata creation timestamp\n\nDefaults to 10 minutes. If you wish to disable this feature, set the value explicitly to 0.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "remediationTemplate": { SchemaProps: spec.SchemaProps{ - Description: "RemediationTemplate is a reference to a remediation template provided by an infrastructure provider.\n\nThis field is completely optional, when filled, the MachineHealthCheck controller creates a new object from the template referenced and hands off remediation of the machine to a controller that lives outside of Cluster API.", + Description: "remediationTemplate is a reference to a remediation template provided by an infrastructure provider.\n\nThis field is completely optional, when filled, the MachineHealthCheck controller creates a new object from the template referenced and hands off remediation of the machine to a controller that lives outside of Cluster API.", Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, @@ -3030,7 +3030,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachinePoolClass(ref common.Refere Properties: map[string]spec.Schema{ "class": { SchemaProps: spec.SchemaProps{ - Description: "Class denotes a type of machine pool present in the cluster, this name MUST be unique within a ClusterClass and can be referenced in the Cluster to create a managed MachinePool.", + Description: "class denotes a type of machine pool present in the cluster, this name MUST be unique within a ClusterClass and can be referenced in the Cluster to create a managed MachinePool.", Default: "", Type: []string{"string"}, Format: "", @@ -3038,14 +3038,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachinePoolClass(ref common.Refere }, "template": { SchemaProps: spec.SchemaProps{ - Description: "Template is a local struct containing a collection of templates for creation of MachinePools objects representing a pool of worker nodes.", + Description: "template is a local struct containing a collection of templates for creation of MachinePools objects representing a pool of worker nodes.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachinePoolClassTemplate"), }, }, "failureDomains": { SchemaProps: spec.SchemaProps{ - Description: "FailureDomains is the list of failure domains the MachinePool should be attached to. Must match a key in the FailureDomains map stored on the cluster object. NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass.", + Description: "failureDomains is the list of failure domains the MachinePool should be attached to. Must match a key in the FailureDomains map stored on the cluster object. NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3060,25 +3060,25 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachinePoolClass(ref common.Refere }, "namingStrategy": { SchemaProps: spec.SchemaProps{ - Description: "NamingStrategy allows changing the naming pattern used when creating the MachinePool.", + Description: "namingStrategy allows changing the naming pattern used when creating the MachinePool.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachinePoolClassNamingStrategy"), }, }, "nodeDrainTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass.", + Description: "nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeVolumeDetachTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass.", + Description: "nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeDeletionTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine Pool is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass.", + Description: "nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine Pool is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, @@ -3107,7 +3107,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachinePoolClassNamingStrategy(ref Properties: map[string]spec.Schema{ "template": { SchemaProps: spec.SchemaProps{ - Description: "Template defines the template to use for generating the name of the MachinePool object. If not defined, it will fallback to `{{ .cluster.name }}-{{ .machinePool.topologyName }}-{{ .random }}`. If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will get concatenated with a random suffix of length 5. The templating mechanism provides the following arguments: * `.cluster.name`: The name of the cluster object. * `.random`: A random alphanumeric string, without vowels, of length 5. * `.machinePool.topologyName`: The name of the MachinePool topology (Cluster.spec.topology.workers.machinePools[].name).", + Description: "template defines the template to use for generating the name of the MachinePool object. If not defined, it will fallback to `{{ .cluster.name }}-{{ .machinePool.topologyName }}-{{ .random }}`. If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will get concatenated with a random suffix of length 5. The templating mechanism provides the following arguments: * `.cluster.name`: The name of the cluster object. * `.random`: A random alphanumeric string, without vowels, of length 5. * `.machinePool.topologyName`: The name of the MachinePool topology (Cluster.spec.topology.workers.machinePools[].name).", Type: []string{"string"}, Format: "", }, @@ -3127,21 +3127,21 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachinePoolClassTemplate(ref commo Properties: map[string]spec.Schema{ "metadata": { SchemaProps: spec.SchemaProps{ - Description: "Metadata is the metadata applied to the MachinePool. At runtime this metadata is merged with the corresponding metadata from the topology.", + Description: "metadata is the metadata applied to the MachinePool. At runtime this metadata is merged with the corresponding metadata from the topology.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ObjectMeta"), }, }, "bootstrap": { SchemaProps: spec.SchemaProps{ - Description: "Bootstrap contains the bootstrap template reference to be used for the creation of the Machines in the MachinePool.", + Description: "bootstrap contains the bootstrap template reference to be used for the creation of the Machines in the MachinePool.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.LocalObjectTemplate"), }, }, "infrastructure": { SchemaProps: spec.SchemaProps{ - Description: "Infrastructure contains the infrastructure template reference to be used for the creation of the MachinePool.", + Description: "infrastructure contains the infrastructure template reference to be used for the creation of the MachinePool.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.LocalObjectTemplate"), }, @@ -3164,14 +3164,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachinePoolTopology(ref common.Ref Properties: map[string]spec.Schema{ "metadata": { SchemaProps: spec.SchemaProps{ - Description: "Metadata is the metadata applied to the MachinePool. At runtime this metadata is merged with the corresponding metadata from the ClusterClass.", + Description: "metadata is the metadata applied to the MachinePool. At runtime this metadata is merged with the corresponding metadata from the ClusterClass.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ObjectMeta"), }, }, "class": { SchemaProps: spec.SchemaProps{ - Description: "Class is the name of the MachinePoolClass used to create the pool of worker nodes. This should match one of the deployment classes defined in the ClusterClass object mentioned in the `Cluster.Spec.Class` field.", + Description: "class is the name of the MachinePoolClass used to create the pool of worker nodes. This should match one of the deployment classes defined in the ClusterClass object mentioned in the `Cluster.Spec.Class` field.", Default: "", Type: []string{"string"}, Format: "", @@ -3179,7 +3179,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachinePoolTopology(ref common.Ref }, "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the unique identifier for this MachinePoolTopology. The value is used with other unique identifiers to create a MachinePool's Name (e.g. cluster's name, etc). In case the name is greater than the allowed maximum length, the values are hashed together.", + Description: "name is the unique identifier for this MachinePoolTopology. The value is used with other unique identifiers to create a MachinePool's Name (e.g. cluster's name, etc). In case the name is greater than the allowed maximum length, the values are hashed together.", Default: "", Type: []string{"string"}, Format: "", @@ -3187,7 +3187,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachinePoolTopology(ref common.Ref }, "failureDomains": { SchemaProps: spec.SchemaProps{ - Description: "FailureDomains is the list of failure domains the machine pool will be created in. Must match a key in the FailureDomains map stored on the cluster object.", + Description: "failureDomains is the list of failure domains the machine pool will be created in. Must match a key in the FailureDomains map stored on the cluster object.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3202,19 +3202,19 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachinePoolTopology(ref common.Ref }, "nodeDrainTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout`", + Description: "nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout`", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeVolumeDetachTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.", + Description: "nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeDeletionTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the MachinePool hosts after the MachinePool is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds.", + Description: "nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the MachinePool hosts after the MachinePool is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, @@ -3227,14 +3227,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachinePoolTopology(ref common.Ref }, "replicas": { SchemaProps: spec.SchemaProps{ - Description: "Replicas is the number of nodes belonging to this pool. If the value is nil, the MachinePool is created without the number of Replicas (defaulting to 1) and it's assumed that an external entity (like cluster autoscaler) is responsible for the management of this value.", + Description: "replicas is the number of nodes belonging to this pool. If the value is nil, the MachinePool is created without the number of Replicas (defaulting to 1) and it's assumed that an external entity (like cluster autoscaler) is responsible for the management of this value.", Type: []string{"integer"}, Format: "int32", }, }, "variables": { SchemaProps: spec.SchemaProps{ - Description: "Variables can be used to customize the MachinePool through patches.", + Description: "variables can be used to customize the MachinePool through patches.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachinePoolVariables"), }, }, @@ -3264,7 +3264,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachinePoolVariables(ref common.Re }, }, SchemaProps: spec.SchemaProps{ - Description: "Overrides can be used to override Cluster level variables.", + Description: "overrides can be used to override Cluster level variables.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3327,7 +3327,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineRollingUpdateDeployment(ref }, "deletePolicy": { SchemaProps: spec.SchemaProps{ - Description: "DeletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. Valid values are \"Random, \"Newest\", \"Oldest\" When no value is supplied, the default DeletePolicy of MachineSet is used", + Description: "deletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. Valid values are \"Random, \"Newest\", \"Oldest\" When no value is supplied, the default DeletePolicy of MachineSet is used", Type: []string{"string"}, Format: "", }, @@ -3445,7 +3445,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineSetSpec(ref common.Referenc Properties: map[string]spec.Schema{ "clusterName": { SchemaProps: spec.SchemaProps{ - Description: "ClusterName is the name of the Cluster this object belongs to.", + Description: "clusterName is the name of the Cluster this object belongs to.", Default: "", Type: []string{"string"}, Format: "", @@ -3453,35 +3453,35 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineSetSpec(ref common.Referenc }, "replicas": { SchemaProps: spec.SchemaProps{ - Description: "Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified.\n\nDefaults to: * if the Kubernetes autoscaler min size and max size annotations are set:\n - if it's a new MachineSet, use min size\n - if the replicas field of the old MachineSet is < min size, use min size\n - if the replicas field of the old MachineSet is > max size, use max size\n - if the replicas field of the old MachineSet is in the (min size, max size) range, keep the value from the oldMS\n* otherwise use 1 Note: Defaulting will be run whenever the replicas field is not set: * A new MachineSet is created with replicas not set. * On an existing MachineSet the replicas field was first set and is now unset. Those cases are especially relevant for the following Kubernetes autoscaler use cases: * A new MachineSet is created and replicas should be managed by the autoscaler * An existing MachineSet which initially wasn't controlled by the autoscaler\n should be later controlled by the autoscaler", + Description: "replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified.\n\nDefaults to: * if the Kubernetes autoscaler min size and max size annotations are set:\n - if it's a new MachineSet, use min size\n - if the replicas field of the old MachineSet is < min size, use min size\n - if the replicas field of the old MachineSet is > max size, use max size\n - if the replicas field of the old MachineSet is in the (min size, max size) range, keep the value from the oldMS\n* otherwise use 1 Note: Defaulting will be run whenever the replicas field is not set: * A new MachineSet is created with replicas not set. * On an existing MachineSet the replicas field was first set and is now unset. Those cases are especially relevant for the following Kubernetes autoscaler use cases: * A new MachineSet is created and replicas should be managed by the autoscaler * An existing MachineSet which initially wasn't controlled by the autoscaler\n should be later controlled by the autoscaler", Type: []string{"integer"}, Format: "int32", }, }, "minReadySeconds": { SchemaProps: spec.SchemaProps{ - Description: "MinReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. Defaults to 0 (machine will be considered available as soon as the Node is ready)", + Description: "minReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. Defaults to 0 (machine will be considered available as soon as the Node is ready)", Type: []string{"integer"}, Format: "int32", }, }, "deletePolicy": { SchemaProps: spec.SchemaProps{ - Description: "DeletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to \"Random\". Valid values are \"Random, \"Newest\", \"Oldest\"", + Description: "deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to \"Random\". Valid values are \"Random, \"Newest\", \"Oldest\"", Type: []string{"string"}, Format: "", }, }, "selector": { SchemaProps: spec.SchemaProps{ - Description: "Selector is a label query over machines that should match the replica count. Label keys and values that must match in order to be controlled by this MachineSet. It must match the machine template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors", + Description: "selector is a label query over machines that should match the replica count. Label keys and values that must match in order to be controlled by this MachineSet. It must match the machine template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors", Default: map[string]interface{}{}, Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector"), }, }, "template": { SchemaProps: spec.SchemaProps{ - Description: "Template is the object that describes the machine that will be created if insufficient replicas are detected. Object references to custom resources are treated as templates.", + Description: "template is the object that describes the machine that will be created if insufficient replicas are detected. Object references to custom resources are treated as templates.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.MachineTemplateSpec"), }, @@ -3504,14 +3504,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineSetStatus(ref common.Refere Properties: map[string]spec.Schema{ "selector": { SchemaProps: spec.SchemaProps{ - Description: "Selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors", + Description: "selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors", Type: []string{"string"}, Format: "", }, }, "replicas": { SchemaProps: spec.SchemaProps{ - Description: "Replicas is the most recently observed number of replicas.", + Description: "replicas is the most recently observed number of replicas.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -3543,7 +3543,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineSetStatus(ref common.Refere }, "observedGeneration": { SchemaProps: spec.SchemaProps{ - Description: "ObservedGeneration reflects the generation of the most recently observed MachineSet.", + Description: "observedGeneration reflects the generation of the most recently observed MachineSet.", Type: []string{"integer"}, Format: "int64", }, @@ -3564,7 +3564,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineSetStatus(ref common.Refere }, "conditions": { SchemaProps: spec.SchemaProps{ - Description: "Conditions defines current service state of the MachineSet.", + Description: "conditions defines current service state of the MachineSet.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3657,7 +3657,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineSpec(ref common.ReferenceCa Properties: map[string]spec.Schema{ "clusterName": { SchemaProps: spec.SchemaProps{ - Description: "ClusterName is the name of the Cluster this object belongs to.", + Description: "clusterName is the name of the Cluster this object belongs to.", Default: "", Type: []string{"string"}, Format: "", @@ -3665,35 +3665,35 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineSpec(ref common.ReferenceCa }, "bootstrap": { SchemaProps: spec.SchemaProps{ - Description: "Bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism.", + Description: "bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.Bootstrap"), }, }, "infrastructureRef": { SchemaProps: spec.SchemaProps{ - Description: "InfrastructureRef is a required reference to a custom resource offered by an infrastructure provider.", + Description: "infrastructureRef is a required reference to a custom resource offered by an infrastructure provider.", Default: map[string]interface{}{}, Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, "version": { SchemaProps: spec.SchemaProps{ - Description: "Version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers.", + Description: "version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers.", Type: []string{"string"}, Format: "", }, }, "providerID": { SchemaProps: spec.SchemaProps{ - Description: "ProviderID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out machines at provider which could not get registered as Kubernetes nodes. With cluster-api as a generic out-of-tree provider for autoscaler, this field is required by autoscaler to be able to have a provider view of the list of machines. Another list of nodes is queried from the k8s apiserver and then a comparison is done to find out unregistered machines and are marked for delete. This field will be set by the actuators and consumed by higher level entities like autoscaler that will be interfacing with cluster-api as generic provider.", + Description: "providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out machines at provider which could not get registered as Kubernetes nodes. With cluster-api as a generic out-of-tree provider for autoscaler, this field is required by autoscaler to be able to have a provider view of the list of machines. Another list of nodes is queried from the k8s apiserver and then a comparison is done to find out unregistered machines and are marked for delete. This field will be set by the actuators and consumed by higher level entities like autoscaler that will be interfacing with cluster-api as generic provider.", Type: []string{"string"}, Format: "", }, }, "failureDomain": { SchemaProps: spec.SchemaProps{ - Description: "FailureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object.", + Description: "failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object.", Type: []string{"string"}, Format: "", }, @@ -3722,19 +3722,19 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineSpec(ref common.ReferenceCa }, "nodeDrainTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout`", + Description: "nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout`", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeVolumeDetachTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.", + Description: "nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, "nodeDeletionTimeout": { SchemaProps: spec.SchemaProps{ - Description: "NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds.", + Description: "nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Duration"), }, }, @@ -3756,39 +3756,39 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineStatus(ref common.Reference Properties: map[string]spec.Schema{ "nodeRef": { SchemaProps: spec.SchemaProps{ - Description: "NodeRef will point to the corresponding Node if it exists.", + Description: "nodeRef will point to the corresponding Node if it exists.", Ref: ref("k8s.io/api/core/v1.ObjectReference"), }, }, "nodeInfo": { SchemaProps: spec.SchemaProps{ - Description: "NodeInfo is a set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info", + Description: "nodeInfo is a set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info", Ref: ref("k8s.io/api/core/v1.NodeSystemInfo"), }, }, "lastUpdated": { SchemaProps: spec.SchemaProps{ - Description: "LastUpdated identifies when the phase of the Machine last transitioned.", + Description: "lastUpdated identifies when the phase of the Machine last transitioned.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), }, }, "failureReason": { SchemaProps: spec.SchemaProps{ - Description: "FailureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation.\n\nThis field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.\n\nAny transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.", + Description: "failureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation.\n\nThis field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.\n\nAny transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.", Type: []string{"string"}, Format: "", }, }, "failureMessage": { SchemaProps: spec.SchemaProps{ - Description: "FailureMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption.\n\nThis field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.\n\nAny transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.", + Description: "failureMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption.\n\nThis field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.\n\nAny transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.", Type: []string{"string"}, Format: "", }, }, "addresses": { SchemaProps: spec.SchemaProps{ - Description: "Addresses is a list of addresses assigned to the machine. This field is copied from the infrastructure provider reference.", + Description: "addresses is a list of addresses assigned to the machine. This field is copied from the infrastructure provider reference.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3802,20 +3802,20 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineStatus(ref common.Reference }, "phase": { SchemaProps: spec.SchemaProps{ - Description: "Phase represents the current phase of machine actuation. E.g. Pending, Running, Terminating, Failed etc.", + Description: "phase represents the current phase of machine actuation. E.g. Pending, Running, Terminating, Failed etc.", Type: []string{"string"}, Format: "", }, }, "certificatesExpiryDate": { SchemaProps: spec.SchemaProps{ - Description: "CertificatesExpiryDate is the expiry date of the machine certificates. This value is only set for control plane machines.", + Description: "certificatesExpiryDate is the expiry date of the machine certificates. This value is only set for control plane machines.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), }, }, "bootstrapReady": { SchemaProps: spec.SchemaProps{ - Description: "BootstrapReady is the state of the bootstrap provider.", + Description: "bootstrapReady is the state of the bootstrap provider.", Default: false, Type: []string{"boolean"}, Format: "", @@ -3823,7 +3823,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineStatus(ref common.Reference }, "infrastructureReady": { SchemaProps: spec.SchemaProps{ - Description: "InfrastructureReady is the state of the infrastructure provider.", + Description: "infrastructureReady is the state of the infrastructure provider.", Default: false, Type: []string{"boolean"}, Format: "", @@ -3831,14 +3831,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_MachineStatus(ref common.Reference }, "observedGeneration": { SchemaProps: spec.SchemaProps{ - Description: "ObservedGeneration is the latest generation observed by the controller.", + Description: "observedGeneration is the latest generation observed by the controller.", Type: []string{"integer"}, Format: "int64", }, }, "conditions": { SchemaProps: spec.SchemaProps{ - Description: "Conditions defines current service state of the Machine.", + Description: "conditions defines current service state of the Machine.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -3989,7 +3989,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ObjectMeta(ref common.ReferenceCal }, "annotations": { SchemaProps: spec.SchemaProps{ - Description: "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations", + Description: "annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -4018,14 +4018,14 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_PatchDefinition(ref common.Referen Properties: map[string]spec.Schema{ "selector": { SchemaProps: spec.SchemaProps{ - Description: "Selector defines on which templates the patch should be applied.", + Description: "selector defines on which templates the patch should be applied.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.PatchSelector"), }, }, "jsonPatches": { SchemaProps: spec.SchemaProps{ - Description: "JSONPatches defines the patches which should be applied on the templates matching the selector. Note: Patches will be applied in the order of the array.", + Description: "jsonPatches defines the patches which should be applied on the templates matching the selector. Note: Patches will be applied in the order of the array.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4055,7 +4055,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_PatchSelector(ref common.Reference Properties: map[string]spec.Schema{ "apiVersion": { SchemaProps: spec.SchemaProps{ - Description: "APIVersion filters templates by apiVersion.", + Description: "apiVersion filters templates by apiVersion.", Default: "", Type: []string{"string"}, Format: "", @@ -4063,7 +4063,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_PatchSelector(ref common.Reference }, "kind": { SchemaProps: spec.SchemaProps{ - Description: "Kind filters templates by kind.", + Description: "kind filters templates by kind.", Default: "", Type: []string{"string"}, Format: "", @@ -4071,7 +4071,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_PatchSelector(ref common.Reference }, "matchResources": { SchemaProps: spec.SchemaProps{ - Description: "MatchResources selects templates based on where they are referenced.", + Description: "matchResources selects templates based on where they are referenced.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.PatchSelectorMatch"), }, @@ -4094,27 +4094,27 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_PatchSelectorMatch(ref common.Refe Properties: map[string]spec.Schema{ "controlPlane": { SchemaProps: spec.SchemaProps{ - Description: "ControlPlane selects templates referenced in .spec.ControlPlane. Note: this will match the controlPlane and also the controlPlane machineInfrastructure (depending on the kind and apiVersion).", + Description: "controlPlane selects templates referenced in .spec.ControlPlane. Note: this will match the controlPlane and also the controlPlane machineInfrastructure (depending on the kind and apiVersion).", Type: []string{"boolean"}, Format: "", }, }, "infrastructureCluster": { SchemaProps: spec.SchemaProps{ - Description: "InfrastructureCluster selects templates referenced in .spec.infrastructure.", + Description: "infrastructureCluster selects templates referenced in .spec.infrastructure.", Type: []string{"boolean"}, Format: "", }, }, "machineDeploymentClass": { SchemaProps: spec.SchemaProps{ - Description: "MachineDeploymentClass selects templates referenced in specific MachineDeploymentClasses in .spec.workers.machineDeployments.", + Description: "machineDeploymentClass selects templates referenced in specific MachineDeploymentClasses in .spec.workers.machineDeployments.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.PatchSelectorMatchMachineDeploymentClass"), }, }, "machinePoolClass": { SchemaProps: spec.SchemaProps{ - Description: "MachinePoolClass selects templates referenced in specific MachinePoolClasses in .spec.workers.machinePools.", + Description: "machinePoolClass selects templates referenced in specific MachinePoolClasses in .spec.workers.machinePools.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.PatchSelectorMatchMachinePoolClass"), }, }, @@ -4135,7 +4135,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_PatchSelectorMatchMachineDeploymen Properties: map[string]spec.Schema{ "names": { SchemaProps: spec.SchemaProps{ - Description: "Names selects templates by class names.", + Description: "names selects templates by class names.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4163,7 +4163,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_PatchSelectorMatchMachinePoolClass Properties: map[string]spec.Schema{ "names": { SchemaProps: spec.SchemaProps{ - Description: "Names selects templates by class names.", + Description: "names selects templates by class names.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4191,7 +4191,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_RemediationStrategy(ref common.Ref Properties: map[string]spec.Schema{ "maxInFlight": { SchemaProps: spec.SchemaProps{ - Description: "MaxInFlight determines how many in flight remediations should happen at the same time.\n\nRemediation only happens on the MachineSet with the most current revision, while older MachineSets (usually present during rollout operations) aren't allowed to remediate.\n\nNote: In general (independent of remediations), unhealthy machines are always prioritized during scale down operations over healthy ones.\n\nMaxInFlight can be set to a fixed number or a percentage. Example: when this is set to 20%, the MachineSet controller deletes at most 20% of the desired replicas.\n\nIf not set, remediation is limited to all machines (bounded by replicas) under the active MachineSet's management.", + Description: "maxInFlight determines how many in flight remediations should happen at the same time.\n\nRemediation only happens on the MachineSet with the most current revision, while older MachineSets (usually present during rollout operations) aren't allowed to remediate.\n\nNote: In general (independent of remediations), unhealthy machines are always prioritized during scale down operations over healthy ones.\n\nMaxInFlight can be set to a fixed number or a percentage. Example: when this is set to 20%, the MachineSet controller deletes at most 20% of the desired replicas.\n\nIf not set, remediation is limited to all machines (bounded by replicas) under the active MachineSet's management.", Ref: ref("k8s.io/apimachinery/pkg/util/intstr.IntOrString"), }, }, @@ -4228,20 +4228,20 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_Topology(ref common.ReferenceCallb }, "rolloutAfter": { SchemaProps: spec.SchemaProps{ - Description: "RolloutAfter performs a rollout of the entire cluster one component at a time, control plane first and then machine deployments.\n\nDeprecated: This field has no function and is going to be removed in the next apiVersion.", + Description: "rolloutAfter performs a rollout of the entire cluster one component at a time, control plane first and then machine deployments.\n\nDeprecated: This field has no function and is going to be removed in the next apiVersion.", Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), }, }, "controlPlane": { SchemaProps: spec.SchemaProps{ - Description: "ControlPlane describes the cluster control plane.", + Description: "controlPlane describes the cluster control plane.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ControlPlaneTopology"), }, }, "workers": { SchemaProps: spec.SchemaProps{ - Description: "Workers encapsulates the different constructs that form the worker nodes for the cluster.", + Description: "workers encapsulates the different constructs that form the worker nodes for the cluster.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.WorkersTopology"), }, }, @@ -4255,7 +4255,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_Topology(ref common.ReferenceCallb }, }, SchemaProps: spec.SchemaProps{ - Description: "Variables can be used to customize the Cluster through patches. They must comply to the corresponding VariableClasses defined in the ClusterClass.", + Description: "variables can be used to customize the Cluster through patches. They must comply to the corresponding VariableClasses defined in the ClusterClass.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4320,7 +4320,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ValidationRule(ref common.Referenc Properties: map[string]spec.Schema{ "rule": { SchemaProps: spec.SchemaProps{ - Description: "Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The `self` variable in the CEL expression is bound to the scoped value. If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via `self.field` and field presence can be checked via `has(self.field)`. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible via `self[mapKey]`, map containment can be checked via `mapKey in self` and all entries of the map are accessible via CEL macros and functions such as `self.all(...)`. If the Rule is scoped to an array, the elements of the array are accessible via `self[i]` and also by macros and functions. If the Rule is scoped to a scalar, `self` is bound to the scalar value. Examples: - Rule scoped to a map of objects: {\"rule\": \"self.components['Widget'].priority < 10\"} - Rule scoped to a list of integers: {\"rule\": \"self.values.all(value, value >= 0 && value < 100)\"} - Rule scoped to a string value: {\"rule\": \"self.startsWith('kube')\"}\n\nUnknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an \"unknown type\". An \"unknown type\" is recursively defined as:\n - A schema with no type and x-kubernetes-preserve-unknown-fields set to true\n - An array where the items schema is of an \"unknown type\"\n - An object where the additionalProperties schema is of an \"unknown type\"\n\nOnly property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are:\n\t \"true\", \"false\", \"null\", \"in\", \"as\", \"break\", \"const\", \"continue\", \"else\", \"for\", \"function\", \"if\",\n\t \"import\", \"let\", \"loop\", \"package\", \"namespace\", \"return\".\nExamples:\n - Rule accessing a property named \"namespace\": {\"rule\": \"self.__namespace__ > 0\"}\n - Rule accessing a property named \"x-prop\": {\"rule\": \"self.x__dash__prop > 0\"}\n - Rule accessing a property named \"redact__d\": {\"rule\": \"self.redact__underscores__d > 0\"}\n\nIf `rule` makes use of the `oldSelf` variable it is implicitly a `transition rule`.\n\nBy default, the `oldSelf` variable is the same type as `self`.\n\nTransition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found.", + Description: "rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The `self` variable in the CEL expression is bound to the scoped value. If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via `self.field` and field presence can be checked via `has(self.field)`. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible via `self[mapKey]`, map containment can be checked via `mapKey in self` and all entries of the map are accessible via CEL macros and functions such as `self.all(...)`. If the Rule is scoped to an array, the elements of the array are accessible via `self[i]` and also by macros and functions. If the Rule is scoped to a scalar, `self` is bound to the scalar value. Examples: - Rule scoped to a map of objects: {\"rule\": \"self.components['Widget'].priority < 10\"} - Rule scoped to a list of integers: {\"rule\": \"self.values.all(value, value >= 0 && value < 100)\"} - Rule scoped to a string value: {\"rule\": \"self.startsWith('kube')\"}\n\nUnknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an \"unknown type\". An \"unknown type\" is recursively defined as:\n - A schema with no type and x-kubernetes-preserve-unknown-fields set to true\n - An array where the items schema is of an \"unknown type\"\n - An object where the additionalProperties schema is of an \"unknown type\"\n\nOnly property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are:\n\t \"true\", \"false\", \"null\", \"in\", \"as\", \"break\", \"const\", \"continue\", \"else\", \"for\", \"function\", \"if\",\n\t \"import\", \"let\", \"loop\", \"package\", \"namespace\", \"return\".\nExamples:\n - Rule accessing a property named \"namespace\": {\"rule\": \"self.__namespace__ > 0\"}\n - Rule accessing a property named \"x-prop\": {\"rule\": \"self.x__dash__prop > 0\"}\n - Rule accessing a property named \"redact__d\": {\"rule\": \"self.redact__underscores__d > 0\"}\n\nIf `rule` makes use of the `oldSelf` variable it is implicitly a `transition rule`.\n\nBy default, the `oldSelf` variable is the same type as `self`.\n\nTransition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found.", Default: "", Type: []string{"string"}, Format: "", @@ -4328,21 +4328,21 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ValidationRule(ref common.Referenc }, "message": { SchemaProps: spec.SchemaProps{ - Description: "Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is \"failed rule: {Rule}\". e.g. \"must be a URL with the host matching spec.host\"", + Description: "message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is \"failed rule: {Rule}\". e.g. \"must be a URL with the host matching spec.host\"", Type: []string{"string"}, Format: "", }, }, "messageExpression": { SchemaProps: spec.SchemaProps{ - Description: "MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: \"x must be less than max (\"+string(self.max)+\")\"", + Description: "messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: \"x must be less than max (\"+string(self.max)+\")\"", Type: []string{"string"}, Format: "", }, }, "reason": { SchemaProps: spec.SchemaProps{ - Description: "Reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The currently supported reasons are: \"FieldValueInvalid\", \"FieldValueForbidden\", \"FieldValueRequired\", \"FieldValueDuplicate\". If not set, default to use \"FieldValueInvalid\". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.", + Description: "reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The currently supported reasons are: \"FieldValueInvalid\", \"FieldValueForbidden\", \"FieldValueRequired\", \"FieldValueDuplicate\". If not set, default to use \"FieldValueInvalid\". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.", Default: FieldValueInvalid, Type: []string{"string"}, Format: "", @@ -4350,7 +4350,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_ValidationRule(ref common.Referenc }, "fieldPath": { SchemaProps: spec.SchemaProps{ - Description: "FieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute `foo` under a map `testMap`, the fieldPath could be set to `.testMap.foo` If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. `.testList` It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to [JSONPath support in Kubernetes](https://kubernetes.io/docs/reference/kubectl/jsonpath/) for more info. Numeric index of array is not supported. For field name which contains special characters, use `['specialName']` to refer the field name. e.g. for attribute `foo.34$` appears in a list `testList`, the fieldPath could be set to `.testList['foo.34$']`", + Description: "fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute `foo` under a map `testMap`, the fieldPath could be set to `.testMap.foo` If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. `.testList` It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to [JSONPath support in Kubernetes](https://kubernetes.io/docs/reference/kubectl/jsonpath/) for more info. Numeric index of array is not supported. For field name which contains special characters, use `['specialName']` to refer the field name. e.g. for attribute `foo.34$` appears in a list `testList`, the fieldPath could be set to `.testList['foo.34$']`", Type: []string{"string"}, Format: "", }, @@ -4371,7 +4371,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_VariableSchema(ref common.Referenc Properties: map[string]spec.Schema{ "openAPIV3Schema": { SchemaProps: spec.SchemaProps{ - Description: "OpenAPIV3Schema defines the schema of a variable via OpenAPI v3 schema. The schema is a subset of the schema used in Kubernetes CRDs.", + Description: "openAPIV3Schema defines the schema of a variable via OpenAPI v3 schema. The schema is a subset of the schema used in Kubernetes CRDs.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.JSONSchemaProps"), }, @@ -4410,7 +4410,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_VariableSchemaMetadata(ref common. }, "annotations": { SchemaProps: spec.SchemaProps{ - Description: "Annotations is an unstructured key value map that can be used to store and retrieve arbitrary metadata. They are not queryable.", + Description: "annotations is an unstructured key value map that can be used to store and retrieve arbitrary metadata. They are not queryable.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -4447,7 +4447,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_WorkersClass(ref common.ReferenceC }, }, SchemaProps: spec.SchemaProps{ - Description: "MachineDeployments is a list of machine deployment classes that can be used to create a set of worker nodes.", + Description: "machineDeployments is a list of machine deployment classes that can be used to create a set of worker nodes.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4469,7 +4469,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_WorkersClass(ref common.ReferenceC }, }, SchemaProps: spec.SchemaProps{ - Description: "MachinePools is a list of machine pool classes that can be used to create a set of worker nodes.", + Description: "machinePools is a list of machine pool classes that can be used to create a set of worker nodes.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4554,7 +4554,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_WorkersTopology(ref common.Referen }, }, SchemaProps: spec.SchemaProps{ - Description: "MachineDeployments is a list of machine deployments in the cluster.", + Description: "machineDeployments is a list of machine deployments in the cluster.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -4576,7 +4576,7 @@ func schema_sigsk8sio_cluster_api_api_v1beta1_WorkersTopology(ref common.Referen }, }, SchemaProps: spec.SchemaProps{ - Description: "MachinePools is a list of machine pools in the cluster.", + Description: "machinePools is a list of machine pools in the cluster.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ diff --git a/bootstrap/kubeadm/api/v1beta1/kubeadm_types.go b/bootstrap/kubeadm/api/v1beta1/kubeadm_types.go index cab637783e27..7c9ac3753301 100644 --- a/bootstrap/kubeadm/api/v1beta1/kubeadm_types.go +++ b/bootstrap/kubeadm/api/v1beta1/kubeadm_types.go @@ -35,18 +35,18 @@ import ( type InitConfiguration struct { metav1.TypeMeta `json:",inline"` - // BootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. + // bootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. // This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature // +optional BootstrapTokens []BootstrapToken `json:"bootstrapTokens,omitempty"` - // NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + // nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. // When used in the context of control plane nodes, NodeRegistration should remain consistent // across both InitConfiguration and JoinConfiguration // +optional NodeRegistration NodeRegistrationOptions `json:"nodeRegistration,omitempty"` - // LocalAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node + // localAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node // In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint // is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This // configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible @@ -55,13 +55,13 @@ type InitConfiguration struct { // +optional LocalAPIEndpoint APIEndpoint `json:"localAPIEndpoint,omitempty"` - // SkipPhases is a list of phases to skip during command execution. + // skipPhases is a list of phases to skip during command execution. // The list of phases can be obtained with the "kubeadm init --help" command. // This option takes effect only on Kubernetes >=1.22.0. // +optional SkipPhases []string `json:"skipPhases,omitempty"` - // Patches contains options related to applying patches to components deployed by kubeadm during + // patches contains options related to applying patches to components deployed by kubeadm during // "kubeadm init". The minimum kubernetes version needed to support Patches is v1.22 // +optional Patches *Patches `json:"patches,omitempty"` @@ -73,22 +73,22 @@ type InitConfiguration struct { type ClusterConfiguration struct { metav1.TypeMeta `json:",inline"` - // Etcd holds configuration for etcd. + // etcd holds configuration for etcd. // NB: This value defaults to a Local (stacked) etcd // +optional Etcd Etcd `json:"etcd,omitempty"` - // Networking holds configuration for the networking topology of the cluster. + // networking holds configuration for the networking topology of the cluster. // NB: This value defaults to the Cluster object spec.clusterNetwork. // +optional Networking Networking `json:"networking,omitempty"` - // KubernetesVersion is the target version of the control plane. + // kubernetesVersion is the target version of the control plane. // NB: This value defaults to the Machine object spec.version // +optional KubernetesVersion string `json:"kubernetesVersion,omitempty"` - // ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it + // controlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it // can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. // In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort // are used; in case the ControlPlaneEndpoint is specified but without a TCP port, @@ -103,28 +103,28 @@ type ClusterConfiguration struct { // +optional ControlPlaneEndpoint string `json:"controlPlaneEndpoint,omitempty"` - // APIServer contains extra settings for the API server control plane component + // apiServer contains extra settings for the API server control plane component // +optional APIServer APIServer `json:"apiServer,omitempty"` - // ControllerManager contains extra settings for the controller manager control plane component + // controllerManager contains extra settings for the controller manager control plane component // +optional ControllerManager ControlPlaneComponent `json:"controllerManager,omitempty"` - // Scheduler contains extra settings for the scheduler control plane component + // scheduler contains extra settings for the scheduler control plane component // +optional Scheduler ControlPlaneComponent `json:"scheduler,omitempty"` - // DNS defines the options for the DNS add-on installed in the cluster. + // dns defines the options for the DNS add-on installed in the cluster. // +optional DNS DNS `json:"dns,omitempty"` - // CertificatesDir specifies where to store or look for all required certificates. + // certificatesDir specifies where to store or look for all required certificates. // NB: if not provided, this will default to `/etc/kubernetes/pki` // +optional CertificatesDir string `json:"certificatesDir,omitempty"` - // ImageRepository sets the container registry to pull images from. + // imageRepository sets the container registry to pull images from. // * If not set, the default registry of kubeadm will be used, i.e. // * registry.k8s.io (new registry): >= v1.22.17, >= v1.23.15, >= v1.24.9, >= v1.25.0 // * k8s.gcr.io (old registry): all older versions @@ -138,7 +138,7 @@ type ClusterConfiguration struct { // +optional ImageRepository string `json:"imageRepository,omitempty"` - // FeatureGates enabled by the user. + // featureGates enabled by the user. // +optional FeatureGates map[string]bool `json:"featureGates,omitempty"` @@ -149,16 +149,16 @@ type ClusterConfiguration struct { // ControlPlaneComponent holds settings common to control plane component of the cluster. type ControlPlaneComponent struct { - // ExtraArgs is an extra set of flags to pass to the control plane component. + // extraArgs is an extra set of flags to pass to the control plane component. // TODO: This is temporary and ideally we would like to switch all components to use ComponentConfig + ConfigMaps. // +optional ExtraArgs map[string]string `json:"extraArgs,omitempty"` - // ExtraVolumes is an extra set of host volumes, mounted to the control plane component. + // extraVolumes is an extra set of host volumes, mounted to the control plane component. // +optional ExtraVolumes []HostPathMount `json:"extraVolumes,omitempty"` - // ExtraEnvs is an extra set of environment variables to pass to the control plane component. + // extraEnvs is an extra set of environment variables to pass to the control plane component. // Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. // This option takes effect only on Kubernetes >=1.31.0. // +optional @@ -169,11 +169,11 @@ type ControlPlaneComponent struct { type APIServer struct { ControlPlaneComponent `json:",inline"` - // CertSANs sets extra Subject Alternative Names for the API Server signing cert. + // certSANs sets extra Subject Alternative Names for the API Server signing cert. // +optional CertSANs []string `json:"certSANs,omitempty"` - // TimeoutForControlPlane controls the timeout that we use for API server to appear + // timeoutForControlPlane controls the timeout that we use for API server to appear // +optional TimeoutForControlPlane *metav1.Duration `json:"timeoutForControlPlane,omitempty"` } @@ -187,12 +187,12 @@ type DNS struct { // ImageMeta allows to customize the image used for components that are not // originated from the Kubernetes/Kubernetes release process. type ImageMeta struct { - // ImageRepository sets the container registry to pull images from. + // imageRepository sets the container registry to pull images from. // if not set, the ImageRepository defined in ClusterConfiguration will be used instead. // +optional ImageRepository string `json:"imageRepository,omitempty"` - // ImageTag allows to specify a tag for the image. + // imageTag allows to specify a tag for the image. // In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. // +optional ImageTag string `json:"imageTag,omitempty"` @@ -210,18 +210,18 @@ type ImageMeta struct { type ClusterStatus struct { metav1.TypeMeta `json:",inline"` - // APIEndpoints currently available in the cluster, one for each control plane/api server instance. + // apiEndpoints currently available in the cluster, one for each control plane/api server instance. // The key of the map is the IP of the host's default interface APIEndpoints map[string]APIEndpoint `json:"apiEndpoints"` } // APIEndpoint struct contains elements of API server instance deployed on a node. type APIEndpoint struct { - // AdvertiseAddress sets the IP address for the API server to advertise. + // advertiseAddress sets the IP address for the API server to advertise. // +optional AdvertiseAddress string `json:"advertiseAddress,omitempty"` - // BindPort sets the secure port for the API Server to bind to. + // bindPort sets the secure port for the API Server to bind to. // Defaults to 6443. // +optional BindPort int32 `json:"bindPort,omitempty"` @@ -231,33 +231,33 @@ type APIEndpoint struct { // Note: The NodeRegistrationOptions struct has to be kept in sync with the structs in MarshalJSON. type NodeRegistrationOptions struct { - // Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + // name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. // This field is also used in the CommonName field of the kubelet's client certificate to the API server. // Defaults to the hostname of the node if not provided. // +optional Name string `json:"name,omitempty"` - // CRISocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use + // criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use // +optional CRISocket string `json:"criSocket,omitempty"` - // Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + // taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process // it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an // empty slice, i.e. `taints: []` in the YAML file. This field is solely used for Node registration. // +optional Taints []corev1.Taint `json:"taints,omitempty"` - // KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + // kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file // kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap // Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. // +optional KubeletExtraArgs map[string]string `json:"kubeletExtraArgs,omitempty"` - // IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. + // ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. // +optional IgnorePreflightErrors []string `json:"ignorePreflightErrors,omitempty"` - // ImagePullPolicy specifies the policy for image pulling + // imagePullPolicy specifies the policy for image pulling // during kubeadm "init" and "join" operations. The value of // this field must be one of "Always", "IfNotPresent" or // "Never". Defaults to "IfNotPresent". This can be used only @@ -266,7 +266,7 @@ type NodeRegistrationOptions struct { // +optional ImagePullPolicy string `json:"imagePullPolicy,omitempty"` - // ImagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. + // imagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. // This option takes effect only on Kubernetes >=1.31.0. // Default: true (defaulted in kubeadm) // +optional @@ -326,43 +326,43 @@ func (n *NodeRegistrationOptions) MarshalJSON() ([]byte, error) { // Networking contains elements describing cluster's networking configuration. type Networking struct { - // ServiceSubnet is the subnet used by k8s services. + // serviceSubnet is the subnet used by k8s services. // Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.pods.cidrBlocks, or // to "10.96.0.0/12" if that's unset. // +optional ServiceSubnet string `json:"serviceSubnet,omitempty"` - // PodSubnet is the subnet used by pods. + // podSubnet is the subnet used by pods. // If unset, the API server will not allocate CIDR ranges for every node. // Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.services.cidrBlocks if that is set // +optional PodSubnet string `json:"podSubnet,omitempty"` - // DNSDomain is the dns domain used by k8s services. Defaults to "cluster.local". + // dnsDomain is the dns domain used by k8s services. Defaults to "cluster.local". // +optional DNSDomain string `json:"dnsDomain,omitempty"` } // BootstrapToken describes one bootstrap token, stored as a Secret in the cluster. type BootstrapToken struct { - // Token is used for establishing bidirectional trust between nodes and control-planes. + // token is used for establishing bidirectional trust between nodes and control-planes. // Used for joining nodes in the cluster. Token *BootstrapTokenString `json:"token"` - // Description sets a human-friendly message why this token exists and what it's used + // description sets a human-friendly message why this token exists and what it's used // for, so other administrators can know its purpose. // +optional Description string `json:"description,omitempty"` - // TTL defines the time to live for this token. Defaults to 24h. + // ttl defines the time to live for this token. Defaults to 24h. // Expires and TTL are mutually exclusive. // +optional TTL *metav1.Duration `json:"ttl,omitempty"` - // Expires specifies the timestamp when this token expires. Defaults to being set + // expires specifies the timestamp when this token expires. Defaults to being set // dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive. // +optional Expires *metav1.Time `json:"expires,omitempty"` - // Usages describes the ways in which this token can be used. Can by default be used + // usages describes the ways in which this token can be used. Can by default be used // for establishing bidirectional trust, but that can be changed here. // +optional Usages []string `json:"usages,omitempty"` - // Groups specifies the extra groups that this token will authenticate as when/if + // groups specifies the extra groups that this token will authenticate as when/if // used for authentication // +optional Groups []string `json:"groups,omitempty"` @@ -371,12 +371,12 @@ type BootstrapToken struct { // Etcd contains elements describing Etcd configuration. type Etcd struct { - // Local provides configuration knobs for configuring the local etcd instance + // local provides configuration knobs for configuring the local etcd instance // Local and External are mutually exclusive // +optional Local *LocalEtcd `json:"local,omitempty"` - // External describes how to connect to an external etcd cluster + // external describes how to connect to an external etcd cluster // Local and External are mutually exclusive // +optional External *ExternalEtcd `json:"external,omitempty"` @@ -387,26 +387,26 @@ type LocalEtcd struct { // ImageMeta allows to customize the container used for etcd ImageMeta `json:",inline"` - // DataDir is the directory etcd will place its data. + // dataDir is the directory etcd will place its data. // Defaults to "/var/lib/etcd". // +optional DataDir string `json:"dataDir,omitempty"` - // ExtraArgs are extra arguments provided to the etcd binary + // extraArgs are extra arguments provided to the etcd binary // when run inside a static pod. // +optional ExtraArgs map[string]string `json:"extraArgs,omitempty"` - // ExtraEnvs is an extra set of environment variables to pass to the control plane component. + // extraEnvs is an extra set of environment variables to pass to the control plane component. // Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. // This option takes effect only on Kubernetes >=1.31.0. // +optional ExtraEnvs []EnvVar `json:"extraEnvs,omitempty"` - // ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert. + // serverCertSANs sets extra Subject Alternative Names for the etcd server signing cert. // +optional ServerCertSANs []string `json:"serverCertSANs,omitempty"` - // PeerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. + // peerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. // +optional PeerCertSANs []string `json:"peerCertSANs,omitempty"` } @@ -414,18 +414,18 @@ type LocalEtcd struct { // ExternalEtcd describes an external etcd cluster. // Kubeadm has no knowledge of where certificate files live and they must be supplied. type ExternalEtcd struct { - // Endpoints of etcd members. Required for ExternalEtcd. + // endpoints of etcd members. Required for ExternalEtcd. Endpoints []string `json:"endpoints"` - // CAFile is an SSL Certificate Authority file used to secure etcd communication. + // caFile is an SSL Certificate Authority file used to secure etcd communication. // Required if using a TLS connection. CAFile string `json:"caFile"` - // CertFile is an SSL certification file used to secure etcd communication. + // certFile is an SSL certification file used to secure etcd communication. // Required if using a TLS connection. CertFile string `json:"certFile"` - // KeyFile is an SSL key file used to secure etcd communication. + // keyFile is an SSL key file used to secure etcd communication. // Required if using a TLS connection. KeyFile string `json:"keyFile"` } @@ -436,36 +436,36 @@ type ExternalEtcd struct { type JoinConfiguration struct { metav1.TypeMeta `json:",inline"` - // NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + // nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. // When used in the context of control plane nodes, NodeRegistration should remain consistent // across both InitConfiguration and JoinConfiguration // +optional NodeRegistration NodeRegistrationOptions `json:"nodeRegistration,omitempty"` - // CACertPath is the path to the SSL certificate authority used to + // caCertPath is the path to the SSL certificate authority used to // secure comunications between node and control-plane. // Defaults to "/etc/kubernetes/pki/ca.crt". // +optional // TODO: revisit when there is defaulting from k/k CACertPath string `json:"caCertPath,omitempty"` - // Discovery specifies the options for the kubelet to use during the TLS Bootstrap process + // discovery specifies the options for the kubelet to use during the TLS Bootstrap process // +optional // TODO: revisit when there is defaulting from k/k Discovery Discovery `json:"discovery,omitempty"` - // ControlPlane defines the additional control plane instance to be deployed on the joining node. + // controlPlane defines the additional control plane instance to be deployed on the joining node. // If nil, no additional control plane instance will be deployed. // +optional ControlPlane *JoinControlPlane `json:"controlPlane,omitempty"` - // SkipPhases is a list of phases to skip during command execution. + // skipPhases is a list of phases to skip during command execution. // The list of phases can be obtained with the "kubeadm init --help" command. // This option takes effect only on Kubernetes >=1.22.0. // +optional SkipPhases []string `json:"skipPhases,omitempty"` - // Patches contains options related to applying patches to components deployed by kubeadm during + // patches contains options related to applying patches to components deployed by kubeadm during // "kubeadm join". The minimum kubernetes version needed to support Patches is v1.22 // +optional Patches *Patches `json:"patches,omitempty"` @@ -473,45 +473,45 @@ type JoinConfiguration struct { // JoinControlPlane contains elements describing an additional control plane instance to be deployed on the joining node. type JoinControlPlane struct { - // LocalAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. + // localAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. // +optional LocalAPIEndpoint APIEndpoint `json:"localAPIEndpoint,omitempty"` } // Discovery specifies the options for the kubelet to use during the TLS Bootstrap process. type Discovery struct { - // BootstrapToken is used to set the options for bootstrap token based discovery + // bootstrapToken is used to set the options for bootstrap token based discovery // BootstrapToken and File are mutually exclusive // +optional BootstrapToken *BootstrapTokenDiscovery `json:"bootstrapToken,omitempty"` - // File is used to specify a file or URL to a kubeconfig file from which to load cluster information + // file is used to specify a file or URL to a kubeconfig file from which to load cluster information // BootstrapToken and File are mutually exclusive // +optional File *FileDiscovery `json:"file,omitempty"` - // TLSBootstrapToken is a token used for TLS bootstrapping. + // tlsBootstrapToken is a token used for TLS bootstrapping. // If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. // If .File is set, this field **must be set** in case the KubeConfigFile does not contain any other authentication information // +optional TLSBootstrapToken string `json:"tlsBootstrapToken,omitempty"` - // Timeout modifies the discovery timeout + // timeout modifies the discovery timeout // +optional Timeout *metav1.Duration `json:"timeout,omitempty"` } // BootstrapTokenDiscovery is used to set the options for bootstrap token based discovery. type BootstrapTokenDiscovery struct { - // Token is a token used to validate cluster information + // token is a token used to validate cluster information // fetched from the control-plane. Token string `json:"token"` - // APIServerEndpoint is an IP or domain name to the API server from which info will be fetched. + // apiServerEndpoint is an IP or domain name to the API server from which info will be fetched. // +optional APIServerEndpoint string `json:"apiServerEndpoint,omitempty"` - // CACertHashes specifies a set of public key pins to verify + // caCertHashes specifies a set of public key pins to verify // when token-based discovery is used. The root CA found during discovery // must match one of these values. Specifying an empty set disables root CA // pinning, which can be unsafe. Each hash is specified as ":", @@ -522,7 +522,7 @@ type BootstrapTokenDiscovery struct { // +optional CACertHashes []string `json:"caCertHashes,omitempty"` - // UnsafeSkipCAVerification allows token-based discovery + // unsafeSkipCAVerification allows token-based discovery // without CA verification via CACertHashes. This can weaken // the security of kubeadm since other nodes can impersonate the control-plane. // +optional @@ -531,10 +531,10 @@ type BootstrapTokenDiscovery struct { // FileDiscovery is used to specify a file or URL to a kubeconfig file from which to load cluster information. type FileDiscovery struct { - // KubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information + // kubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information KubeConfigPath string `json:"kubeConfigPath"` - // KubeConfig is used (optionally) to generate a KubeConfig based on the KubeadmConfig's information. + // kubeConfig is used (optionally) to generate a KubeConfig based on the KubeadmConfig's information. // The file is generated at the path specified in KubeConfigPath. // // Host address (server field) information is automatically populated based on the Cluster's ControlPlaneEndpoint. @@ -546,7 +546,7 @@ type FileDiscovery struct { // FileDiscoveryKubeConfig contains elements describing how to generate the kubeconfig for bootstrapping. type FileDiscoveryKubeConfig struct { - // Cluster contains information about how to communicate with the kubernetes cluster. + // cluster contains information about how to communicate with the kubernetes cluster. // // By default the following fields are automatically populated: // - Server with the Cluster's ControlPlaneEndpoint. @@ -554,7 +554,7 @@ type FileDiscoveryKubeConfig struct { // +optional Cluster *KubeConfigCluster `json:"cluster,omitempty"` - // User contains information that describes identity information. + // user contains information that describes identity information. // This is used to tell the kubernetes cluster who you are. User KubeConfigUser `json:"user"` } @@ -563,29 +563,29 @@ type FileDiscoveryKubeConfig struct { // // Adapted from clientcmdv1.Cluster. type KubeConfigCluster struct { - // Server is the address of the kubernetes cluster (https://hostname:port). + // server is the address of the kubernetes cluster (https://hostname:port). // // Defaults to https:// + Cluster.Spec.ControlPlaneEndpoint. // // +optional Server string `json:"server,omitempty"` - // TLSServerName is used to check server certificate. If TLSServerName is empty, the hostname used to contact the server is used. + // tlsServerName is used to check server certificate. If TLSServerName is empty, the hostname used to contact the server is used. // +optional TLSServerName string `json:"tlsServerName,omitempty"` - // InsecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure. + // insecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure. // +optional InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"` - // CertificateAuthorityData contains PEM-encoded certificate authority certificates. + // certificateAuthorityData contains PEM-encoded certificate authority certificates. // // Defaults to the Cluster's CA certificate if empty. // // +optional CertificateAuthorityData []byte `json:"certificateAuthorityData,omitempty"` - // ProxyURL is the URL to the proxy to be used for all requests made by this + // proxyURL is the URL to the proxy to be used for all requests made by this // client. URLs with "http", "https", and "socks5" schemes are supported. If // this configuration is not provided or the empty string, the client // attempts to construct a proxy configuration from http_proxy and @@ -606,21 +606,21 @@ type KubeConfigCluster struct { // // Adapted from clientcmdv1.AuthInfo. type KubeConfigUser struct { - // AuthProvider specifies a custom authentication plugin for the kubernetes cluster. + // authProvider specifies a custom authentication plugin for the kubernetes cluster. // +optional AuthProvider *KubeConfigAuthProvider `json:"authProvider,omitempty"` - // Exec specifies a custom exec-based authentication plugin for the kubernetes cluster. + // exec specifies a custom exec-based authentication plugin for the kubernetes cluster. // +optional Exec *KubeConfigAuthExec `json:"exec,omitempty"` } // KubeConfigAuthProvider holds the configuration for a specified auth provider. type KubeConfigAuthProvider struct { - // Name is the name of the authentication plugin. + // name is the name of the authentication plugin. Name string `json:"name"` - // Config holds the parameters for the authentication plugin. + // config holds the parameters for the authentication plugin. // +optional Config map[string]string `json:"config,omitempty"` } @@ -631,14 +631,14 @@ type KubeConfigAuthProvider struct { // See the client.authentication.k8s.io API group for specifications of the exact input // and output format. type KubeConfigAuthExec struct { - // Command to execute. + // command to execute. Command string `json:"command"` // Arguments to pass to the command when executing it. // +optional Args []string `json:"args,omitempty"` - // Env defines additional environment variables to expose to the process. These + // env defines additional environment variables to expose to the process. These // are unioned with the host's environment, as well as variables client-go uses // to pass argument to the plugin. // +optional @@ -650,7 +650,7 @@ type KubeConfigAuthExec struct { // +optional APIVersion string `json:"apiVersion,omitempty"` - // ProvideClusterInfo determines whether or not to provide cluster information, + // provideClusterInfo determines whether or not to provide cluster information, // which could potentially contain very large CA data, to this exec plugin as a // part of the KUBERNETES_EXEC_INFO environment variable. By default, it is set // to false. Package k8s.io/client-go/tools/auth/exec provides helper methods for @@ -669,17 +669,17 @@ type KubeConfigAuthExecEnv struct { // HostPathMount contains elements describing volumes that are mounted from the // host. type HostPathMount struct { - // Name of the volume inside the pod template. + // name of the volume inside the pod template. Name string `json:"name"` - // HostPath is the path in the host that will be mounted inside + // hostPath is the path in the host that will be mounted inside // the pod. HostPath string `json:"hostPath"` - // MountPath is the path inside the pod where hostPath will be mounted. + // mountPath is the path inside the pod where hostPath will be mounted. MountPath string `json:"mountPath"` - // ReadOnly controls write access to the volume + // readOnly controls write access to the volume // +optional ReadOnly bool `json:"readOnly,omitempty"` - // PathType is the type of the HostPath. + // pathType is the type of the HostPath. // +optional PathType corev1.HostPathType `json:"pathType,omitempty"` } @@ -743,7 +743,7 @@ func NewBootstrapTokenString(token string) (*BootstrapTokenString, error) { // Patches contains options related to applying patches to components deployed by kubeadm. type Patches struct { - // Directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". + // directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". // For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of // "kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". "patchtype" can be one // of "strategic" "merge" or "json" and they match the patch formats supported by kubectl. diff --git a/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go b/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go index a49dadfa3a19..c9b62a9aad7b 100644 --- a/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go +++ b/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go @@ -51,56 +51,56 @@ var ( // KubeadmConfigSpec defines the desired state of KubeadmConfig. // Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. type KubeadmConfigSpec struct { - // ClusterConfiguration along with InitConfiguration are the configurations necessary for the init command + // clusterConfiguration along with InitConfiguration are the configurations necessary for the init command // +optional ClusterConfiguration *ClusterConfiguration `json:"clusterConfiguration,omitempty"` - // InitConfiguration along with ClusterConfiguration are the configurations necessary for the init command + // initConfiguration along with ClusterConfiguration are the configurations necessary for the init command // +optional InitConfiguration *InitConfiguration `json:"initConfiguration,omitempty"` - // JoinConfiguration is the kubeadm configuration for the join command + // joinConfiguration is the kubeadm configuration for the join command // +optional JoinConfiguration *JoinConfiguration `json:"joinConfiguration,omitempty"` - // Files specifies extra files to be passed to user_data upon creation. + // files specifies extra files to be passed to user_data upon creation. // +optional Files []File `json:"files,omitempty"` - // DiskSetup specifies options for the creation of partition tables and file systems on devices. + // diskSetup specifies options for the creation of partition tables and file systems on devices. // +optional DiskSetup *DiskSetup `json:"diskSetup,omitempty"` - // Mounts specifies a list of mount points to be setup. + // mounts specifies a list of mount points to be setup. // +optional Mounts []MountPoints `json:"mounts,omitempty"` - // PreKubeadmCommands specifies extra commands to run before kubeadm runs + // preKubeadmCommands specifies extra commands to run before kubeadm runs // +optional PreKubeadmCommands []string `json:"preKubeadmCommands,omitempty"` - // PostKubeadmCommands specifies extra commands to run after kubeadm runs + // postKubeadmCommands specifies extra commands to run after kubeadm runs // +optional PostKubeadmCommands []string `json:"postKubeadmCommands,omitempty"` - // Users specifies extra users to add + // users specifies extra users to add // +optional Users []User `json:"users,omitempty"` - // NTP specifies NTP configuration + // ntp specifies NTP configuration // +optional NTP *NTP `json:"ntp,omitempty"` - // Format specifies the output format of the bootstrap data + // format specifies the output format of the bootstrap data // +optional Format Format `json:"format,omitempty"` - // Verbosity is the number for the kubeadm log level verbosity. + // verbosity is the number for the kubeadm log level verbosity. // It overrides the `--v` flag in kubeadm commands. // +optional Verbosity *int32 `json:"verbosity,omitempty"` - // UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + // useExperimentalRetryJoin replaces a basic kubeadm command with a shell // script with retries for joins. // // This is meant to be an experimental temporary workaround on some environments @@ -116,7 +116,7 @@ type KubeadmConfigSpec struct { // When removing also remove from staticcheck exclude-rules for SA1019 in golangci.yml UseExperimentalRetryJoin bool `json:"useExperimentalRetryJoin,omitempty"` - // Ignition contains Ignition specific configuration. + // ignition contains Ignition specific configuration. // +optional Ignition *IgnitionSpec `json:"ignition,omitempty"` } @@ -395,7 +395,7 @@ func (c *KubeadmConfigSpec) validateIgnition(pathPrefix *field.Path) field.Error // IgnitionSpec contains Ignition specific configuration. type IgnitionSpec struct { - // ContainerLinuxConfig contains CLC specific configuration. + // containerLinuxConfig contains CLC specific configuration. // +optional ContainerLinuxConfig *ContainerLinuxConfig `json:"containerLinuxConfig,omitempty"` } @@ -404,47 +404,47 @@ type IgnitionSpec struct { // // We use a structured type here to allow adding additional fields, for example 'version'. type ContainerLinuxConfig struct { - // AdditionalConfig contains additional configuration to be merged with the Ignition + // additionalConfig contains additional configuration to be merged with the Ignition // configuration generated by the bootstrapper controller. More info: https://coreos.github.io/ignition/operator-notes/#config-merging // // The data format is documented here: https://kinvolk.io/docs/flatcar-container-linux/latest/provisioning/cl-config/ // +optional AdditionalConfig string `json:"additionalConfig,omitempty"` - // Strict controls if AdditionalConfig should be strictly parsed. If so, warnings are treated as errors. + // strict controls if AdditionalConfig should be strictly parsed. If so, warnings are treated as errors. // +optional Strict bool `json:"strict,omitempty"` } // KubeadmConfigStatus defines the observed state of KubeadmConfig. type KubeadmConfigStatus struct { - // Ready indicates the BootstrapData field is ready to be consumed + // ready indicates the BootstrapData field is ready to be consumed // +optional Ready bool `json:"ready"` - // DataSecretName is the name of the secret that stores the bootstrap data script. + // dataSecretName is the name of the secret that stores the bootstrap data script. // +optional DataSecretName *string `json:"dataSecretName,omitempty"` - // FailureReason will be set on non-retryable errors + // failureReason will be set on non-retryable errors // // Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details. // // +optional FailureReason string `json:"failureReason,omitempty"` - // FailureMessage will be set on non-retryable errors + // failureMessage will be set on non-retryable errors // // Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details. // // +optional FailureMessage string `json:"failureMessage,omitempty"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions defines current service state of the KubeadmConfig. + // conditions defines current service state of the KubeadmConfig. // +optional Conditions clusterv1.Conditions `json:"conditions,omitempty"` @@ -535,30 +535,30 @@ const ( // File defines the input for generating write_files in cloud-init. type File struct { - // Path specifies the full path on disk where to store the file. + // path specifies the full path on disk where to store the file. Path string `json:"path"` - // Owner specifies the ownership of the file, e.g. "root:root". + // owner specifies the ownership of the file, e.g. "root:root". // +optional Owner string `json:"owner,omitempty"` - // Permissions specifies the permissions to assign to the file, e.g. "0640". + // permissions specifies the permissions to assign to the file, e.g. "0640". // +optional Permissions string `json:"permissions,omitempty"` - // Encoding specifies the encoding of the file contents. + // encoding specifies the encoding of the file contents. // +optional Encoding Encoding `json:"encoding,omitempty"` - // Append specifies whether to append Content to existing file if Path exists. + // append specifies whether to append Content to existing file if Path exists. // +optional Append bool `json:"append,omitempty"` - // Content is the actual content of the file. + // content is the actual content of the file. // +optional Content string `json:"content,omitempty"` - // ContentFrom is a referenced source of content to populate the file. + // contentFrom is a referenced source of content to populate the file. // +optional ContentFrom *FileSource `json:"contentFrom,omitempty"` } @@ -567,7 +567,7 @@ type File struct { // Only one field may be populated in any given instance. Developers adding new // sources of data for target systems should add them here. type FileSource struct { - // Secret represents a secret that should populate this file. + // secret represents a secret that should populate this file. Secret SecretFileSource `json:"secret"` } @@ -576,10 +576,10 @@ type FileSource struct { // The contents of the target Secret's Data field will be presented // as files using the keys in the Data field as the file names. type SecretFileSource struct { - // Name of the secret in the KubeadmBootstrapConfig's namespace to use. + // name of the secret in the KubeadmBootstrapConfig's namespace to use. Name string `json:"name"` - // Key is the key in the secret's data map for this value. + // key is the key in the secret's data map for this value. Key string `json:"key"` } @@ -587,7 +587,7 @@ type SecretFileSource struct { // Only one field may be populated in any given instance. Developers adding new // sources of data for target systems should add them here. type PasswdSource struct { - // Secret represents a secret that should populate this password. + // secret represents a secret that should populate this password. Secret SecretPasswdSource `json:"secret"` } @@ -596,98 +596,98 @@ type PasswdSource struct { // The contents of the target Secret's Data field will be presented // as passwd using the keys in the Data field as the file names. type SecretPasswdSource struct { - // Name of the secret in the KubeadmBootstrapConfig's namespace to use. + // name of the secret in the KubeadmBootstrapConfig's namespace to use. Name string `json:"name"` - // Key is the key in the secret's data map for this value. + // key is the key in the secret's data map for this value. Key string `json:"key"` } // User defines the input for a generated user in cloud-init. type User struct { - // Name specifies the user name + // name specifies the user name Name string `json:"name"` - // Gecos specifies the gecos to use for the user + // gecos specifies the gecos to use for the user // +optional Gecos *string `json:"gecos,omitempty"` - // Groups specifies the additional groups for the user + // groups specifies the additional groups for the user // +optional Groups *string `json:"groups,omitempty"` - // HomeDir specifies the home directory to use for the user + // homeDir specifies the home directory to use for the user // +optional HomeDir *string `json:"homeDir,omitempty"` - // Inactive specifies whether to mark the user as inactive + // inactive specifies whether to mark the user as inactive // +optional Inactive *bool `json:"inactive,omitempty"` - // Shell specifies the user's shell + // shell specifies the user's shell // +optional Shell *string `json:"shell,omitempty"` - // Passwd specifies a hashed password for the user + // passwd specifies a hashed password for the user // +optional Passwd *string `json:"passwd,omitempty"` - // PasswdFrom is a referenced source of passwd to populate the passwd. + // passwdFrom is a referenced source of passwd to populate the passwd. // +optional PasswdFrom *PasswdSource `json:"passwdFrom,omitempty"` - // PrimaryGroup specifies the primary group for the user + // primaryGroup specifies the primary group for the user // +optional PrimaryGroup *string `json:"primaryGroup,omitempty"` - // LockPassword specifies if password login should be disabled + // lockPassword specifies if password login should be disabled // +optional LockPassword *bool `json:"lockPassword,omitempty"` - // Sudo specifies a sudo role for the user + // sudo specifies a sudo role for the user // +optional Sudo *string `json:"sudo,omitempty"` - // SSHAuthorizedKeys specifies a list of ssh authorized keys for the user + // sshAuthorizedKeys specifies a list of ssh authorized keys for the user // +optional SSHAuthorizedKeys []string `json:"sshAuthorizedKeys,omitempty"` } // NTP defines input for generated ntp in cloud-init. type NTP struct { - // Servers specifies which NTP servers to use + // servers specifies which NTP servers to use // +optional Servers []string `json:"servers,omitempty"` - // Enabled specifies whether NTP should be enabled + // enabled specifies whether NTP should be enabled // +optional Enabled *bool `json:"enabled,omitempty"` } // DiskSetup defines input for generated disk_setup and fs_setup in cloud-init. type DiskSetup struct { - // Partitions specifies the list of the partitions to setup. + // partitions specifies the list of the partitions to setup. // +optional Partitions []Partition `json:"partitions,omitempty"` - // Filesystems specifies the list of file systems to setup. + // filesystems specifies the list of file systems to setup. // +optional Filesystems []Filesystem `json:"filesystems,omitempty"` } // Partition defines how to create and layout a partition. type Partition struct { - // Device is the name of the device. + // device is the name of the device. Device string `json:"device"` - // Layout specifies the device layout. + // layout specifies the device layout. // If it is true, a single partition will be created for the entire device. // When layout is false, it means don't partition or ignore existing partitioning. Layout bool `json:"layout"` - // Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + // overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. // Use with caution. Default is 'false'. // +optional Overwrite *bool `json:"overwrite,omitempty"` - // TableType specifies the tupe of partition table. The following are supported: + // tableType specifies the tupe of partition table. The following are supported: // 'mbr': default and setups a MS-DOS partition table // 'gpt': setups a GPT partition table // +optional @@ -696,24 +696,24 @@ type Partition struct { // Filesystem defines the file systems to be created. type Filesystem struct { - // Device specifies the device name + // device specifies the device name Device string `json:"device"` - // Filesystem specifies the file system type. + // filesystem specifies the file system type. Filesystem string `json:"filesystem"` - // Label specifies the file system label to be used. If set to None, no label is used. + // label specifies the file system label to be used. If set to None, no label is used. Label string `json:"label"` - // Partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number. + // partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number. // +optional Partition *string `json:"partition,omitempty"` - // Overwrite defines whether or not to overwrite any existing filesystem. + // overwrite defines whether or not to overwrite any existing filesystem. // If true, any pre-existing file system will be destroyed. Use with Caution. // +optional Overwrite *bool `json:"overwrite,omitempty"` - // ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + // replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . // NOTE: unless you define a label, this requires the use of the 'any' partition directive. // +optional ReplaceFS *string `json:"replaceFS,omitempty"` - // ExtraOpts defined extra options to add to the command for creating the file system. + // extraOpts defined extra options to add to the command for creating the file system. // +optional ExtraOpts []string `json:"extraOpts,omitempty"` } diff --git a/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigs.yaml b/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigs.yaml index 6690e64689be..3d29c546acc4 100644 --- a/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigs.yaml +++ b/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigs.yaml @@ -48,7 +48,7 @@ spec: Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. properties: clusterConfiguration: - description: ClusterConfiguration along with InitConfiguration are + description: clusterConfiguration along with InitConfiguration are the configurations necessary for the init command properties: apiServer: @@ -369,44 +369,44 @@ spec: type: boolean type: object diskSetup: - description: DiskSetup specifies options for the creation of partition + description: diskSetup specifies options for the creation of partition tables and file systems on devices. properties: filesystems: - description: Filesystems specifies the list of file systems to + description: filesystems specifies the list of file systems to setup. items: description: Filesystem defines the file systems to be created. properties: device: - description: Device specifies the device name + description: device specifies the device name type: string extraOpts: - description: ExtraOpts defined extra options to add to the + description: extraOpts defined extra options to add to the command for creating the file system. items: type: string type: array filesystem: - description: Filesystem specifies the file system type. + description: filesystem specifies the file system type. type: string label: - description: Label specifies the file system label to be + description: label specifies the file system label to be used. If set to None, no label is used. type: string overwrite: description: |- - Overwrite defines whether or not to overwrite any existing filesystem. + overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution. type: boolean partition: - description: 'Partition specifies the partition to use. + description: 'partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number.' type: string replaceFS: description: |- - ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the 'any' partition directive. type: string required: @@ -416,28 +416,28 @@ spec: type: object type: array partitions: - description: Partitions specifies the list of the partitions to + description: partitions specifies the list of the partitions to setup. items: description: Partition defines how to create and layout a partition. properties: device: - description: Device is the name of the device. + description: device is the name of the device. type: string layout: description: |- - Layout specifies the device layout. + layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don't partition or ignore existing partitioning. type: boolean overwrite: description: |- - Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is 'false'. type: boolean tableType: description: |- - TableType specifies the tupe of partition table. The following are supported: + tableType specifies the tupe of partition table. The following are supported: 'mbr': default and setups a MS-DOS partition table 'gpt': setups a GPT partition table type: string @@ -448,29 +448,29 @@ spec: type: array type: object files: - description: Files specifies extra files to be passed to user_data + description: files specifies extra files to be passed to user_data upon creation. items: description: File defines the input for generating write_files in cloud-init. properties: content: - description: Content is the actual content of the file. + description: content is the actual content of the file. type: string contentFrom: - description: ContentFrom is a referenced source of content to + description: contentFrom is a referenced source of content to populate the file. properties: secret: - description: Secret represents a secret that should populate + description: secret represents a secret that should populate this file. properties: key: - description: Key is the key in the secret's data map + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -481,22 +481,22 @@ spec: - secret type: object encoding: - description: Encoding specifies the encoding of the file contents. + description: encoding specifies the encoding of the file contents. enum: - base64 - gzip - gzip+base64 type: string owner: - description: Owner specifies the ownership of the file, e.g. + description: owner specifies the ownership of the file, e.g. "root:root". type: string path: - description: Path specifies the full path on disk where to store + description: path specifies the full path on disk where to store the file. type: string permissions: - description: Permissions specifies the permissions to assign + description: permissions specifies the permissions to assign to the file, e.g. "0640". type: string required: @@ -504,12 +504,12 @@ spec: type: object type: array format: - description: Format specifies the output format of the bootstrap data + description: format specifies the output format of the bootstrap data enum: - cloud-config type: string initConfiguration: - description: InitConfiguration along with ClusterConfiguration are + description: initConfiguration along with ClusterConfiguration are the configurations necessary for the init command properties: apiVersion: @@ -660,7 +660,7 @@ spec: type: object type: object joinConfiguration: - description: JoinConfiguration is the kubeadm configuration for the + description: joinConfiguration is the kubeadm configuration for the join command properties: apiVersion: @@ -835,7 +835,7 @@ spec: type: object type: object mounts: - description: Mounts specifies a list of mount points to be setup. + description: mounts specifies a list of mount points to be setup. items: description: MountPoints defines input for generated mounts in cloud-init. items: @@ -843,32 +843,32 @@ spec: type: array type: array ntp: - description: NTP specifies NTP configuration + description: ntp specifies NTP configuration properties: enabled: - description: Enabled specifies whether NTP should be enabled + description: enabled specifies whether NTP should be enabled type: boolean servers: - description: Servers specifies which NTP servers to use + description: servers specifies which NTP servers to use items: type: string type: array type: object postKubeadmCommands: - description: PostKubeadmCommands specifies extra commands to run after + description: postKubeadmCommands specifies extra commands to run after kubeadm runs items: type: string type: array preKubeadmCommands: - description: PreKubeadmCommands specifies extra commands to run before + description: preKubeadmCommands specifies extra commands to run before kubeadm runs items: type: string type: array useExperimentalRetryJoin: description: |- - UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + useExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments @@ -880,50 +880,50 @@ spec: For more information, refer to https://github.com/kubernetes-sigs/cluster-api/pull/2763#discussion_r397306055. type: boolean users: - description: Users specifies extra users to add + description: users specifies extra users to add items: description: User defines the input for a generated user in cloud-init. properties: gecos: - description: Gecos specifies the gecos to use for the user + description: gecos specifies the gecos to use for the user type: string groups: - description: Groups specifies the additional groups for the + description: groups specifies the additional groups for the user type: string homeDir: - description: HomeDir specifies the home directory to use for + description: homeDir specifies the home directory to use for the user type: string inactive: - description: Inactive specifies whether to mark the user as + description: inactive specifies whether to mark the user as inactive type: boolean lockPassword: - description: LockPassword specifies if password login should + description: lockPassword specifies if password login should be disabled type: boolean name: - description: Name specifies the user name + description: name specifies the user name type: string passwd: - description: Passwd specifies a hashed password for the user + description: passwd specifies a hashed password for the user type: string primaryGroup: - description: PrimaryGroup specifies the primary group for the + description: primaryGroup specifies the primary group for the user type: string shell: - description: Shell specifies the user's shell + description: shell specifies the user's shell type: string sshAuthorizedKeys: - description: SSHAuthorizedKeys specifies a list of ssh authorized + description: sshAuthorizedKeys specifies a list of ssh authorized keys for the user items: type: string type: array sudo: - description: Sudo specifies a sudo role for the user + description: sudo specifies a sudo role for the user type: string required: - name @@ -931,7 +931,7 @@ spec: type: array verbosity: description: |- - Verbosity is the number for the kubeadm log level verbosity. + verbosity is the number for the kubeadm log level verbosity. It overrides the `--v` flag in kubeadm commands. format: int32 type: integer @@ -941,13 +941,13 @@ spec: properties: bootstrapData: description: |- - BootstrapData will be a cloud-init script for now. + bootstrapData will be a cloud-init script for now. Deprecated: Switch to DataSecretName. format: byte type: string conditions: - description: Conditions defines current service state of the KubeadmConfig. + description: conditions defines current service state of the KubeadmConfig. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -972,16 +972,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -991,22 +991,22 @@ spec: type: object type: array dataSecretName: - description: DataSecretName is the name of the secret that stores + description: dataSecretName is the name of the secret that stores the bootstrap data script. type: string failureMessage: - description: FailureMessage will be set on non-retryable errors + description: failureMessage will be set on non-retryable errors type: string failureReason: - description: FailureReason will be set on non-retryable errors + description: failureReason will be set on non-retryable errors type: string observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer ready: - description: Ready indicates the BootstrapData field is ready to be + description: ready indicates the BootstrapData field is ready to be consumed type: boolean type: object @@ -1052,15 +1052,15 @@ spec: Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. properties: clusterConfiguration: - description: ClusterConfiguration along with InitConfiguration are + description: clusterConfiguration along with InitConfiguration are the configurations necessary for the init command properties: apiServer: - description: APIServer contains extra settings for the API server + description: apiServer contains extra settings for the API server control plane component properties: certSANs: - description: CertSANs sets extra Subject Alternative Names + description: certSANs sets extra Subject Alternative Names for the API Server signing cert. items: type: string @@ -1068,11 +1068,11 @@ spec: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to pass to + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraVolumes: - description: ExtraVolumes is an extra set of host volumes, + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -1081,21 +1081,21 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the pod where + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod template. + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access to the volume + description: readOnly controls write access to the volume type: boolean required: - hostPath @@ -1104,7 +1104,7 @@ spec: type: object type: array timeoutForControlPlane: - description: TimeoutForControlPlane controls the timeout that + description: timeoutForControlPlane controls the timeout that we use for API server to appear type: string type: object @@ -1117,7 +1117,7 @@ spec: type: string certificatesDir: description: |- - CertificatesDir specifies where to store or look for all required certificates. + certificatesDir specifies where to store or look for all required certificates. NB: if not provided, this will default to `/etc/kubernetes/pki` type: string clusterName: @@ -1125,7 +1125,7 @@ spec: type: string controlPlaneEndpoint: description: |- - ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it + controlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort are used; in case the ControlPlaneEndpoint is specified but without a TCP port, @@ -1139,17 +1139,17 @@ spec: NB: This value defaults to the first value in the Cluster object status.apiEndpoints array. type: string controllerManager: - description: ControllerManager contains extra settings for the + description: controllerManager contains extra settings for the controller manager control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to pass to + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraVolumes: - description: ExtraVolumes is an extra set of host volumes, + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -1158,21 +1158,21 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the pod where + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod template. + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access to the volume + description: readOnly controls write access to the volume type: boolean required: - hostPath @@ -1182,48 +1182,48 @@ spec: type: array type: object dns: - description: DNS defines the options for the DNS add-on installed + description: dns defines the options for the DNS add-on installed in the cluster. properties: imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string type: object etcd: description: |- - Etcd holds configuration for etcd. + etcd holds configuration for etcd. NB: This value defaults to a Local (stacked) etcd properties: external: description: |- - External describes how to connect to an external etcd cluster + external describes how to connect to an external etcd cluster Local and External are mutually exclusive properties: caFile: description: |- - CAFile is an SSL Certificate Authority file used to secure etcd communication. + caFile is an SSL Certificate Authority file used to secure etcd communication. Required if using a TLS connection. type: string certFile: description: |- - CertFile is an SSL certification file used to secure etcd communication. + certFile is an SSL certification file used to secure etcd communication. Required if using a TLS connection. type: string endpoints: - description: Endpoints of etcd members. Required for ExternalEtcd. + description: endpoints of etcd members. Required for ExternalEtcd. items: type: string type: array keyFile: description: |- - KeyFile is an SSL key file used to secure etcd communication. + keyFile is an SSL key file used to secure etcd communication. Required if using a TLS connection. type: string required: @@ -1234,39 +1234,39 @@ spec: type: object local: description: |- - Local provides configuration knobs for configuring the local etcd instance + local provides configuration knobs for configuring the local etcd instance Local and External are mutually exclusive properties: dataDir: description: |- - DataDir is the directory etcd will place its data. + dataDir is the directory etcd will place its data. Defaults to "/var/lib/etcd". type: string extraArgs: additionalProperties: type: string description: |- - ExtraArgs are extra arguments provided to the etcd binary + extraArgs are extra arguments provided to the etcd binary when run inside a static pod. type: object imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string peerCertSANs: - description: PeerCertSANs sets extra Subject Alternative + description: peerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. items: type: string type: array serverCertSANs: - description: ServerCertSANs sets extra Subject Alternative + description: serverCertSANs sets extra Subject Alternative Names for the etcd server signing cert. items: type: string @@ -1276,11 +1276,11 @@ spec: featureGates: additionalProperties: type: boolean - description: FeatureGates enabled by the user. + description: featureGates enabled by the user. type: object imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. If empty, `registry.k8s.io` will be used by default; in case of kubernetes version is a CI build (kubernetes version starts with `ci/` or `ci-cross/`) `gcr.io/k8s-staging-ci-images` will be used as a default for control plane components and for kube-proxy, while `registry.k8s.io` will be used for all the other images. @@ -1295,43 +1295,43 @@ spec: type: string kubernetesVersion: description: |- - KubernetesVersion is the target version of the control plane. + kubernetesVersion is the target version of the control plane. NB: This value defaults to the Machine object spec.version type: string networking: description: |- - Networking holds configuration for the networking topology of the cluster. + networking holds configuration for the networking topology of the cluster. NB: This value defaults to the Cluster object spec.clusterNetwork. properties: dnsDomain: - description: DNSDomain is the dns domain used by k8s services. + description: dnsDomain is the dns domain used by k8s services. Defaults to "cluster.local". type: string podSubnet: description: |- - PodSubnet is the subnet used by pods. + podSubnet is the subnet used by pods. If unset, the API server will not allocate CIDR ranges for every node. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.services.cidrBlocks if that is set type: string serviceSubnet: description: |- - ServiceSubnet is the subnet used by k8s services. + serviceSubnet is the subnet used by k8s services. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.pods.cidrBlocks, or to "10.96.0.0/12" if that's unset. type: string type: object scheduler: - description: Scheduler contains extra settings for the scheduler + description: scheduler contains extra settings for the scheduler control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to pass to + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraVolumes: - description: ExtraVolumes is an extra set of host volumes, + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -1340,21 +1340,21 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the pod where + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod template. + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access to the volume + description: readOnly controls write access to the volume type: boolean required: - hostPath @@ -1365,44 +1365,44 @@ spec: type: object type: object diskSetup: - description: DiskSetup specifies options for the creation of partition + description: diskSetup specifies options for the creation of partition tables and file systems on devices. properties: filesystems: - description: Filesystems specifies the list of file systems to + description: filesystems specifies the list of file systems to setup. items: description: Filesystem defines the file systems to be created. properties: device: - description: Device specifies the device name + description: device specifies the device name type: string extraOpts: - description: ExtraOpts defined extra options to add to the + description: extraOpts defined extra options to add to the command for creating the file system. items: type: string type: array filesystem: - description: Filesystem specifies the file system type. + description: filesystem specifies the file system type. type: string label: - description: Label specifies the file system label to be + description: label specifies the file system label to be used. If set to None, no label is used. type: string overwrite: description: |- - Overwrite defines whether or not to overwrite any existing filesystem. + overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution. type: boolean partition: - description: 'Partition specifies the partition to use. + description: 'partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number.' type: string replaceFS: description: |- - ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the 'any' partition directive. type: string required: @@ -1412,28 +1412,28 @@ spec: type: object type: array partitions: - description: Partitions specifies the list of the partitions to + description: partitions specifies the list of the partitions to setup. items: description: Partition defines how to create and layout a partition. properties: device: - description: Device is the name of the device. + description: device is the name of the device. type: string layout: description: |- - Layout specifies the device layout. + layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don't partition or ignore existing partitioning. type: boolean overwrite: description: |- - Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is 'false'. type: boolean tableType: description: |- - TableType specifies the tupe of partition table. The following are supported: + tableType specifies the tupe of partition table. The following are supported: 'mbr': default and setups a MS-DOS partition table 'gpt': setups a GPT partition table type: string @@ -1444,29 +1444,29 @@ spec: type: array type: object files: - description: Files specifies extra files to be passed to user_data + description: files specifies extra files to be passed to user_data upon creation. items: description: File defines the input for generating write_files in cloud-init. properties: content: - description: Content is the actual content of the file. + description: content is the actual content of the file. type: string contentFrom: - description: ContentFrom is a referenced source of content to + description: contentFrom is a referenced source of content to populate the file. properties: secret: - description: Secret represents a secret that should populate + description: secret represents a secret that should populate this file. properties: key: - description: Key is the key in the secret's data map + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -1477,22 +1477,22 @@ spec: - secret type: object encoding: - description: Encoding specifies the encoding of the file contents. + description: encoding specifies the encoding of the file contents. enum: - base64 - gzip - gzip+base64 type: string owner: - description: Owner specifies the ownership of the file, e.g. + description: owner specifies the ownership of the file, e.g. "root:root". type: string path: - description: Path specifies the full path on disk where to store + description: path specifies the full path on disk where to store the file. type: string permissions: - description: Permissions specifies the permissions to assign + description: permissions specifies the permissions to assign to the file, e.g. "0640". type: string required: @@ -1500,12 +1500,12 @@ spec: type: object type: array format: - description: Format specifies the output format of the bootstrap data + description: format specifies the output format of the bootstrap data enum: - cloud-config type: string initConfiguration: - description: InitConfiguration along with ClusterConfiguration are + description: initConfiguration along with ClusterConfiguration are the configurations necessary for the init command properties: apiVersion: @@ -1517,7 +1517,7 @@ spec: type: string bootstrapTokens: description: |- - BootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. + bootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature items: description: BootstrapToken describes one bootstrap token, stored @@ -1525,35 +1525,35 @@ spec: properties: description: description: |- - Description sets a human-friendly message why this token exists and what it's used + description sets a human-friendly message why this token exists and what it's used for, so other administrators can know its purpose. type: string expires: description: |- - Expires specifies the timestamp when this token expires. Defaults to being set + expires specifies the timestamp when this token expires. Defaults to being set dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive. format: date-time type: string groups: description: |- - Groups specifies the extra groups that this token will authenticate as when/if + groups specifies the extra groups that this token will authenticate as when/if used for authentication items: type: string type: array token: description: |- - Token is used for establishing bidirectional trust between nodes and control-planes. + token is used for establishing bidirectional trust between nodes and control-planes. Used for joining nodes in the cluster. type: string ttl: description: |- - TTL defines the time to live for this token. Defaults to 24h. + ttl defines the time to live for this token. Defaults to 24h. Expires and TTL are mutually exclusive. type: string usages: description: |- - Usages describes the ways in which this token can be used. Can by default be used + usages describes the ways in which this token can be used. Can by default be used for establishing bidirectional trust, but that can be changed here. items: type: string @@ -1572,7 +1572,7 @@ spec: type: string localAPIEndpoint: description: |- - LocalAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node + localAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible @@ -1580,29 +1580,29 @@ spec: fails you may set the desired value here. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address for the + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container runtime + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a slice of pre-flight + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: type: string @@ -1611,19 +1611,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: {}` in the YAML file. This field is solely used for Node registration. items: @@ -1659,7 +1659,7 @@ spec: type: object type: object joinConfiguration: - description: JoinConfiguration is the kubeadm configuration for the + description: joinConfiguration is the kubeadm configuration for the join command properties: apiVersion: @@ -1671,47 +1671,47 @@ spec: type: string caCertPath: description: |- - CACertPath is the path to the SSL certificate authority used to + caCertPath is the path to the SSL certificate authority used to secure comunications between node and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt". type: string controlPlane: description: |- - ControlPlane defines the additional control plane instance to be deployed on the joining node. + controlPlane defines the additional control plane instance to be deployed on the joining node. If nil, no additional control plane instance will be deployed. properties: localAPIEndpoint: - description: LocalAPIEndpoint represents the endpoint of the + description: localAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address for + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object type: object discovery: - description: Discovery specifies the options for the kubelet to + description: discovery specifies the options for the kubelet to use during the TLS Bootstrap process properties: bootstrapToken: description: |- - BootstrapToken is used to set the options for bootstrap token based discovery + bootstrapToken is used to set the options for bootstrap token based discovery BootstrapToken and File are mutually exclusive properties: apiServerEndpoint: - description: APIServerEndpoint is an IP or domain name + description: apiServerEndpoint is an IP or domain name to the API server from which info will be fetched. type: string caCertHashes: description: |- - CACertHashes specifies a set of public key pins to verify + caCertHashes specifies a set of public key pins to verify when token-based discovery is used. The root CA found during discovery must match one of these values. Specifying an empty set disables root CA pinning, which can be unsafe. Each hash is specified as ":", @@ -1724,12 +1724,12 @@ spec: type: array token: description: |- - Token is a token used to validate cluster information + token is a token used to validate cluster information fetched from the control-plane. type: string unsafeSkipCAVerification: description: |- - UnsafeSkipCAVerification allows token-based discovery + unsafeSkipCAVerification allows token-based discovery without CA verification via CACertHashes. This can weaken the security of kubeadm since other nodes can impersonate the control-plane. type: boolean @@ -1738,11 +1738,11 @@ spec: type: object file: description: |- - File is used to specify a file or URL to a kubeconfig file from which to load cluster information + file is used to specify a file or URL to a kubeconfig file from which to load cluster information BootstrapToken and File are mutually exclusive properties: kubeConfigPath: - description: KubeConfigPath is used to specify the actual + description: kubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information type: string @@ -1750,11 +1750,11 @@ spec: - kubeConfigPath type: object timeout: - description: Timeout modifies the discovery timeout + description: timeout modifies the discovery timeout type: string tlsBootstrapToken: description: |- - TLSBootstrapToken is a token used for TLS bootstrapping. + tlsBootstrapToken is a token used for TLS bootstrapping. If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. If .File is set, this field **must be set** in case the KubeConfigFile does not contain any other authentication information type: string @@ -1769,17 +1769,17 @@ spec: type: string nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container runtime + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a slice of pre-flight + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: type: string @@ -1788,19 +1788,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: {}` in the YAML file. This field is solely used for Node registration. items: @@ -1836,7 +1836,7 @@ spec: type: object type: object mounts: - description: Mounts specifies a list of mount points to be setup. + description: mounts specifies a list of mount points to be setup. items: description: MountPoints defines input for generated mounts in cloud-init. items: @@ -1844,32 +1844,32 @@ spec: type: array type: array ntp: - description: NTP specifies NTP configuration + description: ntp specifies NTP configuration properties: enabled: - description: Enabled specifies whether NTP should be enabled + description: enabled specifies whether NTP should be enabled type: boolean servers: - description: Servers specifies which NTP servers to use + description: servers specifies which NTP servers to use items: type: string type: array type: object postKubeadmCommands: - description: PostKubeadmCommands specifies extra commands to run after + description: postKubeadmCommands specifies extra commands to run after kubeadm runs items: type: string type: array preKubeadmCommands: - description: PreKubeadmCommands specifies extra commands to run before + description: preKubeadmCommands specifies extra commands to run before kubeadm runs items: type: string type: array useExperimentalRetryJoin: description: |- - UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + useExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments @@ -1881,50 +1881,50 @@ spec: For more information, refer to https://github.com/kubernetes-sigs/cluster-api/pull/2763#discussion_r397306055. type: boolean users: - description: Users specifies extra users to add + description: users specifies extra users to add items: description: User defines the input for a generated user in cloud-init. properties: gecos: - description: Gecos specifies the gecos to use for the user + description: gecos specifies the gecos to use for the user type: string groups: - description: Groups specifies the additional groups for the + description: groups specifies the additional groups for the user type: string homeDir: - description: HomeDir specifies the home directory to use for + description: homeDir specifies the home directory to use for the user type: string inactive: - description: Inactive specifies whether to mark the user as + description: inactive specifies whether to mark the user as inactive type: boolean lockPassword: - description: LockPassword specifies if password login should + description: lockPassword specifies if password login should be disabled type: boolean name: - description: Name specifies the user name + description: name specifies the user name type: string passwd: - description: Passwd specifies a hashed password for the user + description: passwd specifies a hashed password for the user type: string primaryGroup: - description: PrimaryGroup specifies the primary group for the + description: primaryGroup specifies the primary group for the user type: string shell: - description: Shell specifies the user's shell + description: shell specifies the user's shell type: string sshAuthorizedKeys: - description: SSHAuthorizedKeys specifies a list of ssh authorized + description: sshAuthorizedKeys specifies a list of ssh authorized keys for the user items: type: string type: array sudo: - description: Sudo specifies a sudo role for the user + description: sudo specifies a sudo role for the user type: string required: - name @@ -1932,7 +1932,7 @@ spec: type: array verbosity: description: |- - Verbosity is the number for the kubeadm log level verbosity. + verbosity is the number for the kubeadm log level verbosity. It overrides the `--v` flag in kubeadm commands. format: int32 type: integer @@ -1941,7 +1941,7 @@ spec: description: KubeadmConfigStatus defines the observed state of KubeadmConfig. properties: conditions: - description: Conditions defines current service state of the KubeadmConfig. + description: conditions defines current service state of the KubeadmConfig. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -1966,16 +1966,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -1985,22 +1985,22 @@ spec: type: object type: array dataSecretName: - description: DataSecretName is the name of the secret that stores + description: dataSecretName is the name of the secret that stores the bootstrap data script. type: string failureMessage: - description: FailureMessage will be set on non-retryable errors + description: failureMessage will be set on non-retryable errors type: string failureReason: - description: FailureReason will be set on non-retryable errors + description: failureReason will be set on non-retryable errors type: string observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer ready: - description: Ready indicates the BootstrapData field is ready to be + description: ready indicates the BootstrapData field is ready to be consumed type: boolean type: object @@ -2046,15 +2046,15 @@ spec: Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. properties: clusterConfiguration: - description: ClusterConfiguration along with InitConfiguration are + description: clusterConfiguration along with InitConfiguration are the configurations necessary for the init command properties: apiServer: - description: APIServer contains extra settings for the API server + description: apiServer contains extra settings for the API server control plane component properties: certSANs: - description: CertSANs sets extra Subject Alternative Names + description: certSANs sets extra Subject Alternative Names for the API Server signing cert. items: type: string @@ -2062,12 +2062,12 @@ spec: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to pass to + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -2189,7 +2189,7 @@ spec: type: object type: array extraVolumes: - description: ExtraVolumes is an extra set of host volumes, + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -2198,21 +2198,21 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the pod where + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod template. + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access to the volume + description: readOnly controls write access to the volume type: boolean required: - hostPath @@ -2221,7 +2221,7 @@ spec: type: object type: array timeoutForControlPlane: - description: TimeoutForControlPlane controls the timeout that + description: timeoutForControlPlane controls the timeout that we use for API server to appear type: string type: object @@ -2234,7 +2234,7 @@ spec: type: string certificatesDir: description: |- - CertificatesDir specifies where to store or look for all required certificates. + certificatesDir specifies where to store or look for all required certificates. NB: if not provided, this will default to `/etc/kubernetes/pki` type: string clusterName: @@ -2242,7 +2242,7 @@ spec: type: string controlPlaneEndpoint: description: |- - ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it + controlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort are used; in case the ControlPlaneEndpoint is specified but without a TCP port, @@ -2256,18 +2256,18 @@ spec: NB: This value defaults to the first value in the Cluster object status.apiEndpoints array. type: string controllerManager: - description: ControllerManager contains extra settings for the + description: controllerManager contains extra settings for the controller manager control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to pass to + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -2389,7 +2389,7 @@ spec: type: object type: array extraVolumes: - description: ExtraVolumes is an extra set of host volumes, + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -2398,21 +2398,21 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the pod where + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod template. + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access to the volume + description: readOnly controls write access to the volume type: boolean required: - hostPath @@ -2422,48 +2422,48 @@ spec: type: array type: object dns: - description: DNS defines the options for the DNS add-on installed + description: dns defines the options for the DNS add-on installed in the cluster. properties: imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string type: object etcd: description: |- - Etcd holds configuration for etcd. + etcd holds configuration for etcd. NB: This value defaults to a Local (stacked) etcd properties: external: description: |- - External describes how to connect to an external etcd cluster + external describes how to connect to an external etcd cluster Local and External are mutually exclusive properties: caFile: description: |- - CAFile is an SSL Certificate Authority file used to secure etcd communication. + caFile is an SSL Certificate Authority file used to secure etcd communication. Required if using a TLS connection. type: string certFile: description: |- - CertFile is an SSL certification file used to secure etcd communication. + certFile is an SSL certification file used to secure etcd communication. Required if using a TLS connection. type: string endpoints: - description: Endpoints of etcd members. Required for ExternalEtcd. + description: endpoints of etcd members. Required for ExternalEtcd. items: type: string type: array keyFile: description: |- - KeyFile is an SSL key file used to secure etcd communication. + keyFile is an SSL key file used to secure etcd communication. Required if using a TLS connection. type: string required: @@ -2474,24 +2474,24 @@ spec: type: object local: description: |- - Local provides configuration knobs for configuring the local etcd instance + local provides configuration knobs for configuring the local etcd instance Local and External are mutually exclusive properties: dataDir: description: |- - DataDir is the directory etcd will place its data. + dataDir is the directory etcd will place its data. Defaults to "/var/lib/etcd". type: string extraArgs: additionalProperties: type: string description: |- - ExtraArgs are extra arguments provided to the etcd binary + extraArgs are extra arguments provided to the etcd binary when run inside a static pod. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -2615,22 +2615,22 @@ spec: type: array imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string peerCertSANs: - description: PeerCertSANs sets extra Subject Alternative + description: peerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. items: type: string type: array serverCertSANs: - description: ServerCertSANs sets extra Subject Alternative + description: serverCertSANs sets extra Subject Alternative Names for the etcd server signing cert. items: type: string @@ -2640,11 +2640,11 @@ spec: featureGates: additionalProperties: type: boolean - description: FeatureGates enabled by the user. + description: featureGates enabled by the user. type: object imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. * If not set, the default registry of kubeadm will be used, i.e. * registry.k8s.io (new registry): >= v1.22.17, >= v1.23.15, >= v1.24.9, >= v1.25.0 * k8s.gcr.io (old registry): all older versions @@ -2666,44 +2666,44 @@ spec: type: string kubernetesVersion: description: |- - KubernetesVersion is the target version of the control plane. + kubernetesVersion is the target version of the control plane. NB: This value defaults to the Machine object spec.version type: string networking: description: |- - Networking holds configuration for the networking topology of the cluster. + networking holds configuration for the networking topology of the cluster. NB: This value defaults to the Cluster object spec.clusterNetwork. properties: dnsDomain: - description: DNSDomain is the dns domain used by k8s services. + description: dnsDomain is the dns domain used by k8s services. Defaults to "cluster.local". type: string podSubnet: description: |- - PodSubnet is the subnet used by pods. + podSubnet is the subnet used by pods. If unset, the API server will not allocate CIDR ranges for every node. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.services.cidrBlocks if that is set type: string serviceSubnet: description: |- - ServiceSubnet is the subnet used by k8s services. + serviceSubnet is the subnet used by k8s services. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.pods.cidrBlocks, or to "10.96.0.0/12" if that's unset. type: string type: object scheduler: - description: Scheduler contains extra settings for the scheduler + description: scheduler contains extra settings for the scheduler control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to pass to + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -2825,7 +2825,7 @@ spec: type: object type: array extraVolumes: - description: ExtraVolumes is an extra set of host volumes, + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -2834,21 +2834,21 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the pod where + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod template. + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access to the volume + description: readOnly controls write access to the volume type: boolean required: - hostPath @@ -2859,44 +2859,44 @@ spec: type: object type: object diskSetup: - description: DiskSetup specifies options for the creation of partition + description: diskSetup specifies options for the creation of partition tables and file systems on devices. properties: filesystems: - description: Filesystems specifies the list of file systems to + description: filesystems specifies the list of file systems to setup. items: description: Filesystem defines the file systems to be created. properties: device: - description: Device specifies the device name + description: device specifies the device name type: string extraOpts: - description: ExtraOpts defined extra options to add to the + description: extraOpts defined extra options to add to the command for creating the file system. items: type: string type: array filesystem: - description: Filesystem specifies the file system type. + description: filesystem specifies the file system type. type: string label: - description: Label specifies the file system label to be + description: label specifies the file system label to be used. If set to None, no label is used. type: string overwrite: description: |- - Overwrite defines whether or not to overwrite any existing filesystem. + overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution. type: boolean partition: - description: 'Partition specifies the partition to use. + description: 'partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number.' type: string replaceFS: description: |- - ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the 'any' partition directive. type: string required: @@ -2906,28 +2906,28 @@ spec: type: object type: array partitions: - description: Partitions specifies the list of the partitions to + description: partitions specifies the list of the partitions to setup. items: description: Partition defines how to create and layout a partition. properties: device: - description: Device is the name of the device. + description: device is the name of the device. type: string layout: description: |- - Layout specifies the device layout. + layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don't partition or ignore existing partitioning. type: boolean overwrite: description: |- - Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is 'false'. type: boolean tableType: description: |- - TableType specifies the tupe of partition table. The following are supported: + tableType specifies the tupe of partition table. The following are supported: 'mbr': default and setups a MS-DOS partition table 'gpt': setups a GPT partition table type: string @@ -2938,33 +2938,33 @@ spec: type: array type: object files: - description: Files specifies extra files to be passed to user_data + description: files specifies extra files to be passed to user_data upon creation. items: description: File defines the input for generating write_files in cloud-init. properties: append: - description: Append specifies whether to append Content to existing + description: append specifies whether to append Content to existing file if Path exists. type: boolean content: - description: Content is the actual content of the file. + description: content is the actual content of the file. type: string contentFrom: - description: ContentFrom is a referenced source of content to + description: contentFrom is a referenced source of content to populate the file. properties: secret: - description: Secret represents a secret that should populate + description: secret represents a secret that should populate this file. properties: key: - description: Key is the key in the secret's data map + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -2975,22 +2975,22 @@ spec: - secret type: object encoding: - description: Encoding specifies the encoding of the file contents. + description: encoding specifies the encoding of the file contents. enum: - base64 - gzip - gzip+base64 type: string owner: - description: Owner specifies the ownership of the file, e.g. + description: owner specifies the ownership of the file, e.g. "root:root". type: string path: - description: Path specifies the full path on disk where to store + description: path specifies the full path on disk where to store the file. type: string permissions: - description: Permissions specifies the permissions to assign + description: permissions specifies the permissions to assign to the file, e.g. "0640". type: string required: @@ -2998,32 +2998,32 @@ spec: type: object type: array format: - description: Format specifies the output format of the bootstrap data + description: format specifies the output format of the bootstrap data enum: - cloud-config - ignition type: string ignition: - description: Ignition contains Ignition specific configuration. + description: ignition contains Ignition specific configuration. properties: containerLinuxConfig: - description: ContainerLinuxConfig contains CLC specific configuration. + description: containerLinuxConfig contains CLC specific configuration. properties: additionalConfig: description: |- - AdditionalConfig contains additional configuration to be merged with the Ignition + additionalConfig contains additional configuration to be merged with the Ignition configuration generated by the bootstrapper controller. More info: https://coreos.github.io/ignition/operator-notes/#config-merging The data format is documented here: https://kinvolk.io/docs/flatcar-container-linux/latest/provisioning/cl-config/ type: string strict: - description: Strict controls if AdditionalConfig should be + description: strict controls if AdditionalConfig should be strictly parsed. If so, warnings are treated as errors. type: boolean type: object type: object initConfiguration: - description: InitConfiguration along with ClusterConfiguration are + description: initConfiguration along with ClusterConfiguration are the configurations necessary for the init command properties: apiVersion: @@ -3035,7 +3035,7 @@ spec: type: string bootstrapTokens: description: |- - BootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. + bootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature items: description: BootstrapToken describes one bootstrap token, stored @@ -3043,35 +3043,35 @@ spec: properties: description: description: |- - Description sets a human-friendly message why this token exists and what it's used + description sets a human-friendly message why this token exists and what it's used for, so other administrators can know its purpose. type: string expires: description: |- - Expires specifies the timestamp when this token expires. Defaults to being set + expires specifies the timestamp when this token expires. Defaults to being set dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive. format: date-time type: string groups: description: |- - Groups specifies the extra groups that this token will authenticate as when/if + groups specifies the extra groups that this token will authenticate as when/if used for authentication items: type: string type: array token: description: |- - Token is used for establishing bidirectional trust between nodes and control-planes. + token is used for establishing bidirectional trust between nodes and control-planes. Used for joining nodes in the cluster. type: string ttl: description: |- - TTL defines the time to live for this token. Defaults to 24h. + ttl defines the time to live for this token. Defaults to 24h. Expires and TTL are mutually exclusive. type: string usages: description: |- - Usages describes the ways in which this token can be used. Can by default be used + usages describes the ways in which this token can be used. Can by default be used for establishing bidirectional trust, but that can be changed here. items: type: string @@ -3090,7 +3090,7 @@ spec: type: string localAPIEndpoint: description: |- - LocalAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node + localAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible @@ -3098,36 +3098,36 @@ spec: fails you may set the desired value here. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address for the + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container runtime + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a slice of pre-flight + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: type: string type: array imagePullPolicy: description: |- - ImagePullPolicy specifies the policy for image pulling + imagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations. The value of this field must be one of "Always", "IfNotPresent" or "Never". Defaults to "IfNotPresent". This can be used only @@ -3139,7 +3139,7 @@ spec: type: string imagePullSerial: description: |- - ImagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. + imagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. This option takes effect only on Kubernetes >=1.31.0. Default: true (defaulted in kubeadm) type: boolean @@ -3147,19 +3147,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: []` in the YAML file. This field is solely used for Node registration. items: @@ -3195,12 +3195,12 @@ spec: type: object patches: description: |- - Patches contains options related to applying patches to components deployed by kubeadm during + patches contains options related to applying patches to components deployed by kubeadm during "kubeadm init". The minimum kubernetes version needed to support Patches is v1.22 properties: directory: description: |- - Directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". + directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of "kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". "patchtype" can be one of "strategic" "merge" or "json" and they match the patch formats supported by kubectl. @@ -3214,7 +3214,7 @@ spec: type: object skipPhases: description: |- - SkipPhases is a list of phases to skip during command execution. + skipPhases is a list of phases to skip during command execution. The list of phases can be obtained with the "kubeadm init --help" command. This option takes effect only on Kubernetes >=1.22.0. items: @@ -3222,7 +3222,7 @@ spec: type: array type: object joinConfiguration: - description: JoinConfiguration is the kubeadm configuration for the + description: joinConfiguration is the kubeadm configuration for the join command properties: apiVersion: @@ -3234,47 +3234,47 @@ spec: type: string caCertPath: description: |- - CACertPath is the path to the SSL certificate authority used to + caCertPath is the path to the SSL certificate authority used to secure comunications between node and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt". type: string controlPlane: description: |- - ControlPlane defines the additional control plane instance to be deployed on the joining node. + controlPlane defines the additional control plane instance to be deployed on the joining node. If nil, no additional control plane instance will be deployed. properties: localAPIEndpoint: - description: LocalAPIEndpoint represents the endpoint of the + description: localAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address for + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object type: object discovery: - description: Discovery specifies the options for the kubelet to + description: discovery specifies the options for the kubelet to use during the TLS Bootstrap process properties: bootstrapToken: description: |- - BootstrapToken is used to set the options for bootstrap token based discovery + bootstrapToken is used to set the options for bootstrap token based discovery BootstrapToken and File are mutually exclusive properties: apiServerEndpoint: - description: APIServerEndpoint is an IP or domain name + description: apiServerEndpoint is an IP or domain name to the API server from which info will be fetched. type: string caCertHashes: description: |- - CACertHashes specifies a set of public key pins to verify + caCertHashes specifies a set of public key pins to verify when token-based discovery is used. The root CA found during discovery must match one of these values. Specifying an empty set disables root CA pinning, which can be unsafe. Each hash is specified as ":", @@ -3287,12 +3287,12 @@ spec: type: array token: description: |- - Token is a token used to validate cluster information + token is a token used to validate cluster information fetched from the control-plane. type: string unsafeSkipCAVerification: description: |- - UnsafeSkipCAVerification allows token-based discovery + unsafeSkipCAVerification allows token-based discovery without CA verification via CACertHashes. This can weaken the security of kubeadm since other nodes can impersonate the control-plane. type: boolean @@ -3301,12 +3301,12 @@ spec: type: object file: description: |- - File is used to specify a file or URL to a kubeconfig file from which to load cluster information + file is used to specify a file or URL to a kubeconfig file from which to load cluster information BootstrapToken and File are mutually exclusive properties: kubeConfig: description: |- - KubeConfig is used (optionally) to generate a KubeConfig based on the KubeadmConfig's information. + kubeConfig is used (optionally) to generate a KubeConfig based on the KubeadmConfig's information. The file is generated at the path specified in KubeConfigPath. Host address (server field) information is automatically populated based on the Cluster's ControlPlaneEndpoint. @@ -3314,7 +3314,7 @@ spec: properties: cluster: description: |- - Cluster contains information about how to communicate with the kubernetes cluster. + cluster contains information about how to communicate with the kubernetes cluster. By default the following fields are automatically populated: - Server with the Cluster's ControlPlaneEndpoint. @@ -3322,19 +3322,19 @@ spec: properties: certificateAuthorityData: description: |- - CertificateAuthorityData contains PEM-encoded certificate authority certificates. + certificateAuthorityData contains PEM-encoded certificate authority certificates. Defaults to the Cluster's CA certificate if empty. format: byte type: string insecureSkipTLSVerify: - description: InsecureSkipTLSVerify skips the validity + description: insecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure. type: boolean proxyURL: description: |- - ProxyURL is the URL to the proxy to be used for all requests made by this + proxyURL is the URL to the proxy to be used for all requests made by this client. URLs with "http", "https", and "socks5" schemes are supported. If this configuration is not provided or the empty string, the client attempts to construct a proxy configuration from http_proxy and @@ -3346,40 +3346,40 @@ spec: type: string server: description: |- - Server is the address of the kubernetes cluster (https://hostname:port). + server is the address of the kubernetes cluster (https://hostname:port). Defaults to https:// + Cluster.Spec.ControlPlaneEndpoint. type: string tlsServerName: - description: TLSServerName is used to check server + description: tlsServerName is used to check server certificate. If TLSServerName is empty, the hostname used to contact the server is used. type: string type: object user: description: |- - User contains information that describes identity information. + user contains information that describes identity information. This is used to tell the kubernetes cluster who you are. properties: authProvider: - description: AuthProvider specifies a custom authentication + description: authProvider specifies a custom authentication plugin for the kubernetes cluster. properties: config: additionalProperties: type: string - description: Config holds the parameters for + description: config holds the parameters for the authentication plugin. type: object name: - description: Name is the name of the authentication + description: name is the name of the authentication plugin. type: string required: - name type: object exec: - description: Exec specifies a custom exec-based + description: exec specifies a custom exec-based authentication plugin for the kubernetes cluster. properties: apiVersion: @@ -3395,11 +3395,11 @@ spec: type: string type: array command: - description: Command to execute. + description: command to execute. type: string env: description: |- - Env defines additional environment variables to expose to the process. These + env defines additional environment variables to expose to the process. These are unioned with the host's environment, as well as variables client-go uses to pass argument to the plugin. items: @@ -3418,7 +3418,7 @@ spec: type: array provideClusterInfo: description: |- - ProvideClusterInfo determines whether or not to provide cluster information, + provideClusterInfo determines whether or not to provide cluster information, which could potentially contain very large CA data, to this exec plugin as a part of the KUBERNETES_EXEC_INFO environment variable. By default, it is set to false. Package k8s.io/client-go/tools/auth/exec provides helper methods for @@ -3432,7 +3432,7 @@ spec: - user type: object kubeConfigPath: - description: KubeConfigPath is used to specify the actual + description: kubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information type: string @@ -3440,11 +3440,11 @@ spec: - kubeConfigPath type: object timeout: - description: Timeout modifies the discovery timeout + description: timeout modifies the discovery timeout type: string tlsBootstrapToken: description: |- - TLSBootstrapToken is a token used for TLS bootstrapping. + tlsBootstrapToken is a token used for TLS bootstrapping. If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. If .File is set, this field **must be set** in case the KubeConfigFile does not contain any other authentication information type: string @@ -3459,24 +3459,24 @@ spec: type: string nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container runtime + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a slice of pre-flight + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: type: string type: array imagePullPolicy: description: |- - ImagePullPolicy specifies the policy for image pulling + imagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations. The value of this field must be one of "Always", "IfNotPresent" or "Never". Defaults to "IfNotPresent". This can be used only @@ -3488,7 +3488,7 @@ spec: type: string imagePullSerial: description: |- - ImagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. + imagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. This option takes effect only on Kubernetes >=1.31.0. Default: true (defaulted in kubeadm) type: boolean @@ -3496,19 +3496,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: []` in the YAML file. This field is solely used for Node registration. items: @@ -3544,12 +3544,12 @@ spec: type: object patches: description: |- - Patches contains options related to applying patches to components deployed by kubeadm during + patches contains options related to applying patches to components deployed by kubeadm during "kubeadm join". The minimum kubernetes version needed to support Patches is v1.22 properties: directory: description: |- - Directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". + directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of "kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". "patchtype" can be one of "strategic" "merge" or "json" and they match the patch formats supported by kubectl. @@ -3563,7 +3563,7 @@ spec: type: object skipPhases: description: |- - SkipPhases is a list of phases to skip during command execution. + skipPhases is a list of phases to skip during command execution. The list of phases can be obtained with the "kubeadm init --help" command. This option takes effect only on Kubernetes >=1.22.0. items: @@ -3571,7 +3571,7 @@ spec: type: array type: object mounts: - description: Mounts specifies a list of mount points to be setup. + description: mounts specifies a list of mount points to be setup. items: description: MountPoints defines input for generated mounts in cloud-init. items: @@ -3579,32 +3579,32 @@ spec: type: array type: array ntp: - description: NTP specifies NTP configuration + description: ntp specifies NTP configuration properties: enabled: - description: Enabled specifies whether NTP should be enabled + description: enabled specifies whether NTP should be enabled type: boolean servers: - description: Servers specifies which NTP servers to use + description: servers specifies which NTP servers to use items: type: string type: array type: object postKubeadmCommands: - description: PostKubeadmCommands specifies extra commands to run after + description: postKubeadmCommands specifies extra commands to run after kubeadm runs items: type: string type: array preKubeadmCommands: - description: PreKubeadmCommands specifies extra commands to run before + description: preKubeadmCommands specifies extra commands to run before kubeadm runs items: type: string type: array useExperimentalRetryJoin: description: |- - UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + useExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments @@ -3619,49 +3619,49 @@ spec: When removing also remove from staticcheck exclude-rules for SA1019 in golangci.yml type: boolean users: - description: Users specifies extra users to add + description: users specifies extra users to add items: description: User defines the input for a generated user in cloud-init. properties: gecos: - description: Gecos specifies the gecos to use for the user + description: gecos specifies the gecos to use for the user type: string groups: - description: Groups specifies the additional groups for the + description: groups specifies the additional groups for the user type: string homeDir: - description: HomeDir specifies the home directory to use for + description: homeDir specifies the home directory to use for the user type: string inactive: - description: Inactive specifies whether to mark the user as + description: inactive specifies whether to mark the user as inactive type: boolean lockPassword: - description: LockPassword specifies if password login should + description: lockPassword specifies if password login should be disabled type: boolean name: - description: Name specifies the user name + description: name specifies the user name type: string passwd: - description: Passwd specifies a hashed password for the user + description: passwd specifies a hashed password for the user type: string passwdFrom: - description: PasswdFrom is a referenced source of passwd to + description: passwdFrom is a referenced source of passwd to populate the passwd. properties: secret: - description: Secret represents a secret that should populate + description: secret represents a secret that should populate this password. properties: key: - description: Key is the key in the secret's data map + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -3672,20 +3672,20 @@ spec: - secret type: object primaryGroup: - description: PrimaryGroup specifies the primary group for the + description: primaryGroup specifies the primary group for the user type: string shell: - description: Shell specifies the user's shell + description: shell specifies the user's shell type: string sshAuthorizedKeys: - description: SSHAuthorizedKeys specifies a list of ssh authorized + description: sshAuthorizedKeys specifies a list of ssh authorized keys for the user items: type: string type: array sudo: - description: Sudo specifies a sudo role for the user + description: sudo specifies a sudo role for the user type: string required: - name @@ -3693,7 +3693,7 @@ spec: type: array verbosity: description: |- - Verbosity is the number for the kubeadm log level verbosity. + verbosity is the number for the kubeadm log level verbosity. It overrides the `--v` flag in kubeadm commands. format: int32 type: integer @@ -3702,7 +3702,7 @@ spec: description: KubeadmConfigStatus defines the observed state of KubeadmConfig. properties: conditions: - description: Conditions defines current service state of the KubeadmConfig. + description: conditions defines current service state of the KubeadmConfig. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -3727,16 +3727,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -3747,28 +3747,28 @@ spec: type: object type: array dataSecretName: - description: DataSecretName is the name of the secret that stores + description: dataSecretName is the name of the secret that stores the bootstrap data script. type: string failureMessage: description: |- - FailureMessage will be set on non-retryable errors + failureMessage will be set on non-retryable errors Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details. type: string failureReason: description: |- - FailureReason will be set on non-retryable errors + failureReason will be set on non-retryable errors Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details. type: string observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer ready: - description: Ready indicates the BootstrapData field is ready to be + description: ready indicates the BootstrapData field is ready to be consumed type: boolean v1beta2: diff --git a/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigtemplates.yaml b/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigtemplates.yaml index 6b2a65bab791..23cfa5bbd1f0 100644 --- a/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigtemplates.yaml +++ b/bootstrap/kubeadm/config/crd/bases/bootstrap.cluster.x-k8s.io_kubeadmconfigtemplates.yaml @@ -54,7 +54,7 @@ spec: Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. properties: clusterConfiguration: - description: ClusterConfiguration along with InitConfiguration + description: clusterConfiguration along with InitConfiguration are the configurations necessary for the init command properties: apiServer: @@ -383,47 +383,47 @@ spec: type: boolean type: object diskSetup: - description: DiskSetup specifies options for the creation + description: diskSetup specifies options for the creation of partition tables and file systems on devices. properties: filesystems: - description: Filesystems specifies the list of file systems + description: filesystems specifies the list of file systems to setup. items: description: Filesystem defines the file systems to be created. properties: device: - description: Device specifies the device name + description: device specifies the device name type: string extraOpts: - description: ExtraOpts defined extra options to + description: extraOpts defined extra options to add to the command for creating the file system. items: type: string type: array filesystem: - description: Filesystem specifies the file system + description: filesystem specifies the file system type. type: string label: - description: Label specifies the file system label + description: label specifies the file system label to be used. If set to None, no label is used. type: string overwrite: description: |- - Overwrite defines whether or not to overwrite any existing filesystem. + overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution. type: boolean partition: - description: 'Partition specifies the partition + description: 'partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number.' type: string replaceFS: description: |- - ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the 'any' partition directive. type: string required: @@ -433,29 +433,29 @@ spec: type: object type: array partitions: - description: Partitions specifies the list of the partitions + description: partitions specifies the list of the partitions to setup. items: description: Partition defines how to create and layout a partition. properties: device: - description: Device is the name of the device. + description: device is the name of the device. type: string layout: description: |- - Layout specifies the device layout. + layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don't partition or ignore existing partitioning. type: boolean overwrite: description: |- - Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is 'false'. type: boolean tableType: description: |- - TableType specifies the tupe of partition table. The following are supported: + tableType specifies the tupe of partition table. The following are supported: 'mbr': default and setups a MS-DOS partition table 'gpt': setups a GPT partition table type: string @@ -466,29 +466,29 @@ spec: type: array type: object files: - description: Files specifies extra files to be passed to user_data + description: files specifies extra files to be passed to user_data upon creation. items: description: File defines the input for generating write_files in cloud-init. properties: content: - description: Content is the actual content of the file. + description: content is the actual content of the file. type: string contentFrom: - description: ContentFrom is a referenced source of content + description: contentFrom is a referenced source of content to populate the file. properties: secret: - description: Secret represents a secret that should + description: secret represents a secret that should populate this file. properties: key: - description: Key is the key in the secret's + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -499,7 +499,7 @@ spec: - secret type: object encoding: - description: Encoding specifies the encoding of the + description: encoding specifies the encoding of the file contents. enum: - base64 @@ -507,15 +507,15 @@ spec: - gzip+base64 type: string owner: - description: Owner specifies the ownership of the file, + description: owner specifies the ownership of the file, e.g. "root:root". type: string path: - description: Path specifies the full path on disk where + description: path specifies the full path on disk where to store the file. type: string permissions: - description: Permissions specifies the permissions to + description: permissions specifies the permissions to assign to the file, e.g. "0640". type: string required: @@ -523,13 +523,13 @@ spec: type: object type: array format: - description: Format specifies the output format of the bootstrap + description: format specifies the output format of the bootstrap data enum: - cloud-config type: string initConfiguration: - description: InitConfiguration along with ClusterConfiguration + description: initConfiguration along with ClusterConfiguration are the configurations necessary for the init command properties: apiVersion: @@ -680,7 +680,7 @@ spec: type: object type: object joinConfiguration: - description: JoinConfiguration is the kubeadm configuration + description: joinConfiguration is the kubeadm configuration for the join command properties: apiVersion: @@ -857,7 +857,7 @@ spec: type: object type: object mounts: - description: Mounts specifies a list of mount points to be + description: mounts specifies a list of mount points to be setup. items: description: MountPoints defines input for generated mounts @@ -867,32 +867,32 @@ spec: type: array type: array ntp: - description: NTP specifies NTP configuration + description: ntp specifies NTP configuration properties: enabled: - description: Enabled specifies whether NTP should be enabled + description: enabled specifies whether NTP should be enabled type: boolean servers: - description: Servers specifies which NTP servers to use + description: servers specifies which NTP servers to use items: type: string type: array type: object postKubeadmCommands: - description: PostKubeadmCommands specifies extra commands + description: postKubeadmCommands specifies extra commands to run after kubeadm runs items: type: string type: array preKubeadmCommands: - description: PreKubeadmCommands specifies extra commands to + description: preKubeadmCommands specifies extra commands to run before kubeadm runs items: type: string type: array useExperimentalRetryJoin: description: |- - UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + useExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments @@ -904,53 +904,53 @@ spec: For more information, refer to https://github.com/kubernetes-sigs/cluster-api/pull/2763#discussion_r397306055. type: boolean users: - description: Users specifies extra users to add + description: users specifies extra users to add items: description: User defines the input for a generated user in cloud-init. properties: gecos: - description: Gecos specifies the gecos to use for the + description: gecos specifies the gecos to use for the user type: string groups: - description: Groups specifies the additional groups + description: groups specifies the additional groups for the user type: string homeDir: - description: HomeDir specifies the home directory to + description: homeDir specifies the home directory to use for the user type: string inactive: - description: Inactive specifies whether to mark the + description: inactive specifies whether to mark the user as inactive type: boolean lockPassword: - description: LockPassword specifies if password login + description: lockPassword specifies if password login should be disabled type: boolean name: - description: Name specifies the user name + description: name specifies the user name type: string passwd: - description: Passwd specifies a hashed password for + description: passwd specifies a hashed password for the user type: string primaryGroup: - description: PrimaryGroup specifies the primary group + description: primaryGroup specifies the primary group for the user type: string shell: - description: Shell specifies the user's shell + description: shell specifies the user's shell type: string sshAuthorizedKeys: - description: SSHAuthorizedKeys specifies a list of ssh + description: sshAuthorizedKeys specifies a list of ssh authorized keys for the user items: type: string type: array sudo: - description: Sudo specifies a sudo role for the user + description: sudo specifies a sudo role for the user type: string required: - name @@ -958,7 +958,7 @@ spec: type: array verbosity: description: |- - Verbosity is the number for the kubeadm log level verbosity. + verbosity is the number for the kubeadm log level verbosity. It overrides the `--v` flag in kubeadm commands. format: int32 type: integer @@ -1013,15 +1013,15 @@ spec: Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. properties: clusterConfiguration: - description: ClusterConfiguration along with InitConfiguration + description: clusterConfiguration along with InitConfiguration are the configurations necessary for the init command properties: apiServer: - description: APIServer contains extra settings for the + description: apiServer contains extra settings for the API server control plane component properties: certSANs: - description: CertSANs sets extra Subject Alternative + description: certSANs sets extra Subject Alternative Names for the API Server signing cert. items: type: string @@ -1029,11 +1029,11 @@ spec: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraVolumes: - description: ExtraVolumes is an extra set of host + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -1042,22 +1042,22 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access + description: readOnly controls write access to the volume type: boolean required: @@ -1067,7 +1067,7 @@ spec: type: object type: array timeoutForControlPlane: - description: TimeoutForControlPlane controls the timeout + description: timeoutForControlPlane controls the timeout that we use for API server to appear type: string type: object @@ -1080,7 +1080,7 @@ spec: type: string certificatesDir: description: |- - CertificatesDir specifies where to store or look for all required certificates. + certificatesDir specifies where to store or look for all required certificates. NB: if not provided, this will default to `/etc/kubernetes/pki` type: string clusterName: @@ -1088,7 +1088,7 @@ spec: type: string controlPlaneEndpoint: description: |- - ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it + controlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort are used; in case the ControlPlaneEndpoint is specified but without a TCP port, @@ -1102,17 +1102,17 @@ spec: NB: This value defaults to the first value in the Cluster object status.apiEndpoints array. type: string controllerManager: - description: ControllerManager contains extra settings + description: controllerManager contains extra settings for the controller manager control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraVolumes: - description: ExtraVolumes is an extra set of host + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -1121,22 +1121,22 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access + description: readOnly controls write access to the volume type: boolean required: @@ -1147,49 +1147,49 @@ spec: type: array type: object dns: - description: DNS defines the options for the DNS add-on + description: dns defines the options for the DNS add-on installed in the cluster. properties: imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string type: object etcd: description: |- - Etcd holds configuration for etcd. + etcd holds configuration for etcd. NB: This value defaults to a Local (stacked) etcd properties: external: description: |- - External describes how to connect to an external etcd cluster + external describes how to connect to an external etcd cluster Local and External are mutually exclusive properties: caFile: description: |- - CAFile is an SSL Certificate Authority file used to secure etcd communication. + caFile is an SSL Certificate Authority file used to secure etcd communication. Required if using a TLS connection. type: string certFile: description: |- - CertFile is an SSL certification file used to secure etcd communication. + certFile is an SSL certification file used to secure etcd communication. Required if using a TLS connection. type: string endpoints: - description: Endpoints of etcd members. Required + description: endpoints of etcd members. Required for ExternalEtcd. items: type: string type: array keyFile: description: |- - KeyFile is an SSL key file used to secure etcd communication. + keyFile is an SSL key file used to secure etcd communication. Required if using a TLS connection. type: string required: @@ -1200,39 +1200,39 @@ spec: type: object local: description: |- - Local provides configuration knobs for configuring the local etcd instance + local provides configuration knobs for configuring the local etcd instance Local and External are mutually exclusive properties: dataDir: description: |- - DataDir is the directory etcd will place its data. + dataDir is the directory etcd will place its data. Defaults to "/var/lib/etcd". type: string extraArgs: additionalProperties: type: string description: |- - ExtraArgs are extra arguments provided to the etcd binary + extraArgs are extra arguments provided to the etcd binary when run inside a static pod. type: object imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string peerCertSANs: - description: PeerCertSANs sets extra Subject Alternative + description: peerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. items: type: string type: array serverCertSANs: - description: ServerCertSANs sets extra Subject + description: serverCertSANs sets extra Subject Alternative Names for the etcd server signing cert. items: @@ -1243,11 +1243,11 @@ spec: featureGates: additionalProperties: type: boolean - description: FeatureGates enabled by the user. + description: featureGates enabled by the user. type: object imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. If empty, `registry.k8s.io` will be used by default; in case of kubernetes version is a CI build (kubernetes version starts with `ci/` or `ci-cross/`) `gcr.io/k8s-staging-ci-images` will be used as a default for control plane components and for kube-proxy, while `registry.k8s.io` will be used for all the other images. @@ -1262,43 +1262,43 @@ spec: type: string kubernetesVersion: description: |- - KubernetesVersion is the target version of the control plane. + kubernetesVersion is the target version of the control plane. NB: This value defaults to the Machine object spec.version type: string networking: description: |- - Networking holds configuration for the networking topology of the cluster. + networking holds configuration for the networking topology of the cluster. NB: This value defaults to the Cluster object spec.clusterNetwork. properties: dnsDomain: - description: DNSDomain is the dns domain used by k8s + description: dnsDomain is the dns domain used by k8s services. Defaults to "cluster.local". type: string podSubnet: description: |- - PodSubnet is the subnet used by pods. + podSubnet is the subnet used by pods. If unset, the API server will not allocate CIDR ranges for every node. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.services.cidrBlocks if that is set type: string serviceSubnet: description: |- - ServiceSubnet is the subnet used by k8s services. + serviceSubnet is the subnet used by k8s services. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.pods.cidrBlocks, or to "10.96.0.0/12" if that's unset. type: string type: object scheduler: - description: Scheduler contains extra settings for the + description: scheduler contains extra settings for the scheduler control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraVolumes: - description: ExtraVolumes is an extra set of host + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -1307,22 +1307,22 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access + description: readOnly controls write access to the volume type: boolean required: @@ -1334,47 +1334,47 @@ spec: type: object type: object diskSetup: - description: DiskSetup specifies options for the creation + description: diskSetup specifies options for the creation of partition tables and file systems on devices. properties: filesystems: - description: Filesystems specifies the list of file systems + description: filesystems specifies the list of file systems to setup. items: description: Filesystem defines the file systems to be created. properties: device: - description: Device specifies the device name + description: device specifies the device name type: string extraOpts: - description: ExtraOpts defined extra options to + description: extraOpts defined extra options to add to the command for creating the file system. items: type: string type: array filesystem: - description: Filesystem specifies the file system + description: filesystem specifies the file system type. type: string label: - description: Label specifies the file system label + description: label specifies the file system label to be used. If set to None, no label is used. type: string overwrite: description: |- - Overwrite defines whether or not to overwrite any existing filesystem. + overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution. type: boolean partition: - description: 'Partition specifies the partition + description: 'partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number.' type: string replaceFS: description: |- - ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the 'any' partition directive. type: string required: @@ -1384,29 +1384,29 @@ spec: type: object type: array partitions: - description: Partitions specifies the list of the partitions + description: partitions specifies the list of the partitions to setup. items: description: Partition defines how to create and layout a partition. properties: device: - description: Device is the name of the device. + description: device is the name of the device. type: string layout: description: |- - Layout specifies the device layout. + layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don't partition or ignore existing partitioning. type: boolean overwrite: description: |- - Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is 'false'. type: boolean tableType: description: |- - TableType specifies the tupe of partition table. The following are supported: + tableType specifies the tupe of partition table. The following are supported: 'mbr': default and setups a MS-DOS partition table 'gpt': setups a GPT partition table type: string @@ -1417,29 +1417,29 @@ spec: type: array type: object files: - description: Files specifies extra files to be passed to user_data + description: files specifies extra files to be passed to user_data upon creation. items: description: File defines the input for generating write_files in cloud-init. properties: content: - description: Content is the actual content of the file. + description: content is the actual content of the file. type: string contentFrom: - description: ContentFrom is a referenced source of content + description: contentFrom is a referenced source of content to populate the file. properties: secret: - description: Secret represents a secret that should + description: secret represents a secret that should populate this file. properties: key: - description: Key is the key in the secret's + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -1450,7 +1450,7 @@ spec: - secret type: object encoding: - description: Encoding specifies the encoding of the + description: encoding specifies the encoding of the file contents. enum: - base64 @@ -1458,15 +1458,15 @@ spec: - gzip+base64 type: string owner: - description: Owner specifies the ownership of the file, + description: owner specifies the ownership of the file, e.g. "root:root". type: string path: - description: Path specifies the full path on disk where + description: path specifies the full path on disk where to store the file. type: string permissions: - description: Permissions specifies the permissions to + description: permissions specifies the permissions to assign to the file, e.g. "0640". type: string required: @@ -1474,13 +1474,13 @@ spec: type: object type: array format: - description: Format specifies the output format of the bootstrap + description: format specifies the output format of the bootstrap data enum: - cloud-config type: string initConfiguration: - description: InitConfiguration along with ClusterConfiguration + description: initConfiguration along with ClusterConfiguration are the configurations necessary for the init command properties: apiVersion: @@ -1492,7 +1492,7 @@ spec: type: string bootstrapTokens: description: |- - BootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. + bootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature items: description: BootstrapToken describes one bootstrap @@ -1500,35 +1500,35 @@ spec: properties: description: description: |- - Description sets a human-friendly message why this token exists and what it's used + description sets a human-friendly message why this token exists and what it's used for, so other administrators can know its purpose. type: string expires: description: |- - Expires specifies the timestamp when this token expires. Defaults to being set + expires specifies the timestamp when this token expires. Defaults to being set dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive. format: date-time type: string groups: description: |- - Groups specifies the extra groups that this token will authenticate as when/if + groups specifies the extra groups that this token will authenticate as when/if used for authentication items: type: string type: array token: description: |- - Token is used for establishing bidirectional trust between nodes and control-planes. + token is used for establishing bidirectional trust between nodes and control-planes. Used for joining nodes in the cluster. type: string ttl: description: |- - TTL defines the time to live for this token. Defaults to 24h. + ttl defines the time to live for this token. Defaults to 24h. Expires and TTL are mutually exclusive. type: string usages: description: |- - Usages describes the ways in which this token can be used. Can by default be used + usages describes the ways in which this token can be used. Can by default be used for establishing bidirectional trust, but that can be changed here. items: type: string @@ -1547,7 +1547,7 @@ spec: type: string localAPIEndpoint: description: |- - LocalAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node + localAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible @@ -1555,29 +1555,29 @@ spec: fails you may set the desired value here. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a slice + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: @@ -1587,19 +1587,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: {}` in the YAML file. This field is solely used for Node registration. items: @@ -1635,7 +1635,7 @@ spec: type: object type: object joinConfiguration: - description: JoinConfiguration is the kubeadm configuration + description: joinConfiguration is the kubeadm configuration for the join command properties: apiVersion: @@ -1647,49 +1647,49 @@ spec: type: string caCertPath: description: |- - CACertPath is the path to the SSL certificate authority used to + caCertPath is the path to the SSL certificate authority used to secure comunications between node and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt". type: string controlPlane: description: |- - ControlPlane defines the additional control plane instance to be deployed on the joining node. + controlPlane defines the additional control plane instance to be deployed on the joining node. If nil, no additional control plane instance will be deployed. properties: localAPIEndpoint: - description: LocalAPIEndpoint represents the endpoint + description: localAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object type: object discovery: - description: Discovery specifies the options for the kubelet + description: discovery specifies the options for the kubelet to use during the TLS Bootstrap process properties: bootstrapToken: description: |- - BootstrapToken is used to set the options for bootstrap token based discovery + bootstrapToken is used to set the options for bootstrap token based discovery BootstrapToken and File are mutually exclusive properties: apiServerEndpoint: - description: APIServerEndpoint is an IP or domain + description: apiServerEndpoint is an IP or domain name to the API server from which info will be fetched. type: string caCertHashes: description: |- - CACertHashes specifies a set of public key pins to verify + caCertHashes specifies a set of public key pins to verify when token-based discovery is used. The root CA found during discovery must match one of these values. Specifying an empty set disables root CA pinning, which can be unsafe. Each hash is specified as ":", @@ -1702,12 +1702,12 @@ spec: type: array token: description: |- - Token is a token used to validate cluster information + token is a token used to validate cluster information fetched from the control-plane. type: string unsafeSkipCAVerification: description: |- - UnsafeSkipCAVerification allows token-based discovery + unsafeSkipCAVerification allows token-based discovery without CA verification via CACertHashes. This can weaken the security of kubeadm since other nodes can impersonate the control-plane. type: boolean @@ -1716,11 +1716,11 @@ spec: type: object file: description: |- - File is used to specify a file or URL to a kubeconfig file from which to load cluster information + file is used to specify a file or URL to a kubeconfig file from which to load cluster information BootstrapToken and File are mutually exclusive properties: kubeConfigPath: - description: KubeConfigPath is used to specify + description: kubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information type: string @@ -1728,11 +1728,11 @@ spec: - kubeConfigPath type: object timeout: - description: Timeout modifies the discovery timeout + description: timeout modifies the discovery timeout type: string tlsBootstrapToken: description: |- - TLSBootstrapToken is a token used for TLS bootstrapping. + tlsBootstrapToken is a token used for TLS bootstrapping. If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. If .File is set, this field **must be set** in case the KubeConfigFile does not contain any other authentication information type: string @@ -1747,17 +1747,17 @@ spec: type: string nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a slice + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: @@ -1767,19 +1767,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: {}` in the YAML file. This field is solely used for Node registration. items: @@ -1815,7 +1815,7 @@ spec: type: object type: object mounts: - description: Mounts specifies a list of mount points to be + description: mounts specifies a list of mount points to be setup. items: description: MountPoints defines input for generated mounts @@ -1825,32 +1825,32 @@ spec: type: array type: array ntp: - description: NTP specifies NTP configuration + description: ntp specifies NTP configuration properties: enabled: - description: Enabled specifies whether NTP should be enabled + description: enabled specifies whether NTP should be enabled type: boolean servers: - description: Servers specifies which NTP servers to use + description: servers specifies which NTP servers to use items: type: string type: array type: object postKubeadmCommands: - description: PostKubeadmCommands specifies extra commands + description: postKubeadmCommands specifies extra commands to run after kubeadm runs items: type: string type: array preKubeadmCommands: - description: PreKubeadmCommands specifies extra commands to + description: preKubeadmCommands specifies extra commands to run before kubeadm runs items: type: string type: array useExperimentalRetryJoin: description: |- - UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + useExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments @@ -1862,53 +1862,53 @@ spec: For more information, refer to https://github.com/kubernetes-sigs/cluster-api/pull/2763#discussion_r397306055. type: boolean users: - description: Users specifies extra users to add + description: users specifies extra users to add items: description: User defines the input for a generated user in cloud-init. properties: gecos: - description: Gecos specifies the gecos to use for the + description: gecos specifies the gecos to use for the user type: string groups: - description: Groups specifies the additional groups + description: groups specifies the additional groups for the user type: string homeDir: - description: HomeDir specifies the home directory to + description: homeDir specifies the home directory to use for the user type: string inactive: - description: Inactive specifies whether to mark the + description: inactive specifies whether to mark the user as inactive type: boolean lockPassword: - description: LockPassword specifies if password login + description: lockPassword specifies if password login should be disabled type: boolean name: - description: Name specifies the user name + description: name specifies the user name type: string passwd: - description: Passwd specifies a hashed password for + description: passwd specifies a hashed password for the user type: string primaryGroup: - description: PrimaryGroup specifies the primary group + description: primaryGroup specifies the primary group for the user type: string shell: - description: Shell specifies the user's shell + description: shell specifies the user's shell type: string sshAuthorizedKeys: - description: SSHAuthorizedKeys specifies a list of ssh + description: sshAuthorizedKeys specifies a list of ssh authorized keys for the user items: type: string type: array sudo: - description: Sudo specifies a sudo role for the user + description: sudo specifies a sudo role for the user type: string required: - name @@ -1916,7 +1916,7 @@ spec: type: array verbosity: description: |- - Verbosity is the number for the kubeadm log level verbosity. + verbosity is the number for the kubeadm log level verbosity. It overrides the `--v` flag in kubeadm commands. format: int32 type: integer @@ -1972,7 +1972,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -1993,15 +1993,15 @@ spec: Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. properties: clusterConfiguration: - description: ClusterConfiguration along with InitConfiguration + description: clusterConfiguration along with InitConfiguration are the configurations necessary for the init command properties: apiServer: - description: APIServer contains extra settings for the + description: apiServer contains extra settings for the API server control plane component properties: certSANs: - description: CertSANs sets extra Subject Alternative + description: certSANs sets extra Subject Alternative Names for the API Server signing cert. items: type: string @@ -2009,12 +2009,12 @@ spec: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -2140,7 +2140,7 @@ spec: type: object type: array extraVolumes: - description: ExtraVolumes is an extra set of host + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -2149,22 +2149,22 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access + description: readOnly controls write access to the volume type: boolean required: @@ -2174,7 +2174,7 @@ spec: type: object type: array timeoutForControlPlane: - description: TimeoutForControlPlane controls the timeout + description: timeoutForControlPlane controls the timeout that we use for API server to appear type: string type: object @@ -2187,7 +2187,7 @@ spec: type: string certificatesDir: description: |- - CertificatesDir specifies where to store or look for all required certificates. + certificatesDir specifies where to store or look for all required certificates. NB: if not provided, this will default to `/etc/kubernetes/pki` type: string clusterName: @@ -2195,7 +2195,7 @@ spec: type: string controlPlaneEndpoint: description: |- - ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it + controlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort are used; in case the ControlPlaneEndpoint is specified but without a TCP port, @@ -2209,18 +2209,18 @@ spec: NB: This value defaults to the first value in the Cluster object status.apiEndpoints array. type: string controllerManager: - description: ControllerManager contains extra settings + description: controllerManager contains extra settings for the controller manager control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -2346,7 +2346,7 @@ spec: type: object type: array extraVolumes: - description: ExtraVolumes is an extra set of host + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -2355,22 +2355,22 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access + description: readOnly controls write access to the volume type: boolean required: @@ -2381,49 +2381,49 @@ spec: type: array type: object dns: - description: DNS defines the options for the DNS add-on + description: dns defines the options for the DNS add-on installed in the cluster. properties: imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string type: object etcd: description: |- - Etcd holds configuration for etcd. + etcd holds configuration for etcd. NB: This value defaults to a Local (stacked) etcd properties: external: description: |- - External describes how to connect to an external etcd cluster + external describes how to connect to an external etcd cluster Local and External are mutually exclusive properties: caFile: description: |- - CAFile is an SSL Certificate Authority file used to secure etcd communication. + caFile is an SSL Certificate Authority file used to secure etcd communication. Required if using a TLS connection. type: string certFile: description: |- - CertFile is an SSL certification file used to secure etcd communication. + certFile is an SSL certification file used to secure etcd communication. Required if using a TLS connection. type: string endpoints: - description: Endpoints of etcd members. Required + description: endpoints of etcd members. Required for ExternalEtcd. items: type: string type: array keyFile: description: |- - KeyFile is an SSL key file used to secure etcd communication. + keyFile is an SSL key file used to secure etcd communication. Required if using a TLS connection. type: string required: @@ -2434,24 +2434,24 @@ spec: type: object local: description: |- - Local provides configuration knobs for configuring the local etcd instance + local provides configuration knobs for configuring the local etcd instance Local and External are mutually exclusive properties: dataDir: description: |- - DataDir is the directory etcd will place its data. + dataDir is the directory etcd will place its data. Defaults to "/var/lib/etcd". type: string extraArgs: additionalProperties: type: string description: |- - ExtraArgs are extra arguments provided to the etcd binary + extraArgs are extra arguments provided to the etcd binary when run inside a static pod. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -2580,22 +2580,22 @@ spec: type: array imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string peerCertSANs: - description: PeerCertSANs sets extra Subject Alternative + description: peerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. items: type: string type: array serverCertSANs: - description: ServerCertSANs sets extra Subject + description: serverCertSANs sets extra Subject Alternative Names for the etcd server signing cert. items: @@ -2606,11 +2606,11 @@ spec: featureGates: additionalProperties: type: boolean - description: FeatureGates enabled by the user. + description: featureGates enabled by the user. type: object imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. * If not set, the default registry of kubeadm will be used, i.e. * registry.k8s.io (new registry): >= v1.22.17, >= v1.23.15, >= v1.24.9, >= v1.25.0 * k8s.gcr.io (old registry): all older versions @@ -2632,44 +2632,44 @@ spec: type: string kubernetesVersion: description: |- - KubernetesVersion is the target version of the control plane. + kubernetesVersion is the target version of the control plane. NB: This value defaults to the Machine object spec.version type: string networking: description: |- - Networking holds configuration for the networking topology of the cluster. + networking holds configuration for the networking topology of the cluster. NB: This value defaults to the Cluster object spec.clusterNetwork. properties: dnsDomain: - description: DNSDomain is the dns domain used by k8s + description: dnsDomain is the dns domain used by k8s services. Defaults to "cluster.local". type: string podSubnet: description: |- - PodSubnet is the subnet used by pods. + podSubnet is the subnet used by pods. If unset, the API server will not allocate CIDR ranges for every node. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.services.cidrBlocks if that is set type: string serviceSubnet: description: |- - ServiceSubnet is the subnet used by k8s services. + serviceSubnet is the subnet used by k8s services. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.pods.cidrBlocks, or to "10.96.0.0/12" if that's unset. type: string type: object scheduler: - description: Scheduler contains extra settings for the + description: scheduler contains extra settings for the scheduler control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -2795,7 +2795,7 @@ spec: type: object type: array extraVolumes: - description: ExtraVolumes is an extra set of host + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -2804,22 +2804,22 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access + description: readOnly controls write access to the volume type: boolean required: @@ -2831,47 +2831,47 @@ spec: type: object type: object diskSetup: - description: DiskSetup specifies options for the creation + description: diskSetup specifies options for the creation of partition tables and file systems on devices. properties: filesystems: - description: Filesystems specifies the list of file systems + description: filesystems specifies the list of file systems to setup. items: description: Filesystem defines the file systems to be created. properties: device: - description: Device specifies the device name + description: device specifies the device name type: string extraOpts: - description: ExtraOpts defined extra options to + description: extraOpts defined extra options to add to the command for creating the file system. items: type: string type: array filesystem: - description: Filesystem specifies the file system + description: filesystem specifies the file system type. type: string label: - description: Label specifies the file system label + description: label specifies the file system label to be used. If set to None, no label is used. type: string overwrite: description: |- - Overwrite defines whether or not to overwrite any existing filesystem. + overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution. type: boolean partition: - description: 'Partition specifies the partition + description: 'partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number.' type: string replaceFS: description: |- - ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the 'any' partition directive. type: string required: @@ -2881,29 +2881,29 @@ spec: type: object type: array partitions: - description: Partitions specifies the list of the partitions + description: partitions specifies the list of the partitions to setup. items: description: Partition defines how to create and layout a partition. properties: device: - description: Device is the name of the device. + description: device is the name of the device. type: string layout: description: |- - Layout specifies the device layout. + layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don't partition or ignore existing partitioning. type: boolean overwrite: description: |- - Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is 'false'. type: boolean tableType: description: |- - TableType specifies the tupe of partition table. The following are supported: + tableType specifies the tupe of partition table. The following are supported: 'mbr': default and setups a MS-DOS partition table 'gpt': setups a GPT partition table type: string @@ -2914,33 +2914,33 @@ spec: type: array type: object files: - description: Files specifies extra files to be passed to user_data + description: files specifies extra files to be passed to user_data upon creation. items: description: File defines the input for generating write_files in cloud-init. properties: append: - description: Append specifies whether to append Content + description: append specifies whether to append Content to existing file if Path exists. type: boolean content: - description: Content is the actual content of the file. + description: content is the actual content of the file. type: string contentFrom: - description: ContentFrom is a referenced source of content + description: contentFrom is a referenced source of content to populate the file. properties: secret: - description: Secret represents a secret that should + description: secret represents a secret that should populate this file. properties: key: - description: Key is the key in the secret's + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -2951,7 +2951,7 @@ spec: - secret type: object encoding: - description: Encoding specifies the encoding of the + description: encoding specifies the encoding of the file contents. enum: - base64 @@ -2959,15 +2959,15 @@ spec: - gzip+base64 type: string owner: - description: Owner specifies the ownership of the file, + description: owner specifies the ownership of the file, e.g. "root:root". type: string path: - description: Path specifies the full path on disk where + description: path specifies the full path on disk where to store the file. type: string permissions: - description: Permissions specifies the permissions to + description: permissions specifies the permissions to assign to the file, e.g. "0640". type: string required: @@ -2975,35 +2975,35 @@ spec: type: object type: array format: - description: Format specifies the output format of the bootstrap + description: format specifies the output format of the bootstrap data enum: - cloud-config - ignition type: string ignition: - description: Ignition contains Ignition specific configuration. + description: ignition contains Ignition specific configuration. properties: containerLinuxConfig: - description: ContainerLinuxConfig contains CLC specific + description: containerLinuxConfig contains CLC specific configuration. properties: additionalConfig: description: |- - AdditionalConfig contains additional configuration to be merged with the Ignition + additionalConfig contains additional configuration to be merged with the Ignition configuration generated by the bootstrapper controller. More info: https://coreos.github.io/ignition/operator-notes/#config-merging The data format is documented here: https://kinvolk.io/docs/flatcar-container-linux/latest/provisioning/cl-config/ type: string strict: - description: Strict controls if AdditionalConfig should + description: strict controls if AdditionalConfig should be strictly parsed. If so, warnings are treated as errors. type: boolean type: object type: object initConfiguration: - description: InitConfiguration along with ClusterConfiguration + description: initConfiguration along with ClusterConfiguration are the configurations necessary for the init command properties: apiVersion: @@ -3015,7 +3015,7 @@ spec: type: string bootstrapTokens: description: |- - BootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. + bootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature items: description: BootstrapToken describes one bootstrap @@ -3023,35 +3023,35 @@ spec: properties: description: description: |- - Description sets a human-friendly message why this token exists and what it's used + description sets a human-friendly message why this token exists and what it's used for, so other administrators can know its purpose. type: string expires: description: |- - Expires specifies the timestamp when this token expires. Defaults to being set + expires specifies the timestamp when this token expires. Defaults to being set dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive. format: date-time type: string groups: description: |- - Groups specifies the extra groups that this token will authenticate as when/if + groups specifies the extra groups that this token will authenticate as when/if used for authentication items: type: string type: array token: description: |- - Token is used for establishing bidirectional trust between nodes and control-planes. + token is used for establishing bidirectional trust between nodes and control-planes. Used for joining nodes in the cluster. type: string ttl: description: |- - TTL defines the time to live for this token. Defaults to 24h. + ttl defines the time to live for this token. Defaults to 24h. Expires and TTL are mutually exclusive. type: string usages: description: |- - Usages describes the ways in which this token can be used. Can by default be used + usages describes the ways in which this token can be used. Can by default be used for establishing bidirectional trust, but that can be changed here. items: type: string @@ -3070,7 +3070,7 @@ spec: type: string localAPIEndpoint: description: |- - LocalAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node + localAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible @@ -3078,29 +3078,29 @@ spec: fails you may set the desired value here. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a slice + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: @@ -3108,7 +3108,7 @@ spec: type: array imagePullPolicy: description: |- - ImagePullPolicy specifies the policy for image pulling + imagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations. The value of this field must be one of "Always", "IfNotPresent" or "Never". Defaults to "IfNotPresent". This can be used only @@ -3120,7 +3120,7 @@ spec: type: string imagePullSerial: description: |- - ImagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. + imagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. This option takes effect only on Kubernetes >=1.31.0. Default: true (defaulted in kubeadm) type: boolean @@ -3128,19 +3128,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: []` in the YAML file. This field is solely used for Node registration. items: @@ -3176,12 +3176,12 @@ spec: type: object patches: description: |- - Patches contains options related to applying patches to components deployed by kubeadm during + patches contains options related to applying patches to components deployed by kubeadm during "kubeadm init". The minimum kubernetes version needed to support Patches is v1.22 properties: directory: description: |- - Directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". + directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of "kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". "patchtype" can be one of "strategic" "merge" or "json" and they match the patch formats supported by kubectl. @@ -3195,7 +3195,7 @@ spec: type: object skipPhases: description: |- - SkipPhases is a list of phases to skip during command execution. + skipPhases is a list of phases to skip during command execution. The list of phases can be obtained with the "kubeadm init --help" command. This option takes effect only on Kubernetes >=1.22.0. items: @@ -3203,7 +3203,7 @@ spec: type: array type: object joinConfiguration: - description: JoinConfiguration is the kubeadm configuration + description: joinConfiguration is the kubeadm configuration for the join command properties: apiVersion: @@ -3215,49 +3215,49 @@ spec: type: string caCertPath: description: |- - CACertPath is the path to the SSL certificate authority used to + caCertPath is the path to the SSL certificate authority used to secure comunications between node and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt". type: string controlPlane: description: |- - ControlPlane defines the additional control plane instance to be deployed on the joining node. + controlPlane defines the additional control plane instance to be deployed on the joining node. If nil, no additional control plane instance will be deployed. properties: localAPIEndpoint: - description: LocalAPIEndpoint represents the endpoint + description: localAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object type: object discovery: - description: Discovery specifies the options for the kubelet + description: discovery specifies the options for the kubelet to use during the TLS Bootstrap process properties: bootstrapToken: description: |- - BootstrapToken is used to set the options for bootstrap token based discovery + bootstrapToken is used to set the options for bootstrap token based discovery BootstrapToken and File are mutually exclusive properties: apiServerEndpoint: - description: APIServerEndpoint is an IP or domain + description: apiServerEndpoint is an IP or domain name to the API server from which info will be fetched. type: string caCertHashes: description: |- - CACertHashes specifies a set of public key pins to verify + caCertHashes specifies a set of public key pins to verify when token-based discovery is used. The root CA found during discovery must match one of these values. Specifying an empty set disables root CA pinning, which can be unsafe. Each hash is specified as ":", @@ -3270,12 +3270,12 @@ spec: type: array token: description: |- - Token is a token used to validate cluster information + token is a token used to validate cluster information fetched from the control-plane. type: string unsafeSkipCAVerification: description: |- - UnsafeSkipCAVerification allows token-based discovery + unsafeSkipCAVerification allows token-based discovery without CA verification via CACertHashes. This can weaken the security of kubeadm since other nodes can impersonate the control-plane. type: boolean @@ -3284,12 +3284,12 @@ spec: type: object file: description: |- - File is used to specify a file or URL to a kubeconfig file from which to load cluster information + file is used to specify a file or URL to a kubeconfig file from which to load cluster information BootstrapToken and File are mutually exclusive properties: kubeConfig: description: |- - KubeConfig is used (optionally) to generate a KubeConfig based on the KubeadmConfig's information. + kubeConfig is used (optionally) to generate a KubeConfig based on the KubeadmConfig's information. The file is generated at the path specified in KubeConfigPath. Host address (server field) information is automatically populated based on the Cluster's ControlPlaneEndpoint. @@ -3297,7 +3297,7 @@ spec: properties: cluster: description: |- - Cluster contains information about how to communicate with the kubernetes cluster. + cluster contains information about how to communicate with the kubernetes cluster. By default the following fields are automatically populated: - Server with the Cluster's ControlPlaneEndpoint. @@ -3305,20 +3305,20 @@ spec: properties: certificateAuthorityData: description: |- - CertificateAuthorityData contains PEM-encoded certificate authority certificates. + certificateAuthorityData contains PEM-encoded certificate authority certificates. Defaults to the Cluster's CA certificate if empty. format: byte type: string insecureSkipTLSVerify: - description: InsecureSkipTLSVerify skips + description: insecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure. type: boolean proxyURL: description: |- - ProxyURL is the URL to the proxy to be used for all requests made by this + proxyURL is the URL to the proxy to be used for all requests made by this client. URLs with "http", "https", and "socks5" schemes are supported. If this configuration is not provided or the empty string, the client attempts to construct a proxy configuration from http_proxy and @@ -3330,12 +3330,12 @@ spec: type: string server: description: |- - Server is the address of the kubernetes cluster (https://hostname:port). + server is the address of the kubernetes cluster (https://hostname:port). Defaults to https:// + Cluster.Spec.ControlPlaneEndpoint. type: string tlsServerName: - description: TLSServerName is used to + description: tlsServerName is used to check server certificate. If TLSServerName is empty, the hostname used to contact the server is used. @@ -3343,29 +3343,29 @@ spec: type: object user: description: |- - User contains information that describes identity information. + user contains information that describes identity information. This is used to tell the kubernetes cluster who you are. properties: authProvider: - description: AuthProvider specifies a + description: authProvider specifies a custom authentication plugin for the kubernetes cluster. properties: config: additionalProperties: type: string - description: Config holds the parameters + description: config holds the parameters for the authentication plugin. type: object name: - description: Name is the name of the + description: name is the name of the authentication plugin. type: string required: - name type: object exec: - description: Exec specifies a custom exec-based + description: exec specifies a custom exec-based authentication plugin for the kubernetes cluster. properties: @@ -3382,11 +3382,11 @@ spec: type: string type: array command: - description: Command to execute. + description: command to execute. type: string env: description: |- - Env defines additional environment variables to expose to the process. These + env defines additional environment variables to expose to the process. These are unioned with the host's environment, as well as variables client-go uses to pass argument to the plugin. items: @@ -3405,7 +3405,7 @@ spec: type: array provideClusterInfo: description: |- - ProvideClusterInfo determines whether or not to provide cluster information, + provideClusterInfo determines whether or not to provide cluster information, which could potentially contain very large CA data, to this exec plugin as a part of the KUBERNETES_EXEC_INFO environment variable. By default, it is set to false. Package k8s.io/client-go/tools/auth/exec provides helper methods for @@ -3419,7 +3419,7 @@ spec: - user type: object kubeConfigPath: - description: KubeConfigPath is used to specify + description: kubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information type: string @@ -3427,11 +3427,11 @@ spec: - kubeConfigPath type: object timeout: - description: Timeout modifies the discovery timeout + description: timeout modifies the discovery timeout type: string tlsBootstrapToken: description: |- - TLSBootstrapToken is a token used for TLS bootstrapping. + tlsBootstrapToken is a token used for TLS bootstrapping. If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. If .File is set, this field **must be set** in case the KubeConfigFile does not contain any other authentication information type: string @@ -3446,17 +3446,17 @@ spec: type: string nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a slice + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: @@ -3464,7 +3464,7 @@ spec: type: array imagePullPolicy: description: |- - ImagePullPolicy specifies the policy for image pulling + imagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations. The value of this field must be one of "Always", "IfNotPresent" or "Never". Defaults to "IfNotPresent". This can be used only @@ -3476,7 +3476,7 @@ spec: type: string imagePullSerial: description: |- - ImagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. + imagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. This option takes effect only on Kubernetes >=1.31.0. Default: true (defaulted in kubeadm) type: boolean @@ -3484,19 +3484,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: []` in the YAML file. This field is solely used for Node registration. items: @@ -3532,12 +3532,12 @@ spec: type: object patches: description: |- - Patches contains options related to applying patches to components deployed by kubeadm during + patches contains options related to applying patches to components deployed by kubeadm during "kubeadm join". The minimum kubernetes version needed to support Patches is v1.22 properties: directory: description: |- - Directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". + directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of "kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". "patchtype" can be one of "strategic" "merge" or "json" and they match the patch formats supported by kubectl. @@ -3551,7 +3551,7 @@ spec: type: object skipPhases: description: |- - SkipPhases is a list of phases to skip during command execution. + skipPhases is a list of phases to skip during command execution. The list of phases can be obtained with the "kubeadm init --help" command. This option takes effect only on Kubernetes >=1.22.0. items: @@ -3559,7 +3559,7 @@ spec: type: array type: object mounts: - description: Mounts specifies a list of mount points to be + description: mounts specifies a list of mount points to be setup. items: description: MountPoints defines input for generated mounts @@ -3569,32 +3569,32 @@ spec: type: array type: array ntp: - description: NTP specifies NTP configuration + description: ntp specifies NTP configuration properties: enabled: - description: Enabled specifies whether NTP should be enabled + description: enabled specifies whether NTP should be enabled type: boolean servers: - description: Servers specifies which NTP servers to use + description: servers specifies which NTP servers to use items: type: string type: array type: object postKubeadmCommands: - description: PostKubeadmCommands specifies extra commands + description: postKubeadmCommands specifies extra commands to run after kubeadm runs items: type: string type: array preKubeadmCommands: - description: PreKubeadmCommands specifies extra commands to + description: preKubeadmCommands specifies extra commands to run before kubeadm runs items: type: string type: array useExperimentalRetryJoin: description: |- - UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + useExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments @@ -3609,52 +3609,52 @@ spec: When removing also remove from staticcheck exclude-rules for SA1019 in golangci.yml type: boolean users: - description: Users specifies extra users to add + description: users specifies extra users to add items: description: User defines the input for a generated user in cloud-init. properties: gecos: - description: Gecos specifies the gecos to use for the + description: gecos specifies the gecos to use for the user type: string groups: - description: Groups specifies the additional groups + description: groups specifies the additional groups for the user type: string homeDir: - description: HomeDir specifies the home directory to + description: homeDir specifies the home directory to use for the user type: string inactive: - description: Inactive specifies whether to mark the + description: inactive specifies whether to mark the user as inactive type: boolean lockPassword: - description: LockPassword specifies if password login + description: lockPassword specifies if password login should be disabled type: boolean name: - description: Name specifies the user name + description: name specifies the user name type: string passwd: - description: Passwd specifies a hashed password for + description: passwd specifies a hashed password for the user type: string passwdFrom: - description: PasswdFrom is a referenced source of passwd + description: passwdFrom is a referenced source of passwd to populate the passwd. properties: secret: - description: Secret represents a secret that should + description: secret represents a secret that should populate this password. properties: key: - description: Key is the key in the secret's + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -3665,20 +3665,20 @@ spec: - secret type: object primaryGroup: - description: PrimaryGroup specifies the primary group + description: primaryGroup specifies the primary group for the user type: string shell: - description: Shell specifies the user's shell + description: shell specifies the user's shell type: string sshAuthorizedKeys: - description: SSHAuthorizedKeys specifies a list of ssh + description: sshAuthorizedKeys specifies a list of ssh authorized keys for the user items: type: string type: array sudo: - description: Sudo specifies a sudo role for the user + description: sudo specifies a sudo role for the user type: string required: - name @@ -3686,7 +3686,7 @@ spec: type: array verbosity: description: |- - Verbosity is the number for the kubeadm log level verbosity. + verbosity is the number for the kubeadm log level verbosity. It overrides the `--v` flag in kubeadm commands. format: int32 type: integer diff --git a/cmd/clusterctl/api/v1alpha3/metadata_type.go b/cmd/clusterctl/api/v1alpha3/metadata_type.go index e2ab85a630ba..6533491fb2ed 100644 --- a/cmd/clusterctl/api/v1alpha3/metadata_type.go +++ b/cmd/clusterctl/api/v1alpha3/metadata_type.go @@ -35,13 +35,13 @@ type Metadata struct { // ReleaseSeries maps a provider release series (major/minor) with a API Version of Cluster API (contract). type ReleaseSeries struct { - // Major version of the release series + // major version of the release series Major uint `json:"major,omitempty"` - // Minor version of the release series + // minor version of the release series Minor uint `json:"minor,omitempty"` - // Contract defines the Cluster API contract supported by this series. + // contract defines the Cluster API contract supported by this series. // // The value is an API Version, e.g. `v1alpha3`. Contract string `json:"contract,omitempty"` diff --git a/cmd/clusterctl/api/v1alpha3/provider_type.go b/cmd/clusterctl/api/v1alpha3/provider_type.go index 0c923646d659..d7bb6235ad88 100644 --- a/cmd/clusterctl/api/v1alpha3/provider_type.go +++ b/cmd/clusterctl/api/v1alpha3/provider_type.go @@ -34,20 +34,20 @@ type Provider struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` - // ProviderName indicates the name of the provider. + // providerName indicates the name of the provider. // +optional ProviderName string `json:"providerName,omitempty"` - // Type indicates the type of the provider. + // type indicates the type of the provider. // See ProviderType for a list of supported values // +optional Type string `json:"type,omitempty"` - // Version indicates the component version. + // version indicates the component version. // +optional Version string `json:"version,omitempty"` - // WatchedNamespace indicates the namespace where the provider controller is watching. + // watchedNamespace indicates the namespace where the provider controller is watching. // If empty the provider controller is watching for objects in all namespaces. // // Deprecated: providers complying with the Cluster API v1alpha4 contract or above must watch all namespaces; this field will be removed in a future version of this API diff --git a/cmd/clusterctl/config/crd/bases/clusterctl.cluster.x-k8s.io_metadata.yaml b/cmd/clusterctl/config/crd/bases/clusterctl.cluster.x-k8s.io_metadata.yaml index aec029772427..6f40672e3907 100644 --- a/cmd/clusterctl/config/crd/bases/clusterctl.cluster.x-k8s.io_metadata.yaml +++ b/cmd/clusterctl/config/crd/bases/clusterctl.cluster.x-k8s.io_metadata.yaml @@ -43,15 +43,15 @@ spec: properties: contract: description: |- - Contract defines the Cluster API contract supported by this series. + contract defines the Cluster API contract supported by this series. The value is an API Version, e.g. `v1alpha3`. type: string major: - description: Major version of the release series + description: major version of the release series type: integer minor: - description: Minor version of the release series + description: minor version of the release series type: integer type: object type: array diff --git a/cmd/clusterctl/config/crd/bases/clusterctl.cluster.x-k8s.io_providers.yaml b/cmd/clusterctl/config/crd/bases/clusterctl.cluster.x-k8s.io_providers.yaml index 9c508cc48be5..a0839e612f33 100644 --- a/cmd/clusterctl/config/crd/bases/clusterctl.cluster.x-k8s.io_providers.yaml +++ b/cmd/clusterctl/config/crd/bases/clusterctl.cluster.x-k8s.io_providers.yaml @@ -53,19 +53,19 @@ spec: metadata: type: object providerName: - description: ProviderName indicates the name of the provider. + description: providerName indicates the name of the provider. type: string type: description: |- - Type indicates the type of the provider. + type indicates the type of the provider. See ProviderType for a list of supported values type: string version: - description: Version indicates the component version. + description: version indicates the component version. type: string watchedNamespace: description: |- - WatchedNamespace indicates the namespace where the provider controller is watching. + watchedNamespace indicates the namespace where the provider controller is watching. If empty the provider controller is watching for objects in all namespaces. Deprecated: providers complying with the Cluster API v1alpha4 contract or above must watch all namespaces; this field will be removed in a future version of this API diff --git a/cmd/clusterctl/config/manifest/clusterctl-api.yaml b/cmd/clusterctl/config/manifest/clusterctl-api.yaml index ffda27c50978..73430f589de4 100644 --- a/cmd/clusterctl/config/manifest/clusterctl-api.yaml +++ b/cmd/clusterctl/config/manifest/clusterctl-api.yaml @@ -52,19 +52,19 @@ spec: metadata: type: object providerName: - description: ProviderName indicates the name of the provider. + description: providerName indicates the name of the provider. type: string type: description: |- - Type indicates the type of the provider. + type indicates the type of the provider. See ProviderType for a list of supported values type: string version: - description: Version indicates the component version. + description: version indicates the component version. type: string watchedNamespace: description: |- - WatchedNamespace indicates the namespace where the provider controller is watching. + watchedNamespace indicates the namespace where the provider controller is watching. If empty the provider controller is watching for objects in all namespaces. Deprecated: providers complying with the Cluster API v1alpha4 contract or above must watch all namespaces; this field will be removed in a future version of this API diff --git a/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesetbindings.yaml b/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesetbindings.yaml index 066798121e5e..b6d7467b73ec 100644 --- a/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesetbindings.yaml +++ b/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesetbindings.yaml @@ -47,17 +47,17 @@ spec: ClusterResourceSetBinding. properties: bindings: - description: Bindings is a list of ClusterResourceSets and their resources. + description: bindings is a list of ClusterResourceSets and their resources. items: description: ResourceSetBinding keeps info on all of the resources in a ClusterResourceSet. properties: clusterResourceSetName: - description: ClusterResourceSetName is the name of the ClusterResourceSet + description: clusterResourceSetName is the name of the ClusterResourceSet that is applied to the owner cluster of the binding. type: string resources: - description: Resources is a list of resources that the ClusterResourceSet + description: resources is a list of resources that the ClusterResourceSet has. items: description: ResourceBinding shows the status of a resource @@ -65,28 +65,28 @@ spec: cluster of the ClusterResourceSetBinding object. properties: applied: - description: Applied is to track if a resource is applied + description: applied is to track if a resource is applied to the cluster or not. type: boolean hash: description: |- - Hash is the hash of a resource's data. This can be used to decide if a resource is changed. + hash is the hash of a resource's data. This can be used to decide if a resource is changed. For "ApplyOnce" ClusterResourceSet.spec.strategy, this is no-op as that strategy does not act on change. type: string kind: - description: 'Kind of the resource. Supported kinds are: + description: 'kind of the resource. Supported kinds are: Secrets and ConfigMaps.' enum: - Secret - ConfigMap type: string lastAppliedTime: - description: LastAppliedTime identifies when this resource + description: lastAppliedTime identifies when this resource was last applied to the cluster. format: date-time type: string name: - description: Name of the resource that is in the same + description: name of the resource that is in the same namespace with ClusterResourceSet object. minLength: 1 type: string @@ -142,17 +142,17 @@ spec: ClusterResourceSetBinding. properties: bindings: - description: Bindings is a list of ClusterResourceSets and their resources. + description: bindings is a list of ClusterResourceSets and their resources. items: description: ResourceSetBinding keeps info on all of the resources in a ClusterResourceSet. properties: clusterResourceSetName: - description: ClusterResourceSetName is the name of the ClusterResourceSet + description: clusterResourceSetName is the name of the ClusterResourceSet that is applied to the owner cluster of the binding. type: string resources: - description: Resources is a list of resources that the ClusterResourceSet + description: resources is a list of resources that the ClusterResourceSet has. items: description: ResourceBinding shows the status of a resource @@ -160,28 +160,28 @@ spec: cluster of the ClusterResourceSetBinding object. properties: applied: - description: Applied is to track if a resource is applied + description: applied is to track if a resource is applied to the cluster or not. type: boolean hash: description: |- - Hash is the hash of a resource's data. This can be used to decide if a resource is changed. + hash is the hash of a resource's data. This can be used to decide if a resource is changed. For "ApplyOnce" ClusterResourceSet.spec.strategy, this is no-op as that strategy does not act on change. type: string kind: - description: 'Kind of the resource. Supported kinds are: + description: 'kind of the resource. Supported kinds are: Secrets and ConfigMaps.' enum: - Secret - ConfigMap type: string lastAppliedTime: - description: LastAppliedTime identifies when this resource + description: lastAppliedTime identifies when this resource was last applied to the cluster. format: date-time type: string name: - description: Name of the resource that is in the same + description: name of the resource that is in the same namespace with ClusterResourceSet object. minLength: 1 type: string @@ -234,17 +234,17 @@ spec: ClusterResourceSetBinding. properties: bindings: - description: Bindings is a list of ClusterResourceSets and their resources. + description: bindings is a list of ClusterResourceSets and their resources. items: description: ResourceSetBinding keeps info on all of the resources in a ClusterResourceSet. properties: clusterResourceSetName: - description: ClusterResourceSetName is the name of the ClusterResourceSet + description: clusterResourceSetName is the name of the ClusterResourceSet that is applied to the owner cluster of the binding. type: string resources: - description: Resources is a list of resources that the ClusterResourceSet + description: resources is a list of resources that the ClusterResourceSet has. items: description: ResourceBinding shows the status of a resource @@ -252,28 +252,28 @@ spec: cluster of the ClusterResourceSetBinding object. properties: applied: - description: Applied is to track if a resource is applied + description: applied is to track if a resource is applied to the cluster or not. type: boolean hash: description: |- - Hash is the hash of a resource's data. This can be used to decide if a resource is changed. + hash is the hash of a resource's data. This can be used to decide if a resource is changed. For "ApplyOnce" ClusterResourceSet.spec.strategy, this is no-op as that strategy does not act on change. type: string kind: - description: 'Kind of the resource. Supported kinds are: + description: 'kind of the resource. Supported kinds are: Secrets and ConfigMaps.' enum: - Secret - ConfigMap type: string lastAppliedTime: - description: LastAppliedTime identifies when this resource + description: lastAppliedTime identifies when this resource was last applied to the cluster. format: date-time type: string name: - description: Name of the resource that is in the same + description: name of the resource that is in the same namespace with ClusterResourceSet object. minLength: 1 type: string @@ -289,7 +289,7 @@ spec: type: array clusterName: description: |- - ClusterName is the name of the Cluster this binding applies to. + clusterName is the name of the Cluster this binding applies to. Note: this field mandatory in v1beta2. type: string type: object diff --git a/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesets.yaml b/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesets.yaml index 9c3d8cc60c05..8d8ac27c60ea 100644 --- a/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesets.yaml +++ b/config/crd/bases/addons.cluster.x-k8s.io_clusterresourcesets.yaml @@ -95,20 +95,20 @@ spec: type: object x-kubernetes-map-type: atomic resources: - description: Resources is a list of Secrets/ConfigMaps where each + description: resources is a list of Secrets/ConfigMaps where each contains 1 or more resources to be applied to remote clusters. items: description: ResourceRef specifies a resource. properties: kind: - description: 'Kind of the resource. Supported kinds are: Secrets + description: 'kind of the resource. Supported kinds are: Secrets and ConfigMaps.' enum: - Secret - ConfigMap type: string name: - description: Name of the resource that is in the same namespace + description: name of the resource that is in the same namespace with ClusterResourceSet object. minLength: 1 type: string @@ -118,7 +118,7 @@ spec: type: object type: array strategy: - description: Strategy is the strategy to be used during applying resources. + description: strategy is the strategy to be used during applying resources. Defaults to ApplyOnce. This field is immutable. enum: - ApplyOnce @@ -130,7 +130,7 @@ spec: description: ClusterResourceSetStatus defines the observed state of ClusterResourceSet. properties: conditions: - description: Conditions defines current state of the ClusterResourceSet. + description: conditions defines current state of the ClusterResourceSet. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -155,16 +155,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -174,7 +174,7 @@ spec: type: object type: array observedGeneration: - description: ObservedGeneration reflects the generation of the most + description: observedGeneration reflects the generation of the most recently observed ClusterResourceSet. format: int64 type: integer @@ -269,20 +269,20 @@ spec: type: object x-kubernetes-map-type: atomic resources: - description: Resources is a list of Secrets/ConfigMaps where each + description: resources is a list of Secrets/ConfigMaps where each contains 1 or more resources to be applied to remote clusters. items: description: ResourceRef specifies a resource. properties: kind: - description: 'Kind of the resource. Supported kinds are: Secrets + description: 'kind of the resource. Supported kinds are: Secrets and ConfigMaps.' enum: - Secret - ConfigMap type: string name: - description: Name of the resource that is in the same namespace + description: name of the resource that is in the same namespace with ClusterResourceSet object. minLength: 1 type: string @@ -292,7 +292,7 @@ spec: type: object type: array strategy: - description: Strategy is the strategy to be used during applying resources. + description: strategy is the strategy to be used during applying resources. Defaults to ApplyOnce. This field is immutable. enum: - ApplyOnce @@ -304,7 +304,7 @@ spec: description: ClusterResourceSetStatus defines the observed state of ClusterResourceSet. properties: conditions: - description: Conditions defines current state of the ClusterResourceSet. + description: conditions defines current state of the ClusterResourceSet. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -329,16 +329,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -348,7 +348,7 @@ spec: type: object type: array observedGeneration: - description: ObservedGeneration reflects the generation of the most + description: observedGeneration reflects the generation of the most recently observed ClusterResourceSet. format: int64 type: integer @@ -440,20 +440,20 @@ spec: type: object x-kubernetes-map-type: atomic resources: - description: Resources is a list of Secrets/ConfigMaps where each + description: resources is a list of Secrets/ConfigMaps where each contains 1 or more resources to be applied to remote clusters. items: description: ResourceRef specifies a resource. properties: kind: - description: 'Kind of the resource. Supported kinds are: Secrets + description: 'kind of the resource. Supported kinds are: Secrets and ConfigMaps.' enum: - Secret - ConfigMap type: string name: - description: Name of the resource that is in the same namespace + description: name of the resource that is in the same namespace with ClusterResourceSet object. minLength: 1 type: string @@ -463,7 +463,7 @@ spec: type: object type: array strategy: - description: Strategy is the strategy to be used during applying resources. + description: strategy is the strategy to be used during applying resources. Defaults to ApplyOnce. This field is immutable. enum: - ApplyOnce @@ -476,7 +476,7 @@ spec: description: ClusterResourceSetStatus defines the observed state of ClusterResourceSet. properties: conditions: - description: Conditions defines current state of the ClusterResourceSet. + description: conditions defines current state of the ClusterResourceSet. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -501,16 +501,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -521,7 +521,7 @@ spec: type: object type: array observedGeneration: - description: ObservedGeneration reflects the generation of the most + description: observedGeneration reflects the generation of the most recently observed ClusterResourceSet. format: int64 type: integer diff --git a/config/crd/bases/cluster.x-k8s.io_clusterclasses.yaml b/config/crd/bases/cluster.x-k8s.io_clusterclasses.yaml index d85b3c064855..7c7d13ef3308 100644 --- a/config/crd/bases/cluster.x-k8s.io_clusterclasses.yaml +++ b/config/crd/bases/cluster.x-k8s.io_clusterclasses.yaml @@ -54,7 +54,7 @@ spec: properties: controlPlane: description: |- - ControlPlane is a reference to a local struct that holds the details + controlPlane is a reference to a local struct that holds the details for provisioning the Control Plane for the Cluster. properties: machineInfrastructure: @@ -67,7 +67,7 @@ spec: properties: ref: description: |- - Ref is a required reference to a custom resource + ref is a required reference to a custom resource offered by a provider. properties: apiVersion: @@ -115,7 +115,7 @@ spec: type: object metadata: description: |- - Metadata is the metadata applied to the machines of the ControlPlane. + metadata is the metadata applied to the machines of the ControlPlane. At runtime this metadata is merged with the corresponding metadata from the topology. This field is supported if and only if the control plane provider template @@ -125,7 +125,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -142,7 +142,7 @@ spec: type: object ref: description: |- - Ref is a required reference to a custom resource + ref is a required reference to a custom resource offered by a provider. properties: apiVersion: @@ -190,7 +190,7 @@ spec: type: object infrastructure: description: |- - Infrastructure is a reference to a provider-specific template that holds + infrastructure is a reference to a provider-specific template that holds the details for provisioning infrastructure specific cluster for the underlying provider. The underlying provider is responsible for the implementation @@ -198,7 +198,7 @@ spec: properties: ref: description: |- - Ref is a required reference to a custom resource + ref is a required reference to a custom resource offered by a provider. properties: apiVersion: @@ -246,13 +246,13 @@ spec: type: object workers: description: |- - Workers describes the worker nodes for the cluster. + workers describes the worker nodes for the cluster. It is a collection of node types which can be used to create the worker nodes of the cluster. properties: machineDeployments: description: |- - MachineDeployments is a list of machine deployment classes that can be used to create + machineDeployments is a list of machine deployment classes that can be used to create a set of worker nodes. items: description: |- @@ -261,23 +261,23 @@ spec: properties: class: description: |- - Class denotes a type of worker node present in the cluster, + class denotes a type of worker node present in the cluster, this name MUST be unique within a ClusterClass and can be referenced in the Cluster to create a managed MachineDeployment. type: string template: description: |- - Template is a local struct containing a collection of templates for creation of + template is a local struct containing a collection of templates for creation of MachineDeployment objects representing a set of worker nodes. properties: bootstrap: description: |- - Bootstrap contains the bootstrap template reference to be used + bootstrap contains the bootstrap template reference to be used for the creation of worker Machines. properties: ref: description: |- - Ref is a required reference to a custom resource + ref is a required reference to a custom resource offered by a provider. properties: apiVersion: @@ -325,12 +325,12 @@ spec: type: object infrastructure: description: |- - Infrastructure contains the infrastructure template reference to be used + infrastructure contains the infrastructure template reference to be used for the creation of worker Machines. properties: ref: description: |- - Ref is a required reference to a custom resource + ref is a required reference to a custom resource offered by a provider. properties: apiVersion: @@ -378,14 +378,14 @@ spec: type: object metadata: description: |- - Metadata is the metadata applied to the machines of the MachineDeployment. + metadata is the metadata applied to the machines of the MachineDeployment. At runtime this metadata is merged with the corresponding metadata from the topology. properties: annotations: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -448,12 +448,12 @@ spec: properties: controlPlane: description: |- - ControlPlane is a reference to a local struct that holds the details + controlPlane is a reference to a local struct that holds the details for provisioning the Control Plane for the Cluster. properties: machineHealthCheck: description: |- - MachineHealthCheck defines a MachineHealthCheck for this ControlPlaneClass. + machineHealthCheck defines a MachineHealthCheck for this ControlPlaneClass. This field is supported if and only if the ControlPlane provider template referenced above is Machine based and supports setting replicas. properties: @@ -467,7 +467,7 @@ spec: x-kubernetes-int-or-string: true nodeStartupTimeout: description: |- - NodeStartupTimeout allows to set the maximum time for MachineHealthCheck + nodeStartupTimeout allows to set the maximum time for MachineHealthCheck to consider a Machine unhealthy if a corresponding Node isn't associated through a `Spec.ProviderID` field. @@ -482,7 +482,7 @@ spec: type: string remediationTemplate: description: |- - RemediationTemplate is a reference to a remediation template + remediationTemplate is a reference to a remediation template provided by an infrastructure provider. This field is completely optional, when filled, the MachineHealthCheck controller @@ -531,7 +531,7 @@ spec: x-kubernetes-map-type: atomic unhealthyConditions: description: |- - UnhealthyConditions contains a list of the conditions that determine + unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy. items: @@ -566,7 +566,7 @@ spec: type: object machineInfrastructure: description: |- - MachineInfrastructure defines the metadata and infrastructure information + machineInfrastructure defines the metadata and infrastructure information for control plane machines. This field is supported if and only if the control plane provider template @@ -574,7 +574,7 @@ spec: properties: ref: description: |- - Ref is a required reference to a custom resource + ref is a required reference to a custom resource offered by a provider. properties: apiVersion: @@ -622,7 +622,7 @@ spec: type: object metadata: description: |- - Metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane + metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane if the ControlPlaneTemplate referenced is machine based. If not, it is applied only to the ControlPlane. At runtime this metadata is merged with the corresponding metadata from the topology. @@ -634,7 +634,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -650,12 +650,12 @@ spec: type: object type: object namingStrategy: - description: NamingStrategy allows changing the naming pattern + description: namingStrategy allows changing the naming pattern used when creating the control plane provider object. properties: template: description: |- - Template defines the template to use for generating the name of the ControlPlane object. + template defines the template to use for generating the name of the ControlPlane object. If not defined, it will fallback to `{{ .cluster.name }}-{{ .random }}`. If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will get concatenated with a random suffix of length 5. @@ -666,27 +666,27 @@ spec: type: object nodeDeletionTimeout: description: |- - NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. NOTE: This value can be overridden while defining a Cluster.Topology. type: string nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` NOTE: This value can be overridden while defining a Cluster.Topology. type: string nodeVolumeDetachTimeout: description: |- - NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. NOTE: This value can be overridden while defining a Cluster.Topology. type: string ref: description: |- - Ref is a required reference to a custom resource + ref is a required reference to a custom resource offered by a provider. properties: apiVersion: @@ -734,7 +734,7 @@ spec: type: object infrastructure: description: |- - Infrastructure is a reference to a provider-specific template that holds + infrastructure is a reference to a provider-specific template that holds the details for provisioning infrastructure specific cluster for the underlying provider. The underlying provider is responsible for the implementation @@ -742,7 +742,7 @@ spec: properties: ref: description: |- - Ref is a required reference to a custom resource + ref is a required reference to a custom resource offered by a provider. properties: apiVersion: @@ -790,7 +790,7 @@ spec: type: object patches: description: |- - Patches defines the patches which are applied to customize + patches defines the patches which are applied to customize referenced templates of a ClusterClass. Note: Patches will be applied in the order of the array. items: @@ -799,7 +799,7 @@ spec: properties: definitions: description: |- - Definitions define inline patches. + definitions define inline patches. Note: Patches will be applied in the order of the array. Note: Exactly one of Definitions or External must be set. items: @@ -808,7 +808,7 @@ spec: properties: jsonPatches: description: |- - JSONPatches defines the patches which should be applied on the templates + jsonPatches defines the patches which should be applied on the templates matching the selector. Note: Patches will be applied in the order of the array. items: @@ -816,12 +816,12 @@ spec: properties: op: description: |- - Op defines the operation of the patch. + op defines the operation of the patch. Note: Only `add`, `replace` and `remove` are supported. type: string path: description: |- - Path defines the path of the patch. + path defines the path of the patch. Note: Only the spec of a template can be patched, thus the path has to start with /spec/. Note: For now the only allowed array modifications are `append` and `prepend`, i.e.: * for op: `add`: only index 0 (prepend) and - (append) are allowed @@ -829,7 +829,7 @@ spec: type: string value: description: |- - Value defines the value of the patch. + value defines the value of the patch. Note: Either Value or ValueFrom is required for add and replace operations. Only one of them is allowed to be set at the same time. Note: We have to use apiextensionsv1.JSON instead of our JSON type, @@ -839,19 +839,19 @@ spec: x-kubernetes-preserve-unknown-fields: true valueFrom: description: |- - ValueFrom defines the value of the patch. + valueFrom defines the value of the patch. Note: Either Value or ValueFrom is required for add and replace operations. Only one of them is allowed to be set at the same time. properties: template: description: |- - Template is the Go template to be used to calculate the value. + template is the Go template to be used to calculate the value. A template can reference variables defined in .spec.variables and builtin variables. Note: The template must evaluate to a valid YAML or JSON value. type: string variable: description: |- - Variable is the variable to be used as value. + variable is the variable to be used as value. Variable can be one of the variables defined in .spec.variables or a builtin variable. type: string type: object @@ -861,36 +861,36 @@ spec: type: object type: array selector: - description: Selector defines on which templates the patch + description: selector defines on which templates the patch should be applied. properties: apiVersion: - description: APIVersion filters templates by apiVersion. + description: apiVersion filters templates by apiVersion. type: string kind: - description: Kind filters templates by kind. + description: kind filters templates by kind. type: string matchResources: - description: MatchResources selects templates based + description: matchResources selects templates based on where they are referenced. properties: controlPlane: description: |- - ControlPlane selects templates referenced in .spec.ControlPlane. + controlPlane selects templates referenced in .spec.ControlPlane. Note: this will match the controlPlane and also the controlPlane machineInfrastructure (depending on the kind and apiVersion). type: boolean infrastructureCluster: - description: InfrastructureCluster selects templates + description: infrastructureCluster selects templates referenced in .spec.infrastructure. type: boolean machineDeploymentClass: description: |- - MachineDeploymentClass selects templates referenced in specific MachineDeploymentClasses in + machineDeploymentClass selects templates referenced in specific MachineDeploymentClasses in .spec.workers.machineDeployments. properties: names: - description: Names selects templates by class + description: names selects templates by class names. items: type: string @@ -898,11 +898,11 @@ spec: type: object machinePoolClass: description: |- - MachinePoolClass selects templates referenced in specific MachinePoolClasses in + machinePoolClass selects templates referenced in specific MachinePoolClasses in .spec.workers.machinePools. properties: names: - description: Names selects templates by class + description: names selects templates by class names. items: type: string @@ -920,12 +920,12 @@ spec: type: object type: array description: - description: Description is a human-readable description of + description: description is a human-readable description of this patch. type: string enabledIf: description: |- - EnabledIf is a Go template to be used to calculate if a patch should be enabled. + enabledIf is a Go template to be used to calculate if a patch should be enabled. It can reference variables defined in .spec.variables and builtin variables. The patch will be enabled if the template evaluates to `true`, otherwise it will be disabled. @@ -933,32 +933,32 @@ spec: type: string external: description: |- - External defines an external patch. + external defines an external patch. Note: Exactly one of Definitions or External must be set. properties: discoverVariablesExtension: - description: DiscoverVariablesExtension references an extension + description: discoverVariablesExtension references an extension which is called to discover variables. type: string generateExtension: - description: GenerateExtension references an extension which + description: generateExtension references an extension which is called to generate patches. type: string settings: additionalProperties: type: string description: |- - Settings defines key value pairs to be passed to the extensions. + settings defines key value pairs to be passed to the extensions. Values defined here take precedence over the values defined in the corresponding ExtensionConfig. type: object validateExtension: - description: ValidateExtension references an extension which + description: validateExtension references an extension which is called to validate the topology. type: string type: object name: - description: Name of the patch. + description: name of the patch. type: string required: - name @@ -966,7 +966,7 @@ spec: type: array variables: description: |- - Variables defines the variables which can be configured + variables defines the variables which can be configured in the Cluster topology and are then used in patches. items: description: |- @@ -975,7 +975,7 @@ spec: properties: metadata: description: |- - Metadata is the metadata of a variable. + metadata is the metadata of a variable. It can be used to add additional data for higher level tools to a ClusterClassVariable. @@ -985,7 +985,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map that can be used to store and + annotations is an unstructured key value map that can be used to store and retrieve arbitrary metadata. They are not queryable. type: object @@ -998,27 +998,27 @@ spec: type: object type: object name: - description: Name of the variable. + description: name of the variable. type: string required: description: |- - Required specifies if the variable is required. + required specifies if the variable is required. Note: this applies to the variable as a whole and thus the top-level object defined in the schema. If nested fields are required, this will be specified inside the schema. type: boolean schema: - description: Schema defines the schema of the variable. + description: schema defines the schema of the variable. properties: openAPIV3Schema: description: |- - OpenAPIV3Schema defines the schema of a variable via OpenAPI v3 + openAPIV3Schema defines the schema of a variable via OpenAPI v3 schema. The schema is a subset of the schema used in Kubernetes CRDs. properties: additionalProperties: description: |- - AdditionalProperties specifies the schema of values in a map (keys are always strings). + additionalProperties specifies the schema of values in a map (keys are always strings). NOTE: Can only be set if type is object. NOTE: AdditionalProperties is mutually exclusive with Properties. NOTE: This field uses PreserveUnknownFields and Schemaless, @@ -1026,80 +1026,80 @@ spec: x-kubernetes-preserve-unknown-fields: true allOf: description: |- - AllOf specifies that the variable must validate against all of the subschemas in the array. + allOf specifies that the variable must validate against all of the subschemas in the array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible. x-kubernetes-preserve-unknown-fields: true anyOf: description: |- - AnyOf specifies that the variable must validate against one or more of the subschemas in the array. + anyOf specifies that the variable must validate against one or more of the subschemas in the array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible. x-kubernetes-preserve-unknown-fields: true default: description: |- - Default is the default value of the variable. + default is the default value of the variable. NOTE: Can be set for all types. x-kubernetes-preserve-unknown-fields: true description: - description: Description is a human-readable description + description: description is a human-readable description of this variable. type: string enum: description: |- - Enum is the list of valid values of the variable. + enum is the list of valid values of the variable. NOTE: Can be set for all types. items: x-kubernetes-preserve-unknown-fields: true type: array example: - description: Example is an example for this variable. + description: example is an example for this variable. x-kubernetes-preserve-unknown-fields: true exclusiveMaximum: description: |- - ExclusiveMaximum specifies if the Maximum is exclusive. + exclusiveMaximum specifies if the Maximum is exclusive. NOTE: Can only be set if type is integer or number. type: boolean exclusiveMinimum: description: |- - ExclusiveMinimum specifies if the Minimum is exclusive. + exclusiveMinimum specifies if the Minimum is exclusive. NOTE: Can only be set if type is integer or number. type: boolean format: description: |- - Format is an OpenAPI v3 format string. Unknown formats are ignored. + format is an OpenAPI v3 format string. Unknown formats are ignored. For a list of supported formats please see: (of the k8s.io/apiextensions-apiserver version we're currently using) https://github.com/kubernetes/apiextensions-apiserver/blob/master/pkg/apiserver/validation/formats.go NOTE: Can only be set if type is string. type: string items: description: |- - Items specifies fields of an array. + items specifies fields of an array. NOTE: Can only be set if type is array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible. x-kubernetes-preserve-unknown-fields: true maxItems: description: |- - MaxItems is the max length of an array variable. + maxItems is the max length of an array variable. NOTE: Can only be set if type is array. format: int64 type: integer maxLength: description: |- - MaxLength is the max length of a string variable. + maxLength is the max length of a string variable. NOTE: Can only be set if type is string. format: int64 type: integer maxProperties: description: |- - MaxProperties is the maximum amount of entries in a map or properties in an object. + maxProperties is the maximum amount of entries in a map or properties in an object. NOTE: Can only be set if type is object. format: int64 type: integer maximum: description: |- - Maximum is the maximum of an integer or number variable. + maximum is the maximum of an integer or number variable. If ExclusiveMaximum is false, the variable is valid if it is lower than, or equal to, the value of Maximum. If ExclusiveMaximum is true, the variable is valid if it is strictly lower than the value of Maximum. NOTE: Can only be set if type is integer or number. @@ -1107,25 +1107,25 @@ spec: type: integer minItems: description: |- - MinItems is the min length of an array variable. + minItems is the min length of an array variable. NOTE: Can only be set if type is array. format: int64 type: integer minLength: description: |- - MinLength is the min length of a string variable. + minLength is the min length of a string variable. NOTE: Can only be set if type is string. format: int64 type: integer minProperties: description: |- - MinProperties is the minimum amount of entries in a map or properties in an object. + minProperties is the minimum amount of entries in a map or properties in an object. NOTE: Can only be set if type is object. format: int64 type: integer minimum: description: |- - Minimum is the minimum of an integer or number variable. + minimum is the minimum of an integer or number variable. If ExclusiveMinimum is false, the variable is valid if it is greater than, or equal to, the value of Minimum. If ExclusiveMinimum is true, the variable is valid if it is strictly greater than the value of Minimum. NOTE: Can only be set if type is integer or number. @@ -1133,24 +1133,24 @@ spec: type: integer not: description: |- - Not specifies that the variable must not validate against the subschema. + not specifies that the variable must not validate against the subschema. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible. x-kubernetes-preserve-unknown-fields: true oneOf: description: |- - OneOf specifies that the variable must validate against exactly one of the subschemas in the array. + oneOf specifies that the variable must validate against exactly one of the subschemas in the array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible. x-kubernetes-preserve-unknown-fields: true pattern: description: |- - Pattern is the regex which a string variable must match. + pattern is the regex which a string variable must match. NOTE: Can only be set if type is string. type: string properties: description: |- - Properties specifies fields of an object. + properties specifies fields of an object. NOTE: Can only be set if type is object. NOTE: Properties is mutually exclusive with AdditionalProperties. NOTE: This field uses PreserveUnknownFields and Schemaless, @@ -1158,19 +1158,19 @@ spec: x-kubernetes-preserve-unknown-fields: true required: description: |- - Required specifies which fields of an object are required. + required specifies which fields of an object are required. NOTE: Can only be set if type is object. items: type: string type: array type: description: |- - Type is the type of the variable. + type is the type of the variable. Valid values are: object, array, string, integer, number or boolean. type: string uniqueItems: description: |- - UniqueItems specifies if items in an array must be unique. + uniqueItems specifies if items in an array must be unique. NOTE: Can only be set if type is array. type: boolean x-kubernetes-int-or-string: @@ -1191,20 +1191,21 @@ spec: type: boolean x-kubernetes-preserve-unknown-fields: description: |- - XPreserveUnknownFields allows setting fields in a variable object + x-kubernetes-preserve-unknown-fields allows setting fields in a variable object which are not defined in the variable schema. This affects fields recursively, except if nested properties or additionalProperties are specified in the schema. type: boolean x-kubernetes-validations: - description: XValidations describes a list of validation - rules written in the CEL expression language. + description: x-kubernetes-validations describes a list + of validation rules written in the CEL expression + language. items: description: ValidationRule describes a validation rule written in the CEL expression language. properties: fieldPath: description: |- - FieldPath represents the field path returned when the validation fails. + fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute `foo` under a map `testMap`, the fieldPath could be set to `.testMap.foo` If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. `.testList` @@ -1216,14 +1217,14 @@ spec: type: string message: description: |- - Message represents the message displayed when validation fails. The message is required if the Rule contains + message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" type: string messageExpression: description: |- - MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. + messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the validation failure message is produced @@ -1236,7 +1237,7 @@ spec: reason: default: FieldValueInvalid description: |- - Reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. + reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid. @@ -1247,7 +1248,7 @@ spec: - FieldValueDuplicate type: string rule: - description: "Rule represents the expression which + description: "rule represents the expression which will be evaluated by CEL.\nref: https://github.com/google/cel-spec\nThe Rule is scoped to the location of the x-kubernetes-validations extension in the schema.\nThe `self` variable @@ -1317,14 +1318,14 @@ spec: x-kubernetes-list-type: map x-metadata: description: |- - XMetadata is the metadata of a variable or a nested field within a variable. + x-metadata is the metadata of a variable or a nested field within a variable. It can be used to add additional data for higher level tools. properties: annotations: additionalProperties: type: string description: |- - Annotations is an unstructured key value map that can be used to store and + annotations is an unstructured key value map that can be used to store and retrieve arbitrary metadata. They are not queryable. type: object @@ -1348,13 +1349,13 @@ spec: type: array workers: description: |- - Workers describes the worker nodes for the cluster. + workers describes the worker nodes for the cluster. It is a collection of node types which can be used to create the worker nodes of the cluster. properties: machineDeployments: description: |- - MachineDeployments is a list of machine deployment classes that can be used to create + machineDeployments is a list of machine deployment classes that can be used to create a set of worker nodes. items: description: |- @@ -1363,18 +1364,18 @@ spec: properties: class: description: |- - Class denotes a type of worker node present in the cluster, + class denotes a type of worker node present in the cluster, this name MUST be unique within a ClusterClass and can be referenced in the Cluster to create a managed MachineDeployment. type: string failureDomain: description: |- - FailureDomain is the failure domain the machines will be created in. + failureDomain is the failure domain the machines will be created in. Must match a key in the FailureDomains map stored on the cluster object. NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass. type: string machineHealthCheck: - description: MachineHealthCheck defines a MachineHealthCheck + description: machineHealthCheck defines a MachineHealthCheck for this MachineDeploymentClass. properties: maxUnhealthy: @@ -1387,7 +1388,7 @@ spec: x-kubernetes-int-or-string: true nodeStartupTimeout: description: |- - NodeStartupTimeout allows to set the maximum time for MachineHealthCheck + nodeStartupTimeout allows to set the maximum time for MachineHealthCheck to consider a Machine unhealthy if a corresponding Node isn't associated through a `Spec.ProviderID` field. @@ -1402,7 +1403,7 @@ spec: type: string remediationTemplate: description: |- - RemediationTemplate is a reference to a remediation template + remediationTemplate is a reference to a remediation template provided by an infrastructure provider. This field is completely optional, when filled, the MachineHealthCheck controller @@ -1451,7 +1452,7 @@ spec: x-kubernetes-map-type: atomic unhealthyConditions: description: |- - UnhealthyConditions contains a list of the conditions that determine + unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy. items: @@ -1494,12 +1495,12 @@ spec: format: int32 type: integer namingStrategy: - description: NamingStrategy allows changing the naming pattern + description: namingStrategy allows changing the naming pattern used when creating the MachineDeployment. properties: template: description: |- - Template defines the template to use for generating the name of the MachineDeployment object. + template defines the template to use for generating the name of the MachineDeployment object. If not defined, it will fallback to `{{ .cluster.name }}-{{ .machineDeployment.topologyName }}-{{ .random }}`. If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will get concatenated with a random suffix of length 5. @@ -1511,21 +1512,21 @@ spec: type: object nodeDeletionTimeout: description: |- - NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass. type: string nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass. type: string nodeVolumeDetachTimeout: description: |- - NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass. type: string @@ -1537,7 +1538,7 @@ spec: properties: remediation: description: |- - Remediation controls the strategy of remediating unhealthy machines + remediation controls the strategy of remediating unhealthy machines and how remediating operations should occur during the lifecycle of the dependant MachineSets. properties: maxInFlight: @@ -1545,7 +1546,7 @@ spec: - type: integer - type: string description: |- - MaxInFlight determines how many in flight remediations should happen at the same time. + maxInFlight determines how many in flight remediations should happen at the same time. Remediation only happens on the MachineSet with the most current revision, while older MachineSets (usually present during rollout operations) aren't allowed to remediate. @@ -1568,7 +1569,7 @@ spec: properties: deletePolicy: description: |- - DeletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. + deletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. Valid values are "Random, "Newest", "Oldest" When no value is supplied, the default DeletePolicy of MachineSet is used enum: @@ -1616,7 +1617,7 @@ spec: type: object type: description: |- - Type of deployment. Allowed values are RollingUpdate and OnDelete. + type of deployment. Allowed values are RollingUpdate and OnDelete. The default is RollingUpdate. enum: - RollingUpdate @@ -1625,17 +1626,17 @@ spec: type: object template: description: |- - Template is a local struct containing a collection of templates for creation of + template is a local struct containing a collection of templates for creation of MachineDeployment objects representing a set of worker nodes. properties: bootstrap: description: |- - Bootstrap contains the bootstrap template reference to be used + bootstrap contains the bootstrap template reference to be used for the creation of worker Machines. properties: ref: description: |- - Ref is a required reference to a custom resource + ref is a required reference to a custom resource offered by a provider. properties: apiVersion: @@ -1683,12 +1684,12 @@ spec: type: object infrastructure: description: |- - Infrastructure contains the infrastructure template reference to be used + infrastructure contains the infrastructure template reference to be used for the creation of worker Machines. properties: ref: description: |- - Ref is a required reference to a custom resource + ref is a required reference to a custom resource offered by a provider. properties: apiVersion: @@ -1736,14 +1737,14 @@ spec: type: object metadata: description: |- - Metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment. + metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment. At runtime this metadata is merged with the corresponding metadata from the topology. properties: annotations: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -1772,7 +1773,7 @@ spec: x-kubernetes-list-type: map machinePools: description: |- - MachinePools is a list of machine pool classes that can be used to create + machinePools is a list of machine pool classes that can be used to create a set of worker nodes. items: description: |- @@ -1781,13 +1782,13 @@ spec: properties: class: description: |- - Class denotes a type of machine pool present in the cluster, + class denotes a type of machine pool present in the cluster, this name MUST be unique within a ClusterClass and can be referenced in the Cluster to create a managed MachinePool. type: string failureDomains: description: |- - FailureDomains is the list of failure domains the MachinePool should be attached to. + failureDomains is the list of failure domains the MachinePool should be attached to. Must match a key in the FailureDomains map stored on the cluster object. NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass. items: @@ -1803,12 +1804,12 @@ spec: format: int32 type: integer namingStrategy: - description: NamingStrategy allows changing the naming pattern + description: namingStrategy allows changing the naming pattern used when creating the MachinePool. properties: template: description: |- - Template defines the template to use for generating the name of the MachinePool object. + template defines the template to use for generating the name of the MachinePool object. If not defined, it will fallback to `{{ .cluster.name }}-{{ .machinePool.topologyName }}-{{ .random }}`. If the templated string exceeds 63 characters, it will be trimmed to 58 characters and will get concatenated with a random suffix of length 5. @@ -1820,37 +1821,37 @@ spec: type: object nodeDeletionTimeout: description: |- - NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine Pool is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass. type: string nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass. type: string nodeVolumeDetachTimeout: description: |- - NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass. type: string template: description: |- - Template is a local struct containing a collection of templates for creation of + template is a local struct containing a collection of templates for creation of MachinePools objects representing a pool of worker nodes. properties: bootstrap: description: |- - Bootstrap contains the bootstrap template reference to be used + bootstrap contains the bootstrap template reference to be used for the creation of the Machines in the MachinePool. properties: ref: description: |- - Ref is a required reference to a custom resource + ref is a required reference to a custom resource offered by a provider. properties: apiVersion: @@ -1898,12 +1899,12 @@ spec: type: object infrastructure: description: |- - Infrastructure contains the infrastructure template reference to be used + infrastructure contains the infrastructure template reference to be used for the creation of the MachinePool. properties: ref: description: |- - Ref is a required reference to a custom resource + ref is a required reference to a custom resource offered by a provider. properties: apiVersion: @@ -1951,14 +1952,14 @@ spec: type: object metadata: description: |- - Metadata is the metadata applied to the MachinePool. + metadata is the metadata applied to the MachinePool. At runtime this metadata is merged with the corresponding metadata from the topology. properties: annotations: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -1991,7 +1992,7 @@ spec: description: ClusterClassStatus defines the observed state of the ClusterClass. properties: conditions: - description: Conditions defines current observed state of the ClusterClass. + description: conditions defines current observed state of the ClusterClass. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -2016,16 +2017,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -2036,7 +2037,7 @@ spec: type: object type: array observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer @@ -2110,27 +2111,27 @@ spec: x-kubernetes-list-type: map type: object variables: - description: Variables is a list of ClusterClassStatusVariable that + description: variables is a list of ClusterClassStatusVariable that are defined for the ClusterClass. items: description: ClusterClassStatusVariable defines a variable which appears in the status of a ClusterClass. properties: definitions: - description: Definitions is a list of definitions for a variable. + description: definitions is a list of definitions for a variable. items: description: ClusterClassStatusVariableDefinition defines a variable which appears in the status of a ClusterClass. properties: from: description: |- - From specifies the origin of the variable definition. + from specifies the origin of the variable definition. This will be `inline` for variables defined in the ClusterClass or the name of a patch defined in the ClusterClass for variables discovered from a DiscoverVariables runtime extensions. type: string metadata: description: |- - Metadata is the metadata of a variable. + metadata is the metadata of a variable. It can be used to add additional data for higher level tools to a ClusterClassVariable. @@ -2140,7 +2141,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map that can be used to store and + annotations is an unstructured key value map that can be used to store and retrieve arbitrary metadata. They are not queryable. type: object @@ -2154,23 +2155,23 @@ spec: type: object required: description: |- - Required specifies if the variable is required. + required specifies if the variable is required. Note: this applies to the variable as a whole and thus the top-level object defined in the schema. If nested fields are required, this will be specified inside the schema. type: boolean schema: - description: Schema defines the schema of the variable. + description: schema defines the schema of the variable. properties: openAPIV3Schema: description: |- - OpenAPIV3Schema defines the schema of a variable via OpenAPI v3 + openAPIV3Schema defines the schema of a variable via OpenAPI v3 schema. The schema is a subset of the schema used in Kubernetes CRDs. properties: additionalProperties: description: |- - AdditionalProperties specifies the schema of values in a map (keys are always strings). + additionalProperties specifies the schema of values in a map (keys are always strings). NOTE: Can only be set if type is object. NOTE: AdditionalProperties is mutually exclusive with Properties. NOTE: This field uses PreserveUnknownFields and Schemaless, @@ -2178,80 +2179,80 @@ spec: x-kubernetes-preserve-unknown-fields: true allOf: description: |- - AllOf specifies that the variable must validate against all of the subschemas in the array. + allOf specifies that the variable must validate against all of the subschemas in the array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible. x-kubernetes-preserve-unknown-fields: true anyOf: description: |- - AnyOf specifies that the variable must validate against one or more of the subschemas in the array. + anyOf specifies that the variable must validate against one or more of the subschemas in the array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible. x-kubernetes-preserve-unknown-fields: true default: description: |- - Default is the default value of the variable. + default is the default value of the variable. NOTE: Can be set for all types. x-kubernetes-preserve-unknown-fields: true description: - description: Description is a human-readable description + description: description is a human-readable description of this variable. type: string enum: description: |- - Enum is the list of valid values of the variable. + enum is the list of valid values of the variable. NOTE: Can be set for all types. items: x-kubernetes-preserve-unknown-fields: true type: array example: - description: Example is an example for this variable. + description: example is an example for this variable. x-kubernetes-preserve-unknown-fields: true exclusiveMaximum: description: |- - ExclusiveMaximum specifies if the Maximum is exclusive. + exclusiveMaximum specifies if the Maximum is exclusive. NOTE: Can only be set if type is integer or number. type: boolean exclusiveMinimum: description: |- - ExclusiveMinimum specifies if the Minimum is exclusive. + exclusiveMinimum specifies if the Minimum is exclusive. NOTE: Can only be set if type is integer or number. type: boolean format: description: |- - Format is an OpenAPI v3 format string. Unknown formats are ignored. + format is an OpenAPI v3 format string. Unknown formats are ignored. For a list of supported formats please see: (of the k8s.io/apiextensions-apiserver version we're currently using) https://github.com/kubernetes/apiextensions-apiserver/blob/master/pkg/apiserver/validation/formats.go NOTE: Can only be set if type is string. type: string items: description: |- - Items specifies fields of an array. + items specifies fields of an array. NOTE: Can only be set if type is array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible. x-kubernetes-preserve-unknown-fields: true maxItems: description: |- - MaxItems is the max length of an array variable. + maxItems is the max length of an array variable. NOTE: Can only be set if type is array. format: int64 type: integer maxLength: description: |- - MaxLength is the max length of a string variable. + maxLength is the max length of a string variable. NOTE: Can only be set if type is string. format: int64 type: integer maxProperties: description: |- - MaxProperties is the maximum amount of entries in a map or properties in an object. + maxProperties is the maximum amount of entries in a map or properties in an object. NOTE: Can only be set if type is object. format: int64 type: integer maximum: description: |- - Maximum is the maximum of an integer or number variable. + maximum is the maximum of an integer or number variable. If ExclusiveMaximum is false, the variable is valid if it is lower than, or equal to, the value of Maximum. If ExclusiveMaximum is true, the variable is valid if it is strictly lower than the value of Maximum. NOTE: Can only be set if type is integer or number. @@ -2259,25 +2260,25 @@ spec: type: integer minItems: description: |- - MinItems is the min length of an array variable. + minItems is the min length of an array variable. NOTE: Can only be set if type is array. format: int64 type: integer minLength: description: |- - MinLength is the min length of a string variable. + minLength is the min length of a string variable. NOTE: Can only be set if type is string. format: int64 type: integer minProperties: description: |- - MinProperties is the minimum amount of entries in a map or properties in an object. + minProperties is the minimum amount of entries in a map or properties in an object. NOTE: Can only be set if type is object. format: int64 type: integer minimum: description: |- - Minimum is the minimum of an integer or number variable. + minimum is the minimum of an integer or number variable. If ExclusiveMinimum is false, the variable is valid if it is greater than, or equal to, the value of Minimum. If ExclusiveMinimum is true, the variable is valid if it is strictly greater than the value of Minimum. NOTE: Can only be set if type is integer or number. @@ -2285,24 +2286,24 @@ spec: type: integer not: description: |- - Not specifies that the variable must not validate against the subschema. + not specifies that the variable must not validate against the subschema. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible. x-kubernetes-preserve-unknown-fields: true oneOf: description: |- - OneOf specifies that the variable must validate against exactly one of the subschemas in the array. + oneOf specifies that the variable must validate against exactly one of the subschemas in the array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible. x-kubernetes-preserve-unknown-fields: true pattern: description: |- - Pattern is the regex which a string variable must match. + pattern is the regex which a string variable must match. NOTE: Can only be set if type is string. type: string properties: description: |- - Properties specifies fields of an object. + properties specifies fields of an object. NOTE: Can only be set if type is object. NOTE: Properties is mutually exclusive with AdditionalProperties. NOTE: This field uses PreserveUnknownFields and Schemaless, @@ -2310,19 +2311,19 @@ spec: x-kubernetes-preserve-unknown-fields: true required: description: |- - Required specifies which fields of an object are required. + required specifies which fields of an object are required. NOTE: Can only be set if type is object. items: type: string type: array type: description: |- - Type is the type of the variable. + type is the type of the variable. Valid values are: object, array, string, integer, number or boolean. type: string uniqueItems: description: |- - UniqueItems specifies if items in an array must be unique. + uniqueItems specifies if items in an array must be unique. NOTE: Can only be set if type is array. type: boolean x-kubernetes-int-or-string: @@ -2343,21 +2344,21 @@ spec: type: boolean x-kubernetes-preserve-unknown-fields: description: |- - XPreserveUnknownFields allows setting fields in a variable object + x-kubernetes-preserve-unknown-fields allows setting fields in a variable object which are not defined in the variable schema. This affects fields recursively, except if nested properties or additionalProperties are specified in the schema. type: boolean x-kubernetes-validations: - description: XValidations describes a list of - validation rules written in the CEL expression - language. + description: x-kubernetes-validations describes + a list of validation rules written in the CEL + expression language. items: description: ValidationRule describes a validation rule written in the CEL expression language. properties: fieldPath: description: |- - FieldPath represents the field path returned when the validation fails. + fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute `foo` under a map `testMap`, the fieldPath could be set to `.testMap.foo` If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. `.testList` @@ -2369,14 +2370,14 @@ spec: type: string message: description: |- - Message represents the message displayed when validation fails. The message is required if the Rule contains + message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" type: string messageExpression: description: |- - MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. + messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the validation failure message is produced @@ -2389,7 +2390,7 @@ spec: reason: default: FieldValueInvalid description: |- - Reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. + reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid. @@ -2400,7 +2401,7 @@ spec: - FieldValueDuplicate type: string rule: - description: "Rule represents the expression + description: "rule represents the expression which will be evaluated by CEL.\nref: https://github.com/google/cel-spec\nThe Rule is scoped to the location of the @@ -2479,14 +2480,14 @@ spec: x-kubernetes-list-type: map x-metadata: description: |- - XMetadata is the metadata of a variable or a nested field within a variable. + x-metadata is the metadata of a variable or a nested field within a variable. It can be used to add additional data for higher level tools. properties: annotations: additionalProperties: type: string description: |- - Annotations is an unstructured key value map that can be used to store and + annotations is an unstructured key value map that can be used to store and retrieve arbitrary metadata. They are not queryable. type: object @@ -2509,11 +2510,11 @@ spec: type: object type: array definitionsConflict: - description: DefinitionsConflict specifies whether or not there + description: definitionsConflict specifies whether or not there are conflicting definitions for a single variable name. type: boolean name: - description: Name is the name of the variable. + description: name is the name of the variable. type: string required: - definitions diff --git a/config/crd/bases/cluster.x-k8s.io_clusters.yaml b/config/crd/bases/cluster.x-k8s.io_clusters.yaml index 6f2877c5cc69..4ad16356145b 100644 --- a/config/crd/bases/cluster.x-k8s.io_clusters.yaml +++ b/config/crd/bases/cluster.x-k8s.io_clusters.yaml @@ -54,7 +54,7 @@ spec: properties: apiServerPort: description: |- - APIServerPort specifies the port the API Server should bind to. + apiServerPort specifies the port the API Server should bind to. Defaults to 6443. format: int32 type: integer @@ -83,7 +83,7 @@ spec: type: object type: object controlPlaneEndpoint: - description: ControlPlaneEndpoint represents the endpoint used to + description: controlPlaneEndpoint represents the endpoint used to communicate with the control plane. properties: host: @@ -99,7 +99,7 @@ spec: type: object controlPlaneRef: description: |- - ControlPlaneRef is an optional reference to a provider-specific resource that holds + controlPlaneRef is an optional reference to a provider-specific resource that holds the details for provisioning the Control Plane for a Cluster. properties: apiVersion: @@ -144,7 +144,7 @@ spec: x-kubernetes-map-type: atomic infrastructureRef: description: |- - InfrastructureRef is a reference to a provider-specific resource that holds the details + infrastructureRef is a reference to a provider-specific resource that holds the details for provisioning infrastructure for a cluster in said provider. properties: apiVersion: @@ -188,7 +188,7 @@ spec: type: object x-kubernetes-map-type: atomic paused: - description: Paused can be used to prevent controllers from processing + description: paused can be used to prevent controllers from processing the Cluster and all its associated objects. type: boolean type: object @@ -196,7 +196,7 @@ spec: description: ClusterStatus defines the observed state of Cluster. properties: conditions: - description: Conditions defines current service state of the cluster. + description: conditions defines current service state of the cluster. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -221,16 +221,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -240,11 +240,11 @@ spec: type: object type: array controlPlaneInitialized: - description: ControlPlaneInitialized defines if the control plane + description: controlPlaneInitialized defines if the control plane has been initialized. type: boolean controlPlaneReady: - description: ControlPlaneReady defines if the control plane is ready. + description: controlPlaneReady defines if the control plane is ready. type: boolean failureDomains: additionalProperties: @@ -255,40 +255,40 @@ spec: attributes: additionalProperties: type: string - description: Attributes is a free form map of attributes an + description: attributes is a free form map of attributes an infrastructure provider might use or require. type: object controlPlane: - description: ControlPlane determines if this failure domain + description: controlPlane determines if this failure domain is suitable for use by control plane machines. type: boolean type: object - description: FailureDomains is a slice of failure domain objects synced + description: failureDomains is a slice of failure domain objects synced from the infrastructure provider. type: object failureMessage: description: |- - FailureMessage indicates that there is a fatal problem reconciling the + failureMessage indicates that there is a fatal problem reconciling the state, and will be set to a descriptive error message. type: string failureReason: description: |- - FailureReason indicates that there is a fatal problem reconciling the + failureReason indicates that there is a fatal problem reconciling the state, and will be set to a token value suitable for programmatic interpretation. type: string infrastructureReady: - description: InfrastructureReady is the state of the infrastructure + description: infrastructureReady is the state of the infrastructure provider. type: boolean observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer phase: description: |- - Phase represents the current phase of cluster actuation. + phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc. type: string type: object @@ -340,7 +340,7 @@ spec: properties: apiServerPort: description: |- - APIServerPort specifies the port the API Server should bind to. + apiServerPort specifies the port the API Server should bind to. Defaults to 6443. format: int32 type: integer @@ -369,7 +369,7 @@ spec: type: object type: object controlPlaneEndpoint: - description: ControlPlaneEndpoint represents the endpoint used to + description: controlPlaneEndpoint represents the endpoint used to communicate with the control plane. properties: host: @@ -385,7 +385,7 @@ spec: type: object controlPlaneRef: description: |- - ControlPlaneRef is an optional reference to a provider-specific resource that holds + controlPlaneRef is an optional reference to a provider-specific resource that holds the details for provisioning the Control Plane for a Cluster. properties: apiVersion: @@ -430,7 +430,7 @@ spec: x-kubernetes-map-type: atomic infrastructureRef: description: |- - InfrastructureRef is a reference to a provider-specific resource that holds the details + infrastructureRef is a reference to a provider-specific resource that holds the details for provisioning infrastructure for a cluster in said provider. properties: apiVersion: @@ -474,7 +474,7 @@ spec: type: object x-kubernetes-map-type: atomic paused: - description: Paused can be used to prevent controllers from processing + description: paused can be used to prevent controllers from processing the Cluster and all its associated objects. type: boolean topology: @@ -489,11 +489,11 @@ spec: topology. type: string controlPlane: - description: ControlPlane describes the cluster control plane. + description: controlPlane describes the cluster control plane. properties: metadata: description: |- - Metadata is the metadata applied to the machines of the ControlPlane. + metadata is the metadata applied to the machines of the ControlPlane. At runtime this metadata is merged with the corresponding metadata from the ClusterClass. This field is supported if and only if the control plane provider template @@ -503,7 +503,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -520,7 +520,7 @@ spec: type: object replicas: description: |- - Replicas is the number of control plane nodes. + replicas is the number of control plane nodes. If the value is nil, the ControlPlane object is created without the number of Replicas and it's assumed that the control plane controller does not implement support for this field. When specified against a control plane provider that lacks support for this field, this value will be ignored. @@ -529,7 +529,7 @@ spec: type: object rolloutAfter: description: |- - RolloutAfter performs a rollout of the entire cluster one component at a time, + rolloutAfter performs a rollout of the entire cluster one component at a time, control plane first and then machine deployments. format: date-time type: string @@ -538,11 +538,11 @@ spec: type: string workers: description: |- - Workers encapsulates the different constructs that form the worker nodes + workers encapsulates the different constructs that form the worker nodes for the cluster. properties: machineDeployments: - description: MachineDeployments is a list of machine deployments + description: machineDeployments is a list of machine deployments in the cluster. items: description: |- @@ -551,20 +551,20 @@ spec: properties: class: description: |- - Class is the name of the MachineDeploymentClass used to create the set of worker nodes. + class is the name of the MachineDeploymentClass used to create the set of worker nodes. This should match one of the deployment classes defined in the ClusterClass object mentioned in the `Cluster.Spec.Class` field. type: string metadata: description: |- - Metadata is the metadata applied to the machines of the MachineDeployment. + metadata is the metadata applied to the machines of the MachineDeployment. At runtime this metadata is merged with the corresponding metadata from the ClusterClass. properties: annotations: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -581,14 +581,14 @@ spec: type: object name: description: |- - Name is the unique identifier for this MachineDeploymentTopology. + name is the unique identifier for this MachineDeploymentTopology. The value is used with other unique identifiers to create a MachineDeployment's Name (e.g. cluster's name, etc). In case the name is greater than the allowed maximum length, the values are hashed together. type: string replicas: description: |- - Replicas is the number of worker nodes belonging to this set. + replicas is the number of worker nodes belonging to this set. If the value is nil, the MachineDeployment is created without the number of Replicas (defaulting to zero) and it's assumed that an external entity (like cluster autoscaler) is responsible for the management of this value. @@ -609,7 +609,7 @@ spec: description: ClusterStatus defines the observed state of Cluster. properties: conditions: - description: Conditions defines current service state of the cluster. + description: conditions defines current service state of the cluster. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -634,16 +634,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -653,7 +653,7 @@ spec: type: object type: array controlPlaneReady: - description: ControlPlaneReady defines if the control plane is ready. + description: controlPlaneReady defines if the control plane is ready. type: boolean failureDomains: additionalProperties: @@ -664,40 +664,40 @@ spec: attributes: additionalProperties: type: string - description: Attributes is a free form map of attributes an + description: attributes is a free form map of attributes an infrastructure provider might use or require. type: object controlPlane: - description: ControlPlane determines if this failure domain + description: controlPlane determines if this failure domain is suitable for use by control plane machines. type: boolean type: object - description: FailureDomains is a slice of failure domain objects synced + description: failureDomains is a slice of failure domain objects synced from the infrastructure provider. type: object failureMessage: description: |- - FailureMessage indicates that there is a fatal problem reconciling the + failureMessage indicates that there is a fatal problem reconciling the state, and will be set to a descriptive error message. type: string failureReason: description: |- - FailureReason indicates that there is a fatal problem reconciling the + failureReason indicates that there is a fatal problem reconciling the state, and will be set to a token value suitable for programmatic interpretation. type: string infrastructureReady: - description: InfrastructureReady is the state of the infrastructure + description: infrastructureReady is the state of the infrastructure provider. type: boolean observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer phase: description: |- - Phase represents the current phase of cluster actuation. + phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc. type: string type: object @@ -780,7 +780,7 @@ spec: properties: apiServerPort: description: |- - APIServerPort specifies the port the API Server should bind to. + apiServerPort specifies the port the API Server should bind to. Defaults to 6443. format: int32 type: integer @@ -809,7 +809,7 @@ spec: type: object type: object controlPlaneEndpoint: - description: ControlPlaneEndpoint represents the endpoint used to + description: controlPlaneEndpoint represents the endpoint used to communicate with the control plane. properties: host: @@ -825,7 +825,7 @@ spec: type: object controlPlaneRef: description: |- - ControlPlaneRef is an optional reference to a provider-specific resource that holds + controlPlaneRef is an optional reference to a provider-specific resource that holds the details for provisioning the Control Plane for a Cluster. properties: apiVersion: @@ -870,7 +870,7 @@ spec: x-kubernetes-map-type: atomic infrastructureRef: description: |- - InfrastructureRef is a reference to a provider-specific resource that holds the details + infrastructureRef is a reference to a provider-specific resource that holds the details for provisioning infrastructure for a cluster in said provider. properties: apiVersion: @@ -914,7 +914,7 @@ spec: type: object x-kubernetes-map-type: atomic paused: - description: Paused can be used to prevent controllers from processing + description: paused can be used to prevent controllers from processing the Cluster and all its associated objects. type: boolean topology: @@ -929,16 +929,16 @@ spec: topology. type: string controlPlane: - description: ControlPlane describes the cluster control plane. + description: controlPlane describes the cluster control plane. properties: machineHealthCheck: description: |- - MachineHealthCheck allows to enable, disable and override + machineHealthCheck allows to enable, disable and override the MachineHealthCheck configuration in the ClusterClass for this control plane. properties: enable: description: |- - Enable controls if a MachineHealthCheck should be created for the target machines. + enable controls if a MachineHealthCheck should be created for the target machines. If false: No MachineHealthCheck will be created. @@ -958,7 +958,7 @@ spec: x-kubernetes-int-or-string: true nodeStartupTimeout: description: |- - NodeStartupTimeout allows to set the maximum time for MachineHealthCheck + nodeStartupTimeout allows to set the maximum time for MachineHealthCheck to consider a Machine unhealthy if a corresponding Node isn't associated through a `Spec.ProviderID` field. @@ -973,7 +973,7 @@ spec: type: string remediationTemplate: description: |- - RemediationTemplate is a reference to a remediation template + remediationTemplate is a reference to a remediation template provided by an infrastructure provider. This field is completely optional, when filled, the MachineHealthCheck controller @@ -1022,7 +1022,7 @@ spec: x-kubernetes-map-type: atomic unhealthyConditions: description: |- - UnhealthyConditions contains a list of the conditions that determine + unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy. items: @@ -1057,7 +1057,7 @@ spec: type: object metadata: description: |- - Metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane + metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane if the ControlPlaneTemplate referenced by the ClusterClass is machine based. If not, it is applied only to the ControlPlane. At runtime this metadata is merged with the corresponding metadata from the ClusterClass. @@ -1066,7 +1066,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -1083,35 +1083,35 @@ spec: type: object nodeDeletionTimeout: description: |- - NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. type: string nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string nodeVolumeDetachTimeout: description: |- - NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. type: string replicas: description: |- - Replicas is the number of control plane nodes. + replicas is the number of control plane nodes. If the value is nil, the ControlPlane object is created without the number of Replicas and it's assumed that the control plane controller does not implement support for this field. When specified against a control plane provider that lacks support for this field, this value will be ignored. format: int32 type: integer variables: - description: Variables can be used to customize the ControlPlane + description: variables can be used to customize the ControlPlane through patches. properties: overrides: - description: Overrides can be used to override Cluster + description: overrides can be used to override Cluster level variables. items: description: |- @@ -1120,16 +1120,16 @@ spec: properties: definitionFrom: description: |- - DefinitionFrom specifies where the definition of this Variable is from. + definitionFrom specifies where the definition of this Variable is from. Deprecated: This field is deprecated, must not be set anymore and is going to be removed in the next apiVersion. type: string name: - description: Name of the variable. + description: name of the variable. type: string value: description: |- - Value of the variable. + value of the variable. Note: the value will be validated against the schema of the corresponding ClusterClassVariable from the ClusterClass. Note: We have to use apiextensionsv1.JSON instead of a custom JSON type, because controller-tools has a @@ -1149,7 +1149,7 @@ spec: type: object rolloutAfter: description: |- - RolloutAfter performs a rollout of the entire cluster one component at a time, + rolloutAfter performs a rollout of the entire cluster one component at a time, control plane first and then machine deployments. Deprecated: This field has no function and is going to be removed in the next apiVersion. @@ -1157,7 +1157,7 @@ spec: type: string variables: description: |- - Variables can be used to customize the Cluster through + variables can be used to customize the Cluster through patches. They must comply to the corresponding VariableClasses defined in the ClusterClass. items: @@ -1167,16 +1167,16 @@ spec: properties: definitionFrom: description: |- - DefinitionFrom specifies where the definition of this Variable is from. + definitionFrom specifies where the definition of this Variable is from. Deprecated: This field is deprecated, must not be set anymore and is going to be removed in the next apiVersion. type: string name: - description: Name of the variable. + description: name of the variable. type: string value: description: |- - Value of the variable. + value of the variable. Note: the value will be validated against the schema of the corresponding ClusterClassVariable from the ClusterClass. Note: We have to use apiextensionsv1.JSON instead of a custom JSON type, because controller-tools has a @@ -1197,11 +1197,11 @@ spec: type: string workers: description: |- - Workers encapsulates the different constructs that form the worker nodes + workers encapsulates the different constructs that form the worker nodes for the cluster. properties: machineDeployments: - description: MachineDeployments is a list of machine deployments + description: machineDeployments is a list of machine deployments in the cluster. items: description: |- @@ -1210,23 +1210,23 @@ spec: properties: class: description: |- - Class is the name of the MachineDeploymentClass used to create the set of worker nodes. + class is the name of the MachineDeploymentClass used to create the set of worker nodes. This should match one of the deployment classes defined in the ClusterClass object mentioned in the `Cluster.Spec.Class` field. type: string failureDomain: description: |- - FailureDomain is the failure domain the machines will be created in. + failureDomain is the failure domain the machines will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string machineHealthCheck: description: |- - MachineHealthCheck allows to enable, disable and override + machineHealthCheck allows to enable, disable and override the MachineHealthCheck configuration in the ClusterClass for this MachineDeployment. properties: enable: description: |- - Enable controls if a MachineHealthCheck should be created for the target machines. + enable controls if a MachineHealthCheck should be created for the target machines. If false: No MachineHealthCheck will be created. @@ -1246,7 +1246,7 @@ spec: x-kubernetes-int-or-string: true nodeStartupTimeout: description: |- - NodeStartupTimeout allows to set the maximum time for MachineHealthCheck + nodeStartupTimeout allows to set the maximum time for MachineHealthCheck to consider a Machine unhealthy if a corresponding Node isn't associated through a `Spec.ProviderID` field. @@ -1261,7 +1261,7 @@ spec: type: string remediationTemplate: description: |- - RemediationTemplate is a reference to a remediation template + remediationTemplate is a reference to a remediation template provided by an infrastructure provider. This field is completely optional, when filled, the MachineHealthCheck controller @@ -1310,7 +1310,7 @@ spec: x-kubernetes-map-type: atomic unhealthyConditions: description: |- - UnhealthyConditions contains a list of the conditions that determine + unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy. items: @@ -1345,14 +1345,14 @@ spec: type: object metadata: description: |- - Metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment. + metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment. At runtime this metadata is merged with the corresponding metadata from the ClusterClass. properties: annotations: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -1377,31 +1377,31 @@ spec: type: integer name: description: |- - Name is the unique identifier for this MachineDeploymentTopology. + name is the unique identifier for this MachineDeploymentTopology. The value is used with other unique identifiers to create a MachineDeployment's Name (e.g. cluster's name, etc). In case the name is greater than the allowed maximum length, the values are hashed together. type: string nodeDeletionTimeout: description: |- - NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. type: string nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string nodeVolumeDetachTimeout: description: |- - NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. type: string replicas: description: |- - Replicas is the number of worker nodes belonging to this set. + replicas is the number of worker nodes belonging to this set. If the value is nil, the MachineDeployment is created without the number of Replicas (defaulting to 1) and it's assumed that an external entity (like cluster autoscaler) is responsible for the management of this value. @@ -1414,7 +1414,7 @@ spec: properties: remediation: description: |- - Remediation controls the strategy of remediating unhealthy machines + remediation controls the strategy of remediating unhealthy machines and how remediating operations should occur during the lifecycle of the dependant MachineSets. properties: maxInFlight: @@ -1422,7 +1422,7 @@ spec: - type: integer - type: string description: |- - MaxInFlight determines how many in flight remediations should happen at the same time. + maxInFlight determines how many in flight remediations should happen at the same time. Remediation only happens on the MachineSet with the most current revision, while older MachineSets (usually present during rollout operations) aren't allowed to remediate. @@ -1445,7 +1445,7 @@ spec: properties: deletePolicy: description: |- - DeletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. + deletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. Valid values are "Random, "Newest", "Oldest" When no value is supplied, the default DeletePolicy of MachineSet is used enum: @@ -1493,7 +1493,7 @@ spec: type: object type: description: |- - Type of deployment. Allowed values are RollingUpdate and OnDelete. + type of deployment. Allowed values are RollingUpdate and OnDelete. The default is RollingUpdate. enum: - RollingUpdate @@ -1501,11 +1501,11 @@ spec: type: string type: object variables: - description: Variables can be used to customize the + description: variables can be used to customize the MachineDeployment through patches. properties: overrides: - description: Overrides can be used to override Cluster + description: overrides can be used to override Cluster level variables. items: description: |- @@ -1514,16 +1514,16 @@ spec: properties: definitionFrom: description: |- - DefinitionFrom specifies where the definition of this Variable is from. + definitionFrom specifies where the definition of this Variable is from. Deprecated: This field is deprecated, must not be set anymore and is going to be removed in the next apiVersion. type: string name: - description: Name of the variable. + description: name of the variable. type: string value: description: |- - Value of the variable. + value of the variable. Note: the value will be validated against the schema of the corresponding ClusterClassVariable from the ClusterClass. Note: We have to use apiextensionsv1.JSON instead of a custom JSON type, because controller-tools has a @@ -1549,7 +1549,7 @@ spec: - name x-kubernetes-list-type: map machinePools: - description: MachinePools is a list of machine pools in the + description: machinePools is a list of machine pools in the cluster. items: description: |- @@ -1558,27 +1558,27 @@ spec: properties: class: description: |- - Class is the name of the MachinePoolClass used to create the pool of worker nodes. + class is the name of the MachinePoolClass used to create the pool of worker nodes. This should match one of the deployment classes defined in the ClusterClass object mentioned in the `Cluster.Spec.Class` field. type: string failureDomains: description: |- - FailureDomains is the list of failure domains the machine pool will be created in. + failureDomains is the list of failure domains the machine pool will be created in. Must match a key in the FailureDomains map stored on the cluster object. items: type: string type: array metadata: description: |- - Metadata is the metadata applied to the MachinePool. + metadata is the metadata applied to the MachinePool. At runtime this metadata is merged with the corresponding metadata from the ClusterClass. properties: annotations: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -1603,42 +1603,42 @@ spec: type: integer name: description: |- - Name is the unique identifier for this MachinePoolTopology. + name is the unique identifier for this MachinePoolTopology. The value is used with other unique identifiers to create a MachinePool's Name (e.g. cluster's name, etc). In case the name is greater than the allowed maximum length, the values are hashed together. type: string nodeDeletionTimeout: description: |- - NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the MachinePool + nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the MachinePool hosts after the MachinePool is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. type: string nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string nodeVolumeDetachTimeout: description: |- - NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. type: string replicas: description: |- - Replicas is the number of nodes belonging to this pool. + replicas is the number of nodes belonging to this pool. If the value is nil, the MachinePool is created without the number of Replicas (defaulting to 1) and it's assumed that an external entity (like cluster autoscaler) is responsible for the management of this value. format: int32 type: integer variables: - description: Variables can be used to customize the + description: variables can be used to customize the MachinePool through patches. properties: overrides: - description: Overrides can be used to override Cluster + description: overrides can be used to override Cluster level variables. items: description: |- @@ -1647,16 +1647,16 @@ spec: properties: definitionFrom: description: |- - DefinitionFrom specifies where the definition of this Variable is from. + definitionFrom specifies where the definition of this Variable is from. Deprecated: This field is deprecated, must not be set anymore and is going to be removed in the next apiVersion. type: string name: - description: Name of the variable. + description: name of the variable. type: string value: description: |- - Value of the variable. + value of the variable. Note: the value will be validated against the schema of the corresponding ClusterClassVariable from the ClusterClass. Note: We have to use apiextensionsv1.JSON instead of a custom JSON type, because controller-tools has a @@ -1691,7 +1691,7 @@ spec: description: ClusterStatus defines the observed state of Cluster. properties: conditions: - description: Conditions defines current service state of the cluster. + description: conditions defines current service state of the cluster. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -1716,16 +1716,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -1737,7 +1737,7 @@ spec: type: array controlPlaneReady: description: |- - ControlPlaneReady denotes if the control plane became ready during initial provisioning + controlPlaneReady denotes if the control plane became ready during initial provisioning to receive requests. NOTE: this field is part of the Cluster API contract and it is used to orchestrate provisioning. The value of this field is never updated after provisioning is completed. Please use conditions @@ -1752,44 +1752,44 @@ spec: attributes: additionalProperties: type: string - description: Attributes is a free form map of attributes an + description: attributes is a free form map of attributes an infrastructure provider might use or require. type: object controlPlane: - description: ControlPlane determines if this failure domain + description: controlPlane determines if this failure domain is suitable for use by control plane machines. type: boolean type: object - description: FailureDomains is a slice of failure domain objects synced + description: failureDomains is a slice of failure domain objects synced from the infrastructure provider. type: object failureMessage: description: |- - FailureMessage indicates that there is a fatal problem reconciling the + failureMessage indicates that there is a fatal problem reconciling the state, and will be set to a descriptive error message. Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details. type: string failureReason: description: |- - FailureReason indicates that there is a fatal problem reconciling the + failureReason indicates that there is a fatal problem reconciling the state, and will be set to a token value suitable for programmatic interpretation. Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details. type: string infrastructureReady: - description: InfrastructureReady is the state of the infrastructure + description: infrastructureReady is the state of the infrastructure provider. type: boolean observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer phase: description: |- - Phase represents the current phase of cluster actuation. + phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc. type: string v1beta2: diff --git a/config/crd/bases/cluster.x-k8s.io_machinedeployments.yaml b/config/crd/bases/cluster.x-k8s.io_machinedeployments.yaml index f71420031e22..62aadc4b7192 100644 --- a/config/crd/bases/cluster.x-k8s.io_machinedeployments.yaml +++ b/config/crd/bases/cluster.x-k8s.io_machinedeployments.yaml @@ -70,7 +70,7 @@ spec: description: MachineDeploymentSpec defines the desired state of MachineDeployment. properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string @@ -206,13 +206,13 @@ spec: type: object type: description: |- - Type of deployment. Currently the only supported strategy is + type of deployment. Currently the only supported strategy is "RollingUpdate". Default is RollingUpdate. type: string type: object template: - description: Template describes the machines that will be created. + description: template describes the machines that will be created. properties: metadata: description: |- @@ -223,14 +223,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations type: object generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + generateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. @@ -259,7 +259,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. @@ -270,7 +270,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. @@ -344,12 +344,12 @@ spec: properties: bootstrap: description: |- - Bootstrap is a reference to a local struct which encapsulates + bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism. properties: configRef: description: |- - ConfigRef is a reference to a bootstrap provider-specific resource + configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.Data without the need of a controller. @@ -396,30 +396,30 @@ spec: x-kubernetes-map-type: atomic data: description: |- - Data contains the bootstrap data, such as cloud-init details scripts. + data contains the bootstrap data, such as cloud-init details scripts. If nil, the Machine should remain in the Pending state. Deprecated: Switch to DataSecretName. type: string dataSecretName: description: |- - DataSecretName is the name of the secret that stores the bootstrap data script. + dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state. type: string type: object clusterName: - description: ClusterName is the name of the Cluster this object + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomain: description: |- - FailureDomain is the failure domain the machine will be created in. + failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -464,13 +464,13 @@ spec: x-kubernetes-map-type: atomic nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -483,7 +483,7 @@ spec: type: string version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers. type: string required: @@ -511,7 +511,7 @@ spec: format: int64 type: integer phase: - description: Phase represents the current phase of a MachineDeployment + description: phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown). type: string readyReplicas: @@ -526,7 +526,7 @@ spec: type: integer selector: description: |- - Selector is the same as the label selector but in the string format to avoid introspection + selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors type: string @@ -615,7 +615,7 @@ spec: description: MachineDeploymentSpec defines the desired state of MachineDeployment. properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string @@ -714,7 +714,7 @@ spec: properties: deletePolicy: description: |- - DeletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. + deletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. Valid values are "Random, "Newest", "Oldest" When no value is supplied, the default DeletePolicy of MachineSet is used enum: @@ -762,7 +762,7 @@ spec: type: object type: description: |- - Type of deployment. + type of deployment. Default is RollingUpdate. enum: - RollingUpdate @@ -770,7 +770,7 @@ spec: type: string type: object template: - description: Template describes the machines that will be created. + description: template describes the machines that will be created. properties: metadata: description: |- @@ -781,7 +781,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -803,12 +803,12 @@ spec: properties: bootstrap: description: |- - Bootstrap is a reference to a local struct which encapsulates + bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism. properties: configRef: description: |- - ConfigRef is a reference to a bootstrap provider-specific resource + configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.DataSecretName without the need of a controller. @@ -855,23 +855,23 @@ spec: x-kubernetes-map-type: atomic dataSecretName: description: |- - DataSecretName is the name of the secret that stores the bootstrap data script. + dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state. type: string type: object clusterName: - description: ClusterName is the name of the Cluster this object + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomain: description: |- - FailureDomain is the failure domain the machine will be created in. + failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -916,13 +916,13 @@ spec: x-kubernetes-map-type: atomic nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -935,7 +935,7 @@ spec: type: string version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers. type: string required: @@ -959,7 +959,7 @@ spec: format: int32 type: integer conditions: - description: Conditions defines current service state of the MachineDeployment. + description: conditions defines current service state of the MachineDeployment. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -984,16 +984,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -1007,7 +1007,7 @@ spec: format: int64 type: integer phase: - description: Phase represents the current phase of a MachineDeployment + description: phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown). type: string readyReplicas: @@ -1022,7 +1022,7 @@ spec: type: integer selector: description: |- - Selector is the same as the label selector but in the string format to avoid introspection + selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors type: string @@ -1116,13 +1116,13 @@ spec: description: MachineDeploymentSpec defines the desired state of MachineDeployment. properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string minReadySeconds: description: |- - MinReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. + minReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. Defaults to 0 (machine will be considered available as soon as the Node is ready) format: int32 type: integer @@ -1170,7 +1170,7 @@ spec: type: integer rolloutAfter: description: |- - RolloutAfter is a field to indicate a rollout should be performed + rolloutAfter is a field to indicate a rollout should be performed after the specified time even if no changes have been made to the MachineDeployment. Example: In the YAML the time can be specified in the RFC3339 format. @@ -1234,7 +1234,7 @@ spec: properties: remediation: description: |- - Remediation controls the strategy of remediating unhealthy machines + remediation controls the strategy of remediating unhealthy machines and how remediating operations should occur during the lifecycle of the dependant MachineSets. properties: maxInFlight: @@ -1242,7 +1242,7 @@ spec: - type: integer - type: string description: |- - MaxInFlight determines how many in flight remediations should happen at the same time. + maxInFlight determines how many in flight remediations should happen at the same time. Remediation only happens on the MachineSet with the most current revision, while older MachineSets (usually present during rollout operations) aren't allowed to remediate. @@ -1265,7 +1265,7 @@ spec: properties: deletePolicy: description: |- - DeletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. + deletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. Valid values are "Random, "Newest", "Oldest" When no value is supplied, the default DeletePolicy of MachineSet is used enum: @@ -1313,7 +1313,7 @@ spec: type: object type: description: |- - Type of deployment. Allowed values are RollingUpdate and OnDelete. + type of deployment. Allowed values are RollingUpdate and OnDelete. The default is RollingUpdate. enum: - RollingUpdate @@ -1321,7 +1321,7 @@ spec: type: string type: object template: - description: Template describes the machines that will be created. + description: template describes the machines that will be created. properties: metadata: description: |- @@ -1332,7 +1332,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -1354,12 +1354,12 @@ spec: properties: bootstrap: description: |- - Bootstrap is a reference to a local struct which encapsulates + bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism. properties: configRef: description: |- - ConfigRef is a reference to a bootstrap provider-specific resource + configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.DataSecretName without the need of a controller. @@ -1406,23 +1406,23 @@ spec: x-kubernetes-map-type: atomic dataSecretName: description: |- - DataSecretName is the name of the secret that stores the bootstrap data script. + dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state. type: string type: object clusterName: - description: ClusterName is the name of the Cluster this object + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomain: description: |- - FailureDomain is the failure domain the machine will be created in. + failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -1467,24 +1467,24 @@ spec: x-kubernetes-map-type: atomic nodeDeletionTimeout: description: |- - NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. type: string nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string nodeVolumeDetachTimeout: description: |- - NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. type: string providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -1530,7 +1530,7 @@ spec: x-kubernetes-list-type: map version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers. type: string required: @@ -1554,7 +1554,7 @@ spec: format: int32 type: integer conditions: - description: Conditions defines current service state of the MachineDeployment. + description: conditions defines current service state of the MachineDeployment. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -1579,16 +1579,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -1603,7 +1603,7 @@ spec: format: int64 type: integer phase: - description: Phase represents the current phase of a MachineDeployment + description: phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown). type: string readyReplicas: @@ -1618,7 +1618,7 @@ spec: type: integer selector: description: |- - Selector is the same as the label selector but in the string format to avoid introspection + selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors type: string diff --git a/config/crd/bases/cluster.x-k8s.io_machinehealthchecks.yaml b/config/crd/bases/cluster.x-k8s.io_machinehealthchecks.yaml index 0a63bf3d321e..6893ddd15b4a 100644 --- a/config/crd/bases/cluster.x-k8s.io_machinehealthchecks.yaml +++ b/config/crd/bases/cluster.x-k8s.io_machinehealthchecks.yaml @@ -62,7 +62,7 @@ spec: description: Specification of machine health check policy properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string @@ -81,7 +81,7 @@ spec: type: string remediationTemplate: description: |- - RemediationTemplate is a reference to a remediation template + remediationTemplate is a reference to a remediation template provided by an infrastructure provider. This field is completely optional, when filled, the MachineHealthCheck controller @@ -177,7 +177,7 @@ spec: x-kubernetes-map-type: atomic unhealthyConditions: description: |- - UnhealthyConditions contains a list of the conditions that determine + unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy. items: @@ -210,7 +210,7 @@ spec: description: Most recently observed status of MachineHealthCheck resource properties: conditions: - description: Conditions defines current service state of the MachineHealthCheck. + description: conditions defines current service state of the MachineHealthCheck. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -235,16 +235,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -266,19 +266,19 @@ spec: minimum: 0 type: integer observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer remediationsAllowed: description: |- - RemediationsAllowed is the number of further remediations allowed by this machine health check before + remediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied format: int32 minimum: 0 type: integer targets: - description: Targets shows the current list of machines the machine + description: targets shows the current list of machines the machine health check is watching items: type: string @@ -340,7 +340,7 @@ spec: description: Specification of machine health check policy properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string @@ -361,7 +361,7 @@ spec: type: string remediationTemplate: description: |- - RemediationTemplate is a reference to a remediation template + remediationTemplate is a reference to a remediation template provided by an infrastructure provider. This field is completely optional, when filled, the MachineHealthCheck controller @@ -457,7 +457,7 @@ spec: x-kubernetes-map-type: atomic unhealthyConditions: description: |- - UnhealthyConditions contains a list of the conditions that determine + unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy. items: @@ -499,7 +499,7 @@ spec: description: Most recently observed status of MachineHealthCheck resource properties: conditions: - description: Conditions defines current service state of the MachineHealthCheck. + description: conditions defines current service state of the MachineHealthCheck. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -524,16 +524,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -555,19 +555,19 @@ spec: minimum: 0 type: integer observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer remediationsAllowed: description: |- - RemediationsAllowed is the number of further remediations allowed by this machine health check before + remediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied format: int32 minimum: 0 type: integer targets: - description: Targets shows the current list of machines the machine + description: targets shows the current list of machines the machine health check is watching items: type: string @@ -626,7 +626,7 @@ spec: description: Specification of machine health check policy properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string @@ -642,7 +642,7 @@ spec: x-kubernetes-int-or-string: true nodeStartupTimeout: description: |- - NodeStartupTimeout allows to set the maximum time for MachineHealthCheck + nodeStartupTimeout allows to set the maximum time for MachineHealthCheck to consider a Machine unhealthy if a corresponding Node isn't associated through a `Spec.ProviderID` field. @@ -657,7 +657,7 @@ spec: type: string remediationTemplate: description: |- - RemediationTemplate is a reference to a remediation template + remediationTemplate is a reference to a remediation template provided by an infrastructure provider. This field is completely optional, when filled, the MachineHealthCheck controller @@ -753,7 +753,7 @@ spec: x-kubernetes-map-type: atomic unhealthyConditions: description: |- - UnhealthyConditions contains a list of the conditions that determine + unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy. items: @@ -795,7 +795,7 @@ spec: description: Most recently observed status of MachineHealthCheck resource properties: conditions: - description: Conditions defines current service state of the MachineHealthCheck. + description: conditions defines current service state of the MachineHealthCheck. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -820,16 +820,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -852,19 +852,19 @@ spec: minimum: 0 type: integer observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer remediationsAllowed: description: |- - RemediationsAllowed is the number of further remediations allowed by this machine health check before + remediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied format: int32 minimum: 0 type: integer targets: - description: Targets shows the current list of machines the machine + description: targets shows the current list of machines the machine health check is watching items: type: string diff --git a/config/crd/bases/cluster.x-k8s.io_machinepools.yaml b/config/crd/bases/cluster.x-k8s.io_machinepools.yaml index 608c36d43519..aadf46dcd7c6 100644 --- a/config/crd/bases/cluster.x-k8s.io_machinepools.yaml +++ b/config/crd/bases/cluster.x-k8s.io_machinepools.yaml @@ -62,12 +62,12 @@ spec: description: MachinePoolSpec defines the desired state of MachinePool. properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomains: - description: FailureDomains is the list of failure domains this MachinePool + description: failureDomains is the list of failure domains this MachinePool should be attached to. items: type: string @@ -82,7 +82,7 @@ spec: type: integer providerIDList: description: |- - ProviderIDList are the identification IDs of machine instances provided by the provider. + providerIDList are the identification IDs of machine instances provided by the provider. This field must match the provider IDs as seen on the node objects corresponding to a machine pool's machine instances. items: type: string @@ -143,13 +143,13 @@ spec: type: object type: description: |- - Type of deployment. Currently the only supported strategy is + type of deployment. Currently the only supported strategy is "RollingUpdate". Default is RollingUpdate. type: string type: object template: - description: Template describes the machines that will be created. + description: template describes the machines that will be created. properties: metadata: description: |- @@ -160,14 +160,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations type: object generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + generateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. @@ -196,7 +196,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. @@ -207,7 +207,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. @@ -281,12 +281,12 @@ spec: properties: bootstrap: description: |- - Bootstrap is a reference to a local struct which encapsulates + bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism. properties: configRef: description: |- - ConfigRef is a reference to a bootstrap provider-specific resource + configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.Data without the need of a controller. @@ -333,30 +333,30 @@ spec: x-kubernetes-map-type: atomic data: description: |- - Data contains the bootstrap data, such as cloud-init details scripts. + data contains the bootstrap data, such as cloud-init details scripts. If nil, the Machine should remain in the Pending state. Deprecated: Switch to DataSecretName. type: string dataSecretName: description: |- - DataSecretName is the name of the secret that stores the bootstrap data script. + dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state. type: string type: object clusterName: - description: ClusterName is the name of the Cluster this object + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomain: description: |- - FailureDomain is the failure domain the machine will be created in. + failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -401,13 +401,13 @@ spec: x-kubernetes-map-type: atomic nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -420,7 +420,7 @@ spec: type: string version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers. type: string required: @@ -442,10 +442,10 @@ spec: format: int32 type: integer bootstrapReady: - description: BootstrapReady is the state of the bootstrap provider. + description: bootstrapReady is the state of the bootstrap provider. type: boolean conditions: - description: Conditions define the current service state of the MachinePool. + description: conditions define the current service state of the MachinePool. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -470,16 +470,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -490,20 +490,20 @@ spec: type: array failureMessage: description: |- - FailureMessage indicates that there is a problem reconciling the state, + failureMessage indicates that there is a problem reconciling the state, and will be set to a descriptive error message. type: string failureReason: description: |- - FailureReason indicates that there is a problem reconciling the state, and + failureReason indicates that there is a problem reconciling the state, and will be set to a token value suitable for programmatic interpretation. type: string infrastructureReady: - description: InfrastructureReady is the state of the infrastructure + description: infrastructureReady is the state of the infrastructure provider. type: boolean nodeRefs: - description: NodeRefs will point to the corresponding Nodes if it + description: nodeRefs will point to the corresponding Nodes if it they exist. items: description: ObjectReference contains enough information to let @@ -551,13 +551,13 @@ spec: x-kubernetes-map-type: atomic type: array observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer phase: description: |- - Phase represents the current phase of cluster actuation. + phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc. type: string readyReplicas: @@ -567,7 +567,7 @@ spec: format: int32 type: integer replicas: - description: Replicas is the most recently observed number of replicas. + description: replicas is the most recently observed number of replicas. format: int32 type: integer unavailableReplicas: @@ -636,12 +636,12 @@ spec: description: MachinePoolSpec defines the desired state of MachinePool. properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomains: - description: FailureDomains is the list of failure domains this MachinePool + description: failureDomains is the list of failure domains this MachinePool should be attached to. items: type: string @@ -656,7 +656,7 @@ spec: type: integer providerIDList: description: |- - ProviderIDList are the identification IDs of machine instances provided by the provider. + providerIDList are the identification IDs of machine instances provided by the provider. This field must match the provider IDs as seen on the node objects corresponding to a machine pool's machine instances. items: type: string @@ -668,7 +668,7 @@ spec: format: int32 type: integer template: - description: Template describes the machines that will be created. + description: template describes the machines that will be created. properties: metadata: description: |- @@ -679,7 +679,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -701,12 +701,12 @@ spec: properties: bootstrap: description: |- - Bootstrap is a reference to a local struct which encapsulates + bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism. properties: configRef: description: |- - ConfigRef is a reference to a bootstrap provider-specific resource + configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.DataSecretName without the need of a controller. @@ -753,23 +753,23 @@ spec: x-kubernetes-map-type: atomic dataSecretName: description: |- - DataSecretName is the name of the secret that stores the bootstrap data script. + dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state. type: string type: object clusterName: - description: ClusterName is the name of the Cluster this object + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomain: description: |- - FailureDomain is the failure domain the machine will be created in. + failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -814,13 +814,13 @@ spec: x-kubernetes-map-type: atomic nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -833,7 +833,7 @@ spec: type: string version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers. type: string required: @@ -855,10 +855,10 @@ spec: format: int32 type: integer bootstrapReady: - description: BootstrapReady is the state of the bootstrap provider. + description: bootstrapReady is the state of the bootstrap provider. type: boolean conditions: - description: Conditions define the current service state of the MachinePool. + description: conditions define the current service state of the MachinePool. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -883,16 +883,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -903,20 +903,20 @@ spec: type: array failureMessage: description: |- - FailureMessage indicates that there is a problem reconciling the state, + failureMessage indicates that there is a problem reconciling the state, and will be set to a descriptive error message. type: string failureReason: description: |- - FailureReason indicates that there is a problem reconciling the state, and + failureReason indicates that there is a problem reconciling the state, and will be set to a token value suitable for programmatic interpretation. type: string infrastructureReady: - description: InfrastructureReady is the state of the infrastructure + description: infrastructureReady is the state of the infrastructure provider. type: boolean nodeRefs: - description: NodeRefs will point to the corresponding Nodes if it + description: nodeRefs will point to the corresponding Nodes if it they exist. items: description: ObjectReference contains enough information to let @@ -964,13 +964,13 @@ spec: x-kubernetes-map-type: atomic type: array observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer phase: description: |- - Phase represents the current phase of cluster actuation. + phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc. type: string readyReplicas: @@ -980,7 +980,7 @@ spec: format: int32 type: integer replicas: - description: Replicas is the most recently observed number of replicas. + description: replicas is the most recently observed number of replicas. format: int32 type: integer unavailableReplicas: @@ -1054,12 +1054,12 @@ spec: description: MachinePoolSpec defines the desired state of MachinePool. properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomains: - description: FailureDomains is the list of failure domains this MachinePool + description: failureDomains is the list of failure domains this MachinePool should be attached to. items: type: string @@ -1074,7 +1074,7 @@ spec: type: integer providerIDList: description: |- - ProviderIDList are the identification IDs of machine instances provided by the provider. + providerIDList are the identification IDs of machine instances provided by the provider. This field must match the provider IDs as seen on the node objects corresponding to a machine pool's machine instances. items: type: string @@ -1086,7 +1086,7 @@ spec: format: int32 type: integer template: - description: Template describes the machines that will be created. + description: template describes the machines that will be created. properties: metadata: description: |- @@ -1097,7 +1097,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -1119,12 +1119,12 @@ spec: properties: bootstrap: description: |- - Bootstrap is a reference to a local struct which encapsulates + bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism. properties: configRef: description: |- - ConfigRef is a reference to a bootstrap provider-specific resource + configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.DataSecretName without the need of a controller. @@ -1171,23 +1171,23 @@ spec: x-kubernetes-map-type: atomic dataSecretName: description: |- - DataSecretName is the name of the secret that stores the bootstrap data script. + dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state. type: string type: object clusterName: - description: ClusterName is the name of the Cluster this object + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomain: description: |- - FailureDomain is the failure domain the machine will be created in. + failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -1232,24 +1232,24 @@ spec: x-kubernetes-map-type: atomic nodeDeletionTimeout: description: |- - NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. type: string nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string nodeVolumeDetachTimeout: description: |- - NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. type: string providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -1295,7 +1295,7 @@ spec: x-kubernetes-list-type: map version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers. type: string required: @@ -1317,10 +1317,10 @@ spec: format: int32 type: integer bootstrapReady: - description: BootstrapReady is the state of the bootstrap provider. + description: bootstrapReady is the state of the bootstrap provider. type: boolean conditions: - description: Conditions define the current service state of the MachinePool. + description: conditions define the current service state of the MachinePool. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -1345,16 +1345,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -1366,24 +1366,24 @@ spec: type: array failureMessage: description: |- - FailureMessage indicates that there is a problem reconciling the state, + failureMessage indicates that there is a problem reconciling the state, and will be set to a descriptive error message. Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details. type: string failureReason: description: |- - FailureReason indicates that there is a problem reconciling the state, and + failureReason indicates that there is a problem reconciling the state, and will be set to a token value suitable for programmatic interpretation. Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details. type: string infrastructureReady: - description: InfrastructureReady is the state of the infrastructure + description: infrastructureReady is the state of the infrastructure provider. type: boolean nodeRefs: - description: NodeRefs will point to the corresponding Nodes if it + description: nodeRefs will point to the corresponding Nodes if it they exist. items: description: ObjectReference contains enough information to let @@ -1431,13 +1431,13 @@ spec: x-kubernetes-map-type: atomic type: array observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer phase: description: |- - Phase represents the current phase of cluster actuation. + phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc. type: string readyReplicas: @@ -1447,7 +1447,7 @@ spec: format: int32 type: integer replicas: - description: Replicas is the most recently observed number of replicas. + description: replicas is the most recently observed number of replicas. format: int32 type: integer unavailableReplicas: diff --git a/config/crd/bases/cluster.x-k8s.io_machines.yaml b/config/crd/bases/cluster.x-k8s.io_machines.yaml index 37dd970a37d3..82a59fe02e50 100644 --- a/config/crd/bases/cluster.x-k8s.io_machines.yaml +++ b/config/crd/bases/cluster.x-k8s.io_machines.yaml @@ -67,12 +67,12 @@ spec: properties: bootstrap: description: |- - Bootstrap is a reference to a local struct which encapsulates + bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism. properties: configRef: description: |- - ConfigRef is a reference to a bootstrap provider-specific resource + configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.Data without the need of a controller. @@ -119,30 +119,30 @@ spec: x-kubernetes-map-type: atomic data: description: |- - Data contains the bootstrap data, such as cloud-init details scripts. + data contains the bootstrap data, such as cloud-init details scripts. If nil, the Machine should remain in the Pending state. Deprecated: Switch to DataSecretName. type: string dataSecretName: description: |- - DataSecretName is the name of the secret that stores the bootstrap data script. + dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state. type: string type: object clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomain: description: |- - FailureDomain is the failure domain the machine will be created in. + failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -187,13 +187,13 @@ spec: x-kubernetes-map-type: atomic nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -206,7 +206,7 @@ spec: type: string version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers. type: string required: @@ -219,7 +219,7 @@ spec: properties: addresses: description: |- - Addresses is a list of addresses assigned to the machine. + addresses is a list of addresses assigned to the machine. This field is copied from the infrastructure provider reference. items: description: MachineAddress contains information for the node's @@ -238,10 +238,10 @@ spec: type: object type: array bootstrapReady: - description: BootstrapReady is the state of the bootstrap provider. + description: bootstrapReady is the state of the bootstrap provider. type: boolean conditions: - description: Conditions defines current service state of the Machine. + description: conditions defines current service state of the Machine. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -266,16 +266,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -286,7 +286,7 @@ spec: type: array failureMessage: description: |- - FailureMessage will be set in the event that there is a terminal problem + failureMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption. @@ -305,7 +305,7 @@ spec: type: string failureReason: description: |- - FailureReason will be set in the event that there is a terminal problem + failureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation. @@ -323,16 +323,16 @@ spec: controller's output. type: string infrastructureReady: - description: InfrastructureReady is the state of the infrastructure + description: infrastructureReady is the state of the infrastructure provider. type: boolean lastUpdated: - description: LastUpdated identifies when the phase of the Machine + description: lastUpdated identifies when the phase of the Machine last transitioned. format: date-time type: string nodeRef: - description: NodeRef will point to the corresponding Node if it exists. + description: nodeRef will point to the corresponding Node if it exists. properties: apiVersion: description: API version of the referent. @@ -375,18 +375,18 @@ spec: type: object x-kubernetes-map-type: atomic observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer phase: description: |- - Phase represents the current phase of machine actuation. + phase represents the current phase of machine actuation. E.g. Pending, Running, Terminating, Failed etc. type: string version: description: |- - Version specifies the current version of Kubernetes running + version specifies the current version of Kubernetes running on the corresponding Node. This is meant to be a means of bubbling up status from the Node to the Machine. It is entirely optional, but useful for end-user UX if it’s present. @@ -454,12 +454,12 @@ spec: properties: bootstrap: description: |- - Bootstrap is a reference to a local struct which encapsulates + bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism. properties: configRef: description: |- - ConfigRef is a reference to a bootstrap provider-specific resource + configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.DataSecretName without the need of a controller. @@ -506,23 +506,23 @@ spec: x-kubernetes-map-type: atomic dataSecretName: description: |- - DataSecretName is the name of the secret that stores the bootstrap data script. + dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state. type: string type: object clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomain: description: |- - FailureDomain is the failure domain the machine will be created in. + failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -567,13 +567,13 @@ spec: x-kubernetes-map-type: atomic nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -586,7 +586,7 @@ spec: type: string version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers. type: string required: @@ -599,7 +599,7 @@ spec: properties: addresses: description: |- - Addresses is a list of addresses assigned to the machine. + addresses is a list of addresses assigned to the machine. This field is copied from the infrastructure provider reference. items: description: MachineAddress contains information for the node's @@ -618,10 +618,10 @@ spec: type: object type: array bootstrapReady: - description: BootstrapReady is the state of the bootstrap provider. + description: bootstrapReady is the state of the bootstrap provider. type: boolean conditions: - description: Conditions defines current service state of the Machine. + description: conditions defines current service state of the Machine. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -646,16 +646,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -666,7 +666,7 @@ spec: type: array failureMessage: description: |- - FailureMessage will be set in the event that there is a terminal problem + failureMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption. @@ -685,7 +685,7 @@ spec: type: string failureReason: description: |- - FailureReason will be set in the event that there is a terminal problem + failureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation. @@ -703,17 +703,17 @@ spec: controller's output. type: string infrastructureReady: - description: InfrastructureReady is the state of the infrastructure + description: infrastructureReady is the state of the infrastructure provider. type: boolean lastUpdated: - description: LastUpdated identifies when the phase of the Machine + description: lastUpdated identifies when the phase of the Machine last transitioned. format: date-time type: string nodeInfo: description: |- - NodeInfo is a set of ids/uuids to uniquely identify the node. + nodeInfo is a set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info properties: architecture: @@ -768,7 +768,7 @@ spec: - systemUUID type: object nodeRef: - description: NodeRef will point to the corresponding Node if it exists. + description: nodeRef will point to the corresponding Node if it exists. properties: apiVersion: description: API version of the referent. @@ -811,18 +811,18 @@ spec: type: object x-kubernetes-map-type: atomic observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer phase: description: |- - Phase represents the current phase of machine actuation. + phase represents the current phase of machine actuation. E.g. Pending, Running, Terminating, Failed etc. type: string version: description: |- - Version specifies the current version of Kubernetes running + version specifies the current version of Kubernetes running on the corresponding Node. This is meant to be a means of bubbling up status from the Node to the Machine. It is entirely optional, but useful for end-user UX if it’s present. @@ -885,12 +885,12 @@ spec: properties: bootstrap: description: |- - Bootstrap is a reference to a local struct which encapsulates + bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism. properties: configRef: description: |- - ConfigRef is a reference to a bootstrap provider-specific resource + configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.DataSecretName without the need of a controller. @@ -937,23 +937,23 @@ spec: x-kubernetes-map-type: atomic dataSecretName: description: |- - DataSecretName is the name of the secret that stores the bootstrap data script. + dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state. type: string type: object clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomain: description: |- - FailureDomain is the failure domain the machine will be created in. + failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -998,24 +998,24 @@ spec: x-kubernetes-map-type: atomic nodeDeletionTimeout: description: |- - NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. type: string nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string nodeVolumeDetachTimeout: description: |- - NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. type: string providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -1061,7 +1061,7 @@ spec: x-kubernetes-list-type: map version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers. type: string required: @@ -1074,7 +1074,7 @@ spec: properties: addresses: description: |- - Addresses is a list of addresses assigned to the machine. + addresses is a list of addresses assigned to the machine. This field is copied from the infrastructure provider reference. items: description: MachineAddress contains information for the node's @@ -1093,16 +1093,16 @@ spec: type: object type: array bootstrapReady: - description: BootstrapReady is the state of the bootstrap provider. + description: bootstrapReady is the state of the bootstrap provider. type: boolean certificatesExpiryDate: description: |- - CertificatesExpiryDate is the expiry date of the machine certificates. + certificatesExpiryDate is the expiry date of the machine certificates. This value is only set for control plane machines. format: date-time type: string conditions: - description: Conditions defines current service state of the Machine. + description: conditions defines current service state of the Machine. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -1127,16 +1127,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -1170,7 +1170,7 @@ spec: type: object failureMessage: description: |- - FailureMessage will be set in the event that there is a terminal problem + failureMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption. @@ -1191,7 +1191,7 @@ spec: type: string failureReason: description: |- - FailureReason will be set in the event that there is a terminal problem + failureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation. @@ -1211,17 +1211,17 @@ spec: Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details. type: string infrastructureReady: - description: InfrastructureReady is the state of the infrastructure + description: infrastructureReady is the state of the infrastructure provider. type: boolean lastUpdated: - description: LastUpdated identifies when the phase of the Machine + description: lastUpdated identifies when the phase of the Machine last transitioned. format: date-time type: string nodeInfo: description: |- - NodeInfo is a set of ids/uuids to uniquely identify the node. + nodeInfo is a set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info properties: architecture: @@ -1276,7 +1276,7 @@ spec: - systemUUID type: object nodeRef: - description: NodeRef will point to the corresponding Node if it exists. + description: nodeRef will point to the corresponding Node if it exists. properties: apiVersion: description: API version of the referent. @@ -1319,13 +1319,13 @@ spec: type: object x-kubernetes-map-type: atomic observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer phase: description: |- - Phase represents the current phase of machine actuation. + phase represents the current phase of machine actuation. E.g. Pending, Running, Terminating, Failed etc. type: string v1beta2: diff --git a/config/crd/bases/cluster.x-k8s.io_machinesets.yaml b/config/crd/bases/cluster.x-k8s.io_machinesets.yaml index 4bcc3fc500b5..f49aa31c574c 100644 --- a/config/crd/bases/cluster.x-k8s.io_machinesets.yaml +++ b/config/crd/bases/cluster.x-k8s.io_machinesets.yaml @@ -61,13 +61,13 @@ spec: description: MachineSetSpec defines the desired state of MachineSet. properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string deletePolicy: description: |- - DeletePolicy defines the policy used to identify nodes to delete when downscaling. + deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to "Random". Valid values are "Random, "Newest", "Oldest" enum: - Random @@ -76,20 +76,20 @@ spec: type: string minReadySeconds: description: |- - MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. + minReadySeconds is the minimum number of seconds for which a newly created machine should be ready. Defaults to 0 (machine will be considered available as soon as it is ready) format: int32 type: integer replicas: description: |- - Replicas is the number of desired replicas. + replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. format: int32 type: integer selector: description: |- - Selector is a label query over machines that should match the replica count. + selector is a label query over machines that should match the replica count. Label keys and values that must match in order to be controlled by this MachineSet. It must match the machine template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors @@ -139,7 +139,7 @@ spec: x-kubernetes-map-type: atomic template: description: |- - Template is the object that describes the machine that will be created if + template is the object that describes the machine that will be created if insufficient replicas are detected. Object references to custom resources are treated as templates. properties: @@ -152,14 +152,14 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations type: object generateName: description: |- - GenerateName is an optional prefix, used by the server, to generate a unique + generateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. @@ -188,7 +188,7 @@ spec: type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. @@ -199,7 +199,7 @@ spec: type: string namespace: description: |- - Namespace defines the space within each name must be unique. An empty namespace is + namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. @@ -273,12 +273,12 @@ spec: properties: bootstrap: description: |- - Bootstrap is a reference to a local struct which encapsulates + bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism. properties: configRef: description: |- - ConfigRef is a reference to a bootstrap provider-specific resource + configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.Data without the need of a controller. @@ -325,30 +325,30 @@ spec: x-kubernetes-map-type: atomic data: description: |- - Data contains the bootstrap data, such as cloud-init details scripts. + data contains the bootstrap data, such as cloud-init details scripts. If nil, the Machine should remain in the Pending state. Deprecated: Switch to DataSecretName. type: string dataSecretName: description: |- - DataSecretName is the name of the secret that stores the bootstrap data script. + dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state. type: string type: object clusterName: - description: ClusterName is the name of the Cluster this object + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomain: description: |- - FailureDomain is the failure domain the machine will be created in. + failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -393,13 +393,13 @@ spec: x-kubernetes-map-type: atomic nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -412,7 +412,7 @@ spec: type: string version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers. type: string required: @@ -462,7 +462,7 @@ spec: format: int32 type: integer observedGeneration: - description: ObservedGeneration reflects the generation of the most + description: observedGeneration reflects the generation of the most recently observed MachineSet. format: int64 type: integer @@ -472,12 +472,12 @@ spec: format: int32 type: integer replicas: - description: Replicas is the most recently observed number of replicas. + description: replicas is the most recently observed number of replicas. format: int32 type: integer selector: description: |- - Selector is the same as the label selector but in the string format to avoid introspection + selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors type: string @@ -542,13 +542,13 @@ spec: description: MachineSetSpec defines the desired state of MachineSet. properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string deletePolicy: description: |- - DeletePolicy defines the policy used to identify nodes to delete when downscaling. + deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to "Random". Valid values are "Random, "Newest", "Oldest" enum: - Random @@ -557,21 +557,21 @@ spec: type: string minReadySeconds: description: |- - MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. + minReadySeconds is the minimum number of seconds for which a newly created machine should be ready. Defaults to 0 (machine will be considered available as soon as it is ready) format: int32 type: integer replicas: default: 1 description: |- - Replicas is the number of desired replicas. + replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. format: int32 type: integer selector: description: |- - Selector is a label query over machines that should match the replica count. + selector is a label query over machines that should match the replica count. Label keys and values that must match in order to be controlled by this MachineSet. It must match the machine template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors @@ -621,7 +621,7 @@ spec: x-kubernetes-map-type: atomic template: description: |- - Template is the object that describes the machine that will be created if + template is the object that describes the machine that will be created if insufficient replicas are detected. Object references to custom resources are treated as templates. properties: @@ -634,7 +634,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -656,12 +656,12 @@ spec: properties: bootstrap: description: |- - Bootstrap is a reference to a local struct which encapsulates + bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism. properties: configRef: description: |- - ConfigRef is a reference to a bootstrap provider-specific resource + configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.DataSecretName without the need of a controller. @@ -708,23 +708,23 @@ spec: x-kubernetes-map-type: atomic dataSecretName: description: |- - DataSecretName is the name of the secret that stores the bootstrap data script. + dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state. type: string type: object clusterName: - description: ClusterName is the name of the Cluster this object + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomain: description: |- - FailureDomain is the failure domain the machine will be created in. + failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -769,13 +769,13 @@ spec: x-kubernetes-map-type: atomic nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -788,7 +788,7 @@ spec: type: string version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers. type: string required: @@ -810,7 +810,7 @@ spec: format: int32 type: integer conditions: - description: Conditions defines current service state of the MachineSet. + description: conditions defines current service state of the MachineSet. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -835,16 +835,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -882,7 +882,7 @@ spec: format: int32 type: integer observedGeneration: - description: ObservedGeneration reflects the generation of the most + description: observedGeneration reflects the generation of the most recently observed MachineSet. format: int64 type: integer @@ -892,12 +892,12 @@ spec: format: int32 type: integer replicas: - description: Replicas is the most recently observed number of replicas. + description: replicas is the most recently observed number of replicas. format: int32 type: integer selector: description: |- - Selector is the same as the label selector but in the string format to avoid introspection + selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors type: string @@ -967,13 +967,13 @@ spec: description: MachineSetSpec defines the desired state of MachineSet. properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string deletePolicy: description: |- - DeletePolicy defines the policy used to identify nodes to delete when downscaling. + deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to "Random". Valid values are "Random, "Newest", "Oldest" enum: - Random @@ -982,13 +982,13 @@ spec: type: string minReadySeconds: description: |- - MinReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. + minReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. Defaults to 0 (machine will be considered available as soon as the Node is ready) format: int32 type: integer replicas: description: |- - Replicas is the number of desired replicas. + replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to: @@ -1009,7 +1009,7 @@ spec: type: integer selector: description: |- - Selector is a label query over machines that should match the replica count. + selector is a label query over machines that should match the replica count. Label keys and values that must match in order to be controlled by this MachineSet. It must match the machine template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors @@ -1059,7 +1059,7 @@ spec: x-kubernetes-map-type: atomic template: description: |- - Template is the object that describes the machine that will be created if + template is the object that describes the machine that will be created if insufficient replicas are detected. Object references to custom resources are treated as templates. properties: @@ -1072,7 +1072,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -1094,12 +1094,12 @@ spec: properties: bootstrap: description: |- - Bootstrap is a reference to a local struct which encapsulates + bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism. properties: configRef: description: |- - ConfigRef is a reference to a bootstrap provider-specific resource + configRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.DataSecretName without the need of a controller. @@ -1146,23 +1146,23 @@ spec: x-kubernetes-map-type: atomic dataSecretName: description: |- - DataSecretName is the name of the secret that stores the bootstrap data script. + dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state. type: string type: object clusterName: - description: ClusterName is the name of the Cluster this object + description: clusterName is the name of the Cluster this object belongs to. minLength: 1 type: string failureDomain: description: |- - FailureDomain is the failure domain the machine will be created in. + failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object. type: string infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -1207,24 +1207,24 @@ spec: x-kubernetes-map-type: atomic nodeDeletionTimeout: description: |- - NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine + nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. type: string nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string nodeVolumeDetachTimeout: description: |- - NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. type: string providerID: description: |- - ProviderID is the identification ID of the machine provided by the provider. + providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -1270,7 +1270,7 @@ spec: x-kubernetes-list-type: map version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers. type: string required: @@ -1292,7 +1292,7 @@ spec: format: int32 type: integer conditions: - description: Conditions defines current service state of the MachineSet. + description: conditions defines current service state of the MachineSet. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -1317,16 +1317,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -1370,7 +1370,7 @@ spec: format: int32 type: integer observedGeneration: - description: ObservedGeneration reflects the generation of the most + description: observedGeneration reflects the generation of the most recently observed MachineSet. format: int64 type: integer @@ -1380,12 +1380,12 @@ spec: format: int32 type: integer replicas: - description: Replicas is the most recently observed number of replicas. + description: replicas is the most recently observed number of replicas. format: int32 type: integer selector: description: |- - Selector is the same as the label selector but in the string format to avoid introspection + selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors type: string diff --git a/config/crd/bases/ipam.cluster.x-k8s.io_ipaddressclaims.yaml b/config/crd/bases/ipam.cluster.x-k8s.io_ipaddressclaims.yaml index f05f04474d99..7f3f8515f725 100644 --- a/config/crd/bases/ipam.cluster.x-k8s.io_ipaddressclaims.yaml +++ b/config/crd/bases/ipam.cluster.x-k8s.io_ipaddressclaims.yaml @@ -55,7 +55,7 @@ spec: description: IPAddressClaimSpec is the desired state of an IPAddressClaim. properties: poolRef: - description: PoolRef is a reference to the pool from which an IP address + description: poolRef is a reference to the pool from which an IP address should be created. properties: apiGroup: @@ -82,7 +82,7 @@ spec: description: IPAddressClaimStatus is the observed status of a IPAddressClaim. properties: addressRef: - description: AddressRef is a reference to the address that was created + description: addressRef is a reference to the address that was created for this claim. properties: name: @@ -97,7 +97,7 @@ spec: type: object x-kubernetes-map-type: atomic conditions: - description: Conditions summarises the current state of the IPAddressClaim + description: conditions summarises the current state of the IPAddressClaim items: description: Condition defines an observation of a Cluster API resource operational state. @@ -122,16 +122,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -186,11 +186,11 @@ spec: description: IPAddressClaimSpec is the desired state of an IPAddressClaim. properties: clusterName: - description: ClusterName is the name of the Cluster this object belongs + description: clusterName is the name of the Cluster this object belongs to. type: string poolRef: - description: PoolRef is a reference to the pool from which an IP address + description: poolRef is a reference to the pool from which an IP address should be created. properties: apiGroup: @@ -217,7 +217,7 @@ spec: description: IPAddressClaimStatus is the observed status of a IPAddressClaim. properties: addressRef: - description: AddressRef is a reference to the address that was created + description: addressRef is a reference to the address that was created for this claim. properties: name: @@ -232,7 +232,7 @@ spec: type: object x-kubernetes-map-type: atomic conditions: - description: Conditions summarises the current state of the IPAddressClaim + description: conditions summarises the current state of the IPAddressClaim items: description: Condition defines an observation of a Cluster API resource operational state. @@ -257,16 +257,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string diff --git a/config/crd/bases/ipam.cluster.x-k8s.io_ipaddresses.yaml b/config/crd/bases/ipam.cluster.x-k8s.io_ipaddresses.yaml index b25fee0ab11e..c96733eea0f1 100644 --- a/config/crd/bases/ipam.cluster.x-k8s.io_ipaddresses.yaml +++ b/config/crd/bases/ipam.cluster.x-k8s.io_ipaddresses.yaml @@ -59,10 +59,10 @@ spec: description: IPAddressSpec is the desired state of an IPAddress. properties: address: - description: Address is the IP address. + description: address is the IP address. type: string claimRef: - description: ClaimRef is a reference to the claim this IPAddress was + description: claimRef is a reference to the claim this IPAddress was created for. properties: name: @@ -77,11 +77,11 @@ spec: type: object x-kubernetes-map-type: atomic gateway: - description: Gateway is the network gateway of the network the address + description: gateway is the network gateway of the network the address is from. type: string poolRef: - description: PoolRef is a reference to the pool that this IPAddress + description: poolRef is a reference to the pool that this IPAddress was created from. properties: apiGroup: @@ -102,7 +102,7 @@ spec: type: object x-kubernetes-map-type: atomic prefix: - description: Prefix is the prefix of the address. + description: prefix is the prefix of the address. type: integer required: - address @@ -157,10 +157,10 @@ spec: description: IPAddressSpec is the desired state of an IPAddress. properties: address: - description: Address is the IP address. + description: address is the IP address. type: string claimRef: - description: ClaimRef is a reference to the claim this IPAddress was + description: claimRef is a reference to the claim this IPAddress was created for. properties: name: @@ -175,11 +175,11 @@ spec: type: object x-kubernetes-map-type: atomic gateway: - description: Gateway is the network gateway of the network the address + description: gateway is the network gateway of the network the address is from. type: string poolRef: - description: PoolRef is a reference to the pool that this IPAddress + description: poolRef is a reference to the pool that this IPAddress was created from. properties: apiGroup: @@ -200,7 +200,7 @@ spec: type: object x-kubernetes-map-type: atomic prefix: - description: Prefix is the prefix of the address. + description: prefix is the prefix of the address. type: integer required: - address diff --git a/config/crd/bases/runtime.cluster.x-k8s.io_extensionconfigs.yaml b/config/crd/bases/runtime.cluster.x-k8s.io_extensionconfigs.yaml index b66fbce4ac04..77e6ff8ec402 100644 --- a/config/crd/bases/runtime.cluster.x-k8s.io_extensionconfigs.yaml +++ b/config/crd/bases/runtime.cluster.x-k8s.io_extensionconfigs.yaml @@ -49,35 +49,35 @@ spec: description: ExtensionConfigSpec is the desired state of the ExtensionConfig properties: clientConfig: - description: ClientConfig defines how to communicate with the Extension + description: clientConfig defines how to communicate with the Extension server. properties: caBundle: - description: CABundle is a PEM encoded CA bundle which will be + description: caBundle is a PEM encoded CA bundle which will be used to validate the Extension server's server certificate. format: byte type: string service: description: |- - Service is a reference to the Kubernetes service for the Extension server. + service is a reference to the Kubernetes service for the Extension server. Note: Exactly one of `url` or `service` must be specified. If the Extension server is running within a cluster, then you should use `service`. properties: name: - description: Name is the name of the service. + description: name is the name of the service. type: string namespace: - description: Namespace is the namespace of the service. + description: namespace is the namespace of the service. type: string path: description: |- - Path is an optional URL path and if present may be any string permissible in + path is an optional URL path and if present may be any string permissible in a URL. If a path is set it will be used as prefix to the hook-specific path. type: string port: description: |- - Port is the port on the service that's hosting the Extension server. + port is the port on the service that's hosting the Extension server. Defaults to 443. Port should be a valid port number (1-65535, inclusive). format: int32 @@ -88,7 +88,7 @@ spec: type: object url: description: |- - URL gives the location of the Extension server, in standard URL form + url gives the location of the Extension server, in standard URL form (`scheme://host:port/path`). Note: Exactly one of `url` or `service` must be specified. @@ -107,7 +107,7 @@ spec: type: object namespaceSelector: description: |- - NamespaceSelector decides whether to call the hook for an object based + namespaceSelector decides whether to call the hook for an object based on whether the namespace for that object matches the selector. Defaults to the empty LabelSelector, which matches all objects. properties: @@ -158,7 +158,7 @@ spec: additionalProperties: type: string description: |- - Settings defines key value pairs to be passed to all calls + settings defines key value pairs to be passed to all calls to all supported RuntimeExtensions. Note: Settings can be overridden on the ClusterClass. type: object @@ -169,7 +169,7 @@ spec: description: ExtensionConfigStatus is the current state of the ExtensionConfig properties: conditions: - description: Conditions define the current service state of the ExtensionConfig. + description: conditions define the current service state of the ExtensionConfig. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -194,16 +194,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -214,7 +214,7 @@ spec: type: object type: array handlers: - description: Handlers defines the current ExtensionHandlers supported + description: handlers defines the current ExtensionHandlers supported by an Extension. items: description: ExtensionHandler specifies the details of a handler @@ -222,22 +222,22 @@ spec: properties: failurePolicy: description: |- - FailurePolicy defines how failures in calls to the ExtensionHandler should be handled by a client. + failurePolicy defines how failures in calls to the ExtensionHandler should be handled by a client. Defaults to Fail if not set. type: string name: - description: Name is the unique name of the ExtensionHandler. + description: name is the unique name of the ExtensionHandler. type: string requestHook: - description: RequestHook defines the versioned runtime hook + description: requestHook defines the versioned runtime hook which this ExtensionHandler serves. properties: apiVersion: - description: APIVersion is the group and version of the + description: apiVersion is the group and version of the Hook. type: string hook: - description: Hook is the name of the hook. + description: hook is the name of the hook. type: string required: - apiVersion @@ -245,7 +245,7 @@ spec: type: object timeoutSeconds: description: |- - TimeoutSeconds defines the timeout duration for client calls to the ExtensionHandler. + timeoutSeconds defines the timeout duration for client calls to the ExtensionHandler. Defaults to 10 is not set. format: int32 type: integer diff --git a/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go b/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go index 99e22d5b367b..e3ecfcc36403 100644 --- a/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go +++ b/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go @@ -84,7 +84,7 @@ type KubeadmControlPlaneSpec struct { // +optional Replicas *int32 `json:"replicas,omitempty"` - // Version defines the desired Kubernetes version. + // version defines the desired Kubernetes version. // Please note that if kubeadmConfigSpec.ClusterConfiguration.imageRepository is not set // we don't allow upgrades to versions >= v1.22.0 for which kubeadm uses the old registry (k8s.gcr.io). // Please use a newer patch version with the new registry instead. The default registries of kubeadm are: @@ -92,20 +92,20 @@ type KubeadmControlPlaneSpec struct { // * k8s.gcr.io (old registry): all older versions Version string `json:"version"` - // MachineTemplate contains information about how machines + // machineTemplate contains information about how machines // should be shaped when creating or updating a control plane. MachineTemplate KubeadmControlPlaneMachineTemplate `json:"machineTemplate"` - // KubeadmConfigSpec is a KubeadmConfigSpec + // kubeadmConfigSpec is a KubeadmConfigSpec // to use for initializing and joining machines to the control plane. KubeadmConfigSpec bootstrapv1.KubeadmConfigSpec `json:"kubeadmConfigSpec"` - // RolloutBefore is a field to indicate a rollout should be performed + // rolloutBefore is a field to indicate a rollout should be performed // if the specified criteria is met. // +optional RolloutBefore *RolloutBefore `json:"rolloutBefore,omitempty"` - // RolloutAfter is a field to indicate a rollout should be performed + // rolloutAfter is a field to indicate a rollout should be performed // after the specified time even if no changes have been made to the // KubeadmControlPlane. // Example: In the YAML the time can be specified in the RFC3339 format. @@ -138,22 +138,22 @@ type KubeadmControlPlaneMachineTemplate struct { // +optional ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty"` - // InfrastructureRef is a required reference to a custom resource + // infrastructureRef is a required reference to a custom resource // offered by an infrastructure provider. InfrastructureRef corev1.ObjectReference `json:"infrastructureRef"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // +optional NodeDrainTimeout *metav1.Duration `json:"nodeDrainTimeout,omitempty"` - // NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + // nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes // to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. // +optional NodeVolumeDetachTimeout *metav1.Duration `json:"nodeVolumeDetachTimeout,omitempty"` - // NodeDeletionTimeout defines how long the machine controller will attempt to delete the Node that the Machine + // nodeDeletionTimeout defines how long the machine controller will attempt to delete the Node that the Machine // hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. // If no value is provided, the default value for this property of the Machine resource will be used. // +optional @@ -162,7 +162,7 @@ type KubeadmControlPlaneMachineTemplate struct { // RolloutBefore describes when a rollout should be performed on the KCP machines. type RolloutBefore struct { - // CertificatesExpiryDays indicates a rollout needs to be performed if the + // certificatesExpiryDays indicates a rollout needs to be performed if the // certificates of the machine will expire within the specified days. // +optional CertificatesExpiryDays *int32 `json:"certificatesExpiryDays,omitempty"` @@ -171,7 +171,7 @@ type RolloutBefore struct { // RolloutStrategy describes how to replace existing machines // with new ones. type RolloutStrategy struct { - // Type of rollout. Currently the only supported strategy is + // type of rollout. Currently the only supported strategy is // "RollingUpdate". // Default is RollingUpdate. // +optional @@ -197,7 +197,7 @@ type RollingUpdate struct { // RemediationStrategy allows to define how control plane machine remediation happens. type RemediationStrategy struct { - // MaxRetry is the Max number of retries while attempting to remediate an unhealthy machine. + // maxRetry is the Max number of retries while attempting to remediate an unhealthy machine. // A retry happens when a machine that was created as a replacement for an unhealthy machine also fails. // For example, given a control plane with three machines M1, M2, M3: // @@ -214,14 +214,14 @@ type RemediationStrategy struct { // +optional MaxRetry *int32 `json:"maxRetry,omitempty"` - // RetryPeriod is the duration that KCP should wait before remediating a machine being created as a replacement + // retryPeriod is the duration that KCP should wait before remediating a machine being created as a replacement // for an unhealthy machine (a retry). // // If not set, a retry will happen immediately. // +optional RetryPeriod metav1.Duration `json:"retryPeriod,omitempty"` - // MinHealthyPeriod defines the duration after which KCP will consider any failure to a machine unrelated + // minHealthyPeriod defines the duration after which KCP will consider any failure to a machine unrelated // from the previous one. In this case the remediation is not considered a retry anymore, and thus the retry // counter restarts from 0. For example, assuming MinHealthyPeriod is set to 1h (default) // @@ -258,7 +258,7 @@ type MachineNamingStrategy struct { // KubeadmControlPlaneStatus defines the observed state of KubeadmControlPlane. type KubeadmControlPlaneStatus struct { - // Selector is the label selector in string format to avoid introspection + // selector is the label selector in string format to avoid introspection // by clients, and is used to provide the CRD-based integration for the // scale subresource and additional integrations for things like kubectl // describe.. The string will be in the same format as the query-param syntax. @@ -271,7 +271,7 @@ type KubeadmControlPlaneStatus struct { // +optional Replicas int32 `json:"replicas"` - // Version represents the minimum Kubernetes version for the control plane machines + // version represents the minimum Kubernetes version for the control plane machines // in the cluster. // +optional Version *string `json:"version,omitempty"` @@ -293,7 +293,7 @@ type KubeadmControlPlaneStatus struct { // +optional UnavailableReplicas int32 `json:"unavailableReplicas"` - // Initialized denotes that the KubeadmControlPlane API Server is initialized and thus + // initialized denotes that the KubeadmControlPlane API Server is initialized and thus // it can accept requests. // NOTE: this field is part of the Cluster API contract and it is used to orchestrate provisioning. // The value of this field is never updated after provisioning is completed. Please use conditions @@ -301,7 +301,7 @@ type KubeadmControlPlaneStatus struct { // +optional Initialized bool `json:"initialized"` - // Ready denotes that the KubeadmControlPlane API Server became ready during initial provisioning + // ready denotes that the KubeadmControlPlane API Server became ready during initial provisioning // to receive requests. // NOTE: this field is part of the Cluster API contract and it is used to orchestrate provisioning. // The value of this field is never updated after provisioning is completed. Please use conditions @@ -309,7 +309,7 @@ type KubeadmControlPlaneStatus struct { // +optional Ready bool `json:"ready"` - // FailureReason indicates that there is a terminal problem reconciling the + // failureReason indicates that there is a terminal problem reconciling the // state, and will be set to a token value suitable for // programmatic interpretation. // @@ -326,15 +326,15 @@ type KubeadmControlPlaneStatus struct { // +optional FailureMessage *string `json:"failureMessage,omitempty"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions defines current service state of the KubeadmControlPlane. + // conditions defines current service state of the KubeadmControlPlane. // +optional Conditions clusterv1.Conditions `json:"conditions,omitempty"` - // LastRemediation stores info about last remediation performed. + // lastRemediation stores info about last remediation performed. // +optional LastRemediation *LastRemediationStatus `json:"lastRemediation,omitempty"` @@ -372,13 +372,13 @@ type KubeadmControlPlaneV1Beta2Status struct { // NOTE: if for any reason information about last remediation are lost, RetryCount is going to restart from 0 and thus // more remediations than expected might happen. type LastRemediationStatus struct { - // Machine is the machine name of the latest machine being remediated. + // machine is the machine name of the latest machine being remediated. Machine string `json:"machine"` - // Timestamp is when last remediation happened. It is represented in RFC3339 form and is in UTC. + // timestamp is when last remediation happened. It is represented in RFC3339 form and is in UTC. Timestamp metav1.Time `json:"timestamp"` - // RetryCount used to keep track of remediation retry for the last remediated machine. + // retryCount used to keep track of remediation retry for the last remediated machine. // A retry happens when a machine that was created as a replacement for an unhealthy machine also fails. RetryCount int32 `json:"retryCount"` } diff --git a/controlplane/kubeadm/api/v1beta1/kubeadmcontrolplanetemplate_types.go b/controlplane/kubeadm/api/v1beta1/kubeadmcontrolplanetemplate_types.go index 353359661089..122acb24c5a8 100644 --- a/controlplane/kubeadm/api/v1beta1/kubeadmcontrolplanetemplate_types.go +++ b/controlplane/kubeadm/api/v1beta1/kubeadmcontrolplanetemplate_types.go @@ -70,22 +70,22 @@ type KubeadmControlPlaneTemplateResource struct { // because they are calculated by the Cluster topology reconciler during reconciliation and thus cannot // be configured on the KubeadmControlPlaneTemplate. type KubeadmControlPlaneTemplateResourceSpec struct { - // MachineTemplate contains information about how machines + // machineTemplate contains information about how machines // should be shaped when creating or updating a control plane. // +optional MachineTemplate *KubeadmControlPlaneTemplateMachineTemplate `json:"machineTemplate,omitempty"` - // KubeadmConfigSpec is a KubeadmConfigSpec + // kubeadmConfigSpec is a KubeadmConfigSpec // to use for initializing and joining machines to the control plane. KubeadmConfigSpec bootstrapv1.KubeadmConfigSpec `json:"kubeadmConfigSpec"` - // RolloutBefore is a field to indicate a rollout should be performed + // rolloutBefore is a field to indicate a rollout should be performed // if the specified criteria is met. // // +optional RolloutBefore *RolloutBefore `json:"rolloutBefore,omitempty"` - // RolloutAfter is a field to indicate a rollout should be performed + // rolloutAfter is a field to indicate a rollout should be performed // after the specified time even if no changes have been made to the // KubeadmControlPlane. // @@ -120,18 +120,18 @@ type KubeadmControlPlaneTemplateMachineTemplate struct { // +optional ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // +optional NodeDrainTimeout *metav1.Duration `json:"nodeDrainTimeout,omitempty"` - // NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + // nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes // to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. // +optional NodeVolumeDetachTimeout *metav1.Duration `json:"nodeVolumeDetachTimeout,omitempty"` - // NodeDeletionTimeout defines how long the machine controller will attempt to delete the Node that the Machine + // nodeDeletionTimeout defines how long the machine controller will attempt to delete the Node that the Machine // hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. // If no value is provided, the default value for this property of the Machine resource will be used. // +optional diff --git a/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanes.yaml b/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanes.yaml index 22dfeaa7ce14..0e4c0a820168 100644 --- a/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanes.yaml +++ b/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanes.yaml @@ -81,7 +81,7 @@ spec: properties: infrastructureTemplate: description: |- - InfrastructureTemplate is a required reference to a custom resource + infrastructureTemplate is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -126,11 +126,11 @@ spec: x-kubernetes-map-type: atomic kubeadmConfigSpec: description: |- - KubeadmConfigSpec is a KubeadmConfigSpec + kubeadmConfigSpec is a KubeadmConfigSpec to use for initializing and joining machines to the control plane. properties: clusterConfiguration: - description: ClusterConfiguration along with InitConfiguration + description: clusterConfiguration along with InitConfiguration are the configurations necessary for the init command properties: apiServer: @@ -455,45 +455,45 @@ spec: type: boolean type: object diskSetup: - description: DiskSetup specifies options for the creation of partition + description: diskSetup specifies options for the creation of partition tables and file systems on devices. properties: filesystems: - description: Filesystems specifies the list of file systems + description: filesystems specifies the list of file systems to setup. items: description: Filesystem defines the file systems to be created. properties: device: - description: Device specifies the device name + description: device specifies the device name type: string extraOpts: - description: ExtraOpts defined extra options to add + description: extraOpts defined extra options to add to the command for creating the file system. items: type: string type: array filesystem: - description: Filesystem specifies the file system type. + description: filesystem specifies the file system type. type: string label: - description: Label specifies the file system label to + description: label specifies the file system label to be used. If set to None, no label is used. type: string overwrite: description: |- - Overwrite defines whether or not to overwrite any existing filesystem. + overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution. type: boolean partition: - description: 'Partition specifies the partition to use. + description: 'partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number.' type: string replaceFS: description: |- - ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the 'any' partition directive. type: string required: @@ -503,29 +503,29 @@ spec: type: object type: array partitions: - description: Partitions specifies the list of the partitions + description: partitions specifies the list of the partitions to setup. items: description: Partition defines how to create and layout a partition. properties: device: - description: Device is the name of the device. + description: device is the name of the device. type: string layout: description: |- - Layout specifies the device layout. + layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don't partition or ignore existing partitioning. type: boolean overwrite: description: |- - Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is 'false'. type: boolean tableType: description: |- - TableType specifies the tupe of partition table. The following are supported: + tableType specifies the tupe of partition table. The following are supported: 'mbr': default and setups a MS-DOS partition table 'gpt': setups a GPT partition table type: string @@ -536,29 +536,29 @@ spec: type: array type: object files: - description: Files specifies extra files to be passed to user_data + description: files specifies extra files to be passed to user_data upon creation. items: description: File defines the input for generating write_files in cloud-init. properties: content: - description: Content is the actual content of the file. + description: content is the actual content of the file. type: string contentFrom: - description: ContentFrom is a referenced source of content + description: contentFrom is a referenced source of content to populate the file. properties: secret: - description: Secret represents a secret that should + description: secret represents a secret that should populate this file. properties: key: - description: Key is the key in the secret's data + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -569,7 +569,7 @@ spec: - secret type: object encoding: - description: Encoding specifies the encoding of the file + description: encoding specifies the encoding of the file contents. enum: - base64 @@ -577,15 +577,15 @@ spec: - gzip+base64 type: string owner: - description: Owner specifies the ownership of the file, + description: owner specifies the ownership of the file, e.g. "root:root". type: string path: - description: Path specifies the full path on disk where + description: path specifies the full path on disk where to store the file. type: string permissions: - description: Permissions specifies the permissions to assign + description: permissions specifies the permissions to assign to the file, e.g. "0640". type: string required: @@ -593,13 +593,13 @@ spec: type: object type: array format: - description: Format specifies the output format of the bootstrap + description: format specifies the output format of the bootstrap data enum: - cloud-config type: string initConfiguration: - description: InitConfiguration along with ClusterConfiguration + description: initConfiguration along with ClusterConfiguration are the configurations necessary for the init command properties: apiVersion: @@ -750,7 +750,7 @@ spec: type: object type: object joinConfiguration: - description: JoinConfiguration is the kubeadm configuration for + description: joinConfiguration is the kubeadm configuration for the join command properties: apiVersion: @@ -925,7 +925,7 @@ spec: type: object type: object mounts: - description: Mounts specifies a list of mount points to be setup. + description: mounts specifies a list of mount points to be setup. items: description: MountPoints defines input for generated mounts in cloud-init. @@ -934,32 +934,32 @@ spec: type: array type: array ntp: - description: NTP specifies NTP configuration + description: ntp specifies NTP configuration properties: enabled: - description: Enabled specifies whether NTP should be enabled + description: enabled specifies whether NTP should be enabled type: boolean servers: - description: Servers specifies which NTP servers to use + description: servers specifies which NTP servers to use items: type: string type: array type: object postKubeadmCommands: - description: PostKubeadmCommands specifies extra commands to run + description: postKubeadmCommands specifies extra commands to run after kubeadm runs items: type: string type: array preKubeadmCommands: - description: PreKubeadmCommands specifies extra commands to run + description: preKubeadmCommands specifies extra commands to run before kubeadm runs items: type: string type: array useExperimentalRetryJoin: description: |- - UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + useExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments @@ -971,52 +971,52 @@ spec: For more information, refer to https://github.com/kubernetes-sigs/cluster-api/pull/2763#discussion_r397306055. type: boolean users: - description: Users specifies extra users to add + description: users specifies extra users to add items: description: User defines the input for a generated user in cloud-init. properties: gecos: - description: Gecos specifies the gecos to use for the user + description: gecos specifies the gecos to use for the user type: string groups: - description: Groups specifies the additional groups for + description: groups specifies the additional groups for the user type: string homeDir: - description: HomeDir specifies the home directory to use + description: homeDir specifies the home directory to use for the user type: string inactive: - description: Inactive specifies whether to mark the user + description: inactive specifies whether to mark the user as inactive type: boolean lockPassword: - description: LockPassword specifies if password login should + description: lockPassword specifies if password login should be disabled type: boolean name: - description: Name specifies the user name + description: name specifies the user name type: string passwd: - description: Passwd specifies a hashed password for the + description: passwd specifies a hashed password for the user type: string primaryGroup: - description: PrimaryGroup specifies the primary group for + description: primaryGroup specifies the primary group for the user type: string shell: - description: Shell specifies the user's shell + description: shell specifies the user's shell type: string sshAuthorizedKeys: - description: SSHAuthorizedKeys specifies a list of ssh authorized + description: sshAuthorizedKeys specifies a list of ssh authorized keys for the user items: type: string type: array sudo: - description: Sudo specifies a sudo role for the user + description: sudo specifies a sudo role for the user type: string required: - name @@ -1024,14 +1024,14 @@ spec: type: array verbosity: description: |- - Verbosity is the number for the kubeadm log level verbosity. + verbosity is the number for the kubeadm log level verbosity. It overrides the `--v` flag in kubeadm commands. format: int32 type: integer type: object nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node + nodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string @@ -1067,20 +1067,20 @@ spec: type: object type: description: |- - Type of rollout. Currently the only supported strategy is + type of rollout. Currently the only supported strategy is "RollingUpdate". Default is RollingUpdate. type: string type: object upgradeAfter: description: |- - UpgradeAfter is a field to indicate an upgrade should be performed + upgradeAfter is a field to indicate an upgrade should be performed after the specified time even if no changes have been made to the KubeadmControlPlane format: date-time type: string version: - description: Version defines the desired Kubernetes version. + description: version defines the desired Kubernetes version. type: string required: - infrastructureTemplate @@ -1091,7 +1091,7 @@ spec: description: KubeadmControlPlaneStatus defines the observed state of KubeadmControlPlane. properties: conditions: - description: Conditions defines current service state of the KubeadmControlPlane. + description: conditions defines current service state of the KubeadmControlPlane. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -1116,16 +1116,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -1141,23 +1141,23 @@ spec: type: string failureReason: description: |- - FailureReason indicates that there is a terminal problem reconciling the + failureReason indicates that there is a terminal problem reconciling the state, and will be set to a token value suitable for programmatic interpretation. type: string initialized: description: |- - Initialized denotes whether or not the control plane has the + initialized denotes whether or not the control plane has the uploaded kubeadm-config configmap. type: boolean observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer ready: description: |- - Ready denotes that the KubeadmControlPlane API Server is ready to + ready denotes that the KubeadmControlPlane API Server is ready to receive requests. type: boolean readyReplicas: @@ -1173,7 +1173,7 @@ spec: type: integer selector: description: |- - Selector is the label selector in string format to avoid introspection + selector is the label selector in string format to avoid introspection by clients, and is used to provide the CRD-based integration for the scale subresource and additional integrations for things like kubectl describe.. The string will be in the same format as the query-param syntax. @@ -1271,19 +1271,19 @@ spec: properties: kubeadmConfigSpec: description: |- - KubeadmConfigSpec is a KubeadmConfigSpec + kubeadmConfigSpec is a KubeadmConfigSpec to use for initializing and joining machines to the control plane. properties: clusterConfiguration: - description: ClusterConfiguration along with InitConfiguration + description: clusterConfiguration along with InitConfiguration are the configurations necessary for the init command properties: apiServer: - description: APIServer contains extra settings for the API + description: apiServer contains extra settings for the API server control plane component properties: certSANs: - description: CertSANs sets extra Subject Alternative Names + description: certSANs sets extra Subject Alternative Names for the API Server signing cert. items: type: string @@ -1291,11 +1291,11 @@ spec: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to pass + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraVolumes: - description: ExtraVolumes is an extra set of host volumes, + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -1304,21 +1304,21 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the pod + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod template. + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access to the + description: readOnly controls write access to the volume type: boolean required: @@ -1328,7 +1328,7 @@ spec: type: object type: array timeoutForControlPlane: - description: TimeoutForControlPlane controls the timeout + description: timeoutForControlPlane controls the timeout that we use for API server to appear type: string type: object @@ -1341,7 +1341,7 @@ spec: type: string certificatesDir: description: |- - CertificatesDir specifies where to store or look for all required certificates. + certificatesDir specifies where to store or look for all required certificates. NB: if not provided, this will default to `/etc/kubernetes/pki` type: string clusterName: @@ -1349,7 +1349,7 @@ spec: type: string controlPlaneEndpoint: description: |- - ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it + controlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort are used; in case the ControlPlaneEndpoint is specified but without a TCP port, @@ -1363,17 +1363,17 @@ spec: NB: This value defaults to the first value in the Cluster object status.apiEndpoints array. type: string controllerManager: - description: ControllerManager contains extra settings for + description: controllerManager contains extra settings for the controller manager control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to pass + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraVolumes: - description: ExtraVolumes is an extra set of host volumes, + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -1382,21 +1382,21 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the pod + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod template. + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access to the + description: readOnly controls write access to the volume type: boolean required: @@ -1407,49 +1407,49 @@ spec: type: array type: object dns: - description: DNS defines the options for the DNS add-on installed + description: dns defines the options for the DNS add-on installed in the cluster. properties: imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string type: object etcd: description: |- - Etcd holds configuration for etcd. + etcd holds configuration for etcd. NB: This value defaults to a Local (stacked) etcd properties: external: description: |- - External describes how to connect to an external etcd cluster + external describes how to connect to an external etcd cluster Local and External are mutually exclusive properties: caFile: description: |- - CAFile is an SSL Certificate Authority file used to secure etcd communication. + caFile is an SSL Certificate Authority file used to secure etcd communication. Required if using a TLS connection. type: string certFile: description: |- - CertFile is an SSL certification file used to secure etcd communication. + certFile is an SSL certification file used to secure etcd communication. Required if using a TLS connection. type: string endpoints: - description: Endpoints of etcd members. Required for + description: endpoints of etcd members. Required for ExternalEtcd. items: type: string type: array keyFile: description: |- - KeyFile is an SSL key file used to secure etcd communication. + keyFile is an SSL key file used to secure etcd communication. Required if using a TLS connection. type: string required: @@ -1460,39 +1460,39 @@ spec: type: object local: description: |- - Local provides configuration knobs for configuring the local etcd instance + local provides configuration knobs for configuring the local etcd instance Local and External are mutually exclusive properties: dataDir: description: |- - DataDir is the directory etcd will place its data. + dataDir is the directory etcd will place its data. Defaults to "/var/lib/etcd". type: string extraArgs: additionalProperties: type: string description: |- - ExtraArgs are extra arguments provided to the etcd binary + extraArgs are extra arguments provided to the etcd binary when run inside a static pod. type: object imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string peerCertSANs: - description: PeerCertSANs sets extra Subject Alternative + description: peerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. items: type: string type: array serverCertSANs: - description: ServerCertSANs sets extra Subject Alternative + description: serverCertSANs sets extra Subject Alternative Names for the etcd server signing cert. items: type: string @@ -1502,11 +1502,11 @@ spec: featureGates: additionalProperties: type: boolean - description: FeatureGates enabled by the user. + description: featureGates enabled by the user. type: object imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. If empty, `registry.k8s.io` will be used by default; in case of kubernetes version is a CI build (kubernetes version starts with `ci/` or `ci-cross/`) `gcr.io/k8s-staging-ci-images` will be used as a default for control plane components and for kube-proxy, while `registry.k8s.io` will be used for all the other images. @@ -1521,43 +1521,43 @@ spec: type: string kubernetesVersion: description: |- - KubernetesVersion is the target version of the control plane. + kubernetesVersion is the target version of the control plane. NB: This value defaults to the Machine object spec.version type: string networking: description: |- - Networking holds configuration for the networking topology of the cluster. + networking holds configuration for the networking topology of the cluster. NB: This value defaults to the Cluster object spec.clusterNetwork. properties: dnsDomain: - description: DNSDomain is the dns domain used by k8s services. + description: dnsDomain is the dns domain used by k8s services. Defaults to "cluster.local". type: string podSubnet: description: |- - PodSubnet is the subnet used by pods. + podSubnet is the subnet used by pods. If unset, the API server will not allocate CIDR ranges for every node. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.services.cidrBlocks if that is set type: string serviceSubnet: description: |- - ServiceSubnet is the subnet used by k8s services. + serviceSubnet is the subnet used by k8s services. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.pods.cidrBlocks, or to "10.96.0.0/12" if that's unset. type: string type: object scheduler: - description: Scheduler contains extra settings for the scheduler + description: scheduler contains extra settings for the scheduler control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to pass + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraVolumes: - description: ExtraVolumes is an extra set of host volumes, + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -1566,21 +1566,21 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the pod + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod template. + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access to the + description: readOnly controls write access to the volume type: boolean required: @@ -1592,45 +1592,45 @@ spec: type: object type: object diskSetup: - description: DiskSetup specifies options for the creation of partition + description: diskSetup specifies options for the creation of partition tables and file systems on devices. properties: filesystems: - description: Filesystems specifies the list of file systems + description: filesystems specifies the list of file systems to setup. items: description: Filesystem defines the file systems to be created. properties: device: - description: Device specifies the device name + description: device specifies the device name type: string extraOpts: - description: ExtraOpts defined extra options to add + description: extraOpts defined extra options to add to the command for creating the file system. items: type: string type: array filesystem: - description: Filesystem specifies the file system type. + description: filesystem specifies the file system type. type: string label: - description: Label specifies the file system label to + description: label specifies the file system label to be used. If set to None, no label is used. type: string overwrite: description: |- - Overwrite defines whether or not to overwrite any existing filesystem. + overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution. type: boolean partition: - description: 'Partition specifies the partition to use. + description: 'partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number.' type: string replaceFS: description: |- - ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the 'any' partition directive. type: string required: @@ -1640,29 +1640,29 @@ spec: type: object type: array partitions: - description: Partitions specifies the list of the partitions + description: partitions specifies the list of the partitions to setup. items: description: Partition defines how to create and layout a partition. properties: device: - description: Device is the name of the device. + description: device is the name of the device. type: string layout: description: |- - Layout specifies the device layout. + layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don't partition or ignore existing partitioning. type: boolean overwrite: description: |- - Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is 'false'. type: boolean tableType: description: |- - TableType specifies the tupe of partition table. The following are supported: + tableType specifies the tupe of partition table. The following are supported: 'mbr': default and setups a MS-DOS partition table 'gpt': setups a GPT partition table type: string @@ -1673,29 +1673,29 @@ spec: type: array type: object files: - description: Files specifies extra files to be passed to user_data + description: files specifies extra files to be passed to user_data upon creation. items: description: File defines the input for generating write_files in cloud-init. properties: content: - description: Content is the actual content of the file. + description: content is the actual content of the file. type: string contentFrom: - description: ContentFrom is a referenced source of content + description: contentFrom is a referenced source of content to populate the file. properties: secret: - description: Secret represents a secret that should + description: secret represents a secret that should populate this file. properties: key: - description: Key is the key in the secret's data + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -1706,7 +1706,7 @@ spec: - secret type: object encoding: - description: Encoding specifies the encoding of the file + description: encoding specifies the encoding of the file contents. enum: - base64 @@ -1714,15 +1714,15 @@ spec: - gzip+base64 type: string owner: - description: Owner specifies the ownership of the file, + description: owner specifies the ownership of the file, e.g. "root:root". type: string path: - description: Path specifies the full path on disk where + description: path specifies the full path on disk where to store the file. type: string permissions: - description: Permissions specifies the permissions to assign + description: permissions specifies the permissions to assign to the file, e.g. "0640". type: string required: @@ -1730,13 +1730,13 @@ spec: type: object type: array format: - description: Format specifies the output format of the bootstrap + description: format specifies the output format of the bootstrap data enum: - cloud-config type: string initConfiguration: - description: InitConfiguration along with ClusterConfiguration + description: initConfiguration along with ClusterConfiguration are the configurations necessary for the init command properties: apiVersion: @@ -1748,7 +1748,7 @@ spec: type: string bootstrapTokens: description: |- - BootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. + bootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature items: description: BootstrapToken describes one bootstrap token, @@ -1756,35 +1756,35 @@ spec: properties: description: description: |- - Description sets a human-friendly message why this token exists and what it's used + description sets a human-friendly message why this token exists and what it's used for, so other administrators can know its purpose. type: string expires: description: |- - Expires specifies the timestamp when this token expires. Defaults to being set + expires specifies the timestamp when this token expires. Defaults to being set dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive. format: date-time type: string groups: description: |- - Groups specifies the extra groups that this token will authenticate as when/if + groups specifies the extra groups that this token will authenticate as when/if used for authentication items: type: string type: array token: description: |- - Token is used for establishing bidirectional trust between nodes and control-planes. + token is used for establishing bidirectional trust between nodes and control-planes. Used for joining nodes in the cluster. type: string ttl: description: |- - TTL defines the time to live for this token. Defaults to 24h. + ttl defines the time to live for this token. Defaults to 24h. Expires and TTL are mutually exclusive. type: string usages: description: |- - Usages describes the ways in which this token can be used. Can by default be used + usages describes the ways in which this token can be used. Can by default be used for establishing bidirectional trust, but that can be changed here. items: type: string @@ -1803,7 +1803,7 @@ spec: type: string localAPIEndpoint: description: |- - LocalAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node + localAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible @@ -1811,29 +1811,29 @@ spec: fails you may set the desired value here. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address for + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container runtime + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a slice of + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: @@ -1843,19 +1843,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: {}` in the YAML file. This field is solely used for Node registration. items: @@ -1891,7 +1891,7 @@ spec: type: object type: object joinConfiguration: - description: JoinConfiguration is the kubeadm configuration for + description: joinConfiguration is the kubeadm configuration for the join command properties: apiVersion: @@ -1903,47 +1903,47 @@ spec: type: string caCertPath: description: |- - CACertPath is the path to the SSL certificate authority used to + caCertPath is the path to the SSL certificate authority used to secure comunications between node and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt". type: string controlPlane: description: |- - ControlPlane defines the additional control plane instance to be deployed on the joining node. + controlPlane defines the additional control plane instance to be deployed on the joining node. If nil, no additional control plane instance will be deployed. properties: localAPIEndpoint: - description: LocalAPIEndpoint represents the endpoint + description: localAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object type: object discovery: - description: Discovery specifies the options for the kubelet + description: discovery specifies the options for the kubelet to use during the TLS Bootstrap process properties: bootstrapToken: description: |- - BootstrapToken is used to set the options for bootstrap token based discovery + bootstrapToken is used to set the options for bootstrap token based discovery BootstrapToken and File are mutually exclusive properties: apiServerEndpoint: - description: APIServerEndpoint is an IP or domain + description: apiServerEndpoint is an IP or domain name to the API server from which info will be fetched. type: string caCertHashes: description: |- - CACertHashes specifies a set of public key pins to verify + caCertHashes specifies a set of public key pins to verify when token-based discovery is used. The root CA found during discovery must match one of these values. Specifying an empty set disables root CA pinning, which can be unsafe. Each hash is specified as ":", @@ -1956,12 +1956,12 @@ spec: type: array token: description: |- - Token is a token used to validate cluster information + token is a token used to validate cluster information fetched from the control-plane. type: string unsafeSkipCAVerification: description: |- - UnsafeSkipCAVerification allows token-based discovery + unsafeSkipCAVerification allows token-based discovery without CA verification via CACertHashes. This can weaken the security of kubeadm since other nodes can impersonate the control-plane. type: boolean @@ -1970,11 +1970,11 @@ spec: type: object file: description: |- - File is used to specify a file or URL to a kubeconfig file from which to load cluster information + file is used to specify a file or URL to a kubeconfig file from which to load cluster information BootstrapToken and File are mutually exclusive properties: kubeConfigPath: - description: KubeConfigPath is used to specify the + description: kubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information type: string @@ -1982,11 +1982,11 @@ spec: - kubeConfigPath type: object timeout: - description: Timeout modifies the discovery timeout + description: timeout modifies the discovery timeout type: string tlsBootstrapToken: description: |- - TLSBootstrapToken is a token used for TLS bootstrapping. + tlsBootstrapToken is a token used for TLS bootstrapping. If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. If .File is set, this field **must be set** in case the KubeConfigFile does not contain any other authentication information type: string @@ -2001,17 +2001,17 @@ spec: type: string nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container runtime + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a slice of + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: @@ -2021,19 +2021,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: {}` in the YAML file. This field is solely used for Node registration. items: @@ -2069,7 +2069,7 @@ spec: type: object type: object mounts: - description: Mounts specifies a list of mount points to be setup. + description: mounts specifies a list of mount points to be setup. items: description: MountPoints defines input for generated mounts in cloud-init. @@ -2078,32 +2078,32 @@ spec: type: array type: array ntp: - description: NTP specifies NTP configuration + description: ntp specifies NTP configuration properties: enabled: - description: Enabled specifies whether NTP should be enabled + description: enabled specifies whether NTP should be enabled type: boolean servers: - description: Servers specifies which NTP servers to use + description: servers specifies which NTP servers to use items: type: string type: array type: object postKubeadmCommands: - description: PostKubeadmCommands specifies extra commands to run + description: postKubeadmCommands specifies extra commands to run after kubeadm runs items: type: string type: array preKubeadmCommands: - description: PreKubeadmCommands specifies extra commands to run + description: preKubeadmCommands specifies extra commands to run before kubeadm runs items: type: string type: array useExperimentalRetryJoin: description: |- - UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + useExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments @@ -2115,52 +2115,52 @@ spec: For more information, refer to https://github.com/kubernetes-sigs/cluster-api/pull/2763#discussion_r397306055. type: boolean users: - description: Users specifies extra users to add + description: users specifies extra users to add items: description: User defines the input for a generated user in cloud-init. properties: gecos: - description: Gecos specifies the gecos to use for the user + description: gecos specifies the gecos to use for the user type: string groups: - description: Groups specifies the additional groups for + description: groups specifies the additional groups for the user type: string homeDir: - description: HomeDir specifies the home directory to use + description: homeDir specifies the home directory to use for the user type: string inactive: - description: Inactive specifies whether to mark the user + description: inactive specifies whether to mark the user as inactive type: boolean lockPassword: - description: LockPassword specifies if password login should + description: lockPassword specifies if password login should be disabled type: boolean name: - description: Name specifies the user name + description: name specifies the user name type: string passwd: - description: Passwd specifies a hashed password for the + description: passwd specifies a hashed password for the user type: string primaryGroup: - description: PrimaryGroup specifies the primary group for + description: primaryGroup specifies the primary group for the user type: string shell: - description: Shell specifies the user's shell + description: shell specifies the user's shell type: string sshAuthorizedKeys: - description: SSHAuthorizedKeys specifies a list of ssh authorized + description: sshAuthorizedKeys specifies a list of ssh authorized keys for the user items: type: string type: array sudo: - description: Sudo specifies a sudo role for the user + description: sudo specifies a sudo role for the user type: string required: - name @@ -2168,19 +2168,19 @@ spec: type: array verbosity: description: |- - Verbosity is the number for the kubeadm log level verbosity. + verbosity is the number for the kubeadm log level verbosity. It overrides the `--v` flag in kubeadm commands. format: int32 type: integer type: object machineTemplate: description: |- - MachineTemplate contains information about how machines + machineTemplate contains information about how machines should be shaped when creating or updating a control plane. properties: infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -2232,7 +2232,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -2249,7 +2249,7 @@ spec: type: object nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node + nodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string @@ -2265,7 +2265,7 @@ spec: type: integer rolloutAfter: description: |- - RolloutAfter is a field to indicate a rollout should be performed + rolloutAfter is a field to indicate a rollout should be performed after the specified time even if no changes have been made to the KubeadmControlPlane. format: date-time @@ -2299,13 +2299,13 @@ spec: type: object type: description: |- - Type of rollout. Currently the only supported strategy is + type of rollout. Currently the only supported strategy is "RollingUpdate". Default is RollingUpdate. type: string type: object version: - description: Version defines the desired Kubernetes version. + description: version defines the desired Kubernetes version. type: string required: - kubeadmConfigSpec @@ -2316,7 +2316,7 @@ spec: description: KubeadmControlPlaneStatus defines the observed state of KubeadmControlPlane. properties: conditions: - description: Conditions defines current service state of the KubeadmControlPlane. + description: conditions defines current service state of the KubeadmControlPlane. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -2341,16 +2341,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -2366,23 +2366,23 @@ spec: type: string failureReason: description: |- - FailureReason indicates that there is a terminal problem reconciling the + failureReason indicates that there is a terminal problem reconciling the state, and will be set to a token value suitable for programmatic interpretation. type: string initialized: description: |- - Initialized denotes whether or not the control plane has the + initialized denotes whether or not the control plane has the uploaded kubeadm-config configmap. type: boolean observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer ready: description: |- - Ready denotes that the KubeadmControlPlane API Server is ready to + ready denotes that the KubeadmControlPlane API Server is ready to receive requests. type: boolean readyReplicas: @@ -2398,7 +2398,7 @@ spec: type: integer selector: description: |- - Selector is the label selector in string format to avoid introspection + selector is the label selector in string format to avoid introspection by clients, and is used to provide the CRD-based integration for the scale subresource and additional integrations for things like kubectl describe.. The string will be in the same format as the query-param syntax. @@ -2421,7 +2421,7 @@ spec: type: integer version: description: |- - Version represents the minimum Kubernetes version for the control plane machines + version represents the minimum Kubernetes version for the control plane machines in the cluster. type: string type: object @@ -2507,19 +2507,19 @@ spec: properties: kubeadmConfigSpec: description: |- - KubeadmConfigSpec is a KubeadmConfigSpec + kubeadmConfigSpec is a KubeadmConfigSpec to use for initializing and joining machines to the control plane. properties: clusterConfiguration: - description: ClusterConfiguration along with InitConfiguration + description: clusterConfiguration along with InitConfiguration are the configurations necessary for the init command properties: apiServer: - description: APIServer contains extra settings for the API + description: apiServer contains extra settings for the API server control plane component properties: certSANs: - description: CertSANs sets extra Subject Alternative Names + description: certSANs sets extra Subject Alternative Names for the API Server signing cert. items: type: string @@ -2527,12 +2527,12 @@ spec: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to pass + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -2655,7 +2655,7 @@ spec: type: object type: array extraVolumes: - description: ExtraVolumes is an extra set of host volumes, + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -2664,21 +2664,21 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the pod + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod template. + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access to the + description: readOnly controls write access to the volume type: boolean required: @@ -2688,7 +2688,7 @@ spec: type: object type: array timeoutForControlPlane: - description: TimeoutForControlPlane controls the timeout + description: timeoutForControlPlane controls the timeout that we use for API server to appear type: string type: object @@ -2701,7 +2701,7 @@ spec: type: string certificatesDir: description: |- - CertificatesDir specifies where to store or look for all required certificates. + certificatesDir specifies where to store or look for all required certificates. NB: if not provided, this will default to `/etc/kubernetes/pki` type: string clusterName: @@ -2709,7 +2709,7 @@ spec: type: string controlPlaneEndpoint: description: |- - ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it + controlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort are used; in case the ControlPlaneEndpoint is specified but without a TCP port, @@ -2723,18 +2723,18 @@ spec: NB: This value defaults to the first value in the Cluster object status.apiEndpoints array. type: string controllerManager: - description: ControllerManager contains extra settings for + description: controllerManager contains extra settings for the controller manager control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to pass + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -2857,7 +2857,7 @@ spec: type: object type: array extraVolumes: - description: ExtraVolumes is an extra set of host volumes, + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -2866,21 +2866,21 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the pod + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod template. + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access to the + description: readOnly controls write access to the volume type: boolean required: @@ -2891,49 +2891,49 @@ spec: type: array type: object dns: - description: DNS defines the options for the DNS add-on installed + description: dns defines the options for the DNS add-on installed in the cluster. properties: imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string type: object etcd: description: |- - Etcd holds configuration for etcd. + etcd holds configuration for etcd. NB: This value defaults to a Local (stacked) etcd properties: external: description: |- - External describes how to connect to an external etcd cluster + external describes how to connect to an external etcd cluster Local and External are mutually exclusive properties: caFile: description: |- - CAFile is an SSL Certificate Authority file used to secure etcd communication. + caFile is an SSL Certificate Authority file used to secure etcd communication. Required if using a TLS connection. type: string certFile: description: |- - CertFile is an SSL certification file used to secure etcd communication. + certFile is an SSL certification file used to secure etcd communication. Required if using a TLS connection. type: string endpoints: - description: Endpoints of etcd members. Required for + description: endpoints of etcd members. Required for ExternalEtcd. items: type: string type: array keyFile: description: |- - KeyFile is an SSL key file used to secure etcd communication. + keyFile is an SSL key file used to secure etcd communication. Required if using a TLS connection. type: string required: @@ -2944,24 +2944,24 @@ spec: type: object local: description: |- - Local provides configuration knobs for configuring the local etcd instance + local provides configuration knobs for configuring the local etcd instance Local and External are mutually exclusive properties: dataDir: description: |- - DataDir is the directory etcd will place its data. + dataDir is the directory etcd will place its data. Defaults to "/var/lib/etcd". type: string extraArgs: additionalProperties: type: string description: |- - ExtraArgs are extra arguments provided to the etcd binary + extraArgs are extra arguments provided to the etcd binary when run inside a static pod. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -3088,22 +3088,22 @@ spec: type: array imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string peerCertSANs: - description: PeerCertSANs sets extra Subject Alternative + description: peerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. items: type: string type: array serverCertSANs: - description: ServerCertSANs sets extra Subject Alternative + description: serverCertSANs sets extra Subject Alternative Names for the etcd server signing cert. items: type: string @@ -3113,11 +3113,11 @@ spec: featureGates: additionalProperties: type: boolean - description: FeatureGates enabled by the user. + description: featureGates enabled by the user. type: object imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. * If not set, the default registry of kubeadm will be used, i.e. * registry.k8s.io (new registry): >= v1.22.17, >= v1.23.15, >= v1.24.9, >= v1.25.0 * k8s.gcr.io (old registry): all older versions @@ -3139,44 +3139,44 @@ spec: type: string kubernetesVersion: description: |- - KubernetesVersion is the target version of the control plane. + kubernetesVersion is the target version of the control plane. NB: This value defaults to the Machine object spec.version type: string networking: description: |- - Networking holds configuration for the networking topology of the cluster. + networking holds configuration for the networking topology of the cluster. NB: This value defaults to the Cluster object spec.clusterNetwork. properties: dnsDomain: - description: DNSDomain is the dns domain used by k8s services. + description: dnsDomain is the dns domain used by k8s services. Defaults to "cluster.local". type: string podSubnet: description: |- - PodSubnet is the subnet used by pods. + podSubnet is the subnet used by pods. If unset, the API server will not allocate CIDR ranges for every node. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.services.cidrBlocks if that is set type: string serviceSubnet: description: |- - ServiceSubnet is the subnet used by k8s services. + serviceSubnet is the subnet used by k8s services. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.pods.cidrBlocks, or to "10.96.0.0/12" if that's unset. type: string type: object scheduler: - description: Scheduler contains extra settings for the scheduler + description: scheduler contains extra settings for the scheduler control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags to pass + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -3299,7 +3299,7 @@ spec: type: object type: array extraVolumes: - description: ExtraVolumes is an extra set of host volumes, + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -3308,21 +3308,21 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside the pod + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the pod template. + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the HostPath. + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access to the + description: readOnly controls write access to the volume type: boolean required: @@ -3334,45 +3334,45 @@ spec: type: object type: object diskSetup: - description: DiskSetup specifies options for the creation of partition + description: diskSetup specifies options for the creation of partition tables and file systems on devices. properties: filesystems: - description: Filesystems specifies the list of file systems + description: filesystems specifies the list of file systems to setup. items: description: Filesystem defines the file systems to be created. properties: device: - description: Device specifies the device name + description: device specifies the device name type: string extraOpts: - description: ExtraOpts defined extra options to add + description: extraOpts defined extra options to add to the command for creating the file system. items: type: string type: array filesystem: - description: Filesystem specifies the file system type. + description: filesystem specifies the file system type. type: string label: - description: Label specifies the file system label to + description: label specifies the file system label to be used. If set to None, no label is used. type: string overwrite: description: |- - Overwrite defines whether or not to overwrite any existing filesystem. + overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution. type: boolean partition: - description: 'Partition specifies the partition to use. + description: 'partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number.' type: string replaceFS: description: |- - ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the 'any' partition directive. type: string required: @@ -3382,29 +3382,29 @@ spec: type: object type: array partitions: - description: Partitions specifies the list of the partitions + description: partitions specifies the list of the partitions to setup. items: description: Partition defines how to create and layout a partition. properties: device: - description: Device is the name of the device. + description: device is the name of the device. type: string layout: description: |- - Layout specifies the device layout. + layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don't partition or ignore existing partitioning. type: boolean overwrite: description: |- - Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is 'false'. type: boolean tableType: description: |- - TableType specifies the tupe of partition table. The following are supported: + tableType specifies the tupe of partition table. The following are supported: 'mbr': default and setups a MS-DOS partition table 'gpt': setups a GPT partition table type: string @@ -3415,33 +3415,33 @@ spec: type: array type: object files: - description: Files specifies extra files to be passed to user_data + description: files specifies extra files to be passed to user_data upon creation. items: description: File defines the input for generating write_files in cloud-init. properties: append: - description: Append specifies whether to append Content + description: append specifies whether to append Content to existing file if Path exists. type: boolean content: - description: Content is the actual content of the file. + description: content is the actual content of the file. type: string contentFrom: - description: ContentFrom is a referenced source of content + description: contentFrom is a referenced source of content to populate the file. properties: secret: - description: Secret represents a secret that should + description: secret represents a secret that should populate this file. properties: key: - description: Key is the key in the secret's data + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -3452,7 +3452,7 @@ spec: - secret type: object encoding: - description: Encoding specifies the encoding of the file + description: encoding specifies the encoding of the file contents. enum: - base64 @@ -3460,15 +3460,15 @@ spec: - gzip+base64 type: string owner: - description: Owner specifies the ownership of the file, + description: owner specifies the ownership of the file, e.g. "root:root". type: string path: - description: Path specifies the full path on disk where + description: path specifies the full path on disk where to store the file. type: string permissions: - description: Permissions specifies the permissions to assign + description: permissions specifies the permissions to assign to the file, e.g. "0640". type: string required: @@ -3476,33 +3476,33 @@ spec: type: object type: array format: - description: Format specifies the output format of the bootstrap + description: format specifies the output format of the bootstrap data enum: - cloud-config - ignition type: string ignition: - description: Ignition contains Ignition specific configuration. + description: ignition contains Ignition specific configuration. properties: containerLinuxConfig: - description: ContainerLinuxConfig contains CLC specific configuration. + description: containerLinuxConfig contains CLC specific configuration. properties: additionalConfig: description: |- - AdditionalConfig contains additional configuration to be merged with the Ignition + additionalConfig contains additional configuration to be merged with the Ignition configuration generated by the bootstrapper controller. More info: https://coreos.github.io/ignition/operator-notes/#config-merging The data format is documented here: https://kinvolk.io/docs/flatcar-container-linux/latest/provisioning/cl-config/ type: string strict: - description: Strict controls if AdditionalConfig should + description: strict controls if AdditionalConfig should be strictly parsed. If so, warnings are treated as errors. type: boolean type: object type: object initConfiguration: - description: InitConfiguration along with ClusterConfiguration + description: initConfiguration along with ClusterConfiguration are the configurations necessary for the init command properties: apiVersion: @@ -3514,7 +3514,7 @@ spec: type: string bootstrapTokens: description: |- - BootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. + bootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature items: description: BootstrapToken describes one bootstrap token, @@ -3522,35 +3522,35 @@ spec: properties: description: description: |- - Description sets a human-friendly message why this token exists and what it's used + description sets a human-friendly message why this token exists and what it's used for, so other administrators can know its purpose. type: string expires: description: |- - Expires specifies the timestamp when this token expires. Defaults to being set + expires specifies the timestamp when this token expires. Defaults to being set dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive. format: date-time type: string groups: description: |- - Groups specifies the extra groups that this token will authenticate as when/if + groups specifies the extra groups that this token will authenticate as when/if used for authentication items: type: string type: array token: description: |- - Token is used for establishing bidirectional trust between nodes and control-planes. + token is used for establishing bidirectional trust between nodes and control-planes. Used for joining nodes in the cluster. type: string ttl: description: |- - TTL defines the time to live for this token. Defaults to 24h. + ttl defines the time to live for this token. Defaults to 24h. Expires and TTL are mutually exclusive. type: string usages: description: |- - Usages describes the ways in which this token can be used. Can by default be used + usages describes the ways in which this token can be used. Can by default be used for establishing bidirectional trust, but that can be changed here. items: type: string @@ -3569,7 +3569,7 @@ spec: type: string localAPIEndpoint: description: |- - LocalAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node + localAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible @@ -3577,29 +3577,29 @@ spec: fails you may set the desired value here. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address for + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container runtime + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a slice of + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: @@ -3607,7 +3607,7 @@ spec: type: array imagePullPolicy: description: |- - ImagePullPolicy specifies the policy for image pulling + imagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations. The value of this field must be one of "Always", "IfNotPresent" or "Never". Defaults to "IfNotPresent". This can be used only @@ -3619,7 +3619,7 @@ spec: type: string imagePullSerial: description: |- - ImagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. + imagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. This option takes effect only on Kubernetes >=1.31.0. Default: true (defaulted in kubeadm) type: boolean @@ -3627,19 +3627,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: []` in the YAML file. This field is solely used for Node registration. items: @@ -3675,12 +3675,12 @@ spec: type: object patches: description: |- - Patches contains options related to applying patches to components deployed by kubeadm during + patches contains options related to applying patches to components deployed by kubeadm during "kubeadm init". The minimum kubernetes version needed to support Patches is v1.22 properties: directory: description: |- - Directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". + directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of "kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". "patchtype" can be one of "strategic" "merge" or "json" and they match the patch formats supported by kubectl. @@ -3694,7 +3694,7 @@ spec: type: object skipPhases: description: |- - SkipPhases is a list of phases to skip during command execution. + skipPhases is a list of phases to skip during command execution. The list of phases can be obtained with the "kubeadm init --help" command. This option takes effect only on Kubernetes >=1.22.0. items: @@ -3702,7 +3702,7 @@ spec: type: array type: object joinConfiguration: - description: JoinConfiguration is the kubeadm configuration for + description: joinConfiguration is the kubeadm configuration for the join command properties: apiVersion: @@ -3714,47 +3714,47 @@ spec: type: string caCertPath: description: |- - CACertPath is the path to the SSL certificate authority used to + caCertPath is the path to the SSL certificate authority used to secure comunications between node and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt". type: string controlPlane: description: |- - ControlPlane defines the additional control plane instance to be deployed on the joining node. + controlPlane defines the additional control plane instance to be deployed on the joining node. If nil, no additional control plane instance will be deployed. properties: localAPIEndpoint: - description: LocalAPIEndpoint represents the endpoint + description: localAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object type: object discovery: - description: Discovery specifies the options for the kubelet + description: discovery specifies the options for the kubelet to use during the TLS Bootstrap process properties: bootstrapToken: description: |- - BootstrapToken is used to set the options for bootstrap token based discovery + bootstrapToken is used to set the options for bootstrap token based discovery BootstrapToken and File are mutually exclusive properties: apiServerEndpoint: - description: APIServerEndpoint is an IP or domain + description: apiServerEndpoint is an IP or domain name to the API server from which info will be fetched. type: string caCertHashes: description: |- - CACertHashes specifies a set of public key pins to verify + caCertHashes specifies a set of public key pins to verify when token-based discovery is used. The root CA found during discovery must match one of these values. Specifying an empty set disables root CA pinning, which can be unsafe. Each hash is specified as ":", @@ -3767,12 +3767,12 @@ spec: type: array token: description: |- - Token is a token used to validate cluster information + token is a token used to validate cluster information fetched from the control-plane. type: string unsafeSkipCAVerification: description: |- - UnsafeSkipCAVerification allows token-based discovery + unsafeSkipCAVerification allows token-based discovery without CA verification via CACertHashes. This can weaken the security of kubeadm since other nodes can impersonate the control-plane. type: boolean @@ -3781,12 +3781,12 @@ spec: type: object file: description: |- - File is used to specify a file or URL to a kubeconfig file from which to load cluster information + file is used to specify a file or URL to a kubeconfig file from which to load cluster information BootstrapToken and File are mutually exclusive properties: kubeConfig: description: |- - KubeConfig is used (optionally) to generate a KubeConfig based on the KubeadmConfig's information. + kubeConfig is used (optionally) to generate a KubeConfig based on the KubeadmConfig's information. The file is generated at the path specified in KubeConfigPath. Host address (server field) information is automatically populated based on the Cluster's ControlPlaneEndpoint. @@ -3794,7 +3794,7 @@ spec: properties: cluster: description: |- - Cluster contains information about how to communicate with the kubernetes cluster. + cluster contains information about how to communicate with the kubernetes cluster. By default the following fields are automatically populated: - Server with the Cluster's ControlPlaneEndpoint. @@ -3802,19 +3802,19 @@ spec: properties: certificateAuthorityData: description: |- - CertificateAuthorityData contains PEM-encoded certificate authority certificates. + certificateAuthorityData contains PEM-encoded certificate authority certificates. Defaults to the Cluster's CA certificate if empty. format: byte type: string insecureSkipTLSVerify: - description: InsecureSkipTLSVerify skips the + description: insecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure. type: boolean proxyURL: description: |- - ProxyURL is the URL to the proxy to be used for all requests made by this + proxyURL is the URL to the proxy to be used for all requests made by this client. URLs with "http", "https", and "socks5" schemes are supported. If this configuration is not provided or the empty string, the client attempts to construct a proxy configuration from http_proxy and @@ -3826,12 +3826,12 @@ spec: type: string server: description: |- - Server is the address of the kubernetes cluster (https://hostname:port). + server is the address of the kubernetes cluster (https://hostname:port). Defaults to https:// + Cluster.Spec.ControlPlaneEndpoint. type: string tlsServerName: - description: TLSServerName is used to check + description: tlsServerName is used to check server certificate. If TLSServerName is empty, the hostname used to contact the server is used. @@ -3839,29 +3839,29 @@ spec: type: object user: description: |- - User contains information that describes identity information. + user contains information that describes identity information. This is used to tell the kubernetes cluster who you are. properties: authProvider: - description: AuthProvider specifies a custom + description: authProvider specifies a custom authentication plugin for the kubernetes cluster. properties: config: additionalProperties: type: string - description: Config holds the parameters + description: config holds the parameters for the authentication plugin. type: object name: - description: Name is the name of the authentication + description: name is the name of the authentication plugin. type: string required: - name type: object exec: - description: Exec specifies a custom exec-based + description: exec specifies a custom exec-based authentication plugin for the kubernetes cluster. properties: @@ -3878,11 +3878,11 @@ spec: type: string type: array command: - description: Command to execute. + description: command to execute. type: string env: description: |- - Env defines additional environment variables to expose to the process. These + env defines additional environment variables to expose to the process. These are unioned with the host's environment, as well as variables client-go uses to pass argument to the plugin. items: @@ -3901,7 +3901,7 @@ spec: type: array provideClusterInfo: description: |- - ProvideClusterInfo determines whether or not to provide cluster information, + provideClusterInfo determines whether or not to provide cluster information, which could potentially contain very large CA data, to this exec plugin as a part of the KUBERNETES_EXEC_INFO environment variable. By default, it is set to false. Package k8s.io/client-go/tools/auth/exec provides helper methods for @@ -3915,7 +3915,7 @@ spec: - user type: object kubeConfigPath: - description: KubeConfigPath is used to specify the + description: kubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information type: string @@ -3923,11 +3923,11 @@ spec: - kubeConfigPath type: object timeout: - description: Timeout modifies the discovery timeout + description: timeout modifies the discovery timeout type: string tlsBootstrapToken: description: |- - TLSBootstrapToken is a token used for TLS bootstrapping. + tlsBootstrapToken is a token used for TLS bootstrapping. If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. If .File is set, this field **must be set** in case the KubeConfigFile does not contain any other authentication information type: string @@ -3942,17 +3942,17 @@ spec: type: string nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container runtime + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a slice of + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: @@ -3960,7 +3960,7 @@ spec: type: array imagePullPolicy: description: |- - ImagePullPolicy specifies the policy for image pulling + imagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations. The value of this field must be one of "Always", "IfNotPresent" or "Never". Defaults to "IfNotPresent". This can be used only @@ -3972,7 +3972,7 @@ spec: type: string imagePullSerial: description: |- - ImagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. + imagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. This option takes effect only on Kubernetes >=1.31.0. Default: true (defaulted in kubeadm) type: boolean @@ -3980,19 +3980,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: []` in the YAML file. This field is solely used for Node registration. items: @@ -4028,12 +4028,12 @@ spec: type: object patches: description: |- - Patches contains options related to applying patches to components deployed by kubeadm during + patches contains options related to applying patches to components deployed by kubeadm during "kubeadm join". The minimum kubernetes version needed to support Patches is v1.22 properties: directory: description: |- - Directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". + directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of "kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". "patchtype" can be one of "strategic" "merge" or "json" and they match the patch formats supported by kubectl. @@ -4047,7 +4047,7 @@ spec: type: object skipPhases: description: |- - SkipPhases is a list of phases to skip during command execution. + skipPhases is a list of phases to skip during command execution. The list of phases can be obtained with the "kubeadm init --help" command. This option takes effect only on Kubernetes >=1.22.0. items: @@ -4055,7 +4055,7 @@ spec: type: array type: object mounts: - description: Mounts specifies a list of mount points to be setup. + description: mounts specifies a list of mount points to be setup. items: description: MountPoints defines input for generated mounts in cloud-init. @@ -4064,32 +4064,32 @@ spec: type: array type: array ntp: - description: NTP specifies NTP configuration + description: ntp specifies NTP configuration properties: enabled: - description: Enabled specifies whether NTP should be enabled + description: enabled specifies whether NTP should be enabled type: boolean servers: - description: Servers specifies which NTP servers to use + description: servers specifies which NTP servers to use items: type: string type: array type: object postKubeadmCommands: - description: PostKubeadmCommands specifies extra commands to run + description: postKubeadmCommands specifies extra commands to run after kubeadm runs items: type: string type: array preKubeadmCommands: - description: PreKubeadmCommands specifies extra commands to run + description: preKubeadmCommands specifies extra commands to run before kubeadm runs items: type: string type: array useExperimentalRetryJoin: description: |- - UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + useExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments @@ -4104,51 +4104,51 @@ spec: When removing also remove from staticcheck exclude-rules for SA1019 in golangci.yml type: boolean users: - description: Users specifies extra users to add + description: users specifies extra users to add items: description: User defines the input for a generated user in cloud-init. properties: gecos: - description: Gecos specifies the gecos to use for the user + description: gecos specifies the gecos to use for the user type: string groups: - description: Groups specifies the additional groups for + description: groups specifies the additional groups for the user type: string homeDir: - description: HomeDir specifies the home directory to use + description: homeDir specifies the home directory to use for the user type: string inactive: - description: Inactive specifies whether to mark the user + description: inactive specifies whether to mark the user as inactive type: boolean lockPassword: - description: LockPassword specifies if password login should + description: lockPassword specifies if password login should be disabled type: boolean name: - description: Name specifies the user name + description: name specifies the user name type: string passwd: - description: Passwd specifies a hashed password for the + description: passwd specifies a hashed password for the user type: string passwdFrom: - description: PasswdFrom is a referenced source of passwd + description: passwdFrom is a referenced source of passwd to populate the passwd. properties: secret: - description: Secret represents a secret that should + description: secret represents a secret that should populate this password. properties: key: - description: Key is the key in the secret's data + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -4159,20 +4159,20 @@ spec: - secret type: object primaryGroup: - description: PrimaryGroup specifies the primary group for + description: primaryGroup specifies the primary group for the user type: string shell: - description: Shell specifies the user's shell + description: shell specifies the user's shell type: string sshAuthorizedKeys: - description: SSHAuthorizedKeys specifies a list of ssh authorized + description: sshAuthorizedKeys specifies a list of ssh authorized keys for the user items: type: string type: array sudo: - description: Sudo specifies a sudo role for the user + description: sudo specifies a sudo role for the user type: string required: - name @@ -4180,7 +4180,7 @@ spec: type: array verbosity: description: |- - Verbosity is the number for the kubeadm log level verbosity. + verbosity is the number for the kubeadm log level verbosity. It overrides the `--v` flag in kubeadm commands. format: int32 type: integer @@ -4206,12 +4206,12 @@ spec: type: object machineTemplate: description: |- - MachineTemplate contains information about how machines + machineTemplate contains information about how machines should be shaped when creating or updating a control plane. properties: infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -4263,7 +4263,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -4280,19 +4280,19 @@ spec: type: object nodeDeletionTimeout: description: |- - NodeDeletionTimeout defines how long the machine controller will attempt to delete the Node that the Machine + nodeDeletionTimeout defines how long the machine controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. If no value is provided, the default value for this property of the Machine resource will be used. type: string nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node + nodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string nodeVolumeDetachTimeout: description: |- - NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. type: string required: @@ -4303,7 +4303,7 @@ spec: machine remediation happens. properties: maxRetry: - description: "MaxRetry is the Max number of retries while attempting + description: "maxRetry is the Max number of retries while attempting to remediate an unhealthy machine.\nA retry happens when a machine that was created as a replacement for an unhealthy machine also fails.\nFor example, given a control plane with three machines @@ -4322,7 +4322,7 @@ spec: format: int32 type: integer minHealthyPeriod: - description: "MinHealthyPeriod defines the duration after which + description: "minHealthyPeriod defines the duration after which KCP will consider any failure to a machine unrelated\nfrom the previous one. In this case the remediation is not considered a retry anymore, and thus the retry\ncounter restarts from 0. @@ -4340,7 +4340,7 @@ spec: type: string retryPeriod: description: |- - RetryPeriod is the duration that KCP should wait before remediating a machine being created as a replacement + retryPeriod is the duration that KCP should wait before remediating a machine being created as a replacement for an unhealthy machine (a retry). If not set, a retry will happen immediately. @@ -4355,7 +4355,7 @@ spec: type: integer rolloutAfter: description: |- - RolloutAfter is a field to indicate a rollout should be performed + rolloutAfter is a field to indicate a rollout should be performed after the specified time even if no changes have been made to the KubeadmControlPlane. Example: In the YAML the time can be specified in the RFC3339 format. @@ -4365,12 +4365,12 @@ spec: type: string rolloutBefore: description: |- - RolloutBefore is a field to indicate a rollout should be performed + rolloutBefore is a field to indicate a rollout should be performed if the specified criteria is met. properties: certificatesExpiryDays: description: |- - CertificatesExpiryDays indicates a rollout needs to be performed if the + certificatesExpiryDays indicates a rollout needs to be performed if the certificates of the machine will expire within the specified days. format: int32 type: integer @@ -4404,14 +4404,14 @@ spec: type: object type: description: |- - Type of rollout. Currently the only supported strategy is + type of rollout. Currently the only supported strategy is "RollingUpdate". Default is RollingUpdate. type: string type: object version: description: |- - Version defines the desired Kubernetes version. + version defines the desired Kubernetes version. Please note that if kubeadmConfigSpec.ClusterConfiguration.imageRepository is not set we don't allow upgrades to versions >= v1.22.0 for which kubeadm uses the old registry (k8s.gcr.io). Please use a newer patch version with the new registry instead. The default registries of kubeadm are: @@ -4427,7 +4427,7 @@ spec: description: KubeadmControlPlaneStatus defines the observed state of KubeadmControlPlane. properties: conditions: - description: Conditions defines current service state of the KubeadmControlPlane. + description: conditions defines current service state of the KubeadmControlPlane. items: description: Condition defines an observation of a Cluster API resource operational state. @@ -4452,16 +4452,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -4480,7 +4480,7 @@ spec: type: string failureReason: description: |- - FailureReason indicates that there is a terminal problem reconciling the + failureReason indicates that there is a terminal problem reconciling the state, and will be set to a token value suitable for programmatic interpretation. @@ -4488,27 +4488,27 @@ spec: type: string initialized: description: |- - Initialized denotes that the KubeadmControlPlane API Server is initialized and thus + initialized denotes that the KubeadmControlPlane API Server is initialized and thus it can accept requests. NOTE: this field is part of the Cluster API contract and it is used to orchestrate provisioning. The value of this field is never updated after provisioning is completed. Please use conditions to check the operational state of the control plane. type: boolean lastRemediation: - description: LastRemediation stores info about last remediation performed. + description: lastRemediation stores info about last remediation performed. properties: machine: - description: Machine is the machine name of the latest machine + description: machine is the machine name of the latest machine being remediated. type: string retryCount: description: |- - RetryCount used to keep track of remediation retry for the last remediated machine. + retryCount used to keep track of remediation retry for the last remediated machine. A retry happens when a machine that was created as a replacement for an unhealthy machine also fails. format: int32 type: integer timestamp: - description: Timestamp is when last remediation happened. It is + description: timestamp is when last remediation happened. It is represented in RFC3339 form and is in UTC. format: date-time type: string @@ -4518,13 +4518,13 @@ spec: - timestamp type: object observedGeneration: - description: ObservedGeneration is the latest generation observed + description: observedGeneration is the latest generation observed by the controller. format: int64 type: integer ready: description: |- - Ready denotes that the KubeadmControlPlane API Server became ready during initial provisioning + ready denotes that the KubeadmControlPlane API Server became ready during initial provisioning to receive requests. NOTE: this field is part of the Cluster API contract and it is used to orchestrate provisioning. The value of this field is never updated after provisioning is completed. Please use conditions @@ -4543,7 +4543,7 @@ spec: type: integer selector: description: |- - Selector is the label selector in string format to avoid introspection + selector is the label selector in string format to avoid introspection by clients, and is used to provide the CRD-based integration for the scale subresource and additional integrations for things like kubectl describe.. The string will be in the same format as the query-param syntax. @@ -4654,7 +4654,7 @@ spec: type: object version: description: |- - Version represents the minimum Kubernetes version for the control plane machines + version represents the minimum Kubernetes version for the control plane machines in the cluster. type: string type: object diff --git a/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanetemplates.yaml b/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanetemplates.yaml index 759a4061c702..332634f0bfa1 100644 --- a/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanetemplates.yaml +++ b/controlplane/kubeadm/config/crd/bases/controlplane.cluster.x-k8s.io_kubeadmcontrolplanetemplates.yaml @@ -61,19 +61,19 @@ spec: properties: kubeadmConfigSpec: description: |- - KubeadmConfigSpec is a KubeadmConfigSpec + kubeadmConfigSpec is a KubeadmConfigSpec to use for initializing and joining machines to the control plane. properties: clusterConfiguration: - description: ClusterConfiguration along with InitConfiguration + description: clusterConfiguration along with InitConfiguration are the configurations necessary for the init command properties: apiServer: - description: APIServer contains extra settings for + description: apiServer contains extra settings for the API server control plane component properties: certSANs: - description: CertSANs sets extra Subject Alternative + description: certSANs sets extra Subject Alternative Names for the API Server signing cert. items: type: string @@ -81,11 +81,11 @@ spec: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraVolumes: - description: ExtraVolumes is an extra set of host + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -94,23 +94,23 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access + description: readOnly controls write access to the volume type: boolean required: @@ -120,7 +120,7 @@ spec: type: object type: array timeoutForControlPlane: - description: TimeoutForControlPlane controls the + description: timeoutForControlPlane controls the timeout that we use for API server to appear type: string type: object @@ -133,7 +133,7 @@ spec: type: string certificatesDir: description: |- - CertificatesDir specifies where to store or look for all required certificates. + certificatesDir specifies where to store or look for all required certificates. NB: if not provided, this will default to `/etc/kubernetes/pki` type: string clusterName: @@ -141,7 +141,7 @@ spec: type: string controlPlaneEndpoint: description: |- - ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it + controlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort are used; in case the ControlPlaneEndpoint is specified but without a TCP port, @@ -155,17 +155,17 @@ spec: NB: This value defaults to the first value in the Cluster object status.apiEndpoints array. type: string controllerManager: - description: ControllerManager contains extra settings + description: controllerManager contains extra settings for the controller manager control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraVolumes: - description: ExtraVolumes is an extra set of host + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -174,23 +174,23 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access + description: readOnly controls write access to the volume type: boolean required: @@ -201,49 +201,49 @@ spec: type: array type: object dns: - description: DNS defines the options for the DNS add-on + description: dns defines the options for the DNS add-on installed in the cluster. properties: imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string type: object etcd: description: |- - Etcd holds configuration for etcd. + etcd holds configuration for etcd. NB: This value defaults to a Local (stacked) etcd properties: external: description: |- - External describes how to connect to an external etcd cluster + external describes how to connect to an external etcd cluster Local and External are mutually exclusive properties: caFile: description: |- - CAFile is an SSL Certificate Authority file used to secure etcd communication. + caFile is an SSL Certificate Authority file used to secure etcd communication. Required if using a TLS connection. type: string certFile: description: |- - CertFile is an SSL certification file used to secure etcd communication. + certFile is an SSL certification file used to secure etcd communication. Required if using a TLS connection. type: string endpoints: - description: Endpoints of etcd members. Required + description: endpoints of etcd members. Required for ExternalEtcd. items: type: string type: array keyFile: description: |- - KeyFile is an SSL key file used to secure etcd communication. + keyFile is an SSL key file used to secure etcd communication. Required if using a TLS connection. type: string required: @@ -254,40 +254,40 @@ spec: type: object local: description: |- - Local provides configuration knobs for configuring the local etcd instance + local provides configuration knobs for configuring the local etcd instance Local and External are mutually exclusive properties: dataDir: description: |- - DataDir is the directory etcd will place its data. + dataDir is the directory etcd will place its data. Defaults to "/var/lib/etcd". type: string extraArgs: additionalProperties: type: string description: |- - ExtraArgs are extra arguments provided to the etcd binary + extraArgs are extra arguments provided to the etcd binary when run inside a static pod. type: object imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string peerCertSANs: - description: PeerCertSANs sets extra Subject + description: peerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. items: type: string type: array serverCertSANs: - description: ServerCertSANs sets extra Subject + description: serverCertSANs sets extra Subject Alternative Names for the etcd server signing cert. items: @@ -298,11 +298,11 @@ spec: featureGates: additionalProperties: type: boolean - description: FeatureGates enabled by the user. + description: featureGates enabled by the user. type: object imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. If empty, `registry.k8s.io` will be used by default; in case of kubernetes version is a CI build (kubernetes version starts with `ci/` or `ci-cross/`) `gcr.io/k8s-staging-ci-images` will be used as a default for control plane components and for kube-proxy, while `registry.k8s.io` will be used for all the other images. @@ -317,43 +317,43 @@ spec: type: string kubernetesVersion: description: |- - KubernetesVersion is the target version of the control plane. + kubernetesVersion is the target version of the control plane. NB: This value defaults to the Machine object spec.version type: string networking: description: |- - Networking holds configuration for the networking topology of the cluster. + networking holds configuration for the networking topology of the cluster. NB: This value defaults to the Cluster object spec.clusterNetwork. properties: dnsDomain: - description: DNSDomain is the dns domain used + description: dnsDomain is the dns domain used by k8s services. Defaults to "cluster.local". type: string podSubnet: description: |- - PodSubnet is the subnet used by pods. + podSubnet is the subnet used by pods. If unset, the API server will not allocate CIDR ranges for every node. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.services.cidrBlocks if that is set type: string serviceSubnet: description: |- - ServiceSubnet is the subnet used by k8s services. + serviceSubnet is the subnet used by k8s services. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.pods.cidrBlocks, or to "10.96.0.0/12" if that's unset. type: string type: object scheduler: - description: Scheduler contains extra settings for + description: scheduler contains extra settings for the scheduler control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraVolumes: - description: ExtraVolumes is an extra set of host + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -362,23 +362,23 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access + description: readOnly controls write access to the volume type: boolean required: @@ -390,49 +390,49 @@ spec: type: object type: object diskSetup: - description: DiskSetup specifies options for the creation + description: diskSetup specifies options for the creation of partition tables and file systems on devices. properties: filesystems: - description: Filesystems specifies the list of file + description: filesystems specifies the list of file systems to setup. items: description: Filesystem defines the file systems to be created. properties: device: - description: Device specifies the device name + description: device specifies the device name type: string extraOpts: - description: ExtraOpts defined extra options + description: extraOpts defined extra options to add to the command for creating the file system. items: type: string type: array filesystem: - description: Filesystem specifies the file system + description: filesystem specifies the file system type. type: string label: - description: Label specifies the file system + description: label specifies the file system label to be used. If set to None, no label is used. type: string overwrite: description: |- - Overwrite defines whether or not to overwrite any existing filesystem. + overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution. type: boolean partition: - description: 'Partition specifies the partition + description: 'partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number.' type: string replaceFS: description: |- - ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the 'any' partition directive. type: string required: @@ -442,29 +442,29 @@ spec: type: object type: array partitions: - description: Partitions specifies the list of the + description: partitions specifies the list of the partitions to setup. items: description: Partition defines how to create and layout a partition. properties: device: - description: Device is the name of the device. + description: device is the name of the device. type: string layout: description: |- - Layout specifies the device layout. + layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don't partition or ignore existing partitioning. type: boolean overwrite: description: |- - Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is 'false'. type: boolean tableType: description: |- - TableType specifies the tupe of partition table. The following are supported: + tableType specifies the tupe of partition table. The following are supported: 'mbr': default and setups a MS-DOS partition table 'gpt': setups a GPT partition table type: string @@ -475,30 +475,30 @@ spec: type: array type: object files: - description: Files specifies extra files to be passed + description: files specifies extra files to be passed to user_data upon creation. items: description: File defines the input for generating write_files in cloud-init. properties: content: - description: Content is the actual content of the + description: content is the actual content of the file. type: string contentFrom: - description: ContentFrom is a referenced source + description: contentFrom is a referenced source of content to populate the file. properties: secret: - description: Secret represents a secret that + description: secret represents a secret that should populate this file. properties: key: - description: Key is the key in the secret's + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -509,7 +509,7 @@ spec: - secret type: object encoding: - description: Encoding specifies the encoding of + description: encoding specifies the encoding of the file contents. enum: - base64 @@ -517,15 +517,15 @@ spec: - gzip+base64 type: string owner: - description: Owner specifies the ownership of the + description: owner specifies the ownership of the file, e.g. "root:root". type: string path: - description: Path specifies the full path on disk + description: path specifies the full path on disk where to store the file. type: string permissions: - description: Permissions specifies the permissions + description: permissions specifies the permissions to assign to the file, e.g. "0640". type: string required: @@ -533,13 +533,13 @@ spec: type: object type: array format: - description: Format specifies the output format of the + description: format specifies the output format of the bootstrap data enum: - cloud-config type: string initConfiguration: - description: InitConfiguration along with ClusterConfiguration + description: initConfiguration along with ClusterConfiguration are the configurations necessary for the init command properties: apiVersion: @@ -551,7 +551,7 @@ spec: type: string bootstrapTokens: description: |- - BootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. + bootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature items: description: BootstrapToken describes one bootstrap @@ -559,35 +559,35 @@ spec: properties: description: description: |- - Description sets a human-friendly message why this token exists and what it's used + description sets a human-friendly message why this token exists and what it's used for, so other administrators can know its purpose. type: string expires: description: |- - Expires specifies the timestamp when this token expires. Defaults to being set + expires specifies the timestamp when this token expires. Defaults to being set dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive. format: date-time type: string groups: description: |- - Groups specifies the extra groups that this token will authenticate as when/if + groups specifies the extra groups that this token will authenticate as when/if used for authentication items: type: string type: array token: description: |- - Token is used for establishing bidirectional trust between nodes and control-planes. + token is used for establishing bidirectional trust between nodes and control-planes. Used for joining nodes in the cluster. type: string ttl: description: |- - TTL defines the time to live for this token. Defaults to 24h. + ttl defines the time to live for this token. Defaults to 24h. Expires and TTL are mutually exclusive. type: string usages: description: |- - Usages describes the ways in which this token can be used. Can by default be used + usages describes the ways in which this token can be used. Can by default be used for establishing bidirectional trust, but that can be changed here. items: type: string @@ -606,7 +606,7 @@ spec: type: string localAPIEndpoint: description: |- - LocalAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node + localAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible @@ -614,29 +614,29 @@ spec: fails you may set the desired value here. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: @@ -646,19 +646,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: {}` in the YAML file. This field is solely used for Node registration. items: @@ -694,7 +694,7 @@ spec: type: object type: object joinConfiguration: - description: JoinConfiguration is the kubeadm configuration + description: joinConfiguration is the kubeadm configuration for the join command properties: apiVersion: @@ -706,49 +706,49 @@ spec: type: string caCertPath: description: |- - CACertPath is the path to the SSL certificate authority used to + caCertPath is the path to the SSL certificate authority used to secure comunications between node and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt". type: string controlPlane: description: |- - ControlPlane defines the additional control plane instance to be deployed on the joining node. + controlPlane defines the additional control plane instance to be deployed on the joining node. If nil, no additional control plane instance will be deployed. properties: localAPIEndpoint: - description: LocalAPIEndpoint represents the endpoint + description: localAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. properties: advertiseAddress: - description: AdvertiseAddress sets the IP + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object type: object discovery: - description: Discovery specifies the options for the + description: discovery specifies the options for the kubelet to use during the TLS Bootstrap process properties: bootstrapToken: description: |- - BootstrapToken is used to set the options for bootstrap token based discovery + bootstrapToken is used to set the options for bootstrap token based discovery BootstrapToken and File are mutually exclusive properties: apiServerEndpoint: - description: APIServerEndpoint is an IP or + description: apiServerEndpoint is an IP or domain name to the API server from which info will be fetched. type: string caCertHashes: description: |- - CACertHashes specifies a set of public key pins to verify + caCertHashes specifies a set of public key pins to verify when token-based discovery is used. The root CA found during discovery must match one of these values. Specifying an empty set disables root CA pinning, which can be unsafe. Each hash is specified as ":", @@ -761,12 +761,12 @@ spec: type: array token: description: |- - Token is a token used to validate cluster information + token is a token used to validate cluster information fetched from the control-plane. type: string unsafeSkipCAVerification: description: |- - UnsafeSkipCAVerification allows token-based discovery + unsafeSkipCAVerification allows token-based discovery without CA verification via CACertHashes. This can weaken the security of kubeadm since other nodes can impersonate the control-plane. type: boolean @@ -775,11 +775,11 @@ spec: type: object file: description: |- - File is used to specify a file or URL to a kubeconfig file from which to load cluster information + file is used to specify a file or URL to a kubeconfig file from which to load cluster information BootstrapToken and File are mutually exclusive properties: kubeConfigPath: - description: KubeConfigPath is used to specify + description: kubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information type: string @@ -787,11 +787,11 @@ spec: - kubeConfigPath type: object timeout: - description: Timeout modifies the discovery timeout + description: timeout modifies the discovery timeout type: string tlsBootstrapToken: description: |- - TLSBootstrapToken is a token used for TLS bootstrapping. + tlsBootstrapToken is a token used for TLS bootstrapping. If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. If .File is set, this field **must be set** in case the KubeConfigFile does not contain any other authentication information type: string @@ -806,17 +806,17 @@ spec: type: string nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: @@ -826,19 +826,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: {}` in the YAML file. This field is solely used for Node registration. items: @@ -874,7 +874,7 @@ spec: type: object type: object mounts: - description: Mounts specifies a list of mount points to + description: mounts specifies a list of mount points to be setup. items: description: MountPoints defines input for generated @@ -884,34 +884,34 @@ spec: type: array type: array ntp: - description: NTP specifies NTP configuration + description: ntp specifies NTP configuration properties: enabled: - description: Enabled specifies whether NTP should + description: enabled specifies whether NTP should be enabled type: boolean servers: - description: Servers specifies which NTP servers to + description: servers specifies which NTP servers to use items: type: string type: array type: object postKubeadmCommands: - description: PostKubeadmCommands specifies extra commands + description: postKubeadmCommands specifies extra commands to run after kubeadm runs items: type: string type: array preKubeadmCommands: - description: PreKubeadmCommands specifies extra commands + description: preKubeadmCommands specifies extra commands to run before kubeadm runs items: type: string type: array useExperimentalRetryJoin: description: |- - UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + useExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments @@ -923,53 +923,53 @@ spec: For more information, refer to https://github.com/kubernetes-sigs/cluster-api/pull/2763#discussion_r397306055. type: boolean users: - description: Users specifies extra users to add + description: users specifies extra users to add items: description: User defines the input for a generated user in cloud-init. properties: gecos: - description: Gecos specifies the gecos to use for + description: gecos specifies the gecos to use for the user type: string groups: - description: Groups specifies the additional groups + description: groups specifies the additional groups for the user type: string homeDir: - description: HomeDir specifies the home directory + description: homeDir specifies the home directory to use for the user type: string inactive: - description: Inactive specifies whether to mark + description: inactive specifies whether to mark the user as inactive type: boolean lockPassword: - description: LockPassword specifies if password + description: lockPassword specifies if password login should be disabled type: boolean name: - description: Name specifies the user name + description: name specifies the user name type: string passwd: - description: Passwd specifies a hashed password + description: passwd specifies a hashed password for the user type: string primaryGroup: - description: PrimaryGroup specifies the primary + description: primaryGroup specifies the primary group for the user type: string shell: - description: Shell specifies the user's shell + description: shell specifies the user's shell type: string sshAuthorizedKeys: - description: SSHAuthorizedKeys specifies a list + description: sshAuthorizedKeys specifies a list of ssh authorized keys for the user items: type: string type: array sudo: - description: Sudo specifies a sudo role for the + description: sudo specifies a sudo role for the user type: string required: @@ -978,19 +978,19 @@ spec: type: array verbosity: description: |- - Verbosity is the number for the kubeadm log level verbosity. + verbosity is the number for the kubeadm log level verbosity. It overrides the `--v` flag in kubeadm commands. format: int32 type: integer type: object machineTemplate: description: |- - MachineTemplate contains information about how machines + machineTemplate contains information about how machines should be shaped when creating or updating a control plane. properties: infrastructureRef: description: |- - InfrastructureRef is a required reference to a custom resource + infrastructureRef is a required reference to a custom resource offered by an infrastructure provider. properties: apiVersion: @@ -1042,7 +1042,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -1059,7 +1059,7 @@ spec: type: object nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node + nodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string @@ -1075,7 +1075,7 @@ spec: type: integer rolloutAfter: description: |- - RolloutAfter is a field to indicate a rollout should be performed + rolloutAfter is a field to indicate a rollout should be performed after the specified time even if no changes have been made to the KubeadmControlPlane. format: date-time @@ -1109,13 +1109,13 @@ spec: type: object type: description: |- - Type of rollout. Currently the only supported strategy is + type of rollout. Currently the only supported strategy is "RollingUpdate". Default is RollingUpdate. type: string type: object version: - description: Version defines the desired Kubernetes version. + description: version defines the desired Kubernetes version. type: string required: - kubeadmConfigSpec @@ -1177,7 +1177,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -1202,19 +1202,19 @@ spec: properties: kubeadmConfigSpec: description: |- - KubeadmConfigSpec is a KubeadmConfigSpec + kubeadmConfigSpec is a KubeadmConfigSpec to use for initializing and joining machines to the control plane. properties: clusterConfiguration: - description: ClusterConfiguration along with InitConfiguration + description: clusterConfiguration along with InitConfiguration are the configurations necessary for the init command properties: apiServer: - description: APIServer contains extra settings for + description: apiServer contains extra settings for the API server control plane component properties: certSANs: - description: CertSANs sets extra Subject Alternative + description: certSANs sets extra Subject Alternative Names for the API Server signing cert. items: type: string @@ -1222,12 +1222,12 @@ spec: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -1355,7 +1355,7 @@ spec: type: object type: array extraVolumes: - description: ExtraVolumes is an extra set of host + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -1364,23 +1364,23 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access + description: readOnly controls write access to the volume type: boolean required: @@ -1390,7 +1390,7 @@ spec: type: object type: array timeoutForControlPlane: - description: TimeoutForControlPlane controls the + description: timeoutForControlPlane controls the timeout that we use for API server to appear type: string type: object @@ -1403,7 +1403,7 @@ spec: type: string certificatesDir: description: |- - CertificatesDir specifies where to store or look for all required certificates. + certificatesDir specifies where to store or look for all required certificates. NB: if not provided, this will default to `/etc/kubernetes/pki` type: string clusterName: @@ -1411,7 +1411,7 @@ spec: type: string controlPlaneEndpoint: description: |- - ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it + controlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort are used; in case the ControlPlaneEndpoint is specified but without a TCP port, @@ -1425,18 +1425,18 @@ spec: NB: This value defaults to the first value in the Cluster object status.apiEndpoints array. type: string controllerManager: - description: ControllerManager contains extra settings + description: controllerManager contains extra settings for the controller manager control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -1564,7 +1564,7 @@ spec: type: object type: array extraVolumes: - description: ExtraVolumes is an extra set of host + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -1573,23 +1573,23 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access + description: readOnly controls write access to the volume type: boolean required: @@ -1600,49 +1600,49 @@ spec: type: array type: object dns: - description: DNS defines the options for the DNS add-on + description: dns defines the options for the DNS add-on installed in the cluster. properties: imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string type: object etcd: description: |- - Etcd holds configuration for etcd. + etcd holds configuration for etcd. NB: This value defaults to a Local (stacked) etcd properties: external: description: |- - External describes how to connect to an external etcd cluster + external describes how to connect to an external etcd cluster Local and External are mutually exclusive properties: caFile: description: |- - CAFile is an SSL Certificate Authority file used to secure etcd communication. + caFile is an SSL Certificate Authority file used to secure etcd communication. Required if using a TLS connection. type: string certFile: description: |- - CertFile is an SSL certification file used to secure etcd communication. + certFile is an SSL certification file used to secure etcd communication. Required if using a TLS connection. type: string endpoints: - description: Endpoints of etcd members. Required + description: endpoints of etcd members. Required for ExternalEtcd. items: type: string type: array keyFile: description: |- - KeyFile is an SSL key file used to secure etcd communication. + keyFile is an SSL key file used to secure etcd communication. Required if using a TLS connection. type: string required: @@ -1653,24 +1653,24 @@ spec: type: object local: description: |- - Local provides configuration knobs for configuring the local etcd instance + local provides configuration knobs for configuring the local etcd instance Local and External are mutually exclusive properties: dataDir: description: |- - DataDir is the directory etcd will place its data. + dataDir is the directory etcd will place its data. Defaults to "/var/lib/etcd". type: string extraArgs: additionalProperties: type: string description: |- - ExtraArgs are extra arguments provided to the etcd binary + extraArgs are extra arguments provided to the etcd binary when run inside a static pod. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -1803,23 +1803,23 @@ spec: type: array imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead. type: string imageTag: description: |- - ImageTag allows to specify a tag for the image. + imageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. type: string peerCertSANs: - description: PeerCertSANs sets extra Subject + description: peerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. items: type: string type: array serverCertSANs: - description: ServerCertSANs sets extra Subject + description: serverCertSANs sets extra Subject Alternative Names for the etcd server signing cert. items: @@ -1830,11 +1830,11 @@ spec: featureGates: additionalProperties: type: boolean - description: FeatureGates enabled by the user. + description: featureGates enabled by the user. type: object imageRepository: description: |- - ImageRepository sets the container registry to pull images from. + imageRepository sets the container registry to pull images from. * If not set, the default registry of kubeadm will be used, i.e. * registry.k8s.io (new registry): >= v1.22.17, >= v1.23.15, >= v1.24.9, >= v1.25.0 * k8s.gcr.io (old registry): all older versions @@ -1856,44 +1856,44 @@ spec: type: string kubernetesVersion: description: |- - KubernetesVersion is the target version of the control plane. + kubernetesVersion is the target version of the control plane. NB: This value defaults to the Machine object spec.version type: string networking: description: |- - Networking holds configuration for the networking topology of the cluster. + networking holds configuration for the networking topology of the cluster. NB: This value defaults to the Cluster object spec.clusterNetwork. properties: dnsDomain: - description: DNSDomain is the dns domain used + description: dnsDomain is the dns domain used by k8s services. Defaults to "cluster.local". type: string podSubnet: description: |- - PodSubnet is the subnet used by pods. + podSubnet is the subnet used by pods. If unset, the API server will not allocate CIDR ranges for every node. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.services.cidrBlocks if that is set type: string serviceSubnet: description: |- - ServiceSubnet is the subnet used by k8s services. + serviceSubnet is the subnet used by k8s services. Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.pods.cidrBlocks, or to "10.96.0.0/12" if that's unset. type: string type: object scheduler: - description: Scheduler contains extra settings for + description: scheduler contains extra settings for the scheduler control plane component properties: extraArgs: additionalProperties: type: string - description: ExtraArgs is an extra set of flags + description: extraArgs is an extra set of flags to pass to the control plane component. type: object extraEnvs: description: |- - ExtraEnvs is an extra set of environment variables to pass to the control plane component. + extraEnvs is an extra set of environment variables to pass to the control plane component. Environment variables passed using ExtraEnvs will override any existing environment variables, or *_proxy environment variables that kubeadm adds by default. This option takes effect only on Kubernetes >=1.31.0. items: @@ -2021,7 +2021,7 @@ spec: type: object type: array extraVolumes: - description: ExtraVolumes is an extra set of host + description: extraVolumes is an extra set of host volumes, mounted to the control plane component. items: description: |- @@ -2030,23 +2030,23 @@ spec: properties: hostPath: description: |- - HostPath is the path in the host that will be mounted inside + hostPath is the path in the host that will be mounted inside the pod. type: string mountPath: - description: MountPath is the path inside + description: mountPath is the path inside the pod where hostPath will be mounted. type: string name: - description: Name of the volume inside the + description: name of the volume inside the pod template. type: string pathType: - description: PathType is the type of the + description: pathType is the type of the HostPath. type: string readOnly: - description: ReadOnly controls write access + description: readOnly controls write access to the volume type: boolean required: @@ -2058,49 +2058,49 @@ spec: type: object type: object diskSetup: - description: DiskSetup specifies options for the creation + description: diskSetup specifies options for the creation of partition tables and file systems on devices. properties: filesystems: - description: Filesystems specifies the list of file + description: filesystems specifies the list of file systems to setup. items: description: Filesystem defines the file systems to be created. properties: device: - description: Device specifies the device name + description: device specifies the device name type: string extraOpts: - description: ExtraOpts defined extra options + description: extraOpts defined extra options to add to the command for creating the file system. items: type: string type: array filesystem: - description: Filesystem specifies the file system + description: filesystem specifies the file system type. type: string label: - description: Label specifies the file system + description: label specifies the file system label to be used. If set to None, no label is used. type: string overwrite: description: |- - Overwrite defines whether or not to overwrite any existing filesystem. + overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution. type: boolean partition: - description: 'Partition specifies the partition + description: 'partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number.' type: string replaceFS: description: |- - ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the 'any' partition directive. type: string required: @@ -2110,29 +2110,29 @@ spec: type: object type: array partitions: - description: Partitions specifies the list of the + description: partitions specifies the list of the partitions to setup. items: description: Partition defines how to create and layout a partition. properties: device: - description: Device is the name of the device. + description: device is the name of the device. type: string layout: description: |- - Layout specifies the device layout. + layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don't partition or ignore existing partitioning. type: boolean overwrite: description: |- - Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is 'false'. type: boolean tableType: description: |- - TableType specifies the tupe of partition table. The following are supported: + tableType specifies the tupe of partition table. The following are supported: 'mbr': default and setups a MS-DOS partition table 'gpt': setups a GPT partition table type: string @@ -2143,34 +2143,34 @@ spec: type: array type: object files: - description: Files specifies extra files to be passed + description: files specifies extra files to be passed to user_data upon creation. items: description: File defines the input for generating write_files in cloud-init. properties: append: - description: Append specifies whether to append + description: append specifies whether to append Content to existing file if Path exists. type: boolean content: - description: Content is the actual content of the + description: content is the actual content of the file. type: string contentFrom: - description: ContentFrom is a referenced source + description: contentFrom is a referenced source of content to populate the file. properties: secret: - description: Secret represents a secret that + description: secret represents a secret that should populate this file. properties: key: - description: Key is the key in the secret's + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -2181,7 +2181,7 @@ spec: - secret type: object encoding: - description: Encoding specifies the encoding of + description: encoding specifies the encoding of the file contents. enum: - base64 @@ -2189,15 +2189,15 @@ spec: - gzip+base64 type: string owner: - description: Owner specifies the ownership of the + description: owner specifies the ownership of the file, e.g. "root:root". type: string path: - description: Path specifies the full path on disk + description: path specifies the full path on disk where to store the file. type: string permissions: - description: Permissions specifies the permissions + description: permissions specifies the permissions to assign to the file, e.g. "0640". type: string required: @@ -2205,35 +2205,35 @@ spec: type: object type: array format: - description: Format specifies the output format of the + description: format specifies the output format of the bootstrap data enum: - cloud-config - ignition type: string ignition: - description: Ignition contains Ignition specific configuration. + description: ignition contains Ignition specific configuration. properties: containerLinuxConfig: - description: ContainerLinuxConfig contains CLC specific + description: containerLinuxConfig contains CLC specific configuration. properties: additionalConfig: description: |- - AdditionalConfig contains additional configuration to be merged with the Ignition + additionalConfig contains additional configuration to be merged with the Ignition configuration generated by the bootstrapper controller. More info: https://coreos.github.io/ignition/operator-notes/#config-merging The data format is documented here: https://kinvolk.io/docs/flatcar-container-linux/latest/provisioning/cl-config/ type: string strict: - description: Strict controls if AdditionalConfig + description: strict controls if AdditionalConfig should be strictly parsed. If so, warnings are treated as errors. type: boolean type: object type: object initConfiguration: - description: InitConfiguration along with ClusterConfiguration + description: initConfiguration along with ClusterConfiguration are the configurations necessary for the init command properties: apiVersion: @@ -2245,7 +2245,7 @@ spec: type: string bootstrapTokens: description: |- - BootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. + bootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature items: description: BootstrapToken describes one bootstrap @@ -2253,35 +2253,35 @@ spec: properties: description: description: |- - Description sets a human-friendly message why this token exists and what it's used + description sets a human-friendly message why this token exists and what it's used for, so other administrators can know its purpose. type: string expires: description: |- - Expires specifies the timestamp when this token expires. Defaults to being set + expires specifies the timestamp when this token expires. Defaults to being set dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive. format: date-time type: string groups: description: |- - Groups specifies the extra groups that this token will authenticate as when/if + groups specifies the extra groups that this token will authenticate as when/if used for authentication items: type: string type: array token: description: |- - Token is used for establishing bidirectional trust between nodes and control-planes. + token is used for establishing bidirectional trust between nodes and control-planes. Used for joining nodes in the cluster. type: string ttl: description: |- - TTL defines the time to live for this token. Defaults to 24h. + ttl defines the time to live for this token. Defaults to 24h. Expires and TTL are mutually exclusive. type: string usages: description: |- - Usages describes the ways in which this token can be used. Can by default be used + usages describes the ways in which this token can be used. Can by default be used for establishing bidirectional trust, but that can be changed here. items: type: string @@ -2300,7 +2300,7 @@ spec: type: string localAPIEndpoint: description: |- - LocalAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node + localAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible @@ -2308,29 +2308,29 @@ spec: fails you may set the desired value here. properties: advertiseAddress: - description: AdvertiseAddress sets the IP address + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: @@ -2338,7 +2338,7 @@ spec: type: array imagePullPolicy: description: |- - ImagePullPolicy specifies the policy for image pulling + imagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations. The value of this field must be one of "Always", "IfNotPresent" or "Never". Defaults to "IfNotPresent". This can be used only @@ -2350,7 +2350,7 @@ spec: type: string imagePullSerial: description: |- - ImagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. + imagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. This option takes effect only on Kubernetes >=1.31.0. Default: true (defaulted in kubeadm) type: boolean @@ -2358,19 +2358,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: []` in the YAML file. This field is solely used for Node registration. items: @@ -2406,12 +2406,12 @@ spec: type: object patches: description: |- - Patches contains options related to applying patches to components deployed by kubeadm during + patches contains options related to applying patches to components deployed by kubeadm during "kubeadm init". The minimum kubernetes version needed to support Patches is v1.22 properties: directory: description: |- - Directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". + directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of "kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". "patchtype" can be one of "strategic" "merge" or "json" and they match the patch formats supported by kubectl. @@ -2425,7 +2425,7 @@ spec: type: object skipPhases: description: |- - SkipPhases is a list of phases to skip during command execution. + skipPhases is a list of phases to skip during command execution. The list of phases can be obtained with the "kubeadm init --help" command. This option takes effect only on Kubernetes >=1.22.0. items: @@ -2433,7 +2433,7 @@ spec: type: array type: object joinConfiguration: - description: JoinConfiguration is the kubeadm configuration + description: joinConfiguration is the kubeadm configuration for the join command properties: apiVersion: @@ -2445,49 +2445,49 @@ spec: type: string caCertPath: description: |- - CACertPath is the path to the SSL certificate authority used to + caCertPath is the path to the SSL certificate authority used to secure comunications between node and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt". type: string controlPlane: description: |- - ControlPlane defines the additional control plane instance to be deployed on the joining node. + controlPlane defines the additional control plane instance to be deployed on the joining node. If nil, no additional control plane instance will be deployed. properties: localAPIEndpoint: - description: LocalAPIEndpoint represents the endpoint + description: localAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. properties: advertiseAddress: - description: AdvertiseAddress sets the IP + description: advertiseAddress sets the IP address for the API server to advertise. type: string bindPort: description: |- - BindPort sets the secure port for the API Server to bind to. + bindPort sets the secure port for the API Server to bind to. Defaults to 6443. format: int32 type: integer type: object type: object discovery: - description: Discovery specifies the options for the + description: discovery specifies the options for the kubelet to use during the TLS Bootstrap process properties: bootstrapToken: description: |- - BootstrapToken is used to set the options for bootstrap token based discovery + bootstrapToken is used to set the options for bootstrap token based discovery BootstrapToken and File are mutually exclusive properties: apiServerEndpoint: - description: APIServerEndpoint is an IP or + description: apiServerEndpoint is an IP or domain name to the API server from which info will be fetched. type: string caCertHashes: description: |- - CACertHashes specifies a set of public key pins to verify + caCertHashes specifies a set of public key pins to verify when token-based discovery is used. The root CA found during discovery must match one of these values. Specifying an empty set disables root CA pinning, which can be unsafe. Each hash is specified as ":", @@ -2500,12 +2500,12 @@ spec: type: array token: description: |- - Token is a token used to validate cluster information + token is a token used to validate cluster information fetched from the control-plane. type: string unsafeSkipCAVerification: description: |- - UnsafeSkipCAVerification allows token-based discovery + unsafeSkipCAVerification allows token-based discovery without CA verification via CACertHashes. This can weaken the security of kubeadm since other nodes can impersonate the control-plane. type: boolean @@ -2514,12 +2514,12 @@ spec: type: object file: description: |- - File is used to specify a file or URL to a kubeconfig file from which to load cluster information + file is used to specify a file or URL to a kubeconfig file from which to load cluster information BootstrapToken and File are mutually exclusive properties: kubeConfig: description: |- - KubeConfig is used (optionally) to generate a KubeConfig based on the KubeadmConfig's information. + kubeConfig is used (optionally) to generate a KubeConfig based on the KubeadmConfig's information. The file is generated at the path specified in KubeConfigPath. Host address (server field) information is automatically populated based on the Cluster's ControlPlaneEndpoint. @@ -2527,7 +2527,7 @@ spec: properties: cluster: description: |- - Cluster contains information about how to communicate with the kubernetes cluster. + cluster contains information about how to communicate with the kubernetes cluster. By default the following fields are automatically populated: - Server with the Cluster's ControlPlaneEndpoint. @@ -2535,20 +2535,20 @@ spec: properties: certificateAuthorityData: description: |- - CertificateAuthorityData contains PEM-encoded certificate authority certificates. + certificateAuthorityData contains PEM-encoded certificate authority certificates. Defaults to the Cluster's CA certificate if empty. format: byte type: string insecureSkipTLSVerify: - description: InsecureSkipTLSVerify + description: insecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure. type: boolean proxyURL: description: |- - ProxyURL is the URL to the proxy to be used for all requests made by this + proxyURL is the URL to the proxy to be used for all requests made by this client. URLs with "http", "https", and "socks5" schemes are supported. If this configuration is not provided or the empty string, the client attempts to construct a proxy configuration from http_proxy and @@ -2560,12 +2560,12 @@ spec: type: string server: description: |- - Server is the address of the kubernetes cluster (https://hostname:port). + server is the address of the kubernetes cluster (https://hostname:port). Defaults to https:// + Cluster.Spec.ControlPlaneEndpoint. type: string tlsServerName: - description: TLSServerName is used + description: tlsServerName is used to check server certificate. If TLSServerName is empty, the hostname used to contact the server is used. @@ -2573,30 +2573,30 @@ spec: type: object user: description: |- - User contains information that describes identity information. + user contains information that describes identity information. This is used to tell the kubernetes cluster who you are. properties: authProvider: - description: AuthProvider specifies + description: authProvider specifies a custom authentication plugin for the kubernetes cluster. properties: config: additionalProperties: type: string - description: Config holds the + description: config holds the parameters for the authentication plugin. type: object name: - description: Name is the name + description: name is the name of the authentication plugin. type: string required: - name type: object exec: - description: Exec specifies a custom + description: exec specifies a custom exec-based authentication plugin for the kubernetes cluster. properties: @@ -2614,11 +2614,11 @@ spec: type: string type: array command: - description: Command to execute. + description: command to execute. type: string env: description: |- - Env defines additional environment variables to expose to the process. These + env defines additional environment variables to expose to the process. These are unioned with the host's environment, as well as variables client-go uses to pass argument to the plugin. items: @@ -2637,7 +2637,7 @@ spec: type: array provideClusterInfo: description: |- - ProvideClusterInfo determines whether or not to provide cluster information, + provideClusterInfo determines whether or not to provide cluster information, which could potentially contain very large CA data, to this exec plugin as a part of the KUBERNETES_EXEC_INFO environment variable. By default, it is set to false. Package k8s.io/client-go/tools/auth/exec provides helper methods for @@ -2651,7 +2651,7 @@ spec: - user type: object kubeConfigPath: - description: KubeConfigPath is used to specify + description: kubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information type: string @@ -2659,11 +2659,11 @@ spec: - kubeConfigPath type: object timeout: - description: Timeout modifies the discovery timeout + description: timeout modifies the discovery timeout type: string tlsBootstrapToken: description: |- - TLSBootstrapToken is a token used for TLS bootstrapping. + tlsBootstrapToken is a token used for TLS bootstrapping. If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. If .File is set, this field **must be set** in case the KubeConfigFile does not contain any other authentication information type: string @@ -2678,17 +2678,17 @@ spec: type: string nodeRegistration: description: |- - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration properties: criSocket: - description: CRISocket is used to retrieve container + description: criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use type: string ignorePreflightErrors: - description: IgnorePreflightErrors provides a + description: ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. items: @@ -2696,7 +2696,7 @@ spec: type: array imagePullPolicy: description: |- - ImagePullPolicy specifies the policy for image pulling + imagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations. The value of this field must be one of "Always", "IfNotPresent" or "Never". Defaults to "IfNotPresent". This can be used only @@ -2708,7 +2708,7 @@ spec: type: string imagePullSerial: description: |- - ImagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. + imagePullSerial specifies if image pulling performed by kubeadm must be done serially or in parallel. This option takes effect only on Kubernetes >=1.31.0. Default: true (defaulted in kubeadm) type: boolean @@ -2716,19 +2716,19 @@ spec: additionalProperties: type: string description: |- - KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. type: object name: description: |- - Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. This field is also used in the CommonName field of the kubelet's client certificate to the API server. Defaults to the hostname of the node if not provided. type: string taints: description: |- - Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an empty slice, i.e. `taints: []` in the YAML file. This field is solely used for Node registration. items: @@ -2764,12 +2764,12 @@ spec: type: object patches: description: |- - Patches contains options related to applying patches to components deployed by kubeadm during + patches contains options related to applying patches to components deployed by kubeadm during "kubeadm join". The minimum kubernetes version needed to support Patches is v1.22 properties: directory: description: |- - Directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". + directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of "kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". "patchtype" can be one of "strategic" "merge" or "json" and they match the patch formats supported by kubectl. @@ -2783,7 +2783,7 @@ spec: type: object skipPhases: description: |- - SkipPhases is a list of phases to skip during command execution. + skipPhases is a list of phases to skip during command execution. The list of phases can be obtained with the "kubeadm init --help" command. This option takes effect only on Kubernetes >=1.22.0. items: @@ -2791,7 +2791,7 @@ spec: type: array type: object mounts: - description: Mounts specifies a list of mount points to + description: mounts specifies a list of mount points to be setup. items: description: MountPoints defines input for generated @@ -2801,34 +2801,34 @@ spec: type: array type: array ntp: - description: NTP specifies NTP configuration + description: ntp specifies NTP configuration properties: enabled: - description: Enabled specifies whether NTP should + description: enabled specifies whether NTP should be enabled type: boolean servers: - description: Servers specifies which NTP servers to + description: servers specifies which NTP servers to use items: type: string type: array type: object postKubeadmCommands: - description: PostKubeadmCommands specifies extra commands + description: postKubeadmCommands specifies extra commands to run after kubeadm runs items: type: string type: array preKubeadmCommands: - description: PreKubeadmCommands specifies extra commands + description: preKubeadmCommands specifies extra commands to run before kubeadm runs items: type: string type: array useExperimentalRetryJoin: description: |- - UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + useExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments @@ -2843,52 +2843,52 @@ spec: When removing also remove from staticcheck exclude-rules for SA1019 in golangci.yml type: boolean users: - description: Users specifies extra users to add + description: users specifies extra users to add items: description: User defines the input for a generated user in cloud-init. properties: gecos: - description: Gecos specifies the gecos to use for + description: gecos specifies the gecos to use for the user type: string groups: - description: Groups specifies the additional groups + description: groups specifies the additional groups for the user type: string homeDir: - description: HomeDir specifies the home directory + description: homeDir specifies the home directory to use for the user type: string inactive: - description: Inactive specifies whether to mark + description: inactive specifies whether to mark the user as inactive type: boolean lockPassword: - description: LockPassword specifies if password + description: lockPassword specifies if password login should be disabled type: boolean name: - description: Name specifies the user name + description: name specifies the user name type: string passwd: - description: Passwd specifies a hashed password + description: passwd specifies a hashed password for the user type: string passwdFrom: - description: PasswdFrom is a referenced source of + description: passwdFrom is a referenced source of passwd to populate the passwd. properties: secret: - description: Secret represents a secret that + description: secret represents a secret that should populate this password. properties: key: - description: Key is the key in the secret's + description: key is the key in the secret's data map for this value. type: string name: - description: Name of the secret in the KubeadmBootstrapConfig's + description: name of the secret in the KubeadmBootstrapConfig's namespace to use. type: string required: @@ -2899,20 +2899,20 @@ spec: - secret type: object primaryGroup: - description: PrimaryGroup specifies the primary + description: primaryGroup specifies the primary group for the user type: string shell: - description: Shell specifies the user's shell + description: shell specifies the user's shell type: string sshAuthorizedKeys: - description: SSHAuthorizedKeys specifies a list + description: sshAuthorizedKeys specifies a list of ssh authorized keys for the user items: type: string type: array sudo: - description: Sudo specifies a sudo role for the + description: sudo specifies a sudo role for the user type: string required: @@ -2921,7 +2921,7 @@ spec: type: array verbosity: description: |- - Verbosity is the number for the kubeadm log level verbosity. + verbosity is the number for the kubeadm log level verbosity. It overrides the `--v` flag in kubeadm commands. format: int32 type: integer @@ -2947,7 +2947,7 @@ spec: type: object machineTemplate: description: |- - MachineTemplate contains information about how machines + machineTemplate contains information about how machines should be shaped when creating or updating a control plane. properties: metadata: @@ -2959,7 +2959,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -2976,19 +2976,19 @@ spec: type: object nodeDeletionTimeout: description: |- - NodeDeletionTimeout defines how long the machine controller will attempt to delete the Node that the Machine + nodeDeletionTimeout defines how long the machine controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. If no value is provided, the default value for this property of the Machine resource will be used. type: string nodeDrainTimeout: description: |- - NodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node + nodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` type: string nodeVolumeDetachTimeout: description: |- - NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes + nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. type: string type: object @@ -2997,7 +2997,7 @@ spec: plane machine remediation happens. properties: maxRetry: - description: "MaxRetry is the Max number of retries while + description: "maxRetry is the Max number of retries while attempting to remediate an unhealthy machine.\nA retry happens when a machine that was created as a replacement for an unhealthy machine also fails.\nFor example, given @@ -3017,7 +3017,7 @@ spec: format: int32 type: integer minHealthyPeriod: - description: "MinHealthyPeriod defines the duration after + description: "minHealthyPeriod defines the duration after which KCP will consider any failure to a machine unrelated\nfrom the previous one. In this case the remediation is not considered a retry anymore, and thus the retry\ncounter @@ -3036,7 +3036,7 @@ spec: type: string retryPeriod: description: |- - RetryPeriod is the duration that KCP should wait before remediating a machine being created as a replacement + retryPeriod is the duration that KCP should wait before remediating a machine being created as a replacement for an unhealthy machine (a retry). If not set, a retry will happen immediately. @@ -3044,19 +3044,19 @@ spec: type: object rolloutAfter: description: |- - RolloutAfter is a field to indicate a rollout should be performed + rolloutAfter is a field to indicate a rollout should be performed after the specified time even if no changes have been made to the KubeadmControlPlane. format: date-time type: string rolloutBefore: description: |- - RolloutBefore is a field to indicate a rollout should be performed + rolloutBefore is a field to indicate a rollout should be performed if the specified criteria is met. properties: certificatesExpiryDays: description: |- - CertificatesExpiryDays indicates a rollout needs to be performed if the + certificatesExpiryDays indicates a rollout needs to be performed if the certificates of the machine will expire within the specified days. format: int32 type: integer @@ -3090,7 +3090,7 @@ spec: type: object type: description: |- - Type of rollout. Currently the only supported strategy is + type of rollout. Currently the only supported strategy is "RollingUpdate". Default is RollingUpdate. type: string diff --git a/controlplane/kubeadm/internal/controllers/remediation.go b/controlplane/kubeadm/internal/controllers/remediation.go index 830c6c9cacde..409f946c5b47 100644 --- a/controlplane/kubeadm/internal/controllers/remediation.go +++ b/controlplane/kubeadm/internal/controllers/remediation.go @@ -548,13 +548,13 @@ func (r *KubeadmControlPlaneReconciler) canSafelyRemoveEtcdMember(ctx context.Co // RemediationData struct is used to keep track of information stored in the RemediationInProgressAnnotation in KCP // during remediation and then into the RemediationForAnnotation on the replacement machine once it is created. type RemediationData struct { - // Machine is the machine name of the latest machine being remediated. + // machine is the machine name of the latest machine being remediated. Machine string `json:"machine"` - // Timestamp is when last remediation happened. It is represented in RFC3339 form and is in UTC. + // timestamp is when last remediation happened. It is represented in RFC3339 form and is in UTC. Timestamp metav1.Time `json:"timestamp"` - // RetryCount used to keep track of remediation retry for the last remediated machine. + // retryCount used to keep track of remediation retry for the last remediated machine. // A retry happens when a machine that was created as a replacement for an unhealthy machine also fails. RetryCount int `json:"retryCount"` } diff --git a/exp/addons/api/v1beta1/clusterresourceset_types.go b/exp/addons/api/v1beta1/clusterresourceset_types.go index e8f1e7245c44..a061256044a3 100644 --- a/exp/addons/api/v1beta1/clusterresourceset_types.go +++ b/exp/addons/api/v1beta1/clusterresourceset_types.go @@ -41,11 +41,11 @@ type ClusterResourceSetSpec struct { // Label selector cannot be empty. ClusterSelector metav1.LabelSelector `json:"clusterSelector"` - // Resources is a list of Secrets/ConfigMaps where each contains 1 or more resources to be applied to remote clusters. + // resources is a list of Secrets/ConfigMaps where each contains 1 or more resources to be applied to remote clusters. // +optional Resources []ResourceRef `json:"resources,omitempty"` - // Strategy is the strategy to be used during applying resources. Defaults to ApplyOnce. This field is immutable. + // strategy is the strategy to be used during applying resources. Defaults to ApplyOnce. This field is immutable. // +kubebuilder:validation:Enum=ApplyOnce;Reconcile // +optional Strategy string `json:"strategy,omitempty"` @@ -64,11 +64,11 @@ const ( // ResourceRef specifies a resource. type ResourceRef struct { - // Name of the resource that is in the same namespace with ClusterResourceSet object. + // name of the resource that is in the same namespace with ClusterResourceSet object. // +kubebuilder:validation:MinLength=1 Name string `json:"name"` - // Kind of the resource. Supported kinds are: Secrets and ConfigMaps. + // kind of the resource. Supported kinds are: Secrets and ConfigMaps. // +kubebuilder:validation:Enum=Secret;ConfigMap Kind string `json:"kind"` } @@ -94,11 +94,11 @@ func (c *ClusterResourceSetSpec) SetTypedStrategy(p ClusterResourceSetStrategy) // ClusterResourceSetStatus defines the observed state of ClusterResourceSet. type ClusterResourceSetStatus struct { - // ObservedGeneration reflects the generation of the most recently observed ClusterResourceSet. + // observedGeneration reflects the generation of the most recently observed ClusterResourceSet. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions defines current state of the ClusterResourceSet. + // conditions defines current state of the ClusterResourceSet. // +optional Conditions clusterv1.Conditions `json:"conditions,omitempty"` diff --git a/exp/addons/api/v1beta1/clusterresourcesetbinding_types.go b/exp/addons/api/v1beta1/clusterresourcesetbinding_types.go index fd8933f7ba63..937df7700c2c 100644 --- a/exp/addons/api/v1beta1/clusterresourcesetbinding_types.go +++ b/exp/addons/api/v1beta1/clusterresourcesetbinding_types.go @@ -30,16 +30,16 @@ type ResourceBinding struct { // ResourceRef specifies a resource. ResourceRef `json:",inline"` - // Hash is the hash of a resource's data. This can be used to decide if a resource is changed. + // hash is the hash of a resource's data. This can be used to decide if a resource is changed. // For "ApplyOnce" ClusterResourceSet.spec.strategy, this is no-op as that strategy does not act on change. // +optional Hash string `json:"hash,omitempty"` - // LastAppliedTime identifies when this resource was last applied to the cluster. + // lastAppliedTime identifies when this resource was last applied to the cluster. // +optional LastAppliedTime *metav1.Time `json:"lastAppliedTime,omitempty"` - // Applied is to track if a resource is applied to the cluster or not. + // applied is to track if a resource is applied to the cluster or not. Applied bool `json:"applied"` } @@ -47,10 +47,10 @@ type ResourceBinding struct { // ResourceSetBinding keeps info on all of the resources in a ClusterResourceSet. type ResourceSetBinding struct { - // ClusterResourceSetName is the name of the ClusterResourceSet that is applied to the owner cluster of the binding. + // clusterResourceSetName is the name of the ClusterResourceSet that is applied to the owner cluster of the binding. ClusterResourceSetName string `json:"clusterResourceSetName"` - // Resources is a list of resources that the ClusterResourceSet has. + // resources is a list of resources that the ClusterResourceSet has. // +optional Resources []ResourceBinding `json:"resources,omitempty"` } @@ -182,11 +182,11 @@ type ClusterResourceSetBinding struct { // ClusterResourceSetBindingSpec defines the desired state of ClusterResourceSetBinding. type ClusterResourceSetBindingSpec struct { - // Bindings is a list of ClusterResourceSets and their resources. + // bindings is a list of ClusterResourceSets and their resources. // +optional Bindings []*ResourceSetBinding `json:"bindings,omitempty"` - // ClusterName is the name of the Cluster this binding applies to. + // clusterName is the name of the Cluster this binding applies to. // Note: this field mandatory in v1beta2. // +optional ClusterName string `json:"clusterName,omitempty"` diff --git a/exp/api/v1beta1/machinepool_types.go b/exp/api/v1beta1/machinepool_types.go index 46d063d9e880..1fa322767c96 100644 --- a/exp/api/v1beta1/machinepool_types.go +++ b/exp/api/v1beta1/machinepool_types.go @@ -33,7 +33,7 @@ const ( // MachinePoolSpec defines the desired state of MachinePool. type MachinePoolSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` @@ -42,7 +42,7 @@ type MachinePoolSpec struct { // +optional Replicas *int32 `json:"replicas,omitempty"` - // Template describes the machines that will be created. + // template describes the machines that will be created. Template clusterv1.MachineTemplateSpec `json:"template"` // Minimum number of seconds for which a newly created machine instances should @@ -52,12 +52,12 @@ type MachinePoolSpec struct { // +optional MinReadySeconds *int32 `json:"minReadySeconds,omitempty"` - // ProviderIDList are the identification IDs of machine instances provided by the provider. + // providerIDList are the identification IDs of machine instances provided by the provider. // This field must match the provider IDs as seen on the node objects corresponding to a machine pool's machine instances. // +optional ProviderIDList []string `json:"providerIDList,omitempty"` - // FailureDomains is the list of failure domains this MachinePool should be attached to. + // failureDomains is the list of failure domains this MachinePool should be attached to. // +optional FailureDomains []string `json:"failureDomains,omitempty"` } @@ -68,11 +68,11 @@ type MachinePoolSpec struct { // MachinePoolStatus defines the observed state of MachinePool. type MachinePoolStatus struct { - // NodeRefs will point to the corresponding Nodes if it they exist. + // nodeRefs will point to the corresponding Nodes if it they exist. // +optional NodeRefs []corev1.ObjectReference `json:"nodeRefs,omitempty"` - // Replicas is the most recently observed number of replicas. + // replicas is the most recently observed number of replicas. // +optional Replicas int32 `json:"replicas"` @@ -92,7 +92,7 @@ type MachinePoolStatus struct { // +optional UnavailableReplicas int32 `json:"unavailableReplicas,omitempty"` - // FailureReason indicates that there is a problem reconciling the state, and + // failureReason indicates that there is a problem reconciling the state, and // will be set to a token value suitable for programmatic interpretation. // // Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details. @@ -100,7 +100,7 @@ type MachinePoolStatus struct { // +optional FailureReason *capierrors.MachinePoolStatusFailure `json:"failureReason,omitempty"` - // FailureMessage indicates that there is a problem reconciling the state, + // failureMessage indicates that there is a problem reconciling the state, // and will be set to a descriptive error message. // // Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details. @@ -108,24 +108,24 @@ type MachinePoolStatus struct { // +optional FailureMessage *string `json:"failureMessage,omitempty"` - // Phase represents the current phase of cluster actuation. + // phase represents the current phase of cluster actuation. // E.g. Pending, Running, Terminating, Failed etc. // +optional Phase string `json:"phase,omitempty"` - // BootstrapReady is the state of the bootstrap provider. + // bootstrapReady is the state of the bootstrap provider. // +optional BootstrapReady bool `json:"bootstrapReady"` - // InfrastructureReady is the state of the infrastructure provider. + // infrastructureReady is the state of the infrastructure provider. // +optional InfrastructureReady bool `json:"infrastructureReady"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions define the current service state of the MachinePool. + // conditions define the current service state of the MachinePool. // +optional Conditions clusterv1.Conditions `json:"conditions,omitempty"` diff --git a/exp/ipam/api/v1alpha1/ipaddress_types.go b/exp/ipam/api/v1alpha1/ipaddress_types.go index 172f2b7240d9..1ee18fadcb06 100644 --- a/exp/ipam/api/v1alpha1/ipaddress_types.go +++ b/exp/ipam/api/v1alpha1/ipaddress_types.go @@ -23,19 +23,19 @@ import ( // IPAddressSpec is the desired state of an IPAddress. type IPAddressSpec struct { - // ClaimRef is a reference to the claim this IPAddress was created for. + // claimRef is a reference to the claim this IPAddress was created for. ClaimRef corev1.LocalObjectReference `json:"claimRef"` - // PoolRef is a reference to the pool that this IPAddress was created from. + // poolRef is a reference to the pool that this IPAddress was created from. PoolRef corev1.TypedLocalObjectReference `json:"poolRef"` - // Address is the IP address. + // address is the IP address. Address string `json:"address"` - // Prefix is the prefix of the address. + // prefix is the prefix of the address. Prefix int `json:"prefix"` - // Gateway is the network gateway of the network the address is from. + // gateway is the network gateway of the network the address is from. // +optional Gateway string `json:"gateway,omitempty"` } diff --git a/exp/ipam/api/v1alpha1/ipaddressclaim_types.go b/exp/ipam/api/v1alpha1/ipaddressclaim_types.go index b66a8748d648..02eb49db4335 100644 --- a/exp/ipam/api/v1alpha1/ipaddressclaim_types.go +++ b/exp/ipam/api/v1alpha1/ipaddressclaim_types.go @@ -25,17 +25,17 @@ import ( // IPAddressClaimSpec is the desired state of an IPAddressClaim. type IPAddressClaimSpec struct { - // PoolRef is a reference to the pool from which an IP address should be created. + // poolRef is a reference to the pool from which an IP address should be created. PoolRef corev1.TypedLocalObjectReference `json:"poolRef"` } // IPAddressClaimStatus is the observed status of a IPAddressClaim. type IPAddressClaimStatus struct { - // AddressRef is a reference to the address that was created for this claim. + // addressRef is a reference to the address that was created for this claim. // +optional AddressRef corev1.LocalObjectReference `json:"addressRef,omitempty"` - // Conditions summarises the current state of the IPAddressClaim + // conditions summarises the current state of the IPAddressClaim // +optional Conditions clusterv1.Conditions `json:"conditions,omitempty"` } diff --git a/exp/ipam/api/v1beta1/ipaddress_types.go b/exp/ipam/api/v1beta1/ipaddress_types.go index 4f37aad81c19..fd69f033f5b3 100644 --- a/exp/ipam/api/v1beta1/ipaddress_types.go +++ b/exp/ipam/api/v1beta1/ipaddress_types.go @@ -23,19 +23,19 @@ import ( // IPAddressSpec is the desired state of an IPAddress. type IPAddressSpec struct { - // ClaimRef is a reference to the claim this IPAddress was created for. + // claimRef is a reference to the claim this IPAddress was created for. ClaimRef corev1.LocalObjectReference `json:"claimRef"` - // PoolRef is a reference to the pool that this IPAddress was created from. + // poolRef is a reference to the pool that this IPAddress was created from. PoolRef corev1.TypedLocalObjectReference `json:"poolRef"` - // Address is the IP address. + // address is the IP address. Address string `json:"address"` - // Prefix is the prefix of the address. + // prefix is the prefix of the address. Prefix int `json:"prefix"` - // Gateway is the network gateway of the network the address is from. + // gateway is the network gateway of the network the address is from. // +optional Gateway string `json:"gateway,omitempty"` } diff --git a/exp/ipam/api/v1beta1/ipaddressclaim_types.go b/exp/ipam/api/v1beta1/ipaddressclaim_types.go index 99087db5603b..2e136196d1e5 100644 --- a/exp/ipam/api/v1beta1/ipaddressclaim_types.go +++ b/exp/ipam/api/v1beta1/ipaddressclaim_types.go @@ -25,21 +25,21 @@ import ( // IPAddressClaimSpec is the desired state of an IPAddressClaim. type IPAddressClaimSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +optional ClusterName string `json:"clusterName,omitempty"` - // PoolRef is a reference to the pool from which an IP address should be created. + // poolRef is a reference to the pool from which an IP address should be created. PoolRef corev1.TypedLocalObjectReference `json:"poolRef"` } // IPAddressClaimStatus is the observed status of a IPAddressClaim. type IPAddressClaimStatus struct { - // AddressRef is a reference to the address that was created for this claim. + // addressRef is a reference to the address that was created for this claim. // +optional AddressRef corev1.LocalObjectReference `json:"addressRef,omitempty"` - // Conditions summarises the current state of the IPAddressClaim + // conditions summarises the current state of the IPAddressClaim // +optional Conditions clusterv1.Conditions `json:"conditions,omitempty"` } diff --git a/exp/runtime/api/v1alpha1/extensionconfig_types.go b/exp/runtime/api/v1alpha1/extensionconfig_types.go index bd8c3e5d0620..34855080b018 100644 --- a/exp/runtime/api/v1alpha1/extensionconfig_types.go +++ b/exp/runtime/api/v1alpha1/extensionconfig_types.go @@ -26,16 +26,16 @@ import ( // ExtensionConfigSpec defines the desired state of ExtensionConfig. type ExtensionConfigSpec struct { - // ClientConfig defines how to communicate with the Extension server. + // clientConfig defines how to communicate with the Extension server. ClientConfig ClientConfig `json:"clientConfig"` - // NamespaceSelector decides whether to call the hook for an object based + // namespaceSelector decides whether to call the hook for an object based // on whether the namespace for that object matches the selector. // Defaults to the empty LabelSelector, which matches all objects. // +optional NamespaceSelector *metav1.LabelSelector `json:"namespaceSelector,omitempty"` - // Settings defines key value pairs to be passed to all calls + // settings defines key value pairs to be passed to all calls // to all supported RuntimeExtensions. // Note: Settings can be overridden on the ClusterClass. // +optional @@ -45,7 +45,7 @@ type ExtensionConfigSpec struct { // ClientConfig contains the information to make a client // connection with an Extension server. type ClientConfig struct { - // URL gives the location of the Extension server, in standard URL form + // url gives the location of the Extension server, in standard URL form // (`scheme://host:port/path`). // Note: Exactly one of `url` or `service` must be specified. // @@ -64,7 +64,7 @@ type ClientConfig struct { // +optional URL *string `json:"url,omitempty"` - // Service is a reference to the Kubernetes service for the Extension server. + // service is a reference to the Kubernetes service for the Extension server. // Note: Exactly one of `url` or `service` must be specified. // // If the Extension server is running within a cluster, then you should use `service`. @@ -72,25 +72,25 @@ type ClientConfig struct { // +optional Service *ServiceReference `json:"service,omitempty"` - // CABundle is a PEM encoded CA bundle which will be used to validate the Extension server's server certificate. + // caBundle is a PEM encoded CA bundle which will be used to validate the Extension server's server certificate. // +optional CABundle []byte `json:"caBundle,omitempty"` } // ServiceReference holds a reference to a Kubernetes Service of an Extension server. type ServiceReference struct { - // Namespace is the namespace of the service. + // namespace is the namespace of the service. Namespace string `json:"namespace"` - // Name is the name of the service. + // name is the name of the service. Name string `json:"name"` - // Path is an optional URL path and if present may be any string permissible in + // path is an optional URL path and if present may be any string permissible in // a URL. If a path is set it will be used as prefix to the hook-specific path. // +optional Path *string `json:"path,omitempty"` - // Port is the port on the service that's hosting the Extension server. + // port is the port on the service that's hosting the Extension server. // Defaults to 443. // Port should be a valid port number (1-65535, inclusive). // +optional @@ -103,31 +103,31 @@ type ServiceReference struct { // ExtensionConfigStatus defines the observed state of ExtensionConfig. type ExtensionConfigStatus struct { - // Handlers defines the current ExtensionHandlers supported by an Extension. + // handlers defines the current ExtensionHandlers supported by an Extension. // +optional // +listType=map // +listMapKey=name Handlers []ExtensionHandler `json:"handlers,omitempty"` - // Conditions define the current service state of the ExtensionConfig. + // conditions define the current service state of the ExtensionConfig. // +optional Conditions clusterv1.Conditions `json:"conditions,omitempty"` } // ExtensionHandler specifies the details of a handler for a particular runtime hook registered by an Extension server. type ExtensionHandler struct { - // Name is the unique name of the ExtensionHandler. + // name is the unique name of the ExtensionHandler. Name string `json:"name"` - // RequestHook defines the versioned runtime hook which this ExtensionHandler serves. + // requestHook defines the versioned runtime hook which this ExtensionHandler serves. RequestHook GroupVersionHook `json:"requestHook"` - // TimeoutSeconds defines the timeout duration for client calls to the ExtensionHandler. + // timeoutSeconds defines the timeout duration for client calls to the ExtensionHandler. // Defaults to 10 is not set. // +optional TimeoutSeconds *int32 `json:"timeoutSeconds,omitempty"` - // FailurePolicy defines how failures in calls to the ExtensionHandler should be handled by a client. + // failurePolicy defines how failures in calls to the ExtensionHandler should be handled by a client. // Defaults to Fail if not set. // +optional FailurePolicy *FailurePolicy `json:"failurePolicy,omitempty"` @@ -135,10 +135,10 @@ type ExtensionHandler struct { // GroupVersionHook defines the runtime hook when the ExtensionHandler is called. type GroupVersionHook struct { - // APIVersion is the group and version of the Hook. + // apiVersion is the group and version of the Hook. APIVersion string `json:"apiVersion"` - // Hook is the name of the hook. + // hook is the name of the hook. Hook string `json:"hook"` } diff --git a/exp/runtime/hooks/api/v1alpha1/common_types.go b/exp/runtime/hooks/api/v1alpha1/common_types.go index 97f90c4bf1a9..f7856a436ad1 100644 --- a/exp/runtime/hooks/api/v1alpha1/common_types.go +++ b/exp/runtime/hooks/api/v1alpha1/common_types.go @@ -32,7 +32,7 @@ type RequestObject interface { // Note: By embedding CommonRequest in a runtime.Object the RequestObject // interface is satisfied. type CommonRequest struct { - // Settings defines key value pairs to be passed to the call. + // settings defines key value pairs to be passed to the call. // +optional Settings map[string]string `json:"settings,omitempty"` } @@ -70,7 +70,7 @@ type RetryResponseObject interface { // Note: By embedding CommonResponse in a runtime.Object the ResponseObject // interface is satisfied. type CommonResponse struct { - // Status of the call. One of "Success" or "Failure". + // status of the call. One of "Success" or "Failure". Status ResponseStatus `json:"status"` // A human-readable description of the status of the call. @@ -117,7 +117,7 @@ type CommonRetryResponse struct { // CommonResponse contains Status and Message fields common to all response types. CommonResponse `json:",inline"` - // RetryAfterSeconds when set to a non-zero value signifies that the hook + // retryAfterSeconds when set to a non-zero value signifies that the hook // will be called again at a future time. RetryAfterSeconds int32 `json:"retryAfterSeconds"` } diff --git a/exp/runtime/hooks/api/v1alpha1/discovery_types.go b/exp/runtime/hooks/api/v1alpha1/discovery_types.go index 840dd2986061..61d0ac395505 100644 --- a/exp/runtime/hooks/api/v1alpha1/discovery_types.go +++ b/exp/runtime/hooks/api/v1alpha1/discovery_types.go @@ -41,7 +41,7 @@ type DiscoveryResponse struct { // CommonResponse contains Status and Message fields common to all response types. CommonResponse `json:",inline"` - // Handlers defines the current ExtensionHandlers supported by an Extension. + // handlers defines the current ExtensionHandlers supported by an Extension. // +listType=map // +listMapKey=name Handlers []ExtensionHandler `json:"handlers"` @@ -50,27 +50,27 @@ type DiscoveryResponse struct { // ExtensionHandler represents the discovery information for an extension handler which includes // the hook it supports. type ExtensionHandler struct { - // Name is the name of the ExtensionHandler. + // name is the name of the ExtensionHandler. Name string `json:"name"` - // RequestHook defines the versioned runtime hook which this ExtensionHandler serves. + // requestHook defines the versioned runtime hook which this ExtensionHandler serves. RequestHook GroupVersionHook `json:"requestHook"` - // TimeoutSeconds defines the timeout duration for client calls to the ExtensionHandler. + // timeoutSeconds defines the timeout duration for client calls to the ExtensionHandler. // This is defaulted to 10 if left undefined. TimeoutSeconds *int32 `json:"timeoutSeconds,omitempty"` - // FailurePolicy defines how failures in calls to the ExtensionHandler should be handled by a client. + // failurePolicy defines how failures in calls to the ExtensionHandler should be handled by a client. // This is defaulted to FailurePolicyFail if not defined. FailurePolicy *FailurePolicy `json:"failurePolicy,omitempty"` } // GroupVersionHook defines the runtime hook when the ExtensionHandler is called. type GroupVersionHook struct { - // APIVersion is the group and version of the Hook + // apiVersion is the group and version of the Hook APIVersion string `json:"apiVersion"` - // Hook is the name of the hook + // hook is the name of the hook Hook string `json:"hook"` } diff --git a/exp/runtime/hooks/api/v1alpha1/lifecyclehooks_types.go b/exp/runtime/hooks/api/v1alpha1/lifecyclehooks_types.go index 3293b10877b0..925e119969e2 100644 --- a/exp/runtime/hooks/api/v1alpha1/lifecyclehooks_types.go +++ b/exp/runtime/hooks/api/v1alpha1/lifecyclehooks_types.go @@ -31,7 +31,7 @@ type BeforeClusterCreateRequest struct { // CommonRequest contains fields common to all request types. CommonRequest `json:",inline"` - // Cluster is the cluster object the lifecycle hook corresponds to. + // cluster is the cluster object the lifecycle hook corresponds to. Cluster clusterv1.Cluster `json:"cluster"` } @@ -57,7 +57,7 @@ type AfterControlPlaneInitializedRequest struct { // CommonRequest contains fields common to all request types. CommonRequest `json:",inline"` - // Cluster is the cluster object the lifecycle hook corresponds to. + // cluster is the cluster object the lifecycle hook corresponds to. Cluster clusterv1.Cluster `json:"cluster"` } @@ -84,13 +84,13 @@ type BeforeClusterUpgradeRequest struct { // CommonRequest contains fields common to all request types. CommonRequest `json:",inline"` - // Cluster is the cluster object the lifecycle hook corresponds to. + // cluster is the cluster object the lifecycle hook corresponds to. Cluster clusterv1.Cluster `json:"cluster"` - // FromKubernetesVersion is the current Kubernetes version of the cluster. + // fromKubernetesVersion is the current Kubernetes version of the cluster. FromKubernetesVersion string `json:"fromKubernetesVersion"` - // ToKubernetesVersion is the target Kubernetes version of the upgrade. + // toKubernetesVersion is the target Kubernetes version of the upgrade. ToKubernetesVersion string `json:"toKubernetesVersion"` } @@ -117,10 +117,10 @@ type AfterControlPlaneUpgradeRequest struct { // CommonRequest contains fields common to all request types. CommonRequest `json:",inline"` - // Cluster is the cluster object the lifecycle hook corresponds to. + // cluster is the cluster object the lifecycle hook corresponds to. Cluster clusterv1.Cluster `json:"cluster"` - // KubernetesVersion is the Kubernetes version of the Control Plane after the upgrade. + // kubernetesVersion is the Kubernetes version of the Control Plane after the upgrade. KubernetesVersion string `json:"kubernetesVersion"` } @@ -147,10 +147,10 @@ type AfterClusterUpgradeRequest struct { // CommonRequest contains fields common to all request types. CommonRequest `json:",inline"` - // Cluster is the cluster object the lifecycle hook corresponds to. + // cluster is the cluster object the lifecycle hook corresponds to. Cluster clusterv1.Cluster `json:"cluster"` - // KubernetesVersion is the Kubernetes version after upgrade. + // kubernetesVersion is the Kubernetes version after upgrade. KubernetesVersion string `json:"kubernetesVersion"` } @@ -177,7 +177,7 @@ type BeforeClusterDeleteRequest struct { // CommonRequest contains fields common to all request types. CommonRequest `json:",inline"` - // Cluster is the cluster object the lifecycle hook corresponds to. + // cluster is the cluster object the lifecycle hook corresponds to. Cluster clusterv1.Cluster `json:"cluster"` } diff --git a/exp/runtime/hooks/api/v1alpha1/topologymutation_types.go b/exp/runtime/hooks/api/v1alpha1/topologymutation_types.go index 4a3f2fd0bf51..f9f2fbad63c5 100644 --- a/exp/runtime/hooks/api/v1alpha1/topologymutation_types.go +++ b/exp/runtime/hooks/api/v1alpha1/topologymutation_types.go @@ -34,26 +34,26 @@ type GeneratePatchesRequest struct { // CommonRequest contains Settings field common to all request types. CommonRequest `json:",inline"` - // Variables are global variables for all templates. + // variables are global variables for all templates. Variables []Variable `json:"variables"` - // Items is the list of templates to generate patches for. + // items is the list of templates to generate patches for. Items []GeneratePatchesRequestItem `json:"items"` } // GeneratePatchesRequestItem represents a template to generate patches for. type GeneratePatchesRequestItem struct { - // UID is an identifier for this template. It allows us to correlate the template in the request + // uid is an identifier for this template. It allows us to correlate the template in the request // with the corresponding generated patches in the response. UID types.UID `json:"uid"` - // HolderReference is a reference to the object where the template is used. + // holderReference is a reference to the object where the template is used. HolderReference HolderReference `json:"holderReference"` - // Object contains the template as a raw object. + // object contains the template as a raw object. Object runtime.RawExtension `json:"object"` - // Variables are variables specific for the current template. + // variables are variables specific for the current template. // For example some builtin variables like MachineDeployment replicas and version are context-sensitive // and thus are only added to templates for MachineDeployments and with values which correspond to the // current MachineDeployment. @@ -72,21 +72,21 @@ type GeneratePatchesResponse struct { // CommonResponse contains Status and Message fields common to all response types. CommonResponse `json:",inline"` - // Items is the list of generated patches. + // items is the list of generated patches. Items []GeneratePatchesResponseItem `json:"items"` } // GeneratePatchesResponseItem is a generated patch. type GeneratePatchesResponseItem struct { - // UID identifies the corresponding template in the request on which + // uid identifies the corresponding template in the request on which // the patch should be applied. UID types.UID `json:"uid"` - // PatchType defines the type of the patch. + // patchType defines the type of the patch. // One of: "JSONPatch" or "JSONMergePatch". PatchType PatchType `json:"patchType"` - // Patch contains the patch which should be applied to the template. + // patch contains the patch which should be applied to the template. // It must be of the corresponding PatchType. Patch []byte `json:"patch"` } @@ -114,22 +114,22 @@ type ValidateTopologyRequest struct { // CommonRequest contains Settings field common to all request types. CommonRequest `json:",inline"` - // Variables are global variables for all templates. + // variables are global variables for all templates. Variables []Variable `json:"variables"` - // Items is the list of templates to validate. + // items is the list of templates to validate. Items []*ValidateTopologyRequestItem `json:"items"` } // ValidateTopologyRequestItem represents a template to validate. type ValidateTopologyRequestItem struct { - // HolderReference is a reference to the object where the template is used. + // holderReference is a reference to the object where the template is used. HolderReference HolderReference `json:"holderReference"` - // Object contains the template as a raw object. + // object contains the template as a raw object. Object runtime.RawExtension `json:"object"` - // Variables are variables specific for the current template. + // variables are variables specific for the current template. // For example some builtin variables like MachineDeployment replicas and version are context-sensitive // and thus are only added to templates for MachineDeployments and with values which correspond to the // current MachineDeployment. @@ -149,10 +149,10 @@ type ValidateTopologyResponse struct { // Variable represents a variable value. type Variable struct { - // Name of the variable. + // name of the variable. Name string `json:"name"` - // Value of the variable. + // value of the variable. Value apiextensionsv1.JSON `json:"value"` } @@ -161,19 +161,19 @@ type HolderReference struct { // API version of the referent. APIVersion string `json:"apiVersion"` - // Kind of the referent. + // kind of the referent. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds Kind string `json:"kind"` - // Namespace of the referent. + // namespace of the referent. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ Namespace string `json:"namespace"` - // Name of the referent. + // name of the referent. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names Name string `json:"name"` - // FieldPath is the path to the field of the object which references the template. + // fieldPath is the path to the field of the object which references the template. FieldPath string `json:"fieldPath"` } @@ -197,7 +197,7 @@ type DiscoverVariablesResponse struct { // CommonResponse contains Status and Message fields common to all response types. CommonResponse `json:",inline"` - // Variables are variable schemas for variables defined by the DiscoverVariables hook. + // variables are variable schemas for variables defined by the DiscoverVariables hook. Variables []clusterv1.ClusterClassVariable `json:"variables"` } diff --git a/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go b/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go index 33bbd916edef..5361c480cb26 100644 --- a/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go +++ b/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go @@ -35,42 +35,42 @@ type Builtins struct { // ClusterBuiltins represents builtin cluster variables. type ClusterBuiltins struct { - // Name is the name of the cluster. + // name is the name of the cluster. Name string `json:"name,omitempty"` - // Namespace is the namespace of the cluster. + // namespace is the namespace of the cluster. Namespace string `json:"namespace,omitempty"` - // UID is the unqiue identifier of the cluster. + // uid is the unqiue identifier of the cluster. UID types.UID `json:"uid,omitempty"` - // Topology represents the cluster topology variables. + // topology represents the cluster topology variables. Topology *ClusterTopologyBuiltins `json:"topology,omitempty"` - // Network represents the cluster network variables. + // network represents the cluster network variables. Network *ClusterNetworkBuiltins `json:"network,omitempty"` } // ClusterTopologyBuiltins represents builtin cluster topology variables. type ClusterTopologyBuiltins struct { - // Version is the Kubernetes version of the Cluster. + // version is the Kubernetes version of the Cluster. // NOTE: Please note that this version might temporarily differ from the version // of the ControlPlane or workers while an upgrade process is being orchestrated. Version string `json:"version,omitempty"` - // Class is the name of the ClusterClass of the Cluster. + // class is the name of the ClusterClass of the Cluster. Class string `json:"class,omitempty"` } // ClusterNetworkBuiltins represents builtin cluster network variables. type ClusterNetworkBuiltins struct { - // ServiceDomain is the domain name for services. + // serviceDomain is the domain name for services. ServiceDomain *string `json:"serviceDomain,omitempty"` - // Services is the network ranges from which service VIPs are allocated. + // services is the network ranges from which service VIPs are allocated. Services []string `json:"services,omitempty"` - // Pods is the network ranges from which Pod networks are allocated. + // pods is the network ranges from which Pod networks are allocated. Pods []string `json:"pods,omitempty"` - // IPFamily is the IPFamily the Cluster is operating in. One of Invalid, IPv4, IPv6, DualStack. + // ipFamily is the IPFamily the Cluster is operating in. One of Invalid, IPv4, IPv6, DualStack. // // Deprecated: IPFamily is not a concept in Kubernetes. It was originally introduced in CAPI for CAPD. // IPFamily will be dropped in a future release. More details at https://github.com/kubernetes-sigs/cluster-api/issues/7521 @@ -80,128 +80,128 @@ type ClusterNetworkBuiltins struct { // ControlPlaneBuiltins represents builtin ControlPlane variables. // NOTE: These variables are only set for templates belonging to the ControlPlane object. type ControlPlaneBuiltins struct { - // Version is the Kubernetes version of the ControlPlane object. + // version is the Kubernetes version of the ControlPlane object. // NOTE: Please note that this version is the version we are currently reconciling towards. // It can differ from the current version of the ControlPlane while an upgrade process is // being orchestrated. Version string `json:"version,omitempty"` - // Metadata is the metadata set on the ControlPlane object. + // metadata is the metadata set on the ControlPlane object. Metadata *clusterv1.ObjectMeta `json:"metadata,omitempty"` - // Name is the name of the ControlPlane, + // name is the name of the ControlPlane, // to which the current template belongs to. Name string `json:"name,omitempty"` - // Replicas is the value of the replicas field of the ControlPlane object. + // replicas is the value of the replicas field of the ControlPlane object. Replicas *int64 `json:"replicas,omitempty"` - // MachineTemplate is the value of the .spec.machineTemplate field of the ControlPlane object. + // machineTemplate is the value of the .spec.machineTemplate field of the ControlPlane object. MachineTemplate *ControlPlaneMachineTemplateBuiltins `json:"machineTemplate,omitempty"` } // ControlPlaneMachineTemplateBuiltins is the value of the .spec.machineTemplate field of the ControlPlane object. type ControlPlaneMachineTemplateBuiltins struct { - // InfrastructureRef is the value of the infrastructureRef field of ControlPlane.spec.machineTemplate. + // infrastructureRef is the value of the infrastructureRef field of ControlPlane.spec.machineTemplate. InfrastructureRef ControlPlaneMachineTemplateInfrastructureRefBuiltins `json:"infrastructureRef,omitempty"` } // ControlPlaneMachineTemplateInfrastructureRefBuiltins is the value of the infrastructureRef field of // ControlPlane.spec.machineTemplate. type ControlPlaneMachineTemplateInfrastructureRefBuiltins struct { - // Name of the infrastructureRef. + // name of the infrastructureRef. Name string `json:"name,omitempty"` } // MachineDeploymentBuiltins represents builtin MachineDeployment variables. // NOTE: These variables are only set for templates belonging to a MachineDeployment. type MachineDeploymentBuiltins struct { - // Version is the Kubernetes version of the MachineDeployment, + // version is the Kubernetes version of the MachineDeployment, // to which the current template belongs to. // NOTE: Please note that this version is the version we are currently reconciling towards. // It can differ from the current version of the MachineDeployment machines while an upgrade process is // being orchestrated. Version string `json:"version,omitempty"` - // Metadata is the metadata set on the MachineDeployment. + // metadata is the metadata set on the MachineDeployment. Metadata *clusterv1.ObjectMeta `json:"metadata,omitempty"` - // Class is the class name of the MachineDeployment, + // class is the class name of the MachineDeployment, // to which the current template belongs to. Class string `json:"class,omitempty"` - // Name is the name of the MachineDeployment, + // name is the name of the MachineDeployment, // to which the current template belongs to. Name string `json:"name,omitempty"` - // TopologyName is the topology name of the MachineDeployment, + // topologyName is the topology name of the MachineDeployment, // to which the current template belongs to. TopologyName string `json:"topologyName,omitempty"` - // Replicas is the value of the replicas field of the MachineDeployment, + // replicas is the value of the replicas field of the MachineDeployment, // to which the current template belongs to. Replicas *int64 `json:"replicas,omitempty"` - // Bootstrap is the value of the .spec.template.spec.bootstrap field of the MachineDeployment. + // bootstrap is the value of the .spec.template.spec.bootstrap field of the MachineDeployment. Bootstrap *MachineBootstrapBuiltins `json:"bootstrap,omitempty"` - // InfrastructureRef is the value of the .spec.template.spec.infrastructureRef field of the MachineDeployment. + // infrastructureRef is the value of the .spec.template.spec.infrastructureRef field of the MachineDeployment. InfrastructureRef *MachineInfrastructureRefBuiltins `json:"infrastructureRef,omitempty"` } // MachinePoolBuiltins represents builtin MachinePool variables. // NOTE: These variables are only set for templates belonging to a MachinePool. type MachinePoolBuiltins struct { - // Version is the Kubernetes version of the MachinePool, + // version is the Kubernetes version of the MachinePool, // to which the current template belongs to. // NOTE: Please note that this version is the version we are currently reconciling towards. // It can differ from the current version of the MachinePool machines while an upgrade process is // being orchestrated. Version string `json:"version,omitempty"` - // Metadata is the metadata set on the MachinePool. + // metadata is the metadata set on the MachinePool. Metadata *clusterv1.ObjectMeta `json:"metadata,omitempty"` - // Class is the class name of the MachinePool, + // class is the class name of the MachinePool, // to which the current template belongs to. Class string `json:"class,omitempty"` - // Name is the name of the MachinePool, + // name is the name of the MachinePool, // to which the current template belongs to. Name string `json:"name,omitempty"` - // TopologyName is the topology name of the MachinePool, + // topologyName is the topology name of the MachinePool, // to which the current template belongs to. TopologyName string `json:"topologyName,omitempty"` - // Replicas is the value of the replicas field of the MachinePool, + // replicas is the value of the replicas field of the MachinePool, // to which the current template belongs to. Replicas *int64 `json:"replicas,omitempty"` - // Bootstrap is the value of the .spec.template.spec.bootstrap field of the MachinePool. + // bootstrap is the value of the .spec.template.spec.bootstrap field of the MachinePool. Bootstrap *MachineBootstrapBuiltins `json:"bootstrap,omitempty"` - // InfrastructureRef is the value of the .spec.template.spec.infrastructureRef field of the MachinePool. + // infrastructureRef is the value of the .spec.template.spec.infrastructureRef field of the MachinePool. InfrastructureRef *MachineInfrastructureRefBuiltins `json:"infrastructureRef,omitempty"` } // MachineBootstrapBuiltins is the value of the .spec.template.spec.bootstrap field // of the MachineDeployment or MachinePool. type MachineBootstrapBuiltins struct { - // ConfigRef is the value of the .spec.template.spec.bootstrap.configRef field of the MachineDeployment. + // configRef is the value of the .spec.template.spec.bootstrap.configRef field of the MachineDeployment. ConfigRef *MachineBootstrapConfigRefBuiltins `json:"configRef,omitempty"` } // MachineBootstrapConfigRefBuiltins is the value of the .spec.template.spec.bootstrap.configRef // field of the MachineDeployment or MachinePool. type MachineBootstrapConfigRefBuiltins struct { - // Name of the bootstrap.configRef. + // name of the bootstrap.configRef. Name string `json:"name,omitempty"` } // MachineInfrastructureRefBuiltins is the value of the .spec.template.spec.infrastructureRef field // of the MachineDeployment or MachinePool. type MachineInfrastructureRefBuiltins struct { - // Name of the infrastructureRef. + // name of the infrastructureRef. Name string `json:"name,omitempty"` } diff --git a/exp/runtime/hooks/api/v1alpha1/zz_generated.openapi.go b/exp/runtime/hooks/api/v1alpha1/zz_generated.openapi.go index 03a0617d4b76..f4b3a56bafc6 100644 --- a/exp/runtime/hooks/api/v1alpha1/zz_generated.openapi.go +++ b/exp/runtime/hooks/api/v1alpha1/zz_generated.openapi.go @@ -96,7 +96,7 @@ func schema_runtime_hooks_api_v1alpha1_AfterClusterUpgradeRequest(ref common.Ref }, "settings": { SchemaProps: spec.SchemaProps{ - Description: "Settings defines key value pairs to be passed to the call.", + Description: "settings defines key value pairs to be passed to the call.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -112,14 +112,14 @@ func schema_runtime_hooks_api_v1alpha1_AfterClusterUpgradeRequest(ref common.Ref }, "cluster": { SchemaProps: spec.SchemaProps{ - Description: "Cluster is the cluster object the lifecycle hook corresponds to.", + Description: "cluster is the cluster object the lifecycle hook corresponds to.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.Cluster"), }, }, "kubernetesVersion": { SchemaProps: spec.SchemaProps{ - Description: "KubernetesVersion is the Kubernetes version after upgrade.", + Description: "kubernetesVersion is the Kubernetes version after upgrade.", Default: "", Type: []string{"string"}, Format: "", @@ -157,7 +157,7 @@ func schema_runtime_hooks_api_v1alpha1_AfterClusterUpgradeResponse(ref common.Re }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", + Description: "status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", Default: "", Type: []string{"string"}, Format: "", @@ -202,7 +202,7 @@ func schema_runtime_hooks_api_v1alpha1_AfterControlPlaneInitializedRequest(ref c }, "settings": { SchemaProps: spec.SchemaProps{ - Description: "Settings defines key value pairs to be passed to the call.", + Description: "settings defines key value pairs to be passed to the call.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -218,7 +218,7 @@ func schema_runtime_hooks_api_v1alpha1_AfterControlPlaneInitializedRequest(ref c }, "cluster": { SchemaProps: spec.SchemaProps{ - Description: "Cluster is the cluster object the lifecycle hook corresponds to.", + Description: "cluster is the cluster object the lifecycle hook corresponds to.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.Cluster"), }, @@ -255,7 +255,7 @@ func schema_runtime_hooks_api_v1alpha1_AfterControlPlaneInitializedResponse(ref }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", + Description: "status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", Default: "", Type: []string{"string"}, Format: "", @@ -300,7 +300,7 @@ func schema_runtime_hooks_api_v1alpha1_AfterControlPlaneUpgradeRequest(ref commo }, "settings": { SchemaProps: spec.SchemaProps{ - Description: "Settings defines key value pairs to be passed to the call.", + Description: "settings defines key value pairs to be passed to the call.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -316,14 +316,14 @@ func schema_runtime_hooks_api_v1alpha1_AfterControlPlaneUpgradeRequest(ref commo }, "cluster": { SchemaProps: spec.SchemaProps{ - Description: "Cluster is the cluster object the lifecycle hook corresponds to.", + Description: "cluster is the cluster object the lifecycle hook corresponds to.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.Cluster"), }, }, "kubernetesVersion": { SchemaProps: spec.SchemaProps{ - Description: "KubernetesVersion is the Kubernetes version of the Control Plane after the upgrade.", + Description: "kubernetesVersion is the Kubernetes version of the Control Plane after the upgrade.", Default: "", Type: []string{"string"}, Format: "", @@ -361,7 +361,7 @@ func schema_runtime_hooks_api_v1alpha1_AfterControlPlaneUpgradeResponse(ref comm }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", + Description: "status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", Default: "", Type: []string{"string"}, Format: "", @@ -378,7 +378,7 @@ func schema_runtime_hooks_api_v1alpha1_AfterControlPlaneUpgradeResponse(ref comm }, "retryAfterSeconds": { SchemaProps: spec.SchemaProps{ - Description: "RetryAfterSeconds when set to a non-zero value signifies that the hook will be called again at a future time.", + Description: "retryAfterSeconds when set to a non-zero value signifies that the hook will be called again at a future time.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -414,7 +414,7 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterCreateRequest(ref common.Ref }, "settings": { SchemaProps: spec.SchemaProps{ - Description: "Settings defines key value pairs to be passed to the call.", + Description: "settings defines key value pairs to be passed to the call.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -430,7 +430,7 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterCreateRequest(ref common.Ref }, "cluster": { SchemaProps: spec.SchemaProps{ - Description: "Cluster is the cluster object the lifecycle hook corresponds to.", + Description: "cluster is the cluster object the lifecycle hook corresponds to.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.Cluster"), }, @@ -467,7 +467,7 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterCreateResponse(ref common.Re }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", + Description: "status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", Default: "", Type: []string{"string"}, Format: "", @@ -484,7 +484,7 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterCreateResponse(ref common.Re }, "retryAfterSeconds": { SchemaProps: spec.SchemaProps{ - Description: "RetryAfterSeconds when set to a non-zero value signifies that the hook will be called again at a future time.", + Description: "retryAfterSeconds when set to a non-zero value signifies that the hook will be called again at a future time.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -520,7 +520,7 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterDeleteRequest(ref common.Ref }, "settings": { SchemaProps: spec.SchemaProps{ - Description: "Settings defines key value pairs to be passed to the call.", + Description: "settings defines key value pairs to be passed to the call.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -536,7 +536,7 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterDeleteRequest(ref common.Ref }, "cluster": { SchemaProps: spec.SchemaProps{ - Description: "Cluster is the cluster object the lifecycle hook corresponds to.", + Description: "cluster is the cluster object the lifecycle hook corresponds to.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.Cluster"), }, @@ -573,7 +573,7 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterDeleteResponse(ref common.Re }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", + Description: "status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", Default: "", Type: []string{"string"}, Format: "", @@ -590,7 +590,7 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterDeleteResponse(ref common.Re }, "retryAfterSeconds": { SchemaProps: spec.SchemaProps{ - Description: "RetryAfterSeconds when set to a non-zero value signifies that the hook will be called again at a future time.", + Description: "retryAfterSeconds when set to a non-zero value signifies that the hook will be called again at a future time.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -626,7 +626,7 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterUpgradeRequest(ref common.Re }, "settings": { SchemaProps: spec.SchemaProps{ - Description: "Settings defines key value pairs to be passed to the call.", + Description: "settings defines key value pairs to be passed to the call.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -642,14 +642,14 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterUpgradeRequest(ref common.Re }, "cluster": { SchemaProps: spec.SchemaProps{ - Description: "Cluster is the cluster object the lifecycle hook corresponds to.", + Description: "cluster is the cluster object the lifecycle hook corresponds to.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.Cluster"), }, }, "fromKubernetesVersion": { SchemaProps: spec.SchemaProps{ - Description: "FromKubernetesVersion is the current Kubernetes version of the cluster.", + Description: "fromKubernetesVersion is the current Kubernetes version of the cluster.", Default: "", Type: []string{"string"}, Format: "", @@ -657,7 +657,7 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterUpgradeRequest(ref common.Re }, "toKubernetesVersion": { SchemaProps: spec.SchemaProps{ - Description: "ToKubernetesVersion is the target Kubernetes version of the upgrade.", + Description: "toKubernetesVersion is the target Kubernetes version of the upgrade.", Default: "", Type: []string{"string"}, Format: "", @@ -695,7 +695,7 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterUpgradeResponse(ref common.R }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", + Description: "status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", Default: "", Type: []string{"string"}, Format: "", @@ -712,7 +712,7 @@ func schema_runtime_hooks_api_v1alpha1_BeforeClusterUpgradeResponse(ref common.R }, "retryAfterSeconds": { SchemaProps: spec.SchemaProps{ - Description: "RetryAfterSeconds when set to a non-zero value signifies that the hook will be called again at a future time.", + Description: "retryAfterSeconds when set to a non-zero value signifies that the hook will be called again at a future time.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -769,34 +769,34 @@ func schema_runtime_hooks_api_v1alpha1_ClusterBuiltins(ref common.ReferenceCallb Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the cluster.", + Description: "name is the name of the cluster.", Type: []string{"string"}, Format: "", }, }, "namespace": { SchemaProps: spec.SchemaProps{ - Description: "Namespace is the namespace of the cluster.", + Description: "namespace is the namespace of the cluster.", Type: []string{"string"}, Format: "", }, }, "uid": { SchemaProps: spec.SchemaProps{ - Description: "UID is the unqiue identifier of the cluster.", + Description: "uid is the unqiue identifier of the cluster.", Type: []string{"string"}, Format: "", }, }, "topology": { SchemaProps: spec.SchemaProps{ - Description: "Topology represents the cluster topology variables.", + Description: "topology represents the cluster topology variables.", Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.ClusterTopologyBuiltins"), }, }, "network": { SchemaProps: spec.SchemaProps{ - Description: "Network represents the cluster network variables.", + Description: "network represents the cluster network variables.", Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.ClusterNetworkBuiltins"), }, }, @@ -817,14 +817,14 @@ func schema_runtime_hooks_api_v1alpha1_ClusterNetworkBuiltins(ref common.Referen Properties: map[string]spec.Schema{ "serviceDomain": { SchemaProps: spec.SchemaProps{ - Description: "ServiceDomain is the domain name for services.", + Description: "serviceDomain is the domain name for services.", Type: []string{"string"}, Format: "", }, }, "services": { SchemaProps: spec.SchemaProps{ - Description: "Services is the network ranges from which service VIPs are allocated.", + Description: "services is the network ranges from which service VIPs are allocated.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -839,7 +839,7 @@ func schema_runtime_hooks_api_v1alpha1_ClusterNetworkBuiltins(ref common.Referen }, "pods": { SchemaProps: spec.SchemaProps{ - Description: "Pods is the network ranges from which Pod networks are allocated.", + Description: "pods is the network ranges from which Pod networks are allocated.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -854,7 +854,7 @@ func schema_runtime_hooks_api_v1alpha1_ClusterNetworkBuiltins(ref common.Referen }, "ipFamily": { SchemaProps: spec.SchemaProps{ - Description: "IPFamily is the IPFamily the Cluster is operating in. One of Invalid, IPv4, IPv6, DualStack.\n\nDeprecated: IPFamily is not a concept in Kubernetes. It was originally introduced in CAPI for CAPD. IPFamily will be dropped in a future release. More details at https://github.com/kubernetes-sigs/cluster-api/issues/7521", + Description: "ipFamily is the IPFamily the Cluster is operating in. One of Invalid, IPv4, IPv6, DualStack.\n\nDeprecated: IPFamily is not a concept in Kubernetes. It was originally introduced in CAPI for CAPD. IPFamily will be dropped in a future release. More details at https://github.com/kubernetes-sigs/cluster-api/issues/7521", Type: []string{"string"}, Format: "", }, @@ -874,14 +874,14 @@ func schema_runtime_hooks_api_v1alpha1_ClusterTopologyBuiltins(ref common.Refere Properties: map[string]spec.Schema{ "version": { SchemaProps: spec.SchemaProps{ - Description: "Version is the Kubernetes version of the Cluster. NOTE: Please note that this version might temporarily differ from the version of the ControlPlane or workers while an upgrade process is being orchestrated.", + Description: "version is the Kubernetes version of the Cluster. NOTE: Please note that this version might temporarily differ from the version of the ControlPlane or workers while an upgrade process is being orchestrated.", Type: []string{"string"}, Format: "", }, }, "class": { SchemaProps: spec.SchemaProps{ - Description: "Class is the name of the ClusterClass of the Cluster.", + Description: "class is the name of the ClusterClass of the Cluster.", Type: []string{"string"}, Format: "", }, @@ -901,7 +901,7 @@ func schema_runtime_hooks_api_v1alpha1_CommonRequest(ref common.ReferenceCallbac Properties: map[string]spec.Schema{ "settings": { SchemaProps: spec.SchemaProps{ - Description: "Settings defines key value pairs to be passed to the call.", + Description: "settings defines key value pairs to be passed to the call.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -930,7 +930,7 @@ func schema_runtime_hooks_api_v1alpha1_CommonResponse(ref common.ReferenceCallba Properties: map[string]spec.Schema{ "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", + Description: "status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", Default: "", Type: []string{"string"}, Format: "", @@ -961,7 +961,7 @@ func schema_runtime_hooks_api_v1alpha1_CommonRetryResponse(ref common.ReferenceC Properties: map[string]spec.Schema{ "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", + Description: "status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", Default: "", Type: []string{"string"}, Format: "", @@ -978,7 +978,7 @@ func schema_runtime_hooks_api_v1alpha1_CommonRetryResponse(ref common.ReferenceC }, "retryAfterSeconds": { SchemaProps: spec.SchemaProps{ - Description: "RetryAfterSeconds when set to a non-zero value signifies that the hook will be called again at a future time.", + Description: "retryAfterSeconds when set to a non-zero value signifies that the hook will be called again at a future time.", Default: 0, Type: []string{"integer"}, Format: "int32", @@ -1000,34 +1000,34 @@ func schema_runtime_hooks_api_v1alpha1_ControlPlaneBuiltins(ref common.Reference Properties: map[string]spec.Schema{ "version": { SchemaProps: spec.SchemaProps{ - Description: "Version is the Kubernetes version of the ControlPlane object. NOTE: Please note that this version is the version we are currently reconciling towards. It can differ from the current version of the ControlPlane while an upgrade process is being orchestrated.", + Description: "version is the Kubernetes version of the ControlPlane object. NOTE: Please note that this version is the version we are currently reconciling towards. It can differ from the current version of the ControlPlane while an upgrade process is being orchestrated.", Type: []string{"string"}, Format: "", }, }, "metadata": { SchemaProps: spec.SchemaProps{ - Description: "Metadata is the metadata set on the ControlPlane object.", + Description: "metadata is the metadata set on the ControlPlane object.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ObjectMeta"), }, }, "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the ControlPlane, to which the current template belongs to.", + Description: "name is the name of the ControlPlane, to which the current template belongs to.", Type: []string{"string"}, Format: "", }, }, "replicas": { SchemaProps: spec.SchemaProps{ - Description: "Replicas is the value of the replicas field of the ControlPlane object.", + Description: "replicas is the value of the replicas field of the ControlPlane object.", Type: []string{"integer"}, Format: "int64", }, }, "machineTemplate": { SchemaProps: spec.SchemaProps{ - Description: "MachineTemplate is the value of the .spec.machineTemplate field of the ControlPlane object.", + Description: "machineTemplate is the value of the .spec.machineTemplate field of the ControlPlane object.", Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.ControlPlaneMachineTemplateBuiltins"), }, }, @@ -1048,7 +1048,7 @@ func schema_runtime_hooks_api_v1alpha1_ControlPlaneMachineTemplateBuiltins(ref c Properties: map[string]spec.Schema{ "infrastructureRef": { SchemaProps: spec.SchemaProps{ - Description: "InfrastructureRef is the value of the infrastructureRef field of ControlPlane.spec.machineTemplate.", + Description: "infrastructureRef is the value of the infrastructureRef field of ControlPlane.spec.machineTemplate.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.ControlPlaneMachineTemplateInfrastructureRefBuiltins"), }, @@ -1070,7 +1070,7 @@ func schema_runtime_hooks_api_v1alpha1_ControlPlaneMachineTemplateInfrastructure Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the infrastructureRef.", + Description: "name of the infrastructureRef.", Type: []string{"string"}, Format: "", }, @@ -1104,7 +1104,7 @@ func schema_runtime_hooks_api_v1alpha1_DiscoverVariablesRequest(ref common.Refer }, "settings": { SchemaProps: spec.SchemaProps{ - Description: "Settings defines key value pairs to be passed to the call.", + Description: "settings defines key value pairs to be passed to the call.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -1147,7 +1147,7 @@ func schema_runtime_hooks_api_v1alpha1_DiscoverVariablesResponse(ref common.Refe }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", + Description: "status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", Default: "", Type: []string{"string"}, Format: "", @@ -1164,7 +1164,7 @@ func schema_runtime_hooks_api_v1alpha1_DiscoverVariablesResponse(ref common.Refe }, "variables": { SchemaProps: spec.SchemaProps{ - Description: "Variables are variable schemas for variables defined by the DiscoverVariables hook.", + Description: "variables are variable schemas for variables defined by the DiscoverVariables hook.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1235,7 +1235,7 @@ func schema_runtime_hooks_api_v1alpha1_DiscoveryResponse(ref common.ReferenceCal }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", + Description: "status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", Default: "", Type: []string{"string"}, Format: "", @@ -1260,7 +1260,7 @@ func schema_runtime_hooks_api_v1alpha1_DiscoveryResponse(ref common.ReferenceCal }, }, SchemaProps: spec.SchemaProps{ - Description: "Handlers defines the current ExtensionHandlers supported by an Extension.", + Description: "handlers defines the current ExtensionHandlers supported by an Extension.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1290,7 +1290,7 @@ func schema_runtime_hooks_api_v1alpha1_ExtensionHandler(ref common.ReferenceCall Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the ExtensionHandler.", + Description: "name is the name of the ExtensionHandler.", Default: "", Type: []string{"string"}, Format: "", @@ -1298,21 +1298,21 @@ func schema_runtime_hooks_api_v1alpha1_ExtensionHandler(ref common.ReferenceCall }, "requestHook": { SchemaProps: spec.SchemaProps{ - Description: "RequestHook defines the versioned runtime hook which this ExtensionHandler serves.", + Description: "requestHook defines the versioned runtime hook which this ExtensionHandler serves.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.GroupVersionHook"), }, }, "timeoutSeconds": { SchemaProps: spec.SchemaProps{ - Description: "TimeoutSeconds defines the timeout duration for client calls to the ExtensionHandler. This is defaulted to 10 if left undefined.", + Description: "timeoutSeconds defines the timeout duration for client calls to the ExtensionHandler. This is defaulted to 10 if left undefined.", Type: []string{"integer"}, Format: "int32", }, }, "failurePolicy": { SchemaProps: spec.SchemaProps{ - Description: "FailurePolicy defines how failures in calls to the ExtensionHandler should be handled by a client. This is defaulted to FailurePolicyFail if not defined.", + Description: "failurePolicy defines how failures in calls to the ExtensionHandler should be handled by a client. This is defaulted to FailurePolicyFail if not defined.", Type: []string{"string"}, Format: "", }, @@ -1349,7 +1349,7 @@ func schema_runtime_hooks_api_v1alpha1_GeneratePatchesRequest(ref common.Referen }, "settings": { SchemaProps: spec.SchemaProps{ - Description: "Settings defines key value pairs to be passed to the call.", + Description: "settings defines key value pairs to be passed to the call.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -1365,7 +1365,7 @@ func schema_runtime_hooks_api_v1alpha1_GeneratePatchesRequest(ref common.Referen }, "variables": { SchemaProps: spec.SchemaProps{ - Description: "Variables are global variables for all templates.", + Description: "variables are global variables for all templates.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1379,7 +1379,7 @@ func schema_runtime_hooks_api_v1alpha1_GeneratePatchesRequest(ref common.Referen }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of templates to generate patches for.", + Description: "items is the list of templates to generate patches for.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1409,7 +1409,7 @@ func schema_runtime_hooks_api_v1alpha1_GeneratePatchesRequestItem(ref common.Ref Properties: map[string]spec.Schema{ "uid": { SchemaProps: spec.SchemaProps{ - Description: "UID is an identifier for this template. It allows us to correlate the template in the request with the corresponding generated patches in the response.", + Description: "uid is an identifier for this template. It allows us to correlate the template in the request with the corresponding generated patches in the response.", Default: "", Type: []string{"string"}, Format: "", @@ -1417,20 +1417,20 @@ func schema_runtime_hooks_api_v1alpha1_GeneratePatchesRequestItem(ref common.Ref }, "holderReference": { SchemaProps: spec.SchemaProps{ - Description: "HolderReference is a reference to the object where the template is used.", + Description: "holderReference is a reference to the object where the template is used.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.HolderReference"), }, }, "object": { SchemaProps: spec.SchemaProps{ - Description: "Object contains the template as a raw object.", + Description: "object contains the template as a raw object.", Ref: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, "variables": { SchemaProps: spec.SchemaProps{ - Description: "Variables are variables specific for the current template. For example some builtin variables like MachineDeployment replicas and version are context-sensitive and thus are only added to templates for MachineDeployments and with values which correspond to the current MachineDeployment.", + Description: "variables are variables specific for the current template. For example some builtin variables like MachineDeployment replicas and version are context-sensitive and thus are only added to templates for MachineDeployments and with values which correspond to the current MachineDeployment.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1474,7 +1474,7 @@ func schema_runtime_hooks_api_v1alpha1_GeneratePatchesResponse(ref common.Refere }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", + Description: "status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", Default: "", Type: []string{"string"}, Format: "", @@ -1491,7 +1491,7 @@ func schema_runtime_hooks_api_v1alpha1_GeneratePatchesResponse(ref common.Refere }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of generated patches.", + Description: "items is the list of generated patches.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1521,7 +1521,7 @@ func schema_runtime_hooks_api_v1alpha1_GeneratePatchesResponseItem(ref common.Re Properties: map[string]spec.Schema{ "uid": { SchemaProps: spec.SchemaProps{ - Description: "UID identifies the corresponding template in the request on which the patch should be applied.", + Description: "uid identifies the corresponding template in the request on which the patch should be applied.", Default: "", Type: []string{"string"}, Format: "", @@ -1529,7 +1529,7 @@ func schema_runtime_hooks_api_v1alpha1_GeneratePatchesResponseItem(ref common.Re }, "patchType": { SchemaProps: spec.SchemaProps{ - Description: "PatchType defines the type of the patch. One of: \"JSONPatch\" or \"JSONMergePatch\".\n\nPossible enum values:\n - `\"JSONMergePatch\"` identifies a https://datatracker.ietf.org/doc/html/rfc7386 JSON merge patch.\n - `\"JSONPatch\"` identifies a https://datatracker.ietf.org/doc/html/rfc6902 JSON patch.", + Description: "patchType defines the type of the patch. One of: \"JSONPatch\" or \"JSONMergePatch\".\n\nPossible enum values:\n - `\"JSONMergePatch\"` identifies a https://datatracker.ietf.org/doc/html/rfc7386 JSON merge patch.\n - `\"JSONPatch\"` identifies a https://datatracker.ietf.org/doc/html/rfc6902 JSON patch.", Default: "", Type: []string{"string"}, Format: "", @@ -1538,7 +1538,7 @@ func schema_runtime_hooks_api_v1alpha1_GeneratePatchesResponseItem(ref common.Re }, "patch": { SchemaProps: spec.SchemaProps{ - Description: "Patch contains the patch which should be applied to the template. It must be of the corresponding PatchType.", + Description: "patch contains the patch which should be applied to the template. It must be of the corresponding PatchType.", Type: []string{"string"}, Format: "byte", }, @@ -1559,7 +1559,7 @@ func schema_runtime_hooks_api_v1alpha1_GroupVersionHook(ref common.ReferenceCall Properties: map[string]spec.Schema{ "apiVersion": { SchemaProps: spec.SchemaProps{ - Description: "APIVersion is the group and version of the Hook", + Description: "apiVersion is the group and version of the Hook", Default: "", Type: []string{"string"}, Format: "", @@ -1567,7 +1567,7 @@ func schema_runtime_hooks_api_v1alpha1_GroupVersionHook(ref common.ReferenceCall }, "hook": { SchemaProps: spec.SchemaProps{ - Description: "Hook is the name of the hook", + Description: "hook is the name of the hook", Default: "", Type: []string{"string"}, Format: "", @@ -1597,7 +1597,7 @@ func schema_runtime_hooks_api_v1alpha1_HolderReference(ref common.ReferenceCallb }, "kind": { SchemaProps: spec.SchemaProps{ - Description: "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + Description: "kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", Default: "", Type: []string{"string"}, Format: "", @@ -1605,7 +1605,7 @@ func schema_runtime_hooks_api_v1alpha1_HolderReference(ref common.ReferenceCallb }, "namespace": { SchemaProps: spec.SchemaProps{ - Description: "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/", + Description: "namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/", Default: "", Type: []string{"string"}, Format: "", @@ -1613,7 +1613,7 @@ func schema_runtime_hooks_api_v1alpha1_HolderReference(ref common.ReferenceCallb }, "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", + Description: "name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", Default: "", Type: []string{"string"}, Format: "", @@ -1621,7 +1621,7 @@ func schema_runtime_hooks_api_v1alpha1_HolderReference(ref common.ReferenceCallb }, "fieldPath": { SchemaProps: spec.SchemaProps{ - Description: "FieldPath is the path to the field of the object which references the template.", + Description: "fieldPath is the path to the field of the object which references the template.", Default: "", Type: []string{"string"}, Format: "", @@ -1643,7 +1643,7 @@ func schema_runtime_hooks_api_v1alpha1_MachineBootstrapBuiltins(ref common.Refer Properties: map[string]spec.Schema{ "configRef": { SchemaProps: spec.SchemaProps{ - Description: "ConfigRef is the value of the .spec.template.spec.bootstrap.configRef field of the MachineDeployment.", + Description: "configRef is the value of the .spec.template.spec.bootstrap.configRef field of the MachineDeployment.", Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.MachineBootstrapConfigRefBuiltins"), }, }, @@ -1664,7 +1664,7 @@ func schema_runtime_hooks_api_v1alpha1_MachineBootstrapConfigRefBuiltins(ref com Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the bootstrap.configRef.", + Description: "name of the bootstrap.configRef.", Type: []string{"string"}, Format: "", }, @@ -1684,54 +1684,54 @@ func schema_runtime_hooks_api_v1alpha1_MachineDeploymentBuiltins(ref common.Refe Properties: map[string]spec.Schema{ "version": { SchemaProps: spec.SchemaProps{ - Description: "Version is the Kubernetes version of the MachineDeployment, to which the current template belongs to. NOTE: Please note that this version is the version we are currently reconciling towards. It can differ from the current version of the MachineDeployment machines while an upgrade process is being orchestrated.", + Description: "version is the Kubernetes version of the MachineDeployment, to which the current template belongs to. NOTE: Please note that this version is the version we are currently reconciling towards. It can differ from the current version of the MachineDeployment machines while an upgrade process is being orchestrated.", Type: []string{"string"}, Format: "", }, }, "metadata": { SchemaProps: spec.SchemaProps{ - Description: "Metadata is the metadata set on the MachineDeployment.", + Description: "metadata is the metadata set on the MachineDeployment.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ObjectMeta"), }, }, "class": { SchemaProps: spec.SchemaProps{ - Description: "Class is the class name of the MachineDeployment, to which the current template belongs to.", + Description: "class is the class name of the MachineDeployment, to which the current template belongs to.", Type: []string{"string"}, Format: "", }, }, "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the MachineDeployment, to which the current template belongs to.", + Description: "name is the name of the MachineDeployment, to which the current template belongs to.", Type: []string{"string"}, Format: "", }, }, "topologyName": { SchemaProps: spec.SchemaProps{ - Description: "TopologyName is the topology name of the MachineDeployment, to which the current template belongs to.", + Description: "topologyName is the topology name of the MachineDeployment, to which the current template belongs to.", Type: []string{"string"}, Format: "", }, }, "replicas": { SchemaProps: spec.SchemaProps{ - Description: "Replicas is the value of the replicas field of the MachineDeployment, to which the current template belongs to.", + Description: "replicas is the value of the replicas field of the MachineDeployment, to which the current template belongs to.", Type: []string{"integer"}, Format: "int64", }, }, "bootstrap": { SchemaProps: spec.SchemaProps{ - Description: "Bootstrap is the value of the .spec.template.spec.bootstrap field of the MachineDeployment.", + Description: "bootstrap is the value of the .spec.template.spec.bootstrap field of the MachineDeployment.", Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.MachineBootstrapBuiltins"), }, }, "infrastructureRef": { SchemaProps: spec.SchemaProps{ - Description: "InfrastructureRef is the value of the .spec.template.spec.infrastructureRef field of the MachineDeployment.", + Description: "infrastructureRef is the value of the .spec.template.spec.infrastructureRef field of the MachineDeployment.", Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.MachineInfrastructureRefBuiltins"), }, }, @@ -1752,7 +1752,7 @@ func schema_runtime_hooks_api_v1alpha1_MachineInfrastructureRefBuiltins(ref comm Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the infrastructureRef.", + Description: "name of the infrastructureRef.", Type: []string{"string"}, Format: "", }, @@ -1772,54 +1772,54 @@ func schema_runtime_hooks_api_v1alpha1_MachinePoolBuiltins(ref common.ReferenceC Properties: map[string]spec.Schema{ "version": { SchemaProps: spec.SchemaProps{ - Description: "Version is the Kubernetes version of the MachinePool, to which the current template belongs to. NOTE: Please note that this version is the version we are currently reconciling towards. It can differ from the current version of the MachinePool machines while an upgrade process is being orchestrated.", + Description: "version is the Kubernetes version of the MachinePool, to which the current template belongs to. NOTE: Please note that this version is the version we are currently reconciling towards. It can differ from the current version of the MachinePool machines while an upgrade process is being orchestrated.", Type: []string{"string"}, Format: "", }, }, "metadata": { SchemaProps: spec.SchemaProps{ - Description: "Metadata is the metadata set on the MachinePool.", + Description: "metadata is the metadata set on the MachinePool.", Ref: ref("sigs.k8s.io/cluster-api/api/v1beta1.ObjectMeta"), }, }, "class": { SchemaProps: spec.SchemaProps{ - Description: "Class is the class name of the MachinePool, to which the current template belongs to.", + Description: "class is the class name of the MachinePool, to which the current template belongs to.", Type: []string{"string"}, Format: "", }, }, "name": { SchemaProps: spec.SchemaProps{ - Description: "Name is the name of the MachinePool, to which the current template belongs to.", + Description: "name is the name of the MachinePool, to which the current template belongs to.", Type: []string{"string"}, Format: "", }, }, "topologyName": { SchemaProps: spec.SchemaProps{ - Description: "TopologyName is the topology name of the MachinePool, to which the current template belongs to.", + Description: "topologyName is the topology name of the MachinePool, to which the current template belongs to.", Type: []string{"string"}, Format: "", }, }, "replicas": { SchemaProps: spec.SchemaProps{ - Description: "Replicas is the value of the replicas field of the MachinePool, to which the current template belongs to.", + Description: "replicas is the value of the replicas field of the MachinePool, to which the current template belongs to.", Type: []string{"integer"}, Format: "int64", }, }, "bootstrap": { SchemaProps: spec.SchemaProps{ - Description: "Bootstrap is the value of the .spec.template.spec.bootstrap field of the MachinePool.", + Description: "bootstrap is the value of the .spec.template.spec.bootstrap field of the MachinePool.", Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.MachineBootstrapBuiltins"), }, }, "infrastructureRef": { SchemaProps: spec.SchemaProps{ - Description: "InfrastructureRef is the value of the .spec.template.spec.infrastructureRef field of the MachinePool.", + Description: "infrastructureRef is the value of the .spec.template.spec.infrastructureRef field of the MachinePool.", Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.MachineInfrastructureRefBuiltins"), }, }, @@ -1854,7 +1854,7 @@ func schema_runtime_hooks_api_v1alpha1_ValidateTopologyRequest(ref common.Refere }, "settings": { SchemaProps: spec.SchemaProps{ - Description: "Settings defines key value pairs to be passed to the call.", + Description: "settings defines key value pairs to be passed to the call.", Type: []string{"object"}, AdditionalProperties: &spec.SchemaOrBool{ Allows: true, @@ -1870,7 +1870,7 @@ func schema_runtime_hooks_api_v1alpha1_ValidateTopologyRequest(ref common.Refere }, "variables": { SchemaProps: spec.SchemaProps{ - Description: "Variables are global variables for all templates.", + Description: "variables are global variables for all templates.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1884,7 +1884,7 @@ func schema_runtime_hooks_api_v1alpha1_ValidateTopologyRequest(ref common.Refere }, "items": { SchemaProps: spec.SchemaProps{ - Description: "Items is the list of templates to validate.", + Description: "items is the list of templates to validate.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1913,20 +1913,20 @@ func schema_runtime_hooks_api_v1alpha1_ValidateTopologyRequestItem(ref common.Re Properties: map[string]spec.Schema{ "holderReference": { SchemaProps: spec.SchemaProps{ - Description: "HolderReference is a reference to the object where the template is used.", + Description: "holderReference is a reference to the object where the template is used.", Default: map[string]interface{}{}, Ref: ref("sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1.HolderReference"), }, }, "object": { SchemaProps: spec.SchemaProps{ - Description: "Object contains the template as a raw object.", + Description: "object contains the template as a raw object.", Ref: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"), }, }, "variables": { SchemaProps: spec.SchemaProps{ - Description: "Variables are variables specific for the current template. For example some builtin variables like MachineDeployment replicas and version are context-sensitive and thus are only added to templates for MachineDeployments and with values which correspond to the current MachineDeployment.", + Description: "variables are variables specific for the current template. For example some builtin variables like MachineDeployment replicas and version are context-sensitive and thus are only added to templates for MachineDeployments and with values which correspond to the current MachineDeployment.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -1970,7 +1970,7 @@ func schema_runtime_hooks_api_v1alpha1_ValidateTopologyResponse(ref common.Refer }, "status": { SchemaProps: spec.SchemaProps{ - Description: "Status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", + Description: "status of the call. One of \"Success\" or \"Failure\".\n\nPossible enum values:\n - `\"Failure\"` represents a failure response.\n - `\"Success\"` represents a success response.", Default: "", Type: []string{"string"}, Format: "", @@ -2001,7 +2001,7 @@ func schema_runtime_hooks_api_v1alpha1_Variable(ref common.ReferenceCallback) co Properties: map[string]spec.Schema{ "name": { SchemaProps: spec.SchemaProps{ - Description: "Name of the variable.", + Description: "name of the variable.", Default: "", Type: []string{"string"}, Format: "", @@ -2009,7 +2009,7 @@ func schema_runtime_hooks_api_v1alpha1_Variable(ref common.ReferenceCallback) co }, "value": { SchemaProps: spec.SchemaProps{ - Description: "Value of the variable.", + Description: "value of the variable.", Ref: ref("k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON"), }, }, diff --git a/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfig_types.go b/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfig_types.go index 194293985a72..234eb28489a3 100644 --- a/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfig_types.go +++ b/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfig_types.go @@ -35,56 +35,56 @@ const ( // KubeadmConfigSpec defines the desired state of KubeadmConfig. // Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. type KubeadmConfigSpec struct { - // ClusterConfiguration along with InitConfiguration are the configurations necessary for the init command + // clusterConfiguration along with InitConfiguration are the configurations necessary for the init command // +optional ClusterConfiguration *upstreamv1beta1.ClusterConfiguration `json:"clusterConfiguration,omitempty"` - // InitConfiguration along with ClusterConfiguration are the configurations necessary for the init command + // initConfiguration along with ClusterConfiguration are the configurations necessary for the init command // +optional InitConfiguration *upstreamv1beta1.InitConfiguration `json:"initConfiguration,omitempty"` - // JoinConfiguration is the kubeadm configuration for the join command + // joinConfiguration is the kubeadm configuration for the join command // +optional JoinConfiguration *upstreamv1beta1.JoinConfiguration `json:"joinConfiguration,omitempty"` - // Files specifies extra files to be passed to user_data upon creation. + // files specifies extra files to be passed to user_data upon creation. // +optional Files []File `json:"files,omitempty"` - // DiskSetup specifies options for the creation of partition tables and file systems on devices. + // diskSetup specifies options for the creation of partition tables and file systems on devices. // +optional DiskSetup *DiskSetup `json:"diskSetup,omitempty"` - // Mounts specifies a list of mount points to be setup. + // mounts specifies a list of mount points to be setup. // +optional Mounts []MountPoints `json:"mounts,omitempty"` - // PreKubeadmCommands specifies extra commands to run before kubeadm runs + // preKubeadmCommands specifies extra commands to run before kubeadm runs // +optional PreKubeadmCommands []string `json:"preKubeadmCommands,omitempty"` - // PostKubeadmCommands specifies extra commands to run after kubeadm runs + // postKubeadmCommands specifies extra commands to run after kubeadm runs // +optional PostKubeadmCommands []string `json:"postKubeadmCommands,omitempty"` - // Users specifies extra users to add + // users specifies extra users to add // +optional Users []User `json:"users,omitempty"` - // NTP specifies NTP configuration + // ntp specifies NTP configuration // +optional NTP *NTP `json:"ntp,omitempty"` - // Format specifies the output format of the bootstrap data + // format specifies the output format of the bootstrap data // +optional Format Format `json:"format,omitempty"` - // Verbosity is the number for the kubeadm log level verbosity. + // verbosity is the number for the kubeadm log level verbosity. // It overrides the `--v` flag in kubeadm commands. // +optional Verbosity *int32 `json:"verbosity,omitempty"` - // UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + // useExperimentalRetryJoin replaces a basic kubeadm command with a shell // script with retries for joins. // // This is meant to be an experimental temporary workaround on some environments @@ -100,33 +100,33 @@ type KubeadmConfigSpec struct { // KubeadmConfigStatus defines the observed state of KubeadmConfig. type KubeadmConfigStatus struct { - // Ready indicates the BootstrapData field is ready to be consumed + // ready indicates the BootstrapData field is ready to be consumed Ready bool `json:"ready,omitempty"` - // DataSecretName is the name of the secret that stores the bootstrap data script. + // dataSecretName is the name of the secret that stores the bootstrap data script. // +optional DataSecretName *string `json:"dataSecretName,omitempty"` - // BootstrapData will be a cloud-init script for now. + // bootstrapData will be a cloud-init script for now. // // Deprecated: Switch to DataSecretName. // // +optional BootstrapData []byte `json:"bootstrapData,omitempty"` - // FailureReason will be set on non-retryable errors + // failureReason will be set on non-retryable errors // +optional FailureReason string `json:"failureReason,omitempty"` - // FailureMessage will be set on non-retryable errors + // failureMessage will be set on non-retryable errors // +optional FailureMessage string `json:"failureMessage,omitempty"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions defines current service state of the KubeadmConfig. + // conditions defines current service state of the KubeadmConfig. // +optional Conditions clusterv1alpha3.Conditions `json:"conditions,omitempty"` } @@ -188,26 +188,26 @@ const ( // File defines the input for generating write_files in cloud-init. type File struct { - // Path specifies the full path on disk where to store the file. + // path specifies the full path on disk where to store the file. Path string `json:"path"` - // Owner specifies the ownership of the file, e.g. "root:root". + // owner specifies the ownership of the file, e.g. "root:root". // +optional Owner string `json:"owner,omitempty"` - // Permissions specifies the permissions to assign to the file, e.g. "0640". + // permissions specifies the permissions to assign to the file, e.g. "0640". // +optional Permissions string `json:"permissions,omitempty"` - // Encoding specifies the encoding of the file contents. + // encoding specifies the encoding of the file contents. // +optional Encoding Encoding `json:"encoding,omitempty"` - // Content is the actual content of the file. + // content is the actual content of the file. // +optional Content string `json:"content,omitempty"` - // ContentFrom is a referenced source of content to populate the file. + // contentFrom is a referenced source of content to populate the file. // +optional ContentFrom *FileSource `json:"contentFrom,omitempty"` } @@ -216,7 +216,7 @@ type File struct { // Only one field may be populated in any given instance. Developers adding new // sources of data for target systems should add them here. type FileSource struct { - // Secret represents a secret that should populate this file. + // secret represents a secret that should populate this file. Secret SecretFileSource `json:"secret"` } @@ -225,91 +225,91 @@ type FileSource struct { // The contents of the target Secret's Data field will be presented // as files using the keys in the Data field as the file names. type SecretFileSource struct { - // Name of the secret in the KubeadmBootstrapConfig's namespace to use. + // name of the secret in the KubeadmBootstrapConfig's namespace to use. Name string `json:"name"` - // Key is the key in the secret's data map for this value. + // key is the key in the secret's data map for this value. Key string `json:"key"` } // User defines the input for a generated user in cloud-init. type User struct { - // Name specifies the user name + // name specifies the user name Name string `json:"name"` - // Gecos specifies the gecos to use for the user + // gecos specifies the gecos to use for the user // +optional Gecos *string `json:"gecos,omitempty"` - // Groups specifies the additional groups for the user + // groups specifies the additional groups for the user // +optional Groups *string `json:"groups,omitempty"` - // HomeDir specifies the home directory to use for the user + // homeDir specifies the home directory to use for the user // +optional HomeDir *string `json:"homeDir,omitempty"` - // Inactive specifies whether to mark the user as inactive + // inactive specifies whether to mark the user as inactive // +optional Inactive *bool `json:"inactive,omitempty"` - // Shell specifies the user's shell + // shell specifies the user's shell // +optional Shell *string `json:"shell,omitempty"` - // Passwd specifies a hashed password for the user + // passwd specifies a hashed password for the user // +optional Passwd *string `json:"passwd,omitempty"` - // PrimaryGroup specifies the primary group for the user + // primaryGroup specifies the primary group for the user // +optional PrimaryGroup *string `json:"primaryGroup,omitempty"` - // LockPassword specifies if password login should be disabled + // lockPassword specifies if password login should be disabled // +optional LockPassword *bool `json:"lockPassword,omitempty"` - // Sudo specifies a sudo role for the user + // sudo specifies a sudo role for the user // +optional Sudo *string `json:"sudo,omitempty"` - // SSHAuthorizedKeys specifies a list of ssh authorized keys for the user + // sshAuthorizedKeys specifies a list of ssh authorized keys for the user // +optional SSHAuthorizedKeys []string `json:"sshAuthorizedKeys,omitempty"` } // NTP defines input for generated ntp in cloud-init. type NTP struct { - // Servers specifies which NTP servers to use + // servers specifies which NTP servers to use // +optional Servers []string `json:"servers,omitempty"` - // Enabled specifies whether NTP should be enabled + // enabled specifies whether NTP should be enabled // +optional Enabled *bool `json:"enabled,omitempty"` } // DiskSetup defines input for generated disk_setup and fs_setup in cloud-init. type DiskSetup struct { - // Partitions specifies the list of the partitions to setup. + // partitions specifies the list of the partitions to setup. Partitions []Partition `json:"partitions,omitempty"` - // Filesystems specifies the list of file systems to setup. + // filesystems specifies the list of file systems to setup. Filesystems []Filesystem `json:"filesystems,omitempty"` } // Partition defines how to create and layout a partition. type Partition struct { - // Device is the name of the device. + // device is the name of the device. Device string `json:"device"` - // Layout specifies the device layout. + // layout specifies the device layout. // If it is true, a single partition will be created for the entire device. // When layout is false, it means don't partition or ignore existing partitioning. Layout bool `json:"layout"` - // Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + // overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. // Use with caution. Default is 'false'. // +optional Overwrite *bool `json:"overwrite,omitempty"` - // TableType specifies the tupe of partition table. The following are supported: + // tableType specifies the tupe of partition table. The following are supported: // 'mbr': default and setups a MS-DOS partition table // 'gpt': setups a GPT partition table // +optional @@ -318,24 +318,24 @@ type Partition struct { // Filesystem defines the file systems to be created. type Filesystem struct { - // Device specifies the device name + // device specifies the device name Device string `json:"device"` - // Filesystem specifies the file system type. + // filesystem specifies the file system type. Filesystem string `json:"filesystem"` - // Label specifies the file system label to be used. If set to None, no label is used. + // label specifies the file system label to be used. If set to None, no label is used. Label string `json:"label"` - // Partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number. + // partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number. // +optional Partition *string `json:"partition,omitempty"` - // Overwrite defines whether or not to overwrite any existing filesystem. + // overwrite defines whether or not to overwrite any existing filesystem. // If true, any pre-existing file system will be destroyed. Use with Caution. // +optional Overwrite *bool `json:"overwrite,omitempty"` - // ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + // replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . // NOTE: unless you define a label, this requires the use of the 'any' partition directive. // +optional ReplaceFS *string `json:"replaceFS,omitempty"` - // ExtraOpts defined extra options to add to the command for creating the file system. + // extraOpts defined extra options to add to the command for creating the file system. // +optional ExtraOpts []string `json:"extraOpts,omitempty"` } diff --git a/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadm_types.go b/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadm_types.go index a580bb0a7137..0479d76bf4b8 100644 --- a/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadm_types.go +++ b/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadm_types.go @@ -34,18 +34,18 @@ import ( type InitConfiguration struct { metav1.TypeMeta `json:",inline"` - // BootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. + // bootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. // This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature // +optional BootstrapTokens []BootstrapToken `json:"bootstrapTokens,omitempty"` - // NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + // nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. // When used in the context of control plane nodes, NodeRegistration should remain consistent // across both InitConfiguration and JoinConfiguration // +optional NodeRegistration NodeRegistrationOptions `json:"nodeRegistration,omitempty"` - // LocalAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node + // localAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node // In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint // is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This // configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible @@ -61,22 +61,22 @@ type InitConfiguration struct { type ClusterConfiguration struct { metav1.TypeMeta `json:",inline"` - // Etcd holds configuration for etcd. + // etcd holds configuration for etcd. // NB: This value defaults to a Local (stacked) etcd // +optional Etcd Etcd `json:"etcd,omitempty"` - // Networking holds configuration for the networking topology of the cluster. + // networking holds configuration for the networking topology of the cluster. // NB: This value defaults to the Cluster object spec.clusterNetwork. // +optional Networking Networking `json:"networking,omitempty"` - // KubernetesVersion is the target version of the control plane. + // kubernetesVersion is the target version of the control plane. // NB: This value defaults to the Machine object spec.version // +optional KubernetesVersion string `json:"kubernetesVersion,omitempty"` - // ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it + // controlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it // can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. // In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort // are used; in case the ControlPlaneEndpoint is specified but without a TCP port, @@ -91,35 +91,35 @@ type ClusterConfiguration struct { // +optional ControlPlaneEndpoint string `json:"controlPlaneEndpoint,omitempty"` - // APIServer contains extra settings for the API server control plane component + // apiServer contains extra settings for the API server control plane component // +optional APIServer APIServer `json:"apiServer,omitempty"` - // ControllerManager contains extra settings for the controller manager control plane component + // controllerManager contains extra settings for the controller manager control plane component // +optional ControllerManager ControlPlaneComponent `json:"controllerManager,omitempty"` - // Scheduler contains extra settings for the scheduler control plane component + // scheduler contains extra settings for the scheduler control plane component // +optional Scheduler ControlPlaneComponent `json:"scheduler,omitempty"` - // DNS defines the options for the DNS add-on installed in the cluster. + // dns defines the options for the DNS add-on installed in the cluster. // +optional DNS DNS `json:"dns,omitempty"` - // CertificatesDir specifies where to store or look for all required certificates. + // certificatesDir specifies where to store or look for all required certificates. // NB: if not provided, this will default to `/etc/kubernetes/pki` // +optional CertificatesDir string `json:"certificatesDir,omitempty"` - // ImageRepository sets the container registry to pull images from. + // imageRepository sets the container registry to pull images from. // If empty, `registry.k8s.io` will be used by default; in case of kubernetes version is a CI build (kubernetes version starts with `ci/` or `ci-cross/`) // `gcr.io/k8s-staging-ci-images` will be used as a default for control plane components and for kube-proxy, while `registry.k8s.io` // will be used for all the other images. // +optional ImageRepository string `json:"imageRepository,omitempty"` - // FeatureGates enabled by the user. + // featureGates enabled by the user. // +optional FeatureGates map[string]bool `json:"featureGates,omitempty"` @@ -130,12 +130,12 @@ type ClusterConfiguration struct { // ControlPlaneComponent holds settings common to control plane component of the cluster. type ControlPlaneComponent struct { - // ExtraArgs is an extra set of flags to pass to the control plane component. + // extraArgs is an extra set of flags to pass to the control plane component. // TODO: This is temporary and ideally we would like to switch all components to use ComponentConfig + ConfigMaps. // +optional ExtraArgs map[string]string `json:"extraArgs,omitempty"` - // ExtraVolumes is an extra set of host volumes, mounted to the control plane component. + // extraVolumes is an extra set of host volumes, mounted to the control plane component. // +optional ExtraVolumes []HostPathMount `json:"extraVolumes,omitempty"` } @@ -144,11 +144,11 @@ type ControlPlaneComponent struct { type APIServer struct { ControlPlaneComponent `json:",inline"` - // CertSANs sets extra Subject Alternative Names for the API Server signing cert. + // certSANs sets extra Subject Alternative Names for the API Server signing cert. // +optional CertSANs []string `json:"certSANs,omitempty"` - // TimeoutForControlPlane controls the timeout that we use for API server to appear + // timeoutForControlPlane controls the timeout that we use for API server to appear // +optional TimeoutForControlPlane *metav1.Duration `json:"timeoutForControlPlane,omitempty"` } @@ -162,12 +162,12 @@ type DNS struct { // ImageMeta allows to customize the image used for components that are not // originated from the Kubernetes/Kubernetes release process. type ImageMeta struct { - // ImageRepository sets the container registry to pull images from. + // imageRepository sets the container registry to pull images from. // if not set, the ImageRepository defined in ClusterConfiguration will be used instead. // +optional ImageRepository string `json:"imageRepository,omitempty"` - // ImageTag allows to specify a tag for the image. + // imageTag allows to specify a tag for the image. // In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. // +optional ImageTag string `json:"imageTag,omitempty"` @@ -185,18 +185,18 @@ type ImageMeta struct { type ClusterStatus struct { metav1.TypeMeta `json:",inline"` - // APIEndpoints currently available in the cluster, one for each control plane/api server instance. + // apiEndpoints currently available in the cluster, one for each control plane/api server instance. // The key of the map is the IP of the host's default interface APIEndpoints map[string]APIEndpoint `json:"apiEndpoints"` } // APIEndpoint struct contains elements of API server instance deployed on a node. type APIEndpoint struct { - // AdvertiseAddress sets the IP address for the API server to advertise. + // advertiseAddress sets the IP address for the API server to advertise. // +optional AdvertiseAddress string `json:"advertiseAddress,omitempty"` - // BindPort sets the secure port for the API Server to bind to. + // bindPort sets the secure port for the API Server to bind to. // Defaults to 6443. // +optional BindPort int32 `json:"bindPort,omitempty"` @@ -205,71 +205,71 @@ type APIEndpoint struct { // NodeRegistrationOptions holds fields that relate to registering a new control-plane or node to the cluster, either via "kubeadm init" or "kubeadm join". type NodeRegistrationOptions struct { - // Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. + // name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. // This field is also used in the CommonName field of the kubelet's client certificate to the API server. // Defaults to the hostname of the node if not provided. // +optional Name string `json:"name,omitempty"` - // CRISocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use + // criSocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use // +optional CRISocket string `json:"criSocket,omitempty"` - // Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process + // taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process // it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an // empty slice, i.e. `taints: {}` in the YAML file. This field is solely used for Node registration. Taints []corev1.Taint `json:"taints,omitempty"` - // KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file + // kubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file // kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap // Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. // +optional KubeletExtraArgs map[string]string `json:"kubeletExtraArgs,omitempty"` - // IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. + // ignorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. // +optional IgnorePreflightErrors []string `json:"ignorePreflightErrors,omitempty"` } // Networking contains elements describing cluster's networking configuration. type Networking struct { - // ServiceSubnet is the subnet used by k8s services. + // serviceSubnet is the subnet used by k8s services. // Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.pods.cidrBlocks, or // to "10.96.0.0/12" if that's unset. // +optional ServiceSubnet string `json:"serviceSubnet,omitempty"` - // PodSubnet is the subnet used by pods. + // podSubnet is the subnet used by pods. // If unset, the API server will not allocate CIDR ranges for every node. // Defaults to a comma-delimited string of the Cluster object's spec.clusterNetwork.services.cidrBlocks if that is set // +optional PodSubnet string `json:"podSubnet,omitempty"` - // DNSDomain is the dns domain used by k8s services. Defaults to "cluster.local". + // dnsDomain is the dns domain used by k8s services. Defaults to "cluster.local". // +optional DNSDomain string `json:"dnsDomain,omitempty"` } // BootstrapToken describes one bootstrap token, stored as a Secret in the cluster. type BootstrapToken struct { - // Token is used for establishing bidirectional trust between nodes and control-planes. + // token is used for establishing bidirectional trust between nodes and control-planes. // Used for joining nodes in the cluster. Token *BootstrapTokenString `json:"token"` - // Description sets a human-friendly message why this token exists and what it's used + // description sets a human-friendly message why this token exists and what it's used // for, so other administrators can know its purpose. // +optional Description string `json:"description,omitempty"` - // TTL defines the time to live for this token. Defaults to 24h. + // ttl defines the time to live for this token. Defaults to 24h. // Expires and TTL are mutually exclusive. // +optional TTL *metav1.Duration `json:"ttl,omitempty"` - // Expires specifies the timestamp when this token expires. Defaults to being set + // expires specifies the timestamp when this token expires. Defaults to being set // dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive. // +optional Expires *metav1.Time `json:"expires,omitempty"` - // Usages describes the ways in which this token can be used. Can by default be used + // usages describes the ways in which this token can be used. Can by default be used // for establishing bidirectional trust, but that can be changed here. // +optional Usages []string `json:"usages,omitempty"` - // Groups specifies the extra groups that this token will authenticate as when/if + // groups specifies the extra groups that this token will authenticate as when/if // used for authentication // +optional Groups []string `json:"groups,omitempty"` @@ -278,12 +278,12 @@ type BootstrapToken struct { // Etcd contains elements describing Etcd configuration. type Etcd struct { - // Local provides configuration knobs for configuring the local etcd instance + // local provides configuration knobs for configuring the local etcd instance // Local and External are mutually exclusive // +optional Local *LocalEtcd `json:"local,omitempty"` - // External describes how to connect to an external etcd cluster + // external describes how to connect to an external etcd cluster // Local and External are mutually exclusive // +optional External *ExternalEtcd `json:"external,omitempty"` @@ -294,20 +294,20 @@ type LocalEtcd struct { // ImageMeta allows to customize the container used for etcd ImageMeta `json:",inline"` - // DataDir is the directory etcd will place its data. + // dataDir is the directory etcd will place its data. // Defaults to "/var/lib/etcd". // +optional DataDir string `json:"dataDir,omitempty"` - // ExtraArgs are extra arguments provided to the etcd binary + // extraArgs are extra arguments provided to the etcd binary // when run inside a static pod. // +optional ExtraArgs map[string]string `json:"extraArgs,omitempty"` - // ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert. + // serverCertSANs sets extra Subject Alternative Names for the etcd server signing cert. // +optional ServerCertSANs []string `json:"serverCertSANs,omitempty"` - // PeerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. + // peerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. // +optional PeerCertSANs []string `json:"peerCertSANs,omitempty"` } @@ -315,18 +315,18 @@ type LocalEtcd struct { // ExternalEtcd describes an external etcd cluster. // Kubeadm has no knowledge of where certificate files live and they must be supplied. type ExternalEtcd struct { - // Endpoints of etcd members. Required for ExternalEtcd. + // endpoints of etcd members. Required for ExternalEtcd. Endpoints []string `json:"endpoints"` - // CAFile is an SSL Certificate Authority file used to secure etcd communication. + // caFile is an SSL Certificate Authority file used to secure etcd communication. // Required if using a TLS connection. CAFile string `json:"caFile"` - // CertFile is an SSL certification file used to secure etcd communication. + // certFile is an SSL certification file used to secure etcd communication. // Required if using a TLS connection. CertFile string `json:"certFile"` - // KeyFile is an SSL key file used to secure etcd communication. + // keyFile is an SSL key file used to secure etcd communication. // Required if using a TLS connection. KeyFile string `json:"keyFile"` } @@ -337,25 +337,25 @@ type ExternalEtcd struct { type JoinConfiguration struct { metav1.TypeMeta `json:",inline"` - // NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. + // nodeRegistration holds fields that relate to registering the new control-plane node to the cluster. // When used in the context of control plane nodes, NodeRegistration should remain consistent // across both InitConfiguration and JoinConfiguration // +optional NodeRegistration NodeRegistrationOptions `json:"nodeRegistration,omitempty"` - // CACertPath is the path to the SSL certificate authority used to + // caCertPath is the path to the SSL certificate authority used to // secure comunications between node and control-plane. // Defaults to "/etc/kubernetes/pki/ca.crt". // +optional // TODO: revisit when there is defaulting from k/k CACertPath string `json:"caCertPath,omitempty"` - // Discovery specifies the options for the kubelet to use during the TLS Bootstrap process + // discovery specifies the options for the kubelet to use during the TLS Bootstrap process // +optional // TODO: revisit when there is defaulting from k/k Discovery Discovery `json:"discovery,omitempty"` - // ControlPlane defines the additional control plane instance to be deployed on the joining node. + // controlPlane defines the additional control plane instance to be deployed on the joining node. // If nil, no additional control plane instance will be deployed. // +optional ControlPlane *JoinControlPlane `json:"controlPlane,omitempty"` @@ -363,45 +363,45 @@ type JoinConfiguration struct { // JoinControlPlane contains elements describing an additional control plane instance to be deployed on the joining node. type JoinControlPlane struct { - // LocalAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. + // localAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. // +optional LocalAPIEndpoint APIEndpoint `json:"localAPIEndpoint,omitempty"` } // Discovery specifies the options for the kubelet to use during the TLS Bootstrap process. type Discovery struct { - // BootstrapToken is used to set the options for bootstrap token based discovery + // bootstrapToken is used to set the options for bootstrap token based discovery // BootstrapToken and File are mutually exclusive // +optional BootstrapToken *BootstrapTokenDiscovery `json:"bootstrapToken,omitempty"` - // File is used to specify a file or URL to a kubeconfig file from which to load cluster information + // file is used to specify a file or URL to a kubeconfig file from which to load cluster information // BootstrapToken and File are mutually exclusive // +optional File *FileDiscovery `json:"file,omitempty"` - // TLSBootstrapToken is a token used for TLS bootstrapping. + // tlsBootstrapToken is a token used for TLS bootstrapping. // If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. // If .File is set, this field **must be set** in case the KubeConfigFile does not contain any other authentication information // +optional TLSBootstrapToken string `json:"tlsBootstrapToken,omitempty"` - // Timeout modifies the discovery timeout + // timeout modifies the discovery timeout // +optional Timeout *metav1.Duration `json:"timeout,omitempty"` } // BootstrapTokenDiscovery is used to set the options for bootstrap token based discovery. type BootstrapTokenDiscovery struct { - // Token is a token used to validate cluster information + // token is a token used to validate cluster information // fetched from the control-plane. Token string `json:"token"` - // APIServerEndpoint is an IP or domain name to the API server from which info will be fetched. + // apiServerEndpoint is an IP or domain name to the API server from which info will be fetched. // +optional APIServerEndpoint string `json:"apiServerEndpoint,omitempty"` - // CACertHashes specifies a set of public key pins to verify + // caCertHashes specifies a set of public key pins to verify // when token-based discovery is used. The root CA found during discovery // must match one of these values. Specifying an empty set disables root CA // pinning, which can be unsafe. Each hash is specified as ":", @@ -412,7 +412,7 @@ type BootstrapTokenDiscovery struct { // +optional CACertHashes []string `json:"caCertHashes,omitempty"` - // UnsafeSkipCAVerification allows token-based discovery + // unsafeSkipCAVerification allows token-based discovery // without CA verification via CACertHashes. This can weaken // the security of kubeadm since other nodes can impersonate the control-plane. // +optional @@ -421,24 +421,24 @@ type BootstrapTokenDiscovery struct { // FileDiscovery is used to specify a file or URL to a kubeconfig file from which to load cluster information. type FileDiscovery struct { - // KubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information + // kubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information KubeConfigPath string `json:"kubeConfigPath"` } // HostPathMount contains elements describing volumes that are mounted from the // host. type HostPathMount struct { - // Name of the volume inside the pod template. + // name of the volume inside the pod template. Name string `json:"name"` - // HostPath is the path in the host that will be mounted inside + // hostPath is the path in the host that will be mounted inside // the pod. HostPath string `json:"hostPath"` - // MountPath is the path inside the pod where hostPath will be mounted. + // mountPath is the path inside the pod where hostPath will be mounted. MountPath string `json:"mountPath"` - // ReadOnly controls write access to the volume + // readOnly controls write access to the volume // +optional ReadOnly bool `json:"readOnly,omitempty"` - // PathType is the type of the HostPath. + // pathType is the type of the HostPath. // +optional PathType corev1.HostPathType `json:"pathType,omitempty"` } diff --git a/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfig_types.go b/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfig_types.go index 64425edf63d6..9f823e17a86f 100644 --- a/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfig_types.go +++ b/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfig_types.go @@ -34,56 +34,56 @@ const ( // KubeadmConfigSpec defines the desired state of KubeadmConfig. // Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined. type KubeadmConfigSpec struct { - // ClusterConfiguration along with InitConfiguration are the configurations necessary for the init command + // clusterConfiguration along with InitConfiguration are the configurations necessary for the init command // +optional ClusterConfiguration *ClusterConfiguration `json:"clusterConfiguration,omitempty"` - // InitConfiguration along with ClusterConfiguration are the configurations necessary for the init command + // initConfiguration along with ClusterConfiguration are the configurations necessary for the init command // +optional InitConfiguration *InitConfiguration `json:"initConfiguration,omitempty"` - // JoinConfiguration is the kubeadm configuration for the join command + // joinConfiguration is the kubeadm configuration for the join command // +optional JoinConfiguration *JoinConfiguration `json:"joinConfiguration,omitempty"` - // Files specifies extra files to be passed to user_data upon creation. + // files specifies extra files to be passed to user_data upon creation. // +optional Files []File `json:"files,omitempty"` - // DiskSetup specifies options for the creation of partition tables and file systems on devices. + // diskSetup specifies options for the creation of partition tables and file systems on devices. // +optional DiskSetup *DiskSetup `json:"diskSetup,omitempty"` - // Mounts specifies a list of mount points to be setup. + // mounts specifies a list of mount points to be setup. // +optional Mounts []MountPoints `json:"mounts,omitempty"` - // PreKubeadmCommands specifies extra commands to run before kubeadm runs + // preKubeadmCommands specifies extra commands to run before kubeadm runs // +optional PreKubeadmCommands []string `json:"preKubeadmCommands,omitempty"` - // PostKubeadmCommands specifies extra commands to run after kubeadm runs + // postKubeadmCommands specifies extra commands to run after kubeadm runs // +optional PostKubeadmCommands []string `json:"postKubeadmCommands,omitempty"` - // Users specifies extra users to add + // users specifies extra users to add // +optional Users []User `json:"users,omitempty"` - // NTP specifies NTP configuration + // ntp specifies NTP configuration // +optional NTP *NTP `json:"ntp,omitempty"` - // Format specifies the output format of the bootstrap data + // format specifies the output format of the bootstrap data // +optional Format Format `json:"format,omitempty"` - // Verbosity is the number for the kubeadm log level verbosity. + // verbosity is the number for the kubeadm log level verbosity. // It overrides the `--v` flag in kubeadm commands. // +optional Verbosity *int32 `json:"verbosity,omitempty"` - // UseExperimentalRetryJoin replaces a basic kubeadm command with a shell + // useExperimentalRetryJoin replaces a basic kubeadm command with a shell // script with retries for joins. // // This is meant to be an experimental temporary workaround on some environments @@ -99,26 +99,26 @@ type KubeadmConfigSpec struct { // KubeadmConfigStatus defines the observed state of KubeadmConfig. type KubeadmConfigStatus struct { - // Ready indicates the BootstrapData field is ready to be consumed + // ready indicates the BootstrapData field is ready to be consumed Ready bool `json:"ready,omitempty"` - // DataSecretName is the name of the secret that stores the bootstrap data script. + // dataSecretName is the name of the secret that stores the bootstrap data script. // +optional DataSecretName *string `json:"dataSecretName,omitempty"` - // FailureReason will be set on non-retryable errors + // failureReason will be set on non-retryable errors // +optional FailureReason string `json:"failureReason,omitempty"` - // FailureMessage will be set on non-retryable errors + // failureMessage will be set on non-retryable errors // +optional FailureMessage string `json:"failureMessage,omitempty"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions defines current service state of the KubeadmConfig. + // conditions defines current service state of the KubeadmConfig. // +optional Conditions clusterv1alpha4.Conditions `json:"conditions,omitempty"` } @@ -181,26 +181,26 @@ const ( // File defines the input for generating write_files in cloud-init. type File struct { - // Path specifies the full path on disk where to store the file. + // path specifies the full path on disk where to store the file. Path string `json:"path"` - // Owner specifies the ownership of the file, e.g. "root:root". + // owner specifies the ownership of the file, e.g. "root:root". // +optional Owner string `json:"owner,omitempty"` - // Permissions specifies the permissions to assign to the file, e.g. "0640". + // permissions specifies the permissions to assign to the file, e.g. "0640". // +optional Permissions string `json:"permissions,omitempty"` - // Encoding specifies the encoding of the file contents. + // encoding specifies the encoding of the file contents. // +optional Encoding Encoding `json:"encoding,omitempty"` - // Content is the actual content of the file. + // content is the actual content of the file. // +optional Content string `json:"content,omitempty"` - // ContentFrom is a referenced source of content to populate the file. + // contentFrom is a referenced source of content to populate the file. // +optional ContentFrom *FileSource `json:"contentFrom,omitempty"` } @@ -209,7 +209,7 @@ type File struct { // Only one field may be populated in any given instance. Developers adding new // sources of data for target systems should add them here. type FileSource struct { - // Secret represents a secret that should populate this file. + // secret represents a secret that should populate this file. Secret SecretFileSource `json:"secret"` } @@ -218,91 +218,91 @@ type FileSource struct { // The contents of the target Secret's Data field will be presented // as files using the keys in the Data field as the file names. type SecretFileSource struct { - // Name of the secret in the KubeadmBootstrapConfig's namespace to use. + // name of the secret in the KubeadmBootstrapConfig's namespace to use. Name string `json:"name"` - // Key is the key in the secret's data map for this value. + // key is the key in the secret's data map for this value. Key string `json:"key"` } // User defines the input for a generated user in cloud-init. type User struct { - // Name specifies the user name + // name specifies the user name Name string `json:"name"` - // Gecos specifies the gecos to use for the user + // gecos specifies the gecos to use for the user // +optional Gecos *string `json:"gecos,omitempty"` - // Groups specifies the additional groups for the user + // groups specifies the additional groups for the user // +optional Groups *string `json:"groups,omitempty"` - // HomeDir specifies the home directory to use for the user + // homeDir specifies the home directory to use for the user // +optional HomeDir *string `json:"homeDir,omitempty"` - // Inactive specifies whether to mark the user as inactive + // inactive specifies whether to mark the user as inactive // +optional Inactive *bool `json:"inactive,omitempty"` - // Shell specifies the user's shell + // shell specifies the user's shell // +optional Shell *string `json:"shell,omitempty"` - // Passwd specifies a hashed password for the user + // passwd specifies a hashed password for the user // +optional Passwd *string `json:"passwd,omitempty"` - // PrimaryGroup specifies the primary group for the user + // primaryGroup specifies the primary group for the user // +optional PrimaryGroup *string `json:"primaryGroup,omitempty"` - // LockPassword specifies if password login should be disabled + // lockPassword specifies if password login should be disabled // +optional LockPassword *bool `json:"lockPassword,omitempty"` - // Sudo specifies a sudo role for the user + // sudo specifies a sudo role for the user // +optional Sudo *string `json:"sudo,omitempty"` - // SSHAuthorizedKeys specifies a list of ssh authorized keys for the user + // sshAuthorizedKeys specifies a list of ssh authorized keys for the user // +optional SSHAuthorizedKeys []string `json:"sshAuthorizedKeys,omitempty"` } // NTP defines input for generated ntp in cloud-init. type NTP struct { - // Servers specifies which NTP servers to use + // servers specifies which NTP servers to use // +optional Servers []string `json:"servers,omitempty"` - // Enabled specifies whether NTP should be enabled + // enabled specifies whether NTP should be enabled // +optional Enabled *bool `json:"enabled,omitempty"` } // DiskSetup defines input for generated disk_setup and fs_setup in cloud-init. type DiskSetup struct { - // Partitions specifies the list of the partitions to setup. + // partitions specifies the list of the partitions to setup. Partitions []Partition `json:"partitions,omitempty"` - // Filesystems specifies the list of file systems to setup. + // filesystems specifies the list of file systems to setup. Filesystems []Filesystem `json:"filesystems,omitempty"` } // Partition defines how to create and layout a partition. type Partition struct { - // Device is the name of the device. + // device is the name of the device. Device string `json:"device"` - // Layout specifies the device layout. + // layout specifies the device layout. // If it is true, a single partition will be created for the entire device. // When layout is false, it means don't partition or ignore existing partitioning. Layout bool `json:"layout"` - // Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. + // overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. // Use with caution. Default is 'false'. // +optional Overwrite *bool `json:"overwrite,omitempty"` - // TableType specifies the tupe of partition table. The following are supported: + // tableType specifies the tupe of partition table. The following are supported: // 'mbr': default and setups a MS-DOS partition table // 'gpt': setups a GPT partition table // +optional @@ -311,24 +311,24 @@ type Partition struct { // Filesystem defines the file systems to be created. type Filesystem struct { - // Device specifies the device name + // device specifies the device name Device string `json:"device"` - // Filesystem specifies the file system type. + // filesystem specifies the file system type. Filesystem string `json:"filesystem"` - // Label specifies the file system label to be used. If set to None, no label is used. + // label specifies the file system label to be used. If set to None, no label is used. Label string `json:"label"` - // Partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number. + // partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and , where NUM is the actual partition number. // +optional Partition *string `json:"partition,omitempty"` - // Overwrite defines whether or not to overwrite any existing filesystem. + // overwrite defines whether or not to overwrite any existing filesystem. // If true, any pre-existing file system will be destroyed. Use with Caution. // +optional Overwrite *bool `json:"overwrite,omitempty"` - // ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . + // replaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . // NOTE: unless you define a label, this requires the use of the 'any' partition directive. // +optional ReplaceFS *string `json:"replaceFS,omitempty"` - // ExtraOpts defined extra options to add to the command for creating the file system. + // extraOpts defined extra options to add to the command for creating the file system. // +optional ExtraOpts []string `json:"extraOpts,omitempty"` } diff --git a/internal/apis/controlplane/kubeadm/v1alpha3/kubeadm_control_plane_types.go b/internal/apis/controlplane/kubeadm/v1alpha3/kubeadm_control_plane_types.go index 732f31f9e380..4e8e27d645d8 100644 --- a/internal/apis/controlplane/kubeadm/v1alpha3/kubeadm_control_plane_types.go +++ b/internal/apis/controlplane/kubeadm/v1alpha3/kubeadm_control_plane_types.go @@ -65,24 +65,24 @@ type KubeadmControlPlaneSpec struct { // +optional Replicas *int32 `json:"replicas,omitempty"` - // Version defines the desired Kubernetes version. + // version defines the desired Kubernetes version. Version string `json:"version"` - // InfrastructureTemplate is a required reference to a custom resource + // infrastructureTemplate is a required reference to a custom resource // offered by an infrastructure provider. InfrastructureTemplate corev1.ObjectReference `json:"infrastructureTemplate"` - // KubeadmConfigSpec is a KubeadmConfigSpec + // kubeadmConfigSpec is a KubeadmConfigSpec // to use for initializing and joining machines to the control plane. KubeadmConfigSpec bootstrapv1alpha3.KubeadmConfigSpec `json:"kubeadmConfigSpec"` - // UpgradeAfter is a field to indicate an upgrade should be performed + // upgradeAfter is a field to indicate an upgrade should be performed // after the specified time even if no changes have been made to the // KubeadmControlPlane // +optional UpgradeAfter *metav1.Time `json:"upgradeAfter,omitempty"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // +optional @@ -97,7 +97,7 @@ type KubeadmControlPlaneSpec struct { // RolloutStrategy describes how to replace existing machines // with new ones. type RolloutStrategy struct { - // Type of rollout. Currently the only supported strategy is + // type of rollout. Currently the only supported strategy is // "RollingUpdate". // Default is RollingUpdate. // +optional @@ -123,7 +123,7 @@ type RollingUpdate struct { // KubeadmControlPlaneStatus defines the observed state of KubeadmControlPlane. type KubeadmControlPlaneStatus struct { - // Selector is the label selector in string format to avoid introspection + // selector is the label selector in string format to avoid introspection // by clients, and is used to provide the CRD-based integration for the // scale subresource and additional integrations for things like kubectl // describe.. The string will be in the same format as the query-param syntax. @@ -153,17 +153,17 @@ type KubeadmControlPlaneStatus struct { // +optional UnavailableReplicas int32 `json:"unavailableReplicas,omitempty"` - // Initialized denotes whether or not the control plane has the + // initialized denotes whether or not the control plane has the // uploaded kubeadm-config configmap. // +optional Initialized bool `json:"initialized"` - // Ready denotes that the KubeadmControlPlane API Server is ready to + // ready denotes that the KubeadmControlPlane API Server is ready to // receive requests. // +optional Ready bool `json:"ready"` - // FailureReason indicates that there is a terminal problem reconciling the + // failureReason indicates that there is a terminal problem reconciling the // state, and will be set to a token value suitable for // programmatic interpretation. // +optional @@ -174,11 +174,11 @@ type KubeadmControlPlaneStatus struct { // +optional FailureMessage *string `json:"failureMessage,omitempty"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions defines current service state of the KubeadmControlPlane. + // conditions defines current service state of the KubeadmControlPlane. // +optional Conditions clusterv1alpha3.Conditions `json:"conditions,omitempty"` } diff --git a/internal/apis/controlplane/kubeadm/v1alpha4/kubeadm_control_plane_types.go b/internal/apis/controlplane/kubeadm/v1alpha4/kubeadm_control_plane_types.go index 2ef88217634b..571043a96677 100644 --- a/internal/apis/controlplane/kubeadm/v1alpha4/kubeadm_control_plane_types.go +++ b/internal/apis/controlplane/kubeadm/v1alpha4/kubeadm_control_plane_types.go @@ -59,18 +59,18 @@ type KubeadmControlPlaneSpec struct { // +optional Replicas *int32 `json:"replicas,omitempty"` - // Version defines the desired Kubernetes version. + // version defines the desired Kubernetes version. Version string `json:"version"` - // MachineTemplate contains information about how machines + // machineTemplate contains information about how machines // should be shaped when creating or updating a control plane. MachineTemplate KubeadmControlPlaneMachineTemplate `json:"machineTemplate"` - // KubeadmConfigSpec is a KubeadmConfigSpec + // kubeadmConfigSpec is a KubeadmConfigSpec // to use for initializing and joining machines to the control plane. KubeadmConfigSpec bootstrapv1alpha4.KubeadmConfigSpec `json:"kubeadmConfigSpec"` - // RolloutAfter is a field to indicate a rollout should be performed + // rolloutAfter is a field to indicate a rollout should be performed // after the specified time even if no changes have been made to the // KubeadmControlPlane. // @@ -92,11 +92,11 @@ type KubeadmControlPlaneMachineTemplate struct { // +optional ObjectMeta clusterv1alpha4.ObjectMeta `json:"metadata,omitempty"` - // InfrastructureRef is a required reference to a custom resource + // infrastructureRef is a required reference to a custom resource // offered by an infrastructure provider. InfrastructureRef corev1.ObjectReference `json:"infrastructureRef"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // +optional @@ -106,7 +106,7 @@ type KubeadmControlPlaneMachineTemplate struct { // RolloutStrategy describes how to replace existing machines // with new ones. type RolloutStrategy struct { - // Type of rollout. Currently the only supported strategy is + // type of rollout. Currently the only supported strategy is // "RollingUpdate". // Default is RollingUpdate. // +optional @@ -132,7 +132,7 @@ type RollingUpdate struct { // KubeadmControlPlaneStatus defines the observed state of KubeadmControlPlane. type KubeadmControlPlaneStatus struct { - // Selector is the label selector in string format to avoid introspection + // selector is the label selector in string format to avoid introspection // by clients, and is used to provide the CRD-based integration for the // scale subresource and additional integrations for things like kubectl // describe.. The string will be in the same format as the query-param syntax. @@ -145,7 +145,7 @@ type KubeadmControlPlaneStatus struct { // +optional Replicas int32 `json:"replicas,omitempty"` - // Version represents the minimum Kubernetes version for the control plane machines + // version represents the minimum Kubernetes version for the control plane machines // in the cluster. // +optional Version *string `json:"version,omitempty"` @@ -167,17 +167,17 @@ type KubeadmControlPlaneStatus struct { // +optional UnavailableReplicas int32 `json:"unavailableReplicas,omitempty"` - // Initialized denotes whether or not the control plane has the + // initialized denotes whether or not the control plane has the // uploaded kubeadm-config configmap. // +optional Initialized bool `json:"initialized"` - // Ready denotes that the KubeadmControlPlane API Server is ready to + // ready denotes that the KubeadmControlPlane API Server is ready to // receive requests. // +optional Ready bool `json:"ready"` - // FailureReason indicates that there is a terminal problem reconciling the + // failureReason indicates that there is a terminal problem reconciling the // state, and will be set to a token value suitable for // programmatic interpretation. // +optional @@ -188,11 +188,11 @@ type KubeadmControlPlaneStatus struct { // +optional FailureMessage *string `json:"failureMessage,omitempty"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions defines current service state of the KubeadmControlPlane. + // conditions defines current service state of the KubeadmControlPlane. // +optional Conditions clusterv1alpha4.Conditions `json:"conditions,omitempty"` } diff --git a/internal/apis/core/exp/addons/v1alpha3/clusterresourceset_types.go b/internal/apis/core/exp/addons/v1alpha3/clusterresourceset_types.go index 81d270eeb204..d28a33c2beae 100644 --- a/internal/apis/core/exp/addons/v1alpha3/clusterresourceset_types.go +++ b/internal/apis/core/exp/addons/v1alpha3/clusterresourceset_types.go @@ -40,10 +40,10 @@ type ClusterResourceSetSpec struct { // It must match the Cluster labels. This field is immutable. ClusterSelector metav1.LabelSelector `json:"clusterSelector"` - // Resources is a list of Secrets/ConfigMaps where each contains 1 or more resources to be applied to remote clusters. + // resources is a list of Secrets/ConfigMaps where each contains 1 or more resources to be applied to remote clusters. Resources []ResourceRef `json:"resources,omitempty"` - // Strategy is the strategy to be used during applying resources. Defaults to ApplyOnce. This field is immutable. + // strategy is the strategy to be used during applying resources. Defaults to ApplyOnce. This field is immutable. // +kubebuilder:validation:Enum=ApplyOnce // +optional Strategy string `json:"strategy,omitempty"` @@ -62,11 +62,11 @@ const ( // ResourceRef specifies a resource. type ResourceRef struct { - // Name of the resource that is in the same namespace with ClusterResourceSet object. + // name of the resource that is in the same namespace with ClusterResourceSet object. // +kubebuilder:validation:MinLength=1 Name string `json:"name"` - // Kind of the resource. Supported kinds are: Secrets and ConfigMaps. + // kind of the resource. Supported kinds are: Secrets and ConfigMaps. // +kubebuilder:validation:Enum=Secret;ConfigMap Kind string `json:"kind"` } @@ -89,11 +89,11 @@ func (c *ClusterResourceSetSpec) SetTypedStrategy(p ClusterResourceSetStrategy) // ClusterResourceSetStatus defines the observed state of ClusterResourceSet. type ClusterResourceSetStatus struct { - // ObservedGeneration reflects the generation of the most recently observed ClusterResourceSet. + // observedGeneration reflects the generation of the most recently observed ClusterResourceSet. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions defines current state of the ClusterResourceSet. + // conditions defines current state of the ClusterResourceSet. // +optional Conditions clusterv1alpha3.Conditions `json:"conditions,omitempty"` } diff --git a/internal/apis/core/exp/addons/v1alpha3/clusterresourcesetbinding_types.go b/internal/apis/core/exp/addons/v1alpha3/clusterresourcesetbinding_types.go index 101c2cf11893..78c50be68e11 100644 --- a/internal/apis/core/exp/addons/v1alpha3/clusterresourcesetbinding_types.go +++ b/internal/apis/core/exp/addons/v1alpha3/clusterresourcesetbinding_types.go @@ -29,15 +29,15 @@ type ResourceBinding struct { // ResourceRef specifies a resource. ResourceRef `json:",inline"` - // Hash is the hash of a resource's data. This can be used to decide if a resource is changed. + // hash is the hash of a resource's data. This can be used to decide if a resource is changed. // For "ApplyOnce" ClusterResourceSet.spec.strategy, this is no-op as that strategy does not act on change. Hash string `json:"hash,omitempty"` - // LastAppliedTime identifies when this resource was last applied to the cluster. + // lastAppliedTime identifies when this resource was last applied to the cluster. // +optional LastAppliedTime *metav1.Time `json:"lastAppliedTime,omitempty"` - // Applied is to track if a resource is applied to the cluster or not. + // applied is to track if a resource is applied to the cluster or not. Applied bool `json:"applied"` } @@ -45,10 +45,10 @@ type ResourceBinding struct { // ResourceSetBinding keeps info on all of the resources in a ClusterResourceSet. type ResourceSetBinding struct { - // ClusterResourceSetName is the name of the ClusterResourceSet that is applied to the owner cluster of the binding. + // clusterResourceSetName is the name of the ClusterResourceSet that is applied to the owner cluster of the binding. ClusterResourceSetName string `json:"clusterResourceSetName"` - // Resources is a list of resources that the ClusterResourceSet has. + // resources is a list of resources that the ClusterResourceSet has. Resources []ResourceBinding `json:"resources,omitempty"` } @@ -119,7 +119,7 @@ type ClusterResourceSetBinding struct { // ClusterResourceSetBindingSpec defines the desired state of ClusterResourceSetBinding. type ClusterResourceSetBindingSpec struct { - // Bindings is a list of ClusterResourceSets and their resources. + // bindings is a list of ClusterResourceSets and their resources. Bindings []*ResourceSetBinding `json:"bindings,omitempty"` } diff --git a/internal/apis/core/exp/addons/v1alpha4/clusterresourceset_types.go b/internal/apis/core/exp/addons/v1alpha4/clusterresourceset_types.go index 4b226ab76789..399360fe4387 100644 --- a/internal/apis/core/exp/addons/v1alpha4/clusterresourceset_types.go +++ b/internal/apis/core/exp/addons/v1alpha4/clusterresourceset_types.go @@ -41,10 +41,10 @@ type ClusterResourceSetSpec struct { // Label selector cannot be empty. ClusterSelector metav1.LabelSelector `json:"clusterSelector"` - // Resources is a list of Secrets/ConfigMaps where each contains 1 or more resources to be applied to remote clusters. + // resources is a list of Secrets/ConfigMaps where each contains 1 or more resources to be applied to remote clusters. Resources []ResourceRef `json:"resources,omitempty"` - // Strategy is the strategy to be used during applying resources. Defaults to ApplyOnce. This field is immutable. + // strategy is the strategy to be used during applying resources. Defaults to ApplyOnce. This field is immutable. // +kubebuilder:validation:Enum=ApplyOnce // +optional Strategy string `json:"strategy,omitempty"` @@ -63,11 +63,11 @@ const ( // ResourceRef specifies a resource. type ResourceRef struct { - // Name of the resource that is in the same namespace with ClusterResourceSet object. + // name of the resource that is in the same namespace with ClusterResourceSet object. // +kubebuilder:validation:MinLength=1 Name string `json:"name"` - // Kind of the resource. Supported kinds are: Secrets and ConfigMaps. + // kind of the resource. Supported kinds are: Secrets and ConfigMaps. // +kubebuilder:validation:Enum=Secret;ConfigMap Kind string `json:"kind"` } @@ -90,11 +90,11 @@ func (c *ClusterResourceSetSpec) SetTypedStrategy(p ClusterResourceSetStrategy) // ClusterResourceSetStatus defines the observed state of ClusterResourceSet. type ClusterResourceSetStatus struct { - // ObservedGeneration reflects the generation of the most recently observed ClusterResourceSet. + // observedGeneration reflects the generation of the most recently observed ClusterResourceSet. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions defines current state of the ClusterResourceSet. + // conditions defines current state of the ClusterResourceSet. // +optional Conditions clusterv1alpha4.Conditions `json:"conditions,omitempty"` } diff --git a/internal/apis/core/exp/addons/v1alpha4/clusterresourcesetbinding_types.go b/internal/apis/core/exp/addons/v1alpha4/clusterresourcesetbinding_types.go index 5cd2e123d0ea..3b48a98a7c80 100644 --- a/internal/apis/core/exp/addons/v1alpha4/clusterresourcesetbinding_types.go +++ b/internal/apis/core/exp/addons/v1alpha4/clusterresourcesetbinding_types.go @@ -29,15 +29,15 @@ type ResourceBinding struct { // ResourceRef specifies a resource. ResourceRef `json:",inline"` - // Hash is the hash of a resource's data. This can be used to decide if a resource is changed. + // hash is the hash of a resource's data. This can be used to decide if a resource is changed. // For "ApplyOnce" ClusterResourceSet.spec.strategy, this is no-op as that strategy does not act on change. Hash string `json:"hash,omitempty"` - // LastAppliedTime identifies when this resource was last applied to the cluster. + // lastAppliedTime identifies when this resource was last applied to the cluster. // +optional LastAppliedTime *metav1.Time `json:"lastAppliedTime,omitempty"` - // Applied is to track if a resource is applied to the cluster or not. + // applied is to track if a resource is applied to the cluster or not. Applied bool `json:"applied"` } @@ -45,10 +45,10 @@ type ResourceBinding struct { // ResourceSetBinding keeps info on all of the resources in a ClusterResourceSet. type ResourceSetBinding struct { - // ClusterResourceSetName is the name of the ClusterResourceSet that is applied to the owner cluster of the binding. + // clusterResourceSetName is the name of the ClusterResourceSet that is applied to the owner cluster of the binding. ClusterResourceSetName string `json:"clusterResourceSetName"` - // Resources is a list of resources that the ClusterResourceSet has. + // resources is a list of resources that the ClusterResourceSet has. Resources []ResourceBinding `json:"resources,omitempty"` } @@ -120,7 +120,7 @@ type ClusterResourceSetBinding struct { // ClusterResourceSetBindingSpec defines the desired state of ClusterResourceSetBinding. type ClusterResourceSetBindingSpec struct { - // Bindings is a list of ClusterResourceSets and their resources. + // bindings is a list of ClusterResourceSets and their resources. Bindings []*ResourceSetBinding `json:"bindings,omitempty"` } diff --git a/internal/apis/core/exp/v1alpha3/machinepool_types.go b/internal/apis/core/exp/v1alpha3/machinepool_types.go index 42ad1ac8952d..c68511e539c4 100644 --- a/internal/apis/core/exp/v1alpha3/machinepool_types.go +++ b/internal/apis/core/exp/v1alpha3/machinepool_types.go @@ -33,7 +33,7 @@ const ( // MachinePoolSpec defines the desired state of MachinePool. type MachinePoolSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` @@ -41,7 +41,7 @@ type MachinePoolSpec struct { // This is a pointer to distinguish between explicit zero and not specified. Replicas *int32 `json:"replicas,omitempty"` - // Template describes the machines that will be created. + // template describes the machines that will be created. Template clusterv1alpha3.MachineTemplateSpec `json:"template"` // The deployment strategy to use to replace existing machine instances with @@ -56,12 +56,12 @@ type MachinePoolSpec struct { // +optional MinReadySeconds *int32 `json:"minReadySeconds,omitempty"` - // ProviderIDList are the identification IDs of machine instances provided by the provider. + // providerIDList are the identification IDs of machine instances provided by the provider. // This field must match the provider IDs as seen on the node objects corresponding to a machine pool's machine instances. // +optional ProviderIDList []string `json:"providerIDList,omitempty"` - // FailureDomains is the list of failure domains this MachinePool should be attached to. + // failureDomains is the list of failure domains this MachinePool should be attached to. FailureDomains []string `json:"failureDomains,omitempty"` } @@ -71,11 +71,11 @@ type MachinePoolSpec struct { // MachinePoolStatus defines the observed state of MachinePool. type MachinePoolStatus struct { - // NodeRefs will point to the corresponding Nodes if it they exist. + // nodeRefs will point to the corresponding Nodes if it they exist. // +optional NodeRefs []corev1.ObjectReference `json:"nodeRefs,omitempty"` - // Replicas is the most recently observed number of replicas. + // replicas is the most recently observed number of replicas. // +optional Replicas int32 `json:"replicas"` @@ -95,34 +95,34 @@ type MachinePoolStatus struct { // +optional UnavailableReplicas int32 `json:"unavailableReplicas,omitempty"` - // FailureReason indicates that there is a problem reconciling the state, and + // failureReason indicates that there is a problem reconciling the state, and // will be set to a token value suitable for programmatic interpretation. // +optional FailureReason *capierrors.MachinePoolStatusFailure `json:"failureReason,omitempty"` - // FailureMessage indicates that there is a problem reconciling the state, + // failureMessage indicates that there is a 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 cluster actuation. + // phase represents the current phase of cluster actuation. // E.g. Pending, Running, Terminating, Failed etc. // +optional Phase string `json:"phase,omitempty"` - // BootstrapReady is the state of the bootstrap provider. + // bootstrapReady is the state of the bootstrap provider. // +optional BootstrapReady bool `json:"bootstrapReady"` - // InfrastructureReady is the state of the infrastructure provider. + // infrastructureReady is the state of the infrastructure provider. // +optional InfrastructureReady bool `json:"infrastructureReady"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions define the current service state of the MachinePool. + // conditions define the current service state of the MachinePool. // +optional Conditions clusterv1alpha3.Conditions `json:"conditions,omitempty"` } diff --git a/internal/apis/core/exp/v1alpha4/machinepool_types.go b/internal/apis/core/exp/v1alpha4/machinepool_types.go index 06f6d5876fc2..a9fe8cbbb124 100644 --- a/internal/apis/core/exp/v1alpha4/machinepool_types.go +++ b/internal/apis/core/exp/v1alpha4/machinepool_types.go @@ -33,7 +33,7 @@ const ( // MachinePoolSpec defines the desired state of MachinePool. type MachinePoolSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` @@ -41,7 +41,7 @@ type MachinePoolSpec struct { // This is a pointer to distinguish between explicit zero and not specified. Replicas *int32 `json:"replicas,omitempty"` - // Template describes the machines that will be created. + // template describes the machines that will be created. Template clusterv1alpha4.MachineTemplateSpec `json:"template"` // Minimum number of seconds for which a newly created machine instances should @@ -51,12 +51,12 @@ type MachinePoolSpec struct { // +optional MinReadySeconds *int32 `json:"minReadySeconds,omitempty"` - // ProviderIDList are the identification IDs of machine instances provided by the provider. + // providerIDList are the identification IDs of machine instances provided by the provider. // This field must match the provider IDs as seen on the node objects corresponding to a machine pool's machine instances. // +optional ProviderIDList []string `json:"providerIDList,omitempty"` - // FailureDomains is the list of failure domains this MachinePool should be attached to. + // failureDomains is the list of failure domains this MachinePool should be attached to. FailureDomains []string `json:"failureDomains,omitempty"` } @@ -66,11 +66,11 @@ type MachinePoolSpec struct { // MachinePoolStatus defines the observed state of MachinePool. type MachinePoolStatus struct { - // NodeRefs will point to the corresponding Nodes if it they exist. + // nodeRefs will point to the corresponding Nodes if it they exist. // +optional NodeRefs []corev1.ObjectReference `json:"nodeRefs,omitempty"` - // Replicas is the most recently observed number of replicas. + // replicas is the most recently observed number of replicas. // +optional Replicas int32 `json:"replicas"` @@ -90,34 +90,34 @@ type MachinePoolStatus struct { // +optional UnavailableReplicas int32 `json:"unavailableReplicas,omitempty"` - // FailureReason indicates that there is a problem reconciling the state, and + // failureReason indicates that there is a problem reconciling the state, and // will be set to a token value suitable for programmatic interpretation. // +optional FailureReason *capierrors.MachinePoolStatusFailure `json:"failureReason,omitempty"` - // FailureMessage indicates that there is a problem reconciling the state, + // failureMessage indicates that there is a 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 cluster actuation. + // phase represents the current phase of cluster actuation. // E.g. Pending, Running, Terminating, Failed etc. // +optional Phase string `json:"phase,omitempty"` - // BootstrapReady is the state of the bootstrap provider. + // bootstrapReady is the state of the bootstrap provider. // +optional BootstrapReady bool `json:"bootstrapReady"` - // InfrastructureReady is the state of the infrastructure provider. + // infrastructureReady is the state of the infrastructure provider. // +optional InfrastructureReady bool `json:"infrastructureReady"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions define the current service state of the MachinePool. + // conditions define the current service state of the MachinePool. // +optional Conditions clusterv1alpha4.Conditions `json:"conditions,omitempty"` } diff --git a/internal/apis/core/v1alpha3/cluster_types.go b/internal/apis/core/v1alpha3/cluster_types.go index 9e106ce3492e..8fd90e134c9f 100644 --- a/internal/apis/core/v1alpha3/cluster_types.go +++ b/internal/apis/core/v1alpha3/cluster_types.go @@ -38,7 +38,7 @@ const ( // ClusterSpec defines the desired state of Cluster. type ClusterSpec struct { - // Paused can be used to prevent controllers from processing the Cluster and all its associated objects. + // paused can be used to prevent controllers from processing the Cluster and all its associated objects. // +optional Paused bool `json:"paused,omitempty"` @@ -46,16 +46,16 @@ type ClusterSpec struct { // +optional ClusterNetwork *ClusterNetwork `json:"clusterNetwork,omitempty"` - // ControlPlaneEndpoint represents the endpoint used to communicate with the control plane. + // controlPlaneEndpoint represents the endpoint used to communicate with the control plane. // +optional ControlPlaneEndpoint APIEndpoint `json:"controlPlaneEndpoint"` - // ControlPlaneRef is an optional reference to a provider-specific resource that holds + // controlPlaneRef is an optional reference to a provider-specific resource that holds // the details for provisioning the Control Plane for a Cluster. // +optional ControlPlaneRef *corev1.ObjectReference `json:"controlPlaneRef,omitempty"` - // InfrastructureRef is a reference to a provider-specific resource that holds the details + // infrastructureRef is a reference to a provider-specific resource that holds the details // for provisioning infrastructure for a cluster in said provider. // +optional InfrastructureRef *corev1.ObjectReference `json:"infrastructureRef,omitempty"` @@ -68,7 +68,7 @@ type ClusterSpec struct { // ClusterNetwork specifies the different networking // parameters for a cluster. type ClusterNetwork struct { - // APIServerPort specifies the port the API Server should bind to. + // apiServerPort specifies the port the API Server should bind to. // Defaults to 6443. // +optional APIServerPort *int32 `json:"apiServerPort,omitempty"` @@ -108,42 +108,42 @@ func (n *NetworkRanges) String() string { // ClusterStatus defines the observed state of Cluster. type ClusterStatus struct { - // FailureDomains is a slice of failure domain objects synced from the infrastructure provider. + // failureDomains is a slice of failure domain objects synced from the infrastructure provider. FailureDomains FailureDomains `json:"failureDomains,omitempty"` - // FailureReason indicates that there is a fatal problem reconciling the + // failureReason indicates that there is a fatal problem reconciling the // state, and will be set to a token value suitable for // programmatic interpretation. // +optional FailureReason *capierrors.ClusterStatusError `json:"failureReason,omitempty"` - // FailureMessage indicates that there is a fatal problem reconciling the + // failureMessage indicates that there is a fatal 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 cluster actuation. + // phase represents the current phase of cluster actuation. // E.g. Pending, Running, Terminating, Failed etc. // +optional Phase string `json:"phase,omitempty"` - // InfrastructureReady is the state of the infrastructure provider. + // infrastructureReady is the state of the infrastructure provider. // +optional InfrastructureReady bool `json:"infrastructureReady"` - // ControlPlaneInitialized defines if the control plane has been initialized. + // controlPlaneInitialized defines if the control plane has been initialized. // +optional ControlPlaneInitialized bool `json:"controlPlaneInitialized"` - // ControlPlaneReady defines if the control plane is ready. + // controlPlaneReady defines if the control plane is ready. // +optional ControlPlaneReady bool `json:"controlPlaneReady,omitempty"` - // Conditions defines current service state of the cluster. + // conditions defines current service state of the cluster. // +optional Conditions Conditions `json:"conditions,omitempty"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` } @@ -265,11 +265,11 @@ func (in FailureDomains) GetIDs() []*string { // FailureDomainSpec is the Schema for Cluster API failure domains. // It allows controllers to understand how many failure domains a cluster can optionally span across. type FailureDomainSpec struct { - // ControlPlane determines if this failure domain is suitable for use by control plane machines. + // controlPlane determines if this failure domain is suitable for use by control plane machines. // +optional ControlPlane bool `json:"controlPlane"` - // Attributes is a free form map of attributes an infrastructure provider might use or require. + // attributes is a free form map of attributes an infrastructure provider might use or require. // +optional Attributes map[string]string `json:"attributes,omitempty"` } diff --git a/internal/apis/core/v1alpha3/common_types.go b/internal/apis/core/v1alpha3/common_types.go index 58ef4a74e2cf..3ee944bb52e7 100644 --- a/internal/apis/core/v1alpha3/common_types.go +++ b/internal/apis/core/v1alpha3/common_types.go @@ -123,7 +123,7 @@ type MachineAddresses []MachineAddress // In future versions, controller-tools@v2 might allow overriding the type and validation for embedded // types. When that happens, this hack should be revisited. type ObjectMeta struct { - // Name must be unique within a namespace. Is required when creating resources, although + // name must be unique within a namespace. Is required when creating resources, although // some resources may allow a client to request the generation of an appropriate name // automatically. Name is primarily intended for creation idempotence and configuration // definition. @@ -134,7 +134,7 @@ type ObjectMeta struct { // Deprecated: This field has no function and is going to be removed in a next release. Name string `json:"name,omitempty"` - // GenerateName is an optional prefix, used by the server, to generate a unique + // generateName is an optional prefix, used by the server, to generate a unique // name ONLY IF the Name field has not been provided. // If this field is used, the name returned to the client will be different // than the name passed. This value will also be combined with a unique suffix. @@ -154,7 +154,7 @@ type ObjectMeta struct { // Deprecated: This field has no function and is going to be removed in a next release. GenerateName string `json:"generateName,omitempty"` - // Namespace defines the space within each name must be unique. An empty namespace is + // namespace defines the space within each name must be unique. An empty namespace is // equivalent to the "default" namespace, but "default" is the canonical representation. // Not all objects are required to be scoped to a namespace - the value of this field for // those objects will be empty. @@ -174,7 +174,7 @@ type ObjectMeta struct { // +optional Labels map[string]string `json:"labels,omitempty"` - // Annotations is an unstructured key value map stored with a resource that may be + // annotations is an unstructured key value map stored with a resource that may be // set by external tools to store and retrieve arbitrary metadata. They are not // queryable and should be preserved when modifying objects. // More info: http://kubernetes.io/docs/user-guide/annotations diff --git a/internal/apis/core/v1alpha3/condition_types.go b/internal/apis/core/v1alpha3/condition_types.go index 3a950da84766..b993200f1e47 100644 --- a/internal/apis/core/v1alpha3/condition_types.go +++ b/internal/apis/core/v1alpha3/condition_types.go @@ -53,17 +53,17 @@ type ConditionType string // Condition defines an observation of a Cluster API resource operational state. type Condition struct { - // Type of condition in CamelCase or in foo.example.com/CamelCase. + // 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. + // 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 + // 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 diff --git a/internal/apis/core/v1alpha3/machine_types.go b/internal/apis/core/v1alpha3/machine_types.go index 69b0e1b3053a..7d0a2324d064 100644 --- a/internal/apis/core/v1alpha3/machine_types.go +++ b/internal/apis/core/v1alpha3/machine_types.go @@ -56,24 +56,24 @@ const ( // MachineSpec defines the desired state of Machine. type MachineSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` - // Bootstrap is a reference to a local struct which encapsulates + // bootstrap is a reference to a local struct which encapsulates // fields to configure the Machine’s bootstrapping mechanism. Bootstrap Bootstrap `json:"bootstrap"` - // InfrastructureRef is a required reference to a custom resource + // infrastructureRef is a required reference to a custom resource // offered by an infrastructure provider. InfrastructureRef corev1.ObjectReference `json:"infrastructureRef"` - // Version defines the desired Kubernetes version. + // version defines the desired Kubernetes version. // This field is meant to be optionally used by bootstrap providers. // +optional Version *string `json:"version,omitempty"` - // ProviderID is the identification ID of the machine provided by the provider. + // providerID is the identification ID of the machine provided by the provider. // This field must match the provider ID as seen on the node object corresponding to this machine. // This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler // with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -86,12 +86,12 @@ type MachineSpec struct { // +optional ProviderID *string `json:"providerID,omitempty"` - // FailureDomain is the failure domain the machine will be created in. + // failureDomain is the failure domain the machine will be created in. // Must match a key in the FailureDomains map stored on the cluster object. // +optional FailureDomain *string `json:"failureDomain,omitempty"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // +optional @@ -104,22 +104,22 @@ type MachineSpec struct { // MachineStatus defines the observed state of Machine. type MachineStatus struct { - // NodeRef will point to the corresponding Node if it exists. + // nodeRef will point to the corresponding Node if it exists. // +optional NodeRef *corev1.ObjectReference `json:"nodeRef,omitempty"` - // LastUpdated identifies when the phase of the Machine last transitioned. + // lastUpdated identifies when the phase of the Machine last transitioned. // +optional LastUpdated *metav1.Time `json:"lastUpdated,omitempty"` - // Version specifies the current version of Kubernetes running + // version specifies the current version of Kubernetes running // on the corresponding Node. This is meant to be a means of bubbling // up status from the Node to the Machine. // It is entirely optional, but useful for end-user UX if it’s present. // +optional Version *string `json:"version,omitempty"` - // FailureReason will be set in the event that there is a terminal problem + // failureReason will be set in the event that there is a terminal problem // reconciling the Machine and will contain a succinct value suitable // for machine interpretation. // @@ -138,7 +138,7 @@ type MachineStatus struct { // +optional FailureReason *capierrors.MachineStatusError `json:"failureReason,omitempty"` - // FailureMessage will be set in the event that there is a terminal problem + // failureMessage will be set in the event that there is a terminal problem // reconciling the Machine and will contain a more verbose string suitable // for logging and human consumption. // @@ -157,29 +157,29 @@ type MachineStatus struct { // +optional FailureMessage *string `json:"failureMessage,omitempty"` - // Addresses is a list of addresses assigned to the machine. + // addresses is a list of addresses assigned to the machine. // This field is copied from the infrastructure provider reference. // +optional Addresses MachineAddresses `json:"addresses,omitempty"` - // Phase represents the current phase of machine actuation. + // phase represents the current phase of machine actuation. // E.g. Pending, Running, Terminating, Failed etc. // +optional Phase string `json:"phase,omitempty"` - // BootstrapReady is the state of the bootstrap provider. + // bootstrapReady is the state of the bootstrap provider. // +optional BootstrapReady bool `json:"bootstrapReady"` - // InfrastructureReady is the state of the infrastructure provider. + // infrastructureReady is the state of the infrastructure provider. // +optional InfrastructureReady bool `json:"infrastructureReady"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions defines current service state of the Machine. + // conditions defines current service state of the Machine. // +optional Conditions Conditions `json:"conditions,omitempty"` } @@ -213,14 +213,14 @@ func (m *MachineStatus) GetTypedPhase() MachinePhase { // Bootstrap capsulates fields to configure the Machine’s bootstrapping mechanism. type Bootstrap struct { - // ConfigRef is a reference to a bootstrap provider-specific resource + // configRef is a reference to a bootstrap provider-specific resource // that holds configuration details. The reference is optional to // allow users/operators to specify Bootstrap.Data without // the need of a controller. // +optional ConfigRef *corev1.ObjectReference `json:"configRef,omitempty"` - // Data contains the bootstrap data, such as cloud-init details scripts. + // data contains the bootstrap data, such as cloud-init details scripts. // If nil, the Machine should remain in the Pending state. // // Deprecated: Switch to DataSecretName. @@ -228,7 +228,7 @@ type Bootstrap struct { // +optional Data *string `json:"data,omitempty"` - // DataSecretName is the name of the secret that stores the bootstrap data script. + // dataSecretName is the name of the secret that stores the bootstrap data script. // If nil, the Machine should remain in the Pending state. // +optional DataSecretName *string `json:"dataSecretName,omitempty"` diff --git a/internal/apis/core/v1alpha3/machinedeployment_types.go b/internal/apis/core/v1alpha3/machinedeployment_types.go index 4aa959c8d6b0..7efaf05baa1e 100644 --- a/internal/apis/core/v1alpha3/machinedeployment_types.go +++ b/internal/apis/core/v1alpha3/machinedeployment_types.go @@ -47,7 +47,7 @@ const ( // MachineDeploymentSpec defines the desired state of MachineDeployment. type MachineDeploymentSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` @@ -60,7 +60,7 @@ type MachineDeploymentSpec struct { // It must match the machine template's labels. Selector metav1.LabelSelector `json:"selector"` - // Template describes the machines that will be created. + // template describes the machines that will be created. Template MachineTemplateSpec `json:"template"` // The deployment strategy to use to replace existing machines with @@ -100,7 +100,7 @@ type MachineDeploymentSpec struct { // MachineDeploymentStrategy describes how to replace existing machines // with new ones. type MachineDeploymentStrategy struct { - // Type of deployment. Currently the only supported strategy is + // type of deployment. Currently the only supported strategy is // "RollingUpdate". // Default is RollingUpdate. // +optional @@ -160,7 +160,7 @@ type MachineDeploymentStatus struct { // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Selector is the same as the label selector but in the string format to avoid introspection + // selector is the same as the label selector but in the string format to avoid introspection // by clients. The string will be in the same format as the query-param syntax. // More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors // +optional @@ -193,7 +193,7 @@ type MachineDeploymentStatus struct { // +optional UnavailableReplicas int32 `json:"unavailableReplicas,omitempty"` - // Phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown). + // phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown). // +optional Phase string `json:"phase,omitempty"` } diff --git a/internal/apis/core/v1alpha3/machinehealthcheck_types.go b/internal/apis/core/v1alpha3/machinehealthcheck_types.go index 00aba45ab68e..fb94304e8319 100644 --- a/internal/apis/core/v1alpha3/machinehealthcheck_types.go +++ b/internal/apis/core/v1alpha3/machinehealthcheck_types.go @@ -26,14 +26,14 @@ import ( // MachineHealthCheckSpec defines the desired state of MachineHealthCheck. type MachineHealthCheckSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` // Label selector to match machines whose health will be exercised Selector metav1.LabelSelector `json:"selector"` - // UnhealthyConditions contains a list of the conditions that determine + // unhealthyConditions contains a list of the conditions that determine // whether a node is considered unhealthy. The conditions are combined in a // logical OR, i.e. if any of the conditions is met, the node is unhealthy. // @@ -50,7 +50,7 @@ type MachineHealthCheckSpec struct { // +optional NodeStartupTimeout *metav1.Duration `json:"nodeStartupTimeout,omitempty"` - // RemediationTemplate is a reference to a remediation template + // remediationTemplate is a reference to a remediation template // provided by an infrastructure provider. // // This field is completely optional, when filled, the MachineHealthCheck controller @@ -93,20 +93,20 @@ type MachineHealthCheckStatus struct { // +kubebuilder:validation:Minimum=0 CurrentHealthy int32 `json:"currentHealthy,omitempty"` - // RemediationsAllowed is the number of further remediations allowed by this machine health check before + // remediationsAllowed is the number of further remediations allowed by this machine health check before // maxUnhealthy short circuiting will be applied // +kubebuilder:validation:Minimum=0 RemediationsAllowed int32 `json:"remediationsAllowed,omitempty"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Targets shows the current list of machines the machine health check is watching + // targets shows the current list of machines the machine health check is watching // +optional Targets []string `json:"targets,omitempty"` - // Conditions defines current service state of the MachineHealthCheck. + // conditions defines current service state of the MachineHealthCheck. // +optional Conditions Conditions `json:"conditions,omitempty"` } diff --git a/internal/apis/core/v1alpha3/machineset_types.go b/internal/apis/core/v1alpha3/machineset_types.go index 6ce31ca0ec95..431f400969bc 100644 --- a/internal/apis/core/v1alpha3/machineset_types.go +++ b/internal/apis/core/v1alpha3/machineset_types.go @@ -29,33 +29,33 @@ import ( // MachineSetSpec defines the desired state of MachineSet. type MachineSetSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` - // Replicas is the number of desired replicas. + // replicas is the number of desired replicas. // This is a pointer to distinguish between explicit zero and unspecified. // Defaults to 1. // +optional Replicas *int32 `json:"replicas,omitempty"` - // MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. + // minReadySeconds is the minimum number of seconds for which a newly created machine should be ready. // Defaults to 0 (machine will be considered available as soon as it is ready) // +optional MinReadySeconds int32 `json:"minReadySeconds,omitempty"` - // DeletePolicy defines the policy used to identify nodes to delete when downscaling. + // deletePolicy defines the policy used to identify nodes to delete when downscaling. // Defaults to "Random". Valid values are "Random, "Newest", "Oldest" // +kubebuilder:validation:Enum=Random;Newest;Oldest DeletePolicy string `json:"deletePolicy,omitempty"` - // Selector is a label query over machines that should match the replica count. + // selector is a label query over machines that should match the replica count. // Label keys and values that must match in order to be controlled by this MachineSet. // It must match the machine template's labels. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors Selector metav1.LabelSelector `json:"selector"` - // Template is the object that describes the machine that will be created if + // template is the object that describes the machine that will be created if // insufficient replicas are detected. // Object references to custom resources are treated as templates. // +optional @@ -109,13 +109,13 @@ const ( // MachineSetStatus defines the observed state of MachineSet. type MachineSetStatus struct { - // Selector is the same as the label selector but in the string format to avoid introspection + // selector is the same as the label selector but in the string format to avoid introspection // by clients. The string will be in the same format as the query-param syntax. // More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors // +optional Selector string `json:"selector,omitempty"` - // Replicas is the most recently observed number of replicas. + // replicas is the most recently observed number of replicas. // +optional Replicas int32 `json:"replicas,omitempty"` @@ -131,7 +131,7 @@ type MachineSetStatus struct { // +optional AvailableReplicas int32 `json:"availableReplicas,omitempty"` - // ObservedGeneration reflects the generation of the most recently observed MachineSet. + // observedGeneration reflects the generation of the most recently observed MachineSet. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` diff --git a/internal/apis/core/v1alpha4/cluster_types.go b/internal/apis/core/v1alpha4/cluster_types.go index 019329d7c62e..65fdc019afb7 100644 --- a/internal/apis/core/v1alpha4/cluster_types.go +++ b/internal/apis/core/v1alpha4/cluster_types.go @@ -39,7 +39,7 @@ const ( // ClusterSpec defines the desired state of Cluster. type ClusterSpec struct { - // Paused can be used to prevent controllers from processing the Cluster and all its associated objects. + // paused can be used to prevent controllers from processing the Cluster and all its associated objects. // +optional Paused bool `json:"paused,omitempty"` @@ -47,16 +47,16 @@ type ClusterSpec struct { // +optional ClusterNetwork *ClusterNetwork `json:"clusterNetwork,omitempty"` - // ControlPlaneEndpoint represents the endpoint used to communicate with the control plane. + // controlPlaneEndpoint represents the endpoint used to communicate with the control plane. // +optional ControlPlaneEndpoint APIEndpoint `json:"controlPlaneEndpoint"` - // ControlPlaneRef is an optional reference to a provider-specific resource that holds + // controlPlaneRef is an optional reference to a provider-specific resource that holds // the details for provisioning the Control Plane for a Cluster. // +optional ControlPlaneRef *corev1.ObjectReference `json:"controlPlaneRef,omitempty"` - // InfrastructureRef is a reference to a provider-specific resource that holds the details + // infrastructureRef is a reference to a provider-specific resource that holds the details // for provisioning infrastructure for a cluster in said provider. // +optional InfrastructureRef *corev1.ObjectReference `json:"infrastructureRef,omitempty"` @@ -77,16 +77,16 @@ type Topology struct { // The Kubernetes version of the cluster. Version string `json:"version"` - // RolloutAfter performs a rollout of the entire cluster one component at a time, + // rolloutAfter performs a rollout of the entire cluster one component at a time, // control plane first and then machine deployments. // +optional RolloutAfter *metav1.Time `json:"rolloutAfter,omitempty"` - // ControlPlane describes the cluster control plane. + // controlPlane describes the cluster control plane. // +optional ControlPlane ControlPlaneTopology `json:"controlPlane"` - // Workers encapsulates the different constructs that form the worker nodes + // workers encapsulates the different constructs that form the worker nodes // for the cluster. // +optional Workers *WorkersTopology `json:"workers,omitempty"` @@ -94,14 +94,14 @@ type Topology struct { // ControlPlaneTopology specifies the parameters for the control plane nodes in the cluster. type ControlPlaneTopology struct { - // Metadata is the metadata applied to the machines of the ControlPlane. + // metadata is the metadata applied to the machines of the ControlPlane. // At runtime this metadata is merged with the corresponding metadata from the ClusterClass. // // This field is supported if and only if the control plane provider template // referenced in the ClusterClass is Machine based. Metadata ObjectMeta `json:"metadata,omitempty"` - // Replicas is the number of control plane nodes. + // replicas is the number of control plane nodes. // If the value is nil, the ControlPlane object is created without the number of Replicas // and it's assumed that the control plane controller does not implement support for this field. // When specified against a control plane provider that lacks support for this field, this value will be ignored. @@ -111,29 +111,29 @@ type ControlPlaneTopology struct { // WorkersTopology represents the different sets of worker nodes in the cluster. type WorkersTopology struct { - // MachineDeployments is a list of machine deployments in the cluster. + // machineDeployments is a list of machine deployments in the cluster. MachineDeployments []MachineDeploymentTopology `json:"machineDeployments,omitempty"` } // MachineDeploymentTopology specifies the different parameters for a set of worker nodes in the topology. // This set of nodes is managed by a MachineDeployment object whose lifecycle is managed by the Cluster controller. type MachineDeploymentTopology struct { - // Metadata is the metadata applied to the machines of the MachineDeployment. + // metadata is the metadata applied to the machines of the MachineDeployment. // At runtime this metadata is merged with the corresponding metadata from the ClusterClass. Metadata ObjectMeta `json:"metadata,omitempty"` - // Class is the name of the MachineDeploymentClass used to create the set of worker nodes. + // class is the name of the MachineDeploymentClass used to create the set of worker nodes. // This should match one of the deployment classes defined in the ClusterClass object // mentioned in the `Cluster.Spec.Class` field. Class string `json:"class"` - // Name is the unique identifier for this MachineDeploymentTopology. + // name is the unique identifier for this MachineDeploymentTopology. // The value is used with other unique identifiers to create a MachineDeployment's Name // (e.g. cluster's name, etc). In case the name is greater than the allowed maximum length, // the values are hashed together. Name string `json:"name"` - // Replicas is the number of worker nodes belonging to this set. + // replicas is the number of worker nodes belonging to this set. // If the value is nil, the MachineDeployment is created without the number of Replicas (defaulting to zero) // and it's assumed that an external entity (like cluster autoscaler) is responsible for the management // of this value. @@ -148,7 +148,7 @@ type MachineDeploymentTopology struct { // ClusterNetwork specifies the different networking // parameters for a cluster. type ClusterNetwork struct { - // APIServerPort specifies the port the API Server should bind to. + // apiServerPort specifies the port the API Server should bind to. // Defaults to 6443. // +optional APIServerPort *int32 `json:"apiServerPort,omitempty"` @@ -188,38 +188,38 @@ func (n *NetworkRanges) String() string { // ClusterStatus defines the observed state of Cluster. type ClusterStatus struct { - // FailureDomains is a slice of failure domain objects synced from the infrastructure provider. + // failureDomains is a slice of failure domain objects synced from the infrastructure provider. FailureDomains FailureDomains `json:"failureDomains,omitempty"` - // FailureReason indicates that there is a fatal problem reconciling the + // failureReason indicates that there is a fatal problem reconciling the // state, and will be set to a token value suitable for // programmatic interpretation. // +optional FailureReason *capierrors.ClusterStatusError `json:"failureReason,omitempty"` - // FailureMessage indicates that there is a fatal problem reconciling the + // failureMessage indicates that there is a fatal 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 cluster actuation. + // phase represents the current phase of cluster actuation. // E.g. Pending, Running, Terminating, Failed etc. // +optional Phase string `json:"phase,omitempty"` - // InfrastructureReady is the state of the infrastructure provider. + // infrastructureReady is the state of the infrastructure provider. // +optional InfrastructureReady bool `json:"infrastructureReady"` - // ControlPlaneReady defines if the control plane is ready. + // controlPlaneReady defines if the control plane is ready. // +optional ControlPlaneReady bool `json:"controlPlaneReady,omitempty"` - // Conditions defines current service state of the cluster. + // conditions defines current service state of the cluster. // +optional Conditions Conditions `json:"conditions,omitempty"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` } @@ -430,11 +430,11 @@ func (in FailureDomains) GetIDs() []*string { // FailureDomainSpec is the Schema for Cluster API failure domains. // It allows controllers to understand how many failure domains a cluster can optionally span across. type FailureDomainSpec struct { - // ControlPlane determines if this failure domain is suitable for use by control plane machines. + // controlPlane determines if this failure domain is suitable for use by control plane machines. // +optional ControlPlane bool `json:"controlPlane"` - // Attributes is a free form map of attributes an infrastructure provider might use or require. + // attributes is a free form map of attributes an infrastructure provider might use or require. // +optional Attributes map[string]string `json:"attributes,omitempty"` } diff --git a/internal/apis/core/v1alpha4/clusterclass_types.go b/internal/apis/core/v1alpha4/clusterclass_types.go index 62a6413b70a5..ad70f9d33455 100644 --- a/internal/apis/core/v1alpha4/clusterclass_types.go +++ b/internal/apis/core/v1alpha4/clusterclass_types.go @@ -39,18 +39,18 @@ type ClusterClass struct { // ClusterClassSpec describes the desired state of the ClusterClass. type ClusterClassSpec struct { - // Infrastructure is a reference to a provider-specific template that holds + // infrastructure is a reference to a provider-specific template that holds // the details for provisioning infrastructure specific cluster // for the underlying provider. // The underlying provider is responsible for the implementation // of the template to an infrastructure cluster. Infrastructure LocalObjectTemplate `json:"infrastructure,omitempty"` - // ControlPlane is a reference to a local struct that holds the details + // controlPlane is a reference to a local struct that holds the details // for provisioning the Control Plane for the Cluster. ControlPlane ControlPlaneClass `json:"controlPlane,omitempty"` - // Workers describes the worker nodes for the cluster. + // workers describes the worker nodes for the cluster. // It is a collection of node types which can be used to create // the worker nodes of the cluster. // +optional @@ -59,7 +59,7 @@ type ClusterClassSpec struct { // ControlPlaneClass defines the class for the control plane. type ControlPlaneClass struct { - // Metadata is the metadata applied to the machines of the ControlPlane. + // metadata is the metadata applied to the machines of the ControlPlane. // At runtime this metadata is merged with the corresponding metadata from the topology. // // This field is supported if and only if the control plane provider template @@ -81,7 +81,7 @@ type ControlPlaneClass struct { // WorkersClass is a collection of deployment classes. type WorkersClass struct { - // MachineDeployments is a list of machine deployment classes that can be used to create + // machineDeployments is a list of machine deployment classes that can be used to create // a set of worker nodes. MachineDeployments []MachineDeploymentClass `json:"machineDeployments,omitempty"` } @@ -89,12 +89,12 @@ type WorkersClass struct { // MachineDeploymentClass serves as a template to define a set of worker nodes of the cluster // provisioned using the `ClusterClass`. type MachineDeploymentClass struct { - // Class denotes a type of worker node present in the cluster, + // class denotes a type of worker node present in the cluster, // this name MUST be unique within a ClusterClass and can be referenced // in the Cluster to create a managed MachineDeployment. Class string `json:"class"` - // Template is a local struct containing a collection of templates for creation of + // template is a local struct containing a collection of templates for creation of // MachineDeployment objects representing a set of worker nodes. Template MachineDeploymentClassTemplate `json:"template"` } @@ -102,22 +102,22 @@ type MachineDeploymentClass struct { // MachineDeploymentClassTemplate defines how a MachineDeployment generated from a MachineDeploymentClass // should look like. type MachineDeploymentClassTemplate struct { - // Metadata is the metadata applied to the machines of the MachineDeployment. + // metadata is the metadata applied to the machines of the MachineDeployment. // At runtime this metadata is merged with the corresponding metadata from the topology. Metadata ObjectMeta `json:"metadata,omitempty"` - // Bootstrap contains the bootstrap template reference to be used + // bootstrap contains the bootstrap template reference to be used // for the creation of worker Machines. Bootstrap LocalObjectTemplate `json:"bootstrap"` - // Infrastructure contains the infrastructure template reference to be used + // infrastructure contains the infrastructure template reference to be used // for the creation of worker Machines. Infrastructure LocalObjectTemplate `json:"infrastructure"` } // LocalObjectTemplate defines a template for a topology Class. type LocalObjectTemplate struct { - // Ref is a required reference to a custom resource + // ref is a required reference to a custom resource // offered by a provider. Ref *corev1.ObjectReference `json:"ref"` } diff --git a/internal/apis/core/v1alpha4/common_types.go b/internal/apis/core/v1alpha4/common_types.go index 6893544c3eb9..bc17ac1ecfe6 100644 --- a/internal/apis/core/v1alpha4/common_types.go +++ b/internal/apis/core/v1alpha4/common_types.go @@ -182,7 +182,7 @@ type ObjectMeta struct { // +optional Labels map[string]string `json:"labels,omitempty"` - // Annotations is an unstructured key value map stored with a resource that may be + // annotations is an unstructured key value map stored with a resource that may be // set by external tools to store and retrieve arbitrary metadata. They are not // queryable and should be preserved when modifying objects. // More info: http://kubernetes.io/docs/user-guide/annotations diff --git a/internal/apis/core/v1alpha4/condition_types.go b/internal/apis/core/v1alpha4/condition_types.go index 5ff2ffcc0a2a..910bb42ba859 100644 --- a/internal/apis/core/v1alpha4/condition_types.go +++ b/internal/apis/core/v1alpha4/condition_types.go @@ -53,17 +53,17 @@ type ConditionType string // Condition defines an observation of a Cluster API resource operational state. type Condition struct { - // Type of condition in CamelCase or in foo.example.com/CamelCase. + // 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. + // 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 + // 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 diff --git a/internal/apis/core/v1alpha4/machine_types.go b/internal/apis/core/v1alpha4/machine_types.go index 6c9c7875cf74..ef74d2c71036 100644 --- a/internal/apis/core/v1alpha4/machine_types.go +++ b/internal/apis/core/v1alpha4/machine_types.go @@ -56,24 +56,24 @@ const ( // MachineSpec defines the desired state of Machine. type MachineSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` - // Bootstrap is a reference to a local struct which encapsulates + // bootstrap is a reference to a local struct which encapsulates // fields to configure the Machine’s bootstrapping mechanism. Bootstrap Bootstrap `json:"bootstrap"` - // InfrastructureRef is a required reference to a custom resource + // infrastructureRef is a required reference to a custom resource // offered by an infrastructure provider. InfrastructureRef corev1.ObjectReference `json:"infrastructureRef"` - // Version defines the desired Kubernetes version. + // version defines the desired Kubernetes version. // This field is meant to be optionally used by bootstrap providers. // +optional Version *string `json:"version,omitempty"` - // ProviderID is the identification ID of the machine provided by the provider. + // providerID is the identification ID of the machine provided by the provider. // This field must match the provider ID as seen on the node object corresponding to this machine. // This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler // with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out @@ -86,12 +86,12 @@ type MachineSpec struct { // +optional ProviderID *string `json:"providerID,omitempty"` - // FailureDomain is the failure domain the machine will be created in. + // failureDomain is the failure domain the machine will be created in. // Must match a key in the FailureDomains map stored on the cluster object. // +optional FailureDomain *string `json:"failureDomain,omitempty"` - // NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. + // nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. // The default value is 0, meaning that the node can be drained without any time limitations. // NOTE: NodeDrainTimeout is different from `kubectl drain --timeout` // +optional @@ -104,27 +104,27 @@ type MachineSpec struct { // MachineStatus defines the observed state of Machine. type MachineStatus struct { - // NodeRef will point to the corresponding Node if it exists. + // nodeRef will point to the corresponding Node if it exists. // +optional NodeRef *corev1.ObjectReference `json:"nodeRef,omitempty"` - // NodeInfo is a set of ids/uuids to uniquely identify the node. + // nodeInfo is a set of ids/uuids to uniquely identify the node. // More info: https://kubernetes.io/docs/concepts/nodes/node/#info // +optional NodeInfo *corev1.NodeSystemInfo `json:"nodeInfo,omitempty"` - // LastUpdated identifies when the phase of the Machine last transitioned. + // lastUpdated identifies when the phase of the Machine last transitioned. // +optional LastUpdated *metav1.Time `json:"lastUpdated,omitempty"` - // Version specifies the current version of Kubernetes running + // version specifies the current version of Kubernetes running // on the corresponding Node. This is meant to be a means of bubbling // up status from the Node to the Machine. // It is entirely optional, but useful for end-user UX if it’s present. // +optional Version *string `json:"version,omitempty"` - // FailureReason will be set in the event that there is a terminal problem + // failureReason will be set in the event that there is a terminal problem // reconciling the Machine and will contain a succinct value suitable // for machine interpretation. // @@ -143,7 +143,7 @@ type MachineStatus struct { // +optional FailureReason *capierrors.MachineStatusError `json:"failureReason,omitempty"` - // FailureMessage will be set in the event that there is a terminal problem + // failureMessage will be set in the event that there is a terminal problem // reconciling the Machine and will contain a more verbose string suitable // for logging and human consumption. // @@ -162,29 +162,29 @@ type MachineStatus struct { // +optional FailureMessage *string `json:"failureMessage,omitempty"` - // Addresses is a list of addresses assigned to the machine. + // addresses is a list of addresses assigned to the machine. // This field is copied from the infrastructure provider reference. // +optional Addresses MachineAddresses `json:"addresses,omitempty"` - // Phase represents the current phase of machine actuation. + // phase represents the current phase of machine actuation. // E.g. Pending, Running, Terminating, Failed etc. // +optional Phase string `json:"phase,omitempty"` - // BootstrapReady is the state of the bootstrap provider. + // bootstrapReady is the state of the bootstrap provider. // +optional BootstrapReady bool `json:"bootstrapReady"` - // InfrastructureReady is the state of the infrastructure provider. + // infrastructureReady is the state of the infrastructure provider. // +optional InfrastructureReady bool `json:"infrastructureReady"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Conditions defines current service state of the Machine. + // conditions defines current service state of the Machine. // +optional Conditions Conditions `json:"conditions,omitempty"` } @@ -218,14 +218,14 @@ func (m *MachineStatus) GetTypedPhase() MachinePhase { // Bootstrap encapsulates fields to configure the Machine’s bootstrapping mechanism. type Bootstrap struct { - // ConfigRef is a reference to a bootstrap provider-specific resource + // configRef is a reference to a bootstrap provider-specific resource // that holds configuration details. The reference is optional to // allow users/operators to specify Bootstrap.DataSecretName without // the need of a controller. // +optional ConfigRef *corev1.ObjectReference `json:"configRef,omitempty"` - // DataSecretName is the name of the secret that stores the bootstrap data script. + // dataSecretName is the name of the secret that stores the bootstrap data script. // If nil, the Machine should remain in the Pending state. // +optional DataSecretName *string `json:"dataSecretName,omitempty"` diff --git a/internal/apis/core/v1alpha4/machinedeployment_types.go b/internal/apis/core/v1alpha4/machinedeployment_types.go index dd71006fe24d..38da6c2d9881 100644 --- a/internal/apis/core/v1alpha4/machinedeployment_types.go +++ b/internal/apis/core/v1alpha4/machinedeployment_types.go @@ -63,7 +63,7 @@ const ( // MachineDeploymentSpec defines the desired state of MachineDeployment. type MachineDeploymentSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` @@ -78,7 +78,7 @@ type MachineDeploymentSpec struct { // It must match the machine template's labels. Selector metav1.LabelSelector `json:"selector"` - // Template describes the machines that will be created. + // template describes the machines that will be created. Template MachineTemplateSpec `json:"template"` // The deployment strategy to use to replace existing machines with @@ -118,7 +118,7 @@ type MachineDeploymentSpec struct { // MachineDeploymentStrategy describes how to replace existing machines // with new ones. type MachineDeploymentStrategy struct { - // Type of deployment. + // type of deployment. // Default is RollingUpdate. // +kubebuilder:validation:Enum=RollingUpdate;OnDelete // +optional @@ -167,7 +167,7 @@ type MachineRollingUpdateDeployment struct { // +optional MaxSurge *intstr.IntOrString `json:"maxSurge,omitempty"` - // DeletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. + // deletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. // Valid values are "Random, "Newest", "Oldest" // When no value is supplied, the default DeletePolicy of MachineSet is used // +kubebuilder:validation:Enum=Random;Newest;Oldest @@ -185,7 +185,7 @@ type MachineDeploymentStatus struct { // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Selector is the same as the label selector but in the string format to avoid introspection + // selector is the same as the label selector but in the string format to avoid introspection // by clients. The string will be in the same format as the query-param syntax. // More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors // +optional @@ -218,11 +218,11 @@ type MachineDeploymentStatus struct { // +optional UnavailableReplicas int32 `json:"unavailableReplicas,omitempty"` - // Phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown). + // phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown). // +optional Phase string `json:"phase,omitempty"` - // Conditions defines current service state of the MachineDeployment. + // conditions defines current service state of the MachineDeployment. // +optional Conditions Conditions `json:"conditions,omitempty"` } diff --git a/internal/apis/core/v1alpha4/machinehealthcheck_types.go b/internal/apis/core/v1alpha4/machinehealthcheck_types.go index 2933768ca88f..8695b2ceeeff 100644 --- a/internal/apis/core/v1alpha4/machinehealthcheck_types.go +++ b/internal/apis/core/v1alpha4/machinehealthcheck_types.go @@ -26,14 +26,14 @@ import ( // MachineHealthCheckSpec defines the desired state of MachineHealthCheck. type MachineHealthCheckSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` // Label selector to match machines whose health will be exercised Selector metav1.LabelSelector `json:"selector"` - // UnhealthyConditions contains a list of the conditions that determine + // unhealthyConditions contains a list of the conditions that determine // whether a node is considered unhealthy. The conditions are combined in a // logical OR, i.e. if any of the conditions is met, the node is unhealthy. // @@ -61,7 +61,7 @@ type MachineHealthCheckSpec struct { // +optional NodeStartupTimeout *metav1.Duration `json:"nodeStartupTimeout,omitempty"` - // RemediationTemplate is a reference to a remediation template + // remediationTemplate is a reference to a remediation template // provided by an infrastructure provider. // // This field is completely optional, when filled, the MachineHealthCheck controller @@ -104,20 +104,20 @@ type MachineHealthCheckStatus struct { // +kubebuilder:validation:Minimum=0 CurrentHealthy int32 `json:"currentHealthy,omitempty"` - // RemediationsAllowed is the number of further remediations allowed by this machine health check before + // remediationsAllowed is the number of further remediations allowed by this machine health check before // maxUnhealthy short circuiting will be applied // +kubebuilder:validation:Minimum=0 RemediationsAllowed int32 `json:"remediationsAllowed,omitempty"` - // ObservedGeneration is the latest generation observed by the controller. + // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Targets shows the current list of machines the machine health check is watching + // targets shows the current list of machines the machine health check is watching // +optional Targets []string `json:"targets,omitempty"` - // Conditions defines current service state of the MachineHealthCheck. + // conditions defines current service state of the MachineHealthCheck. // +optional Conditions Conditions `json:"conditions,omitempty"` } diff --git a/internal/apis/core/v1alpha4/machineset_types.go b/internal/apis/core/v1alpha4/machineset_types.go index 59c2bb7a106c..70a81a041f09 100644 --- a/internal/apis/core/v1alpha4/machineset_types.go +++ b/internal/apis/core/v1alpha4/machineset_types.go @@ -35,34 +35,34 @@ const ( // MachineSetSpec defines the desired state of MachineSet. type MachineSetSpec struct { - // ClusterName is the name of the Cluster this object belongs to. + // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` - // Replicas is the number of desired replicas. + // replicas is the number of desired replicas. // This is a pointer to distinguish between explicit zero and unspecified. // Defaults to 1. // +optional // +kubebuilder:default=1 Replicas *int32 `json:"replicas,omitempty"` - // MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. + // minReadySeconds is the minimum number of seconds for which a newly created machine should be ready. // Defaults to 0 (machine will be considered available as soon as it is ready) // +optional MinReadySeconds int32 `json:"minReadySeconds,omitempty"` - // DeletePolicy defines the policy used to identify nodes to delete when downscaling. + // deletePolicy defines the policy used to identify nodes to delete when downscaling. // Defaults to "Random". Valid values are "Random, "Newest", "Oldest" // +kubebuilder:validation:Enum=Random;Newest;Oldest DeletePolicy string `json:"deletePolicy,omitempty"` - // Selector is a label query over machines that should match the replica count. + // selector is a label query over machines that should match the replica count. // Label keys and values that must match in order to be controlled by this MachineSet. // It must match the machine template's labels. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors Selector metav1.LabelSelector `json:"selector"` - // Template is the object that describes the machine that will be created if + // template is the object that describes the machine that will be created if // insufficient replicas are detected. // Object references to custom resources are treated as templates. // +optional @@ -116,13 +116,13 @@ const ( // MachineSetStatus defines the observed state of MachineSet. type MachineSetStatus struct { - // Selector is the same as the label selector but in the string format to avoid introspection + // selector is the same as the label selector but in the string format to avoid introspection // by clients. The string will be in the same format as the query-param syntax. // More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors // +optional Selector string `json:"selector,omitempty"` - // Replicas is the most recently observed number of replicas. + // replicas is the most recently observed number of replicas. // +optional Replicas int32 `json:"replicas,omitempty"` @@ -138,7 +138,7 @@ type MachineSetStatus struct { // +optional AvailableReplicas int32 `json:"availableReplicas,omitempty"` - // ObservedGeneration reflects the generation of the most recently observed MachineSet. + // observedGeneration reflects the generation of the most recently observed MachineSet. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` @@ -164,7 +164,7 @@ type MachineSetStatus struct { FailureReason *capierrors.MachineSetStatusError `json:"failureReason,omitempty"` // +optional FailureMessage *string `json:"failureMessage,omitempty"` - // Conditions defines current service state of the MachineSet. + // conditions defines current service state of the MachineSet. // +optional Conditions Conditions `json:"conditions,omitempty"` } diff --git a/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockerclusters.yaml b/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockerclusters.yaml index dae31c85af27..84e5bd468041 100644 --- a/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockerclusters.yaml +++ b/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockerclusters.yaml @@ -68,11 +68,11 @@ spec: attributes: additionalProperties: type: string - description: Attributes is a free form map of attributes an + description: attributes is a free form map of attributes an infrastructure provider might use or require. type: object controlPlane: - description: ControlPlane determines if this failure domain + description: controlPlane determines if this failure domain is suitable for use by control plane machines. type: boolean type: object @@ -112,16 +112,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -139,11 +139,11 @@ spec: attributes: additionalProperties: type: string - description: Attributes is a free form map of attributes an + description: attributes is a free form map of attributes an infrastructure provider might use or require. type: object controlPlane: - description: ControlPlane determines if this failure domain + description: controlPlane determines if this failure domain is suitable for use by control plane machines. type: boolean type: object @@ -220,11 +220,11 @@ spec: attributes: additionalProperties: type: string - description: Attributes is a free form map of attributes an + description: attributes is a free form map of attributes an infrastructure provider might use or require. type: object controlPlane: - description: ControlPlane determines if this failure domain + description: controlPlane determines if this failure domain is suitable for use by control plane machines. type: boolean type: object @@ -279,16 +279,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -306,11 +306,11 @@ spec: attributes: additionalProperties: type: string - description: Attributes is a free form map of attributes an + description: attributes is a free form map of attributes an infrastructure provider might use or require. type: object controlPlane: - description: ControlPlane determines if this failure domain + description: controlPlane determines if this failure domain is suitable for use by control plane machines. type: boolean type: object @@ -389,11 +389,11 @@ spec: attributes: additionalProperties: type: string - description: Attributes is a free form map of attributes an + description: attributes is a free form map of attributes an infrastructure provider might use or require. type: object controlPlane: - description: ControlPlane determines if this failure domain + description: controlPlane determines if this failure domain is suitable for use by control plane machines. type: boolean type: object @@ -470,16 +470,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -498,11 +498,11 @@ spec: attributes: additionalProperties: type: string - description: Attributes is a free form map of attributes an + description: attributes is a free form map of attributes an infrastructure provider might use or require. type: object controlPlane: - description: ControlPlane determines if this failure domain + description: controlPlane determines if this failure domain is suitable for use by control plane machines. type: boolean type: object diff --git a/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockerclustertemplates.yaml b/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockerclustertemplates.yaml index b38829d1038b..fdfd55b1c456 100644 --- a/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockerclustertemplates.yaml +++ b/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockerclustertemplates.yaml @@ -82,11 +82,11 @@ spec: attributes: additionalProperties: type: string - description: Attributes is a free form map of attributes + description: attributes is a free form map of attributes an infrastructure provider might use or require. type: object controlPlane: - description: ControlPlane determines if this failure + description: controlPlane determines if this failure domain is suitable for use by control plane machines. type: boolean type: object @@ -166,7 +166,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations @@ -210,11 +210,11 @@ spec: attributes: additionalProperties: type: string - description: Attributes is a free form map of attributes + description: attributes is a free form map of attributes an infrastructure provider might use or require. type: object controlPlane: - description: ControlPlane determines if this failure + description: controlPlane determines if this failure domain is suitable for use by control plane machines. type: boolean type: object diff --git a/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachinepools.yaml b/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachinepools.yaml index 93d21b8b10af..f534ac2bc115 100644 --- a/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachinepools.yaml +++ b/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachinepools.yaml @@ -124,16 +124,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -321,16 +321,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -514,16 +514,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string diff --git a/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachinepooltemplates.yaml b/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachinepooltemplates.yaml index dc3b18a4050a..2da59b33f976 100644 --- a/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachinepooltemplates.yaml +++ b/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachinepooltemplates.yaml @@ -61,7 +61,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations diff --git a/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachines.yaml b/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachines.yaml index 376b25a5784f..907dc13dc984 100644 --- a/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachines.yaml +++ b/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachines.yaml @@ -138,16 +138,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -298,16 +298,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string @@ -478,16 +478,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string diff --git a/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachinetemplates.yaml b/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachinetemplates.yaml index 8a5431476f18..6703c7b13f15 100644 --- a/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachinetemplates.yaml +++ b/test/infrastructure/docker/config/crd/bases/infrastructure.cluster.x-k8s.io_dockermachinetemplates.yaml @@ -248,7 +248,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations diff --git a/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemoryclusters.yaml b/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemoryclusters.yaml index b8fae7fdf223..77f89c9d2be1 100644 --- a/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemoryclusters.yaml +++ b/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemoryclusters.yaml @@ -96,16 +96,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string diff --git a/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemoryclustertemplates.yaml b/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemoryclustertemplates.yaml index 144333f6b43a..a1d873acac47 100644 --- a/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemoryclustertemplates.yaml +++ b/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemoryclustertemplates.yaml @@ -61,7 +61,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations diff --git a/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemorymachines.yaml b/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemorymachines.yaml index cd96333e3be6..91ea35cac75f 100644 --- a/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemorymachines.yaml +++ b/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemorymachines.yaml @@ -194,16 +194,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string diff --git a/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemorymachinetemplates.yaml b/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemorymachinetemplates.yaml index b87651396a77..1eedee8ed923 100644 --- a/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemorymachinetemplates.yaml +++ b/test/infrastructure/inmemory/config/crd/bases/infrastructure.cluster.x-k8s.io_inmemorymachinetemplates.yaml @@ -61,7 +61,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations diff --git a/util/test/builder/crd/test.cluster.x-k8s.io_phase0obj.yaml b/util/test/builder/crd/test.cluster.x-k8s.io_phase0obj.yaml index 1be851749ef3..7840adced473 100644 --- a/util/test/builder/crd/test.cluster.x-k8s.io_phase0obj.yaml +++ b/util/test/builder/crd/test.cluster.x-k8s.io_phase0obj.yaml @@ -76,16 +76,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string diff --git a/util/test/builder/crd/test.cluster.x-k8s.io_phase1obj.yaml b/util/test/builder/crd/test.cluster.x-k8s.io_phase1obj.yaml index afd96132a486..5d12b23ada39 100644 --- a/util/test/builder/crd/test.cluster.x-k8s.io_phase1obj.yaml +++ b/util/test/builder/crd/test.cluster.x-k8s.io_phase1obj.yaml @@ -77,16 +77,16 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, Unknown. + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string diff --git a/util/test/builder/crd/test.cluster.x-k8s.io_phase2obj.yaml b/util/test/builder/crd/test.cluster.x-k8s.io_phase2obj.yaml index af8448a0adb7..43d419252f3e 100644 --- a/util/test/builder/crd/test.cluster.x-k8s.io_phase2obj.yaml +++ b/util/test/builder/crd/test.cluster.x-k8s.io_phase2obj.yaml @@ -145,17 +145,17 @@ spec: type: string severity: description: |- - Severity provides an explicit classification of Reason code, so the users or machines can immediately + 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. type: string status: - description: Status of the condition, one of True, False, + description: status of the condition, one of True, False, Unknown. type: string type: description: |- - Type of condition in CamelCase or in foo.example.com/CamelCase. + 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. type: string