Module cluster_api_rs::api::capi_clusterclass

Structs

• ClusterClass
  Auto-generated derived type for ClusterClassSpec via CustomResource
• 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.
• 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.
• 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
  ClusterClassSpec describes the desired state of the ClusterClass.
• ClusterClassStatus
  ClusterClassStatus defines the observed state of the ClusterClass.
• 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
  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.
• 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
  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.
• 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.
• ClusterClassWorkersMachineDeploymentsStrategy
  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
  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

• ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3SchemaXKubernetesValidationsReason
  ValidationRule describes a validation rule written in the CEL expression language.
• ClusterClassVariablesSchemaOpenApiv3SchemaXKubernetesValidationsReason
  ValidationRule describes a validation rule written in the CEL expression language.
• ClusterClassWorkersMachineDeploymentsStrategyRollingUpdateDeletePolicy
  Rolling update config params. Present only if MachineDeploymentStrategyType = RollingUpdate.
• ClusterClassWorkersMachineDeploymentsStrategyType
  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.