ClusterV2ClusterV2 is the Schema for the ClusterV2s API. Provides a Rancher v2 Cluster v2 resource. This can be used to create node-driver and custom RKE2 and K3s Clusters for Rancher v2 environments and retrieve their information.
TypeMR
Providerprovider-rancher2
Grouprancher.rancher2.m.contrib.crossplane.io
Scopenamespaced
Versionv1

1apiVersion: rancher.rancher2.m.contrib.crossplane.io/v1

2kind: ClusterV2

kind
string
metadata
object
spec
object

ClusterV2Spec defines the desired state of ClusterV2

forProvider
required
object

(No description available)

array

Agent env vars is a list of additional environment variables to be appended to the cattle-cluster-agent and fleet-agent deployment, and the plan for the system upgrade controller to upgrade nodes. Cluster V2 default agent env vars

name
string
value
string
array

Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the cattle-cluster-agent deployment. This argument is available in Rancher v2.7.5 and above. Optional customization for cluster agent

array

A list of tolerations to be appended to the default tolerations. User defined tolerations to append to agent

effect
string
key
string
operator
string
seconds
number
value
string
array

Override resource requirements overrides the default value for requests and/or limits. User defined resource requirements to set on the agent

array

Supported in Rancher 2.11.0 and above. Defines the configuration of a Priority Class and or Pod Disruption Budget. Currently only supported in the cluster_agent_deployment_customization field, and requires the cattle_cluster_agent_scheduling_customization feature to be enabled. User defined scheduling customization for the cattle cluster agent

array

The definition of a Pod Disruption Budget deployed for the cluster agent The Pod Disruption Budget created for the cattle cluster agent

array

The definition of a Priority Class deployed for the cluster agent The Priority Class created for the cattle cluster agent

array

Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the fleet-agent deployment. The argument is available in Rancher v2.7.5 and above. Optional customization for fleet agent

array

A list of tolerations to be appended to the default tolerations. User defined tolerations to append to agent

effect
string
key
string
operator
string
seconds
number
value
string
array

Override resource requirements overrides the default value for requests and/or limits. User defined resource requirements to set on the agent

labels
object
array

Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation. Cluster V2 local auth endpoint

caCerts
string
enabled
boolean
fqdn
string
name
string
array

The RKE configuration for the cluster. Cluster V2 rke config

array

Data directory configuration for the kubernetes distro, system-agent, and provisioning resources. Cluster V2 data directories

etcd
array

Etcd configures the behavior of the automatic etcd snapshot feature. Cluster V2 etcd

array

Creation option for etcd service. ETCD snapshot S3 config

array

Cluster V2 etcd snapshot create. Cluster V2 etcd snapshot create

array

Cluster V2 etcd snapshot restore. Cluster V2 etcd snapshot restore

array

Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation. Cluster V2 local auth endpoint

caCerts
string
enabled
boolean
fqdn
string
array

Default values for machine pool configurations if unset

array

Cluster V2 machine pools. Cluster V2 machine pools

etcdRole
boolean
labels
object
array

Machine pool node config. Machine config data

kind
string
name
string
machineOs
string
name
string
paused
boolean
quantity
number
array

Machine pool rolling update. Machine pool rolling update

taints
array

Machine pool taints. Machine pool taints

effect
string
key
string
value
string
workerRole
boolean
array

Machine selector config is the same as machine_global_config except that a label selector can be specified with the configuration. The configuration will only be applied to nodes that match the provided label selector. The configuration from machine_selector_config takes precedence over the one from machine_global_config. This argument is available in Rancher v2.7.2 and later. Cluster V2 machine selector config

config
string
array

Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. Machine label selector

array

Match expressions is a list of label selector requirements. The requirements are ANDed. Label selector match expressions

key
string
operator
string
values
array

Values is a list of string values. Label selector requirement values

array

Machine selector files provide a means to deliver files to nodes so that the files can be in place before initiating RKE2/K3s server or agent processes. Please refer to Rancher documentation for RKE2 Cluster Configuration Reference and K3s Cluster Configuration Reference. This argument is available in Rancher v2.7.2 and later. Cluster V2 machine selector files

