Module capi_clusterclass

Structs

ClusterClass

Auto-generated derived type for ClusterClassSpec via CustomResource

ClusterClassAvailabilityGates

ClusterAvailabilityGate contains the type of a Cluster condition to be used as availability gate.

ClusterClassControlPlane

controlPlane is a reference to a local struct that holds the details for provisioning the Control Plane for the Cluster.

ClusterClassControlPlaneMachineHealthCheck

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.

ClusterClassControlPlaneMachineHealthCheckRemediationTemplate

remediationTemplate is a reference to a remediation template provided by an infrastructure provider.

ClusterClassControlPlaneMachineHealthCheckUnhealthyConditions

UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration. When the named condition has been in the given status for at least the timeout value, a node is considered unhealthy.

ClusterClassControlPlaneMachineInfrastructure

machineInfrastructure defines the metadata and infrastructure information for control plane machines.

ClusterClassControlPlaneMachineInfrastructureRef

ref is a required reference to a custom resource offered by a provider.

ClusterClassControlPlaneMetadata

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.

ClusterClassControlPlaneNamingStrategy

namingStrategy allows changing the naming pattern used when creating the control plane provider object.

ClusterClassControlPlaneReadinessGates

MachineReadinessGate contains the type of a Machine condition to be used as a readiness gate.

ClusterClassControlPlaneRef

ref is a required reference to a custom resource offered by a provider.

ClusterClassInfrastructure

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.

ClusterClassInfrastructureNamingStrategy

infrastructureNamingStrategy allows changing the naming pattern used when creating the infrastructure object.

ClusterClassInfrastructureRef

ref is a required reference to a custom resource offered by a provider.

ClusterClassPatches

ClusterClassPatch defines a patch which is applied to customize the referenced templates.

ClusterClassPatchesDefinitions

PatchDefinition defines a patch which is applied to customize the referenced templates.

ClusterClassPatchesDefinitionsJsonPatches

JSONPatch defines a JSON patch.

ClusterClassPatchesDefinitionsJsonPatchesValueFrom

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.

ClusterClassPatchesDefinitionsSelector

selector defines on which templates the patch should be applied.

ClusterClassPatchesDefinitionsSelectorMatchResources

matchResources selects templates based on where they are referenced.

ClusterClassPatchesDefinitionsSelectorMatchResourcesMachineDeploymentClass

machineDeploymentClass selects templates referenced in specific MachineDeploymentClasses in .spec.workers.machineDeployments.

ClusterClassPatchesDefinitionsSelectorMatchResourcesMachinePoolClass

machinePoolClass selects templates referenced in specific MachinePoolClasses in .spec.workers.machinePools.

ClusterClassPatchesExternal

external defines an external patch. Note: Exactly one of Definitions or External must be set.

ClusterClassSpec

spec is the desired state of ClusterClass.

ClusterClassStatus

status is the observed state of ClusterClass.

ClusterClassStatusV1beta2

v1beta2 groups all the fields that will be added or modified in ClusterClass’s status with the V1Beta2 version.

ClusterClassStatusVariables

ClusterClassStatusVariable defines a variable which appears in the status of a ClusterClass.

ClusterClassStatusVariablesDefinitions

ClusterClassStatusVariableDefinition defines a variable which appears in the status of a ClusterClass.

ClusterClassStatusVariablesDefinitionsMetadata

metadata is the metadata of a variable. It can be used to add additional data for higher level tools to a ClusterClassVariable.

ClusterClassStatusVariablesDefinitionsSchema

schema defines the schema of the variable.

ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3Schema

openAPIV3Schema defines the schema of a variable via OpenAPI v3 schema. The schema is a subset of the schema used in Kubernetes CRDs.

ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3SchemaXKubernetesValidations

ValidationRule describes a validation rule written in the CEL expression language.

ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3SchemaXMetadata

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.

ClusterClassVariables

ClusterClassVariable defines a variable which can be configured in the Cluster topology and used in patches.

ClusterClassVariablesMetadata

metadata is the metadata of a variable. It can be used to add additional data for higher level tools to a ClusterClassVariable.

ClusterClassVariablesSchema

schema defines the schema of the variable.

ClusterClassVariablesSchemaOpenApiv3Schema

openAPIV3Schema defines the schema of a variable via OpenAPI v3 schema. The schema is a subset of the schema used in Kubernetes CRDs.

ClusterClassVariablesSchemaOpenApiv3SchemaXKubernetesValidations

ValidationRule describes a validation rule written in the CEL expression language.

ClusterClassVariablesSchemaOpenApiv3SchemaXMetadata

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.

ClusterClassWorkers

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.

ClusterClassWorkersMachineDeployments

MachineDeploymentClass serves as a template to define a set of worker nodes of the cluster provisioned using the ClusterClass.