array

File sources represents the source of the files. Multiple files can be delivered to nodes that match the provided label selector. File sources

array

Configmap represents a K8s configmap which is the source of files. It is mutually exclusive with secret. The configmap which is the source of files

items
array

Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, and etc. Items(files) to retrieve from the K8s object

dynamic
boolean
hash
string
key
string
path
string
name
string
secret
array

Secret represents a K8s secret which is the source of files. It is mutually exclusive with configmap. The secret which is the source of files

items
array

Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, and etc. Items(files) to retrieve from the K8s object

dynamic
boolean
hash
string
key
string
path
string
name
string
array

Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. Machine label selector

array

Match expressions is a list of label selector requirements. The requirements are ANDed. Label selector match expressions

key
string
operator
string
values
array

Values is a list of string values. Label selector requirement values

array

The networking stack used by the cluster. Cluster V2 networking

array

Docker registries from which the cluster pulls images. Cluster V2 registries

configs
array

Cluster V2 docker registries config. Registry config

mirrors
array

Cluster V2 docker registries mirror. Registry mirrors

array

Registry mirror endpoints. Registry mirror endpoints

hostname
string
rewrites
object
array

Cluster V2 certificate rotation. Cluster V2 certificate rotation

array

Service certificates to rotate with this generation. Service certificates to rotate with this generation.

array

Cluster upgrade strategy. Cluster V2 upgrade strategy

array

Controlplane nodes drain options. Controlplane nodes drain options

array

Worker nodes drain options. Worker nodes drain options

object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

array

Agent env vars is a list of additional environment variables to be appended to the cattle-cluster-agent and fleet-agent deployment, and the plan for the system upgrade controller to upgrade nodes. Cluster V2 default agent env vars

name
string
value
string
array

Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the cattle-cluster-agent deployment. This argument is available in Rancher v2.7.5 and above. Optional customization for cluster agent

array

A list of tolerations to be appended to the default tolerations. User defined tolerations to append to agent

effect
string
key
string
operator
string
seconds
number
value
string
array

Override resource requirements overrides the default value for requests and/or limits. User defined resource requirements to set on the agent

array

Supported in Rancher 2.11.0 and above. Defines the configuration of a Priority Class and or Pod Disruption Budget. Currently only supported in the cluster_agent_deployment_customization field, and requires the cattle_cluster_agent_scheduling_customization feature to be enabled. User defined scheduling customization for the cattle cluster agent

array

The definition of a Pod Disruption Budget deployed for the cluster agent The Pod Disruption Budget created for the cattle cluster agent

array

The definition of a Priority Class deployed for the cluster agent The Priority Class created for the cattle cluster agent

array

Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the fleet-agent deployment. The argument is available in Rancher v2.7.5 and above. Optional customization for fleet agent

array

A list of tolerations to be appended to the default tolerations. User defined tolerations to append to agent

effect
string
key
string
operator
string
seconds
number
value
string
array

Override resource requirements overrides the default value for requests and/or limits. User defined resource requirements to set on the agent

labels
object
array

Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation. Cluster V2 local auth endpoint

caCerts
string
enabled
boolean
fqdn
string
name
string
array

The RKE configuration for the cluster. Cluster V2 rke config

array

Data directory configuration for the kubernetes distro, system-agent, and provisioning resources. Cluster V2 data directories

etcd
array

Etcd configures the behavior of the automatic etcd snapshot feature. Cluster V2 etcd

array

Creation option for etcd service. ETCD snapshot S3 config

array

Cluster V2 etcd snapshot create. Cluster V2 etcd snapshot create

array

Cluster V2 etcd snapshot restore. Cluster V2 etcd snapshot restore

array

Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation. Cluster V2 local auth endpoint

caCerts
string
enabled
boolean
fqdn
string
array

Default values for machine pool configurations if unset

array

Cluster V2 machine pools. Cluster V2 machine pools

etcdRole
boolean
labels
object
array

Machine pool node config. Machine config data

kind
string
name
string
machineOs
string
name
string
paused
boolean
quantity
number
array

Machine pool rolling update. Machine pool rolling update

taints
array

Machine pool taints. Machine pool taints

effect
string
key
string
value
string
workerRole
boolean
array

Machine selector config is the same as machine_global_config except that a label selector can be specified with the configuration. The configuration will only be applied to nodes that match the provided label selector. The configuration from machine_selector_config takes precedence over the one from machine_global_config. This argument is available in Rancher v2.7.2 and later. Cluster V2 machine selector config

config
string
array

Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. Machine label selector

array

Match expressions is a list of label selector requirements. The requirements are ANDed. Label selector match expressions

key
string
operator
string
values
array

Values is a list of string values. Label selector requirement values

array

Machine selector files provide a means to deliver files to nodes so that the files can be in place before initiating RKE2/K3s server or agent processes. Please refer to Rancher documentation for RKE2 Cluster Configuration Reference and K3s Cluster Configuration Reference. This argument is available in Rancher v2.7.2 and later. Cluster V2 machine selector files

array

File sources represents the source of the files. Multiple files can be delivered to nodes that match the provided label selector. File sources

array

Configmap represents a K8s configmap which is the source of files. It is mutually exclusive with secret. The configmap which is the source of files

items
array

Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, and etc. Items(files) to retrieve from the K8s object

dynamic
boolean
hash
string
key
string
path
string
name
string
secret
array

Secret represents a K8s secret which is the source of files. It is mutually exclusive with configmap. The secret which is the source of files

items
array

Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, and etc. Items(files) to retrieve from the K8s object

dynamic
boolean
hash
string
key
string
path
string
name
string
array

Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. Machine label selector

array

Match expressions is a list of label selector requirements. The requirements are ANDed. Label selector match expressions

key
string
operator
string
values
array

Values is a list of string values. Label selector requirement values

array

The networking stack used by the cluster. Cluster V2 networking

array

Docker registries from which the cluster pulls images. Cluster V2 registries

configs
array

Cluster V2 docker registries config. Registry config

mirrors
array

Cluster V2 docker registries mirror. Registry mirrors

array

Registry mirror endpoints. Registry mirror endpoints

hostname
string
rewrites
object
array

Cluster V2 certificate rotation. Cluster V2 certificate rotation

array

Service certificates to rotate with this generation. Service certificates to rotate with this generation.

array

Cluster upgrade strategy. Cluster V2 upgrade strategy

array

Controlplane nodes drain options. Controlplane nodes drain options

array

Worker nodes drain options. Worker nodes drain options

array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

kind
required
string
name
required
string
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

name
required
string
status
object

ClusterV2Status defines the observed state of ClusterV2.

object

(No description available)

array

Agent env vars is a list of additional environment variables to be appended to the cattle-cluster-agent and fleet-agent deployment, and the plan for the system upgrade controller to upgrade nodes. Cluster V2 default agent env vars

name
string
value
string
array

Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the cattle-cluster-agent deployment. This argument is available in Rancher v2.7.5 and above. Optional customization for cluster agent

array

A list of tolerations to be appended to the default tolerations. User defined tolerations to append to agent

effect
string
key
string
operator
string
seconds
number
value
string
array

Override resource requirements overrides the default value for requests and/or limits. User defined resource requirements to set on the agent

array

Supported in Rancher 2.11.0 and above. Defines the configuration of a Priority Class and or Pod Disruption Budget. Currently only supported in the cluster_agent_deployment_customization field, and requires the cattle_cluster_agent_scheduling_customization feature to be enabled. User defined scheduling customization for the cattle cluster agent

array

The definition of a Pod Disruption Budget deployed for the cluster agent The Pod Disruption Budget created for the cattle cluster agent

array

The definition of a Priority Class deployed for the cluster agent The Priority Class created for the cattle cluster agent