ClusterClassWorkersMachineDeploymentsMachineHealthCheck

machineHealthCheck defines a MachineHealthCheck for this MachineDeploymentClass.

ClusterClassWorkersMachineDeploymentsMachineHealthCheckRemediationTemplate

remediationTemplate is a reference to a remediation template provided by an infrastructure provider.

ClusterClassWorkersMachineDeploymentsMachineHealthCheckUnhealthyConditions

UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration. When the named condition has been in the given status for at least the timeout value, a node is considered unhealthy.

ClusterClassWorkersMachineDeploymentsNamingStrategy

namingStrategy allows changing the naming pattern used when creating the MachineDeployment.

ClusterClassWorkersMachineDeploymentsReadinessGates

MachineReadinessGate contains the type of a Machine condition to be used as a readiness gate.

ClusterClassWorkersMachineDeploymentsStrategy

strategy is the deployment strategy to use to replace existing machines with new ones. NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.

ClusterClassWorkersMachineDeploymentsStrategyRemediation

remediation controls the strategy of remediating unhealthy machines and how remediating operations should occur during the lifecycle of the dependant MachineSets.

ClusterClassWorkersMachineDeploymentsStrategyRollingUpdate

rollingUpdate is the rolling update config params. Present only if MachineDeploymentStrategyType = RollingUpdate.

ClusterClassWorkersMachineDeploymentsTemplate

template is a local struct containing a collection of templates for creation of MachineDeployment objects representing a set of worker nodes.

ClusterClassWorkersMachineDeploymentsTemplateBootstrap

bootstrap contains the bootstrap template reference to be used for the creation of worker Machines.

ClusterClassWorkersMachineDeploymentsTemplateBootstrapRef

ref is a required reference to a custom resource offered by a provider.

ClusterClassWorkersMachineDeploymentsTemplateInfrastructure

infrastructure contains the infrastructure template reference to be used for the creation of worker Machines.

ClusterClassWorkersMachineDeploymentsTemplateInfrastructureRef

ref is a required reference to a custom resource offered by a provider.

ClusterClassWorkersMachineDeploymentsTemplateMetadata

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.

ClusterClassWorkersMachinePools

MachinePoolClass serves as a template to define a pool of worker nodes of the cluster provisioned using ClusterClass.

ClusterClassWorkersMachinePoolsNamingStrategy

namingStrategy allows changing the naming pattern used when creating the MachinePool.

ClusterClassWorkersMachinePoolsTemplate

template is a local struct containing a collection of templates for creation of MachinePools objects representing a pool of worker nodes.

ClusterClassWorkersMachinePoolsTemplateBootstrap

bootstrap contains the bootstrap template reference to be used for the creation of the Machines in the MachinePool.

ClusterClassWorkersMachinePoolsTemplateBootstrapRef

ref is a required reference to a custom resource offered by a provider.

ClusterClassWorkersMachinePoolsTemplateInfrastructure

infrastructure contains the infrastructure template reference to be used for the creation of the MachinePool.

ClusterClassWorkersMachinePoolsTemplateInfrastructureRef

ref is a required reference to a custom resource offered by a provider.

ClusterClassWorkersMachinePoolsTemplateMetadata

metadata is the metadata applied to the MachinePool. At runtime this metadata is merged with the corresponding metadata from the topology.

Enums

ClusterClassAvailabilityGatesPolarity

ClusterAvailabilityGate contains the type of a Cluster condition to be used as availability gate.

ClusterClassControlPlaneReadinessGatesPolarity

MachineReadinessGate contains the type of a Machine condition to be used as a readiness gate.

ClusterClassPatchesDefinitionsJsonPatchesOp

JSONPatch defines a JSON patch.

ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3SchemaType

openAPIV3Schema defines the schema of a variable via OpenAPI v3 schema. The schema is a subset of the schema used in Kubernetes CRDs.

ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3SchemaXKubernetesValidationsReason

ValidationRule describes a validation rule written in the CEL expression language.

ClusterClassVariablesSchemaOpenApiv3SchemaType

openAPIV3Schema defines the schema of a variable via OpenAPI v3 schema. The schema is a subset of the schema used in Kubernetes CRDs.

ClusterClassVariablesSchemaOpenApiv3SchemaXKubernetesValidationsReason

ValidationRule describes a validation rule written in the CEL expression language.

ClusterClassWorkersMachineDeploymentsReadinessGatesPolarity

MachineReadinessGate contains the type of a Machine condition to be used as a readiness gate.

ClusterClassWorkersMachineDeploymentsStrategyRollingUpdateDeletePolicy

rollingUpdate is the rolling update config params. Present only if MachineDeploymentStrategyType = RollingUpdate.

ClusterClassWorkersMachineDeploymentsStrategyType

strategy is the deployment strategy to use to replace existing machines with new ones. NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.