array

Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the fleet-agent deployment. The argument is available in Rancher v2.7.5 and above. Optional customization for fleet agent

array

A list of tolerations to be appended to the default tolerations. User defined tolerations to append to agent

effect
string
key
string
operator
string
seconds
number
value
string
array

Override resource requirements overrides the default value for requests and/or limits. User defined resource requirements to set on the agent

id
string
labels
object
array

Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation. Cluster V2 local auth endpoint

caCerts
string
enabled
boolean
fqdn
string
name
string
array

The RKE configuration for the cluster. Cluster V2 rke config

array

Data directory configuration for the kubernetes distro, system-agent, and provisioning resources. Cluster V2 data directories

etcd
array

Etcd configures the behavior of the automatic etcd snapshot feature. Cluster V2 etcd

array

Creation option for etcd service. ETCD snapshot S3 config

array

Cluster V2 etcd snapshot create. Cluster V2 etcd snapshot create

array

Cluster V2 etcd snapshot restore. Cluster V2 etcd snapshot restore

array

Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation. Cluster V2 local auth endpoint

caCerts
string
enabled
boolean
fqdn
string
array

Default values for machine pool configurations if unset

array

Cluster V2 machine pools. Cluster V2 machine pools

etcdRole
boolean
labels
object
array

Machine pool node config. Machine config data

kind
string
name
string
machineOs
string
name
string
paused
boolean
quantity
number
array

Machine pool rolling update. Machine pool rolling update

taints
array

Machine pool taints. Machine pool taints

effect
string
key
string
value
string
workerRole
boolean
array

Machine selector config is the same as machine_global_config except that a label selector can be specified with the configuration. The configuration will only be applied to nodes that match the provided label selector. The configuration from machine_selector_config takes precedence over the one from machine_global_config. This argument is available in Rancher v2.7.2 and later. Cluster V2 machine selector config

config
string
array

Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. Machine label selector

array

Match expressions is a list of label selector requirements. The requirements are ANDed. Label selector match expressions

key
string
operator
string
values
array

Values is a list of string values. Label selector requirement values

array

Machine selector files provide a means to deliver files to nodes so that the files can be in place before initiating RKE2/K3s server or agent processes. Please refer to Rancher documentation for RKE2 Cluster Configuration Reference and K3s Cluster Configuration Reference. This argument is available in Rancher v2.7.2 and later. Cluster V2 machine selector files

array

File sources represents the source of the files. Multiple files can be delivered to nodes that match the provided label selector. File sources

array

Configmap represents a K8s configmap which is the source of files. It is mutually exclusive with secret. The configmap which is the source of files

items
array

Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, and etc. Items(files) to retrieve from the K8s object

dynamic
boolean
hash
string
key
string
path
string
name
string
secret
array

Secret represents a K8s secret which is the source of files. It is mutually exclusive with configmap. The secret which is the source of files

items
array

Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, and etc. Items(files) to retrieve from the K8s object

dynamic
boolean
hash
string
key
string
path
string
name
string
array

Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. Machine label selector

array

Match expressions is a list of label selector requirements. The requirements are ANDed. Label selector match expressions

key
string
operator
string
values
array

Values is a list of string values. Label selector requirement values

array

The networking stack used by the cluster. Cluster V2 networking

array

Docker registries from which the cluster pulls images. Cluster V2 registries

configs
array

Cluster V2 docker registries config. Registry config

mirrors
array

Cluster V2 docker registries mirror. Registry mirrors

array

Registry mirror endpoints. Registry mirror endpoints

hostname
string
rewrites
object
array

Cluster V2 certificate rotation. Cluster V2 certificate rotation

array

Service certificates to rotate with this generation. Service certificates to rotate with this generation.

array

Cluster upgrade strategy. Cluster V2 upgrade strategy

array

Controlplane nodes drain options. Controlplane nodes drain options

array

Worker nodes drain options. Worker nodes drain options

array

Conditions of the resource.

lastTransitionTime
required
string
message
string
reason
required
string
status
required
string
type
required
string