ClusterCluster is the Schema for the Clusters API. Provides a Rancher v2 Cluster resource. This can be used to create imported 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: Cluster

kind
string
metadata
object
spec
object

ClusterSpec defines the desired state of Cluster

forProvider
required
object

(No description available)

agentEnvVars
array

Optional Agent Env Vars for Rancher agent. For Rancher v2.5.6 and above (list) Optional Agent Env Vars for Rancher agent

name
string
value
string
aksConfigV2
array

The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with eks_config_v2, gke_config_v2, k3s_config, oke_config and rke_config (list maxitems:1)

authorizedIpRanges
array

The AKS authorized ip ranges (list) The AKS authorized ip ranges

baseUrl
string
dnsPrefix
string
imported
boolean
monitoring
boolean
name
string
nodePools
array

The AKS nnode pools. Required if imported=false (list) The AKS node pools to use. Required if import=false

availabilityZones
array

The AKS node pool availability zones (list) The AKS node pool availability zones

count
number
labels
object
maxCount
number
maxPods
number
maxSurge
string
minCount
number
mode
string
name
string
osType
string
taints
array

(Optonal) The AKS node pool taints (list) The AKS node pool taints

vmSize
string
subnet
string
tags
object
clusterAgentDeploymentCustomization
array

Optional customization for cluster agent. For Rancher v2.7.5 and above (list) Optional customization for cluster agent

appendTolerations
array

User defined tolerations to append to agent (list) User defined tolerations to append to agent

effect
string
key
string
operator
string
seconds
number
value
string
overrideResourceRequirements
array

User defined resource requirements to set on the agent (list) User defined resource requirements to set on the agent

cpuLimit
string
schedulingCustomization
array

Supported in Rancher 2.11.0 and above. Defines the configuration of a Priority Class and or Pod Disruption Budget. Currently only supported by 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

podDisruptionBudget
array

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

priorityClass
array

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

value
number
clusterAuthEndpoint
array

Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

caCerts
string
enabled
boolean
fqdn
string
clusterTemplateAnswers
array

Cluster template answers. For Rancher v2.3.x and above (list maxitems:1) Cluster template answers

clusterId
string
projectId
string
values
object
clusterTemplateQuestions
array

Cluster template questions. For Rancher v2.3.x and above (list) Cluster template questions

default
string
required
boolean
type
string
variable
string
driver
string
eksConfigV2
array

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with gke_config_v2, k3s_config, oke_config and rke_config. For Rancher v2.5.x and above (list maxitems:1)

imported
boolean
kmsKey
string
loggingTypes
array

The AWS cloudwatch logging types. audit, api, scheduler, controllerManager and authenticator values are allowed (list) The AWS logging types

name
string
nodeGroups
array

The EKS cluster name to import. Required to create a new cluster (list) The AWS node groups to use

diskSize
number
ec2SshKey
string
gpu
boolean
imageId
string
labels
object
launchTemplate
array

The EKS node groups launch template (list Maxitem: 1) The EKS node groups launch template

id
string
name
string
version
number
maxSize
number
minSize
number
name
string
nodeRole
string
spotInstanceTypes
array

The EKS node group sport instace types (list string) The EKS node group spot instance types

subnets
array

List of subnets in the virtual network to use (list) The EKS node group subnets

tags
object
userData
string
publicAccessSources
array

The EKS cluster public access sources (map) The EKS cluster public access sources

region
string
securityGroups
array

List of security groups to use for the cluster (list) List of security groups to use for the cluster

subnets
array

List of subnets in the virtual network to use (list) List of subnets in the virtual network to use

tags
object
fleetAgentDeploymentCustomization
array

Optional customization for fleet agent. For Rancher v2.7.5 and above (list) Optional customization for fleet agent

appendTolerations
array

User defined tolerations to append to agent (list) User defined tolerations to append to agent

effect
string
key
string
operator
string
seconds
number
value
string
overrideResourceRequirements
array

User defined resource requirements to set on the agent (list) User defined resource requirements to set on the agent

cpuLimit
string
gkeConfigV2
array

The Google GKE V2 configuration for gke Clusters. Conflicts with aks_config_v2, eks_config_v2, k3s_config, oke_config and rke_config. For Rancher v2.5.8 and above (list maxitems:1)

clusterAddons
array

The GKE cluster addons (List maxitems:1) The GKE cluster addons

googleCredentialSecretSecretRef
object

Google credential secret (string) Google credential secret

key
required
string
name
required
string
imported
boolean
ipAllocationPolicy
array

The GKE ip allocation policy (List maxitems:1) The GKE ip allocation policy

labels
object
locations
array

The GKE cluster locations (List) The GKE cluster locations

masterAuthorizedNetworksConfig
array

The GKE cluster master authorized networks config (List maxitems:1) The GKE cluster master authorized networks config

cidrBlocks
array

The GKE master authorized network config cidr blocks (List) The GKE master authorized network config cidr blocks

cidrBlock
string
enabled
boolean
name
string
network
string
nodePools
array

The AKS nnode pools. Required if imported=false (list) The GKE cluster node pools

autoscaling
array

The GKE node pool config autoscaling (List maxitems:1) The GKE node pool config autoscaling

enabled
boolean
config
array

The GKE node pool node config (List maxitems:1) The GKE node pool node config

diskType
string
imageType
string
labels
object
oauthScopes
array

The GKE node config oauth scopes (List) The GKE node config oauth scopes

tags
array

The AKS cluster tags (map) The GKE node config tags

taints
array

(Optonal) The AKS node pool taints (list) The GKE node config taints

effect
string
key
string
value
string
management
array

The GKE node pool config management (List maxitems:1) The GKE node pool config management

autoRepair
boolean
name
string
version
string
privateClusterConfig
array

The GKE private cluster config (List maxitems:1) The GKE private cluster config

projectId
string
region
string
zone
string
importedConfig
array

The imported configuration for generic imported Clusters. Conflicts with aks_config_v2, eks_config_v2, gke_config_v2, rke_config, rke2_config and k3s_config (list maxitems:1)

k3sConfig
array

The K3S configuration for k3s imported Clusters. Conflicts with aks_config_v2, eks_config_v2, gke_config_v2, oke_config and rke_config (list maxitems:1)

upgradeStrategy
array

RKE upgrade strategy (list maxitems:1) The K3S upgrade strategy

version
string
labels
object
name
string
okeConfig
array

The Oracle OKE configuration for oke Clusters. Conflicts with aks_config_v2, eks_config_v2, gke_config_v2, k3s_config and rke_config (list maxitems:1)

flexOcpus
number
kmsKeyId
string
nodeImage
string
nodeShape
string
podCidr
string
privateKeyContentsSecretRef
object

The private API key file contents for the specified user, in PEM format. Required unless using instance principals or workload identity to authenticate (string) The private API key file contents for the specified user, in PEM format

key
required
string
name
required
string
privateKeyPassphraseSecretRef
object

The passphrase (if any) of the private key for the OKE cluster. Required unless using instance principals or workload identity to authenticate (string) The passphrase of the private key for the OKE cluster

key
required
string
name
required
string
region
string
tenancyId
string
userOcid
string
vcnName
string
rke2Config
array

The RKE2 configuration for rke2 Clusters. Conflicts with aks_config_v2, k3s_config, oke_config and rke_config (list maxitems:1)

upgradeStrategy
array

RKE upgrade strategy (list maxitems:1) The RKE2 upgrade strategy

version
string
rkeConfig
array

The RKE configuration for rke Clusters. Conflicts with aks_config_v2, eks_config_v2, gke_config_v2, oke_config and k3s_config (list maxitems:1)

addons
string
addonsInclude
array

Addons yaml manifests to deploy on RKE cluster (list) Optional addons yaml manisfest to deploy on rke cluster.

authentication
array

Kubernetes cluster authentication (list maxitems:1) Kubernetes cluster authentication

sans
array

RKE sans for authentication ([]string)

strategy
string
authorization
array

Kubernetes cluster authorization (list maxitems:1) Kubernetes cluster authorization

mode
string
options
object
bastionHost
array

RKE bastion host (list maxitems:1) RKE bastion host

address
string
port
string
sshKeySecretRef
object

Bastion host SSH private key (string)

key
required
string
name
required
string
user
string
cloudProvider
array

RKE cloud provider rke-cloud-providers (list maxitems:1)

awsCloudProvider
array

RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)

global
serviceOverride
array

(list)

region
string
service
string
url
string
azureCloudProvider
array

RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)

aadClientCertPasswordSecretRef
object

(string)

key
required
string
name
required
string
aadClientIdSecretRef
object

(string)

key
required
string
name
required
string
aadClientSecretSecretRef
object

(string)

key
required
string
name
required
string
cloud
string
location
string
subscriptionIdSecretRef
object

(string)

key
required
string
name
required
string
tenantIdSecretRef
object

(string)

key
required
string
name
required
string
vmType
string
vnetName
string
name
string
openstackCloudProvider
array

RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)

blockStorage
array

(list maxitems:1)

bsVersion
string
global
array

(list maxitems:1)

authUrl
string
caFile
string
domainIdSecretRef
object

Required if domain_name not provided. (string)

key
required
string
name
required
string
passwordSecretRef
object

(string)

key
required
string
name
required
string
region
string
tenantIdSecretRef
object

(string)

key
required
string
name
required
string
trustIdSecretRef
object

(string)

key
required
string
name
required
string
usernameSecretRef
object

(string)

key
required
string
name
required
string
loadBalancer
metadata
array

(list maxitems:1)

route
array

(list maxitems:1)

routerId
string
vsphereCloudProvider
array

RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument name is required on virtual_center configuration. (list maxitems:1)

disk
array

(list maxitems:1)

global
array

(list maxitems:1)

passwordSecretRef
object

(string)

key
required
string
name
required
string
port
string
userSecretRef
object

User to connect bastion host (string)

key
required
string
name
required
string
network
array

Kubernetes cluster networking (list maxitems:1)

virtualCenter
array

(List)

name
string
passwordSecretRef
object

(string)

key
required
string
name
required
string
port
string
userSecretRef
object

User to connect bastion host (string)

key
required
string
name
required
string
workspace
array

(list maxitems:1)

folder
string
server
string
dns
array

RKE dns add-on. For Rancher v2.2.x (list maxitems:1)

linearAutoscalerParams
array

LinearAutoScalerParams dns config (list Maxitem: 1) Linear Autoscaler Params

max
number
min
number
nodelocal
array

Nodelocal dns config (list Maxitem: 1) Nodelocal dns

ipAddress
string
options
object
provider
string
reverseCidrs
array

DNS add-on reverse cidr (list)

tolerations
array

DNS add-on tolerations (list) DNS service tolerations

effect
string
key
string
operator
string
seconds
number
value
string
updateStrategy
array

DNS update strategy (list Maxitems: 1) Update deployment strategy

rollingUpdate
array

Monitoring daemon set rolling update (list Maxitems: 1) Rolling update for update strategy

maxSurge
number
strategy
string
upstreamNameservers
array

DNS add-on upstream nameservers (list)

ingress
array

Kubernetes ingress configuration (list maxitems:1) Kubernetes ingress configuration

dnsPolicy
string
extraArgs
object
httpPort
number
httpsPort
number
options
object
provider
string
tolerations
array

DNS add-on tolerations (list) Ingress add-on tolerations

effect
string
key
string
operator
string
seconds
number
value
string
updateStrategy
array

DNS update strategy (list Maxitems: 1) Update daemon set strategy

rollingUpdate
array

Monitoring daemon set rolling update (list Maxitems: 1) Rolling update for update strategy

strategy
string
monitoring
array

Kubernetes cluster monitoring (list maxitems:1) Kubernetes cluster monitoring

options
object
provider
string
replicas
number
tolerations
array

DNS add-on tolerations (list) Monitoring add-on tolerations

effect
string
key
string
operator
string
seconds
number
value
string
updateStrategy
array

DNS update strategy (list Maxitems: 1) Update deployment strategy

rollingUpdate
array

Monitoring daemon set rolling update (list Maxitems: 1) Rolling update for update strategy

maxSurge
number
strategy
string
network
array

Kubernetes cluster networking (list maxitems:1) Kubernetes cluster networking

aciNetworkProvider
array

ACI provider config for RKE network (list maxitems:63)

aep
string
apicHosts
array

List of APIC hosts to connect for APIC API (list)

apicUserCrtSecretRef
object

APIC user certificate (string)

key
required
string
name
required
string
apicUserKeySecretRef
object

APIC user key (string)

key
required
string
name
required
string
capic
string
encapType
string
infraVlan
string
kafkaBrokers
array

List of Kafka broker hosts (list)

l3out
string
l3outExternalNetworks
array

L3out external networks (list)

systemId
string
tenant
string
tokenSecretRef
object

ACI token (string)

key
required
string
name
required
string
vmmDomain
string
vrfName
string
vrfTenant
string
calicoNetworkProvider
array

Calico provider config for RKE network (list maxitems:1)

canalNetworkProvider
array

Canal provider config for RKE network (list maxitems:1)

iface
string
flannelNetworkProvider
array

Flannel provider config for RKE network (list maxitems:1)

iface
string
mtu
number
options
object
plugin
string
tolerations
array

DNS add-on tolerations (list) Network add-on tolerations

effect
string
key
string
operator
string
seconds
number
value
string
weaveNetworkProvider
array

Weave provider config for RKE network (list maxitems:1)

password
string
nodes
array

RKE cluster nodes (list) Optional RKE cluster nodes

address
string
labels
object
nodeId
string
port
string
role
array

(Requires) Roles for the node. controlplane, etcd and worker are supported. (list)

sshKeySecretRef
object

Bastion host SSH private key (string)

key
required
string
name
required
string
userSecretRef
object

User to connect bastion host (string)

key
required
string
name
required
string
privateRegistries
array

private registries for docker images (list) Optional private registries for docker images

ecrCredentialPlugin
array

ECR credential plugin config (list maxitems:1) ECR credential plugin config

awsSecretAccessKeySecretRef
object

AWS secret access key (string)

key
required
string
name
required
string
awsSessionTokenSecretRef
object

AWS session token (string)

key
required
string
name
required
string
isDefault
boolean
passwordSecretRef
object

(string)

key
required
string
name
required
string
url
string
userSecretRef
object

User to connect bastion host (string)

key
required
string
name
required
string
services
array

Kubernetes cluster services (list maxitems:1) Kubernetes cluster services

etcd
array

Etcd options for RKE services (list maxitems:1)

backupConfig
array

Backup options for etcd service. For Rancher v2.2.x (list maxitems:1)

enabled
boolean
retention
number
s3BackupConfig
array

S3 config options for etcd backup (list maxitems:1)

accessKeySecretRef
object

Access key for S3 service (string)

key
required
string
name
required
string
customCa
string
endpoint
string
folder
string
region
string
secretKeySecretRef
object

Secret key for S3 service (string)

key
required
string
name
required
string
timeout
number
caCert
string
certSecretRef
object

TLS certificate for etcd service (string)

key
required
string
name
required
string
creation
string
externalUrls
array

External urls for etcd service (list)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

gid
number
image
string
keySecretRef
object

The GKE taint key (string)

key
required
string
name
required
string
path
string
retention
string
snapshot
boolean
uid
number
kubeApi
array

Kube API options for RKE services (list maxitems:1)

admissionConfiguration
array

Admission configuration (map) Cluster admission configuration

kind
string
plugins
array

Admission configuration plugins. (list plugin) Admission configuration plugins

name
string
path
string
auditLog
array

K8s audit log configuration. (list maxitems: 1)

configuration
array

Plugin configuration. (string) Ex:

format
string
maxAge
number
maxBackup
number
maxSize
number
path
string
policy
string
enabled
boolean
eventRateLimit
array

K8s event rate limit configuration. (list maxitems: 1)

enabled
boolean
extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

image
string
secretsEncryptionConfig
array

Encrypt k8s secret data configration. (list maxitem: 1)

enabled
boolean
kubeController
array

Kube Controller options for RKE services (list maxitems:1)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

image
string
kubelet
array

Kubelet options for RKE services (list maxitems:1)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

failSwapOn
boolean
image
string
kubeproxy
array

Kubeproxy options for RKE services (list maxitems:1)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

image
string
scheduler
array

Scheduler options for RKE services (list maxitems:1)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

image
string
upgradeStrategy
array

RKE upgrade strategy (list maxitems:1) RKE upgrade strategy

drain
boolean
drainInput
array

RKE drain node input (list Maxitems: 1)

force
boolean
timeout
number
initProvider
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.

agentEnvVars
array

Optional Agent Env Vars for Rancher agent. For Rancher v2.5.6 and above (list) Optional Agent Env Vars for Rancher agent

name
string
value
string
aksConfigV2
array

The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with eks_config_v2, gke_config_v2, k3s_config, oke_config and rke_config (list maxitems:1)

authorizedIpRanges
array

The AKS authorized ip ranges (list) The AKS authorized ip ranges

baseUrl
string
dnsPrefix
string
imported
boolean
monitoring
boolean
name
string
nodePools
array

The AKS nnode pools. Required if imported=false (list) The AKS node pools to use. Required if import=false

availabilityZones
array

The AKS node pool availability zones (list) The AKS node pool availability zones

count
number
labels
object
maxCount
number
maxPods
number
maxSurge
string
minCount
number
mode
string
name
string
osType
string
taints
array

(Optonal) The AKS node pool taints (list) The AKS node pool taints

vmSize
string
subnet
string
tags
object
clusterAgentDeploymentCustomization
array

Optional customization for cluster agent. For Rancher v2.7.5 and above (list) Optional customization for cluster agent

appendTolerations
array

User defined tolerations to append to agent (list) User defined tolerations to append to agent

effect
string
key
string
operator
string
seconds
number
value
string
overrideResourceRequirements
array

User defined resource requirements to set on the agent (list) User defined resource requirements to set on the agent

cpuLimit
string
schedulingCustomization
array

Supported in Rancher 2.11.0 and above. Defines the configuration of a Priority Class and or Pod Disruption Budget. Currently only supported by 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

podDisruptionBudget
array

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

priorityClass
array

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

value
number
clusterAuthEndpoint
array

Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

caCerts
string
enabled
boolean
fqdn
string
clusterTemplateAnswers
array

Cluster template answers. For Rancher v2.3.x and above (list maxitems:1) Cluster template answers

clusterId
string
projectId
string
values
object
clusterTemplateQuestions
array

Cluster template questions. For Rancher v2.3.x and above (list) Cluster template questions

default
string
required
boolean
type
string
variable
string
driver
string
eksConfigV2
array

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with gke_config_v2, k3s_config, oke_config and rke_config. For Rancher v2.5.x and above (list maxitems:1)

imported
boolean
kmsKey
string
loggingTypes
array

The AWS cloudwatch logging types. audit, api, scheduler, controllerManager and authenticator values are allowed (list) The AWS logging types

name
string
nodeGroups
array

The EKS cluster name to import. Required to create a new cluster (list) The AWS node groups to use

diskSize
number
ec2SshKey
string
gpu
boolean
imageId
string
labels
object
launchTemplate
array

The EKS node groups launch template (list Maxitem: 1) The EKS node groups launch template

id
string
name
string
version
number
maxSize
number
minSize
number
name
string
nodeRole
string
spotInstanceTypes
array

The EKS node group sport instace types (list string) The EKS node group spot instance types

subnets
array

List of subnets in the virtual network to use (list) The EKS node group subnets

tags
object
userData
string
publicAccessSources
array

The EKS cluster public access sources (map) The EKS cluster public access sources

region
string
securityGroups
array

List of security groups to use for the cluster (list) List of security groups to use for the cluster

subnets
array

List of subnets in the virtual network to use (list) List of subnets in the virtual network to use

tags
object
fleetAgentDeploymentCustomization
array

Optional customization for fleet agent. For Rancher v2.7.5 and above (list) Optional customization for fleet agent

appendTolerations
array

User defined tolerations to append to agent (list) User defined tolerations to append to agent

effect
string
key
string
operator
string
seconds
number
value
string
overrideResourceRequirements
array

User defined resource requirements to set on the agent (list) User defined resource requirements to set on the agent

cpuLimit
string
gkeConfigV2
array

The Google GKE V2 configuration for gke Clusters. Conflicts with aks_config_v2, eks_config_v2, k3s_config, oke_config and rke_config. For Rancher v2.5.8 and above (list maxitems:1)

clusterAddons
array

The GKE cluster addons (List maxitems:1) The GKE cluster addons

googleCredentialSecretSecretRef
required
object

Google credential secret (string) Google credential secret

key
required
string
name
required
string
imported
boolean
ipAllocationPolicy
array

The GKE ip allocation policy (List maxitems:1) The GKE ip allocation policy

labels
object
locations
array

The GKE cluster locations (List) The GKE cluster locations

masterAuthorizedNetworksConfig
array

The GKE cluster master authorized networks config (List maxitems:1) The GKE cluster master authorized networks config

cidrBlocks
array

The GKE master authorized network config cidr blocks (List) The GKE master authorized network config cidr blocks

cidrBlock
string
enabled
boolean
name
string
network
string
nodePools
array

The AKS nnode pools. Required if imported=false (list) The GKE cluster node pools

autoscaling
array

The GKE node pool config autoscaling (List maxitems:1) The GKE node pool config autoscaling

enabled
boolean
config
array

The GKE node pool node config (List maxitems:1) The GKE node pool node config

diskType
string
imageType
string
labels
object
oauthScopes
array

The GKE node config oauth scopes (List) The GKE node config oauth scopes

tags
array

The AKS cluster tags (map) The GKE node config tags

taints
array

(Optonal) The AKS node pool taints (list) The GKE node config taints

effect
string
key
string
value
string
management
array

The GKE node pool config management (List maxitems:1) The GKE node pool config management

autoRepair
boolean
name
string
version
string
privateClusterConfig
array

The GKE private cluster config (List maxitems:1) The GKE private cluster config

projectId
string
region
string
zone
string
importedConfig
array

The imported configuration for generic imported Clusters. Conflicts with aks_config_v2, eks_config_v2, gke_config_v2, rke_config, rke2_config and k3s_config (list maxitems:1)

k3sConfig
array

The K3S configuration for k3s imported Clusters. Conflicts with aks_config_v2, eks_config_v2, gke_config_v2, oke_config and rke_config (list maxitems:1)

upgradeStrategy
array

RKE upgrade strategy (list maxitems:1) The K3S upgrade strategy

version
string
labels
object
name
string
okeConfig
array

The Oracle OKE configuration for oke Clusters. Conflicts with aks_config_v2, eks_config_v2, gke_config_v2, k3s_config and rke_config (list maxitems:1)

flexOcpus
number
kmsKeyId
string
nodeImage
string
nodeShape
string
podCidr
string
privateKeyContentsSecretRef
object

The private API key file contents for the specified user, in PEM format. Required unless using instance principals or workload identity to authenticate (string) The private API key file contents for the specified user, in PEM format

key
required
string
name
required
string
privateKeyPassphraseSecretRef
object

The passphrase (if any) of the private key for the OKE cluster. Required unless using instance principals or workload identity to authenticate (string) The passphrase of the private key for the OKE cluster

key
required
string
name
required
string
region
string
tenancyId
string
userOcid
string
vcnName
string
rke2Config
array

The RKE2 configuration for rke2 Clusters. Conflicts with aks_config_v2, k3s_config, oke_config and rke_config (list maxitems:1)

upgradeStrategy
array

RKE upgrade strategy (list maxitems:1) The RKE2 upgrade strategy

version
string
rkeConfig
array

The RKE configuration for rke Clusters. Conflicts with aks_config_v2, eks_config_v2, gke_config_v2, oke_config and k3s_config (list maxitems:1)

addons
string
addonsInclude
array

Addons yaml manifests to deploy on RKE cluster (list) Optional addons yaml manisfest to deploy on rke cluster.

authentication
array

Kubernetes cluster authentication (list maxitems:1) Kubernetes cluster authentication

sans
array

RKE sans for authentication ([]string)

strategy
string
authorization
array

Kubernetes cluster authorization (list maxitems:1) Kubernetes cluster authorization

mode
string
options
object
bastionHost
array

RKE bastion host (list maxitems:1) RKE bastion host

address
string
port
string
sshKeySecretRef
object

Bastion host SSH private key (string)

key
required
string
name
required
string
user
string
cloudProvider
array

RKE cloud provider rke-cloud-providers (list maxitems:1)

awsCloudProvider
array

RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)

global
serviceOverride
array

(list)

region
string
service
string
url
string
azureCloudProvider
array

RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)

aadClientCertPasswordSecretRef
object

(string)

key
required
string
name
required
string
aadClientIdSecretRef
required
object

(string)

key
required
string
name
required
string
aadClientSecretSecretRef
required
object

(string)

key
required
string
name
required
string
cloud
string
location
string
subscriptionIdSecretRef
required
object

(string)

key
required
string
name
required
string
tenantIdSecretRef
required
object

(string)

key
required
string
name
required
string
vmType
string
vnetName
string
name
string
openstackCloudProvider
array

RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)

blockStorage
array

(list maxitems:1)

bsVersion
string
global
array

(list maxitems:1)

authUrl
string
caFile
string
domainIdSecretRef
object

Required if domain_name not provided. (string)

key
required
string
name
required
string
passwordSecretRef
required
object

(string)

key
required
string
name
required
string
region
string
tenantIdSecretRef
object

(string)

key
required
string
name
required
string
trustIdSecretRef
object

(string)

key
required
string
name
required
string
usernameSecretRef
required
object

(string)

key
required
string
name
required
string
loadBalancer
metadata
array

(list maxitems:1)

route
array

(list maxitems:1)

routerId
string
vsphereCloudProvider
array

RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument name is required on virtual_center configuration. (list maxitems:1)

disk
array

(list maxitems:1)

global
array

(list maxitems:1)

passwordSecretRef
object

(string)

key
required
string
name
required
string
port
string
userSecretRef
object

User to connect bastion host (string)

key
required
string
name
required
string
network
array

Kubernetes cluster networking (list maxitems:1)

virtualCenter
array

(List)

name
string
passwordSecretRef
required
object

(string)

key
required
string
name
required
string
port
string
userSecretRef
required
object

User to connect bastion host (string)

key
required
string
name
required
string
workspace
array

(list maxitems:1)

folder
string
server
string
dns
array

RKE dns add-on. For Rancher v2.2.x (list maxitems:1)

linearAutoscalerParams
array

LinearAutoScalerParams dns config (list Maxitem: 1) Linear Autoscaler Params

max
number
min
number
nodelocal
array

Nodelocal dns config (list Maxitem: 1) Nodelocal dns

ipAddress
string
options
object
provider
string
reverseCidrs
array

DNS add-on reverse cidr (list)

tolerations
array

DNS add-on tolerations (list) DNS service tolerations

effect
string
key
string
operator
string
seconds
number
value
string
updateStrategy
array

DNS update strategy (list Maxitems: 1) Update deployment strategy

rollingUpdate
array

Monitoring daemon set rolling update (list Maxitems: 1) Rolling update for update strategy

maxSurge
number
strategy
string
upstreamNameservers
array

DNS add-on upstream nameservers (list)

ingress
array

Kubernetes ingress configuration (list maxitems:1) Kubernetes ingress configuration

dnsPolicy
string
extraArgs
object
httpPort
number
httpsPort
number
options
object
provider
string
tolerations
array

DNS add-on tolerations (list) Ingress add-on tolerations

effect
string
key
string
operator
string
seconds
number
value
string
updateStrategy
array

DNS update strategy (list Maxitems: 1) Update daemon set strategy

rollingUpdate
array

Monitoring daemon set rolling update (list Maxitems: 1) Rolling update for update strategy

strategy
string
monitoring
array

Kubernetes cluster monitoring (list maxitems:1) Kubernetes cluster monitoring

options
object
provider
string
replicas
number
tolerations
array

DNS add-on tolerations (list) Monitoring add-on tolerations

effect
string
key
string
operator
string
seconds
number
value
string
updateStrategy
array

DNS update strategy (list Maxitems: 1) Update deployment strategy

rollingUpdate
array

Monitoring daemon set rolling update (list Maxitems: 1) Rolling update for update strategy

maxSurge
number
strategy
string
network
array

Kubernetes cluster networking (list maxitems:1) Kubernetes cluster networking

aciNetworkProvider
array

ACI provider config for RKE network (list maxitems:63)

aep
string
apicHosts
array

List of APIC hosts to connect for APIC API (list)

apicUserCrtSecretRef
required
object

APIC user certificate (string)

key
required
string
name
required
string
apicUserKeySecretRef
required
object

APIC user key (string)

key
required
string
name
required
string
capic
string
encapType
string
infraVlan
string
kafkaBrokers
array

List of Kafka broker hosts (list)

l3out
string
l3outExternalNetworks
array

L3out external networks (list)

systemId
string
tenant
string
tokenSecretRef
required
object

ACI token (string)

key
required
string
name
required
string
vmmDomain
string
vrfName
string
vrfTenant
string
calicoNetworkProvider
array

Calico provider config for RKE network (list maxitems:1)

canalNetworkProvider
array

Canal provider config for RKE network (list maxitems:1)

iface
string
flannelNetworkProvider
array

Flannel provider config for RKE network (list maxitems:1)

iface
string
mtu
number
options
object
plugin
string
tolerations
array

DNS add-on tolerations (list) Network add-on tolerations

effect
string
key
string
operator
string
seconds
number
value
string
weaveNetworkProvider
array

Weave provider config for RKE network (list maxitems:1)

password
string
nodes
array

RKE cluster nodes (list) Optional RKE cluster nodes

address
string
labels
object
nodeId
string
port
string
role
array

(Requires) Roles for the node. controlplane, etcd and worker are supported. (list)

sshKeySecretRef
object

Bastion host SSH private key (string)

key
required
string
name
required
string
userSecretRef
required
object

User to connect bastion host (string)

key
required
string
name
required
string
privateRegistries
array

private registries for docker images (list) Optional private registries for docker images

ecrCredentialPlugin
array

ECR credential plugin config (list maxitems:1) ECR credential plugin config

awsSecretAccessKeySecretRef
object

AWS secret access key (string)

key
required
string
name
required
string
awsSessionTokenSecretRef
object

AWS session token (string)

key
required
string
name
required
string
isDefault
boolean
passwordSecretRef
object

(string)

key
required
string
name
required
string
url
string
userSecretRef
object

User to connect bastion host (string)

key
required
string
name
required
string
services
array

Kubernetes cluster services (list maxitems:1) Kubernetes cluster services

etcd
array

Etcd options for RKE services (list maxitems:1)

backupConfig
array

Backup options for etcd service. For Rancher v2.2.x (list maxitems:1)

enabled
boolean
retention
number
s3BackupConfig
array

S3 config options for etcd backup (list maxitems:1)

accessKeySecretRef
object

Access key for S3 service (string)

key
required
string
name
required
string
customCa
string
endpoint
string
folder
string
region
string
secretKeySecretRef
object

Secret key for S3 service (string)

key
required
string
name
required
string
timeout
number
caCert
string
certSecretRef
object

TLS certificate for etcd service (string)

key
required
string
name
required
string
creation
string
externalUrls
array

External urls for etcd service (list)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

gid
number
image
string
keySecretRef
object

The GKE taint key (string)

key
required
string
name
required
string
path
string
retention
string
snapshot
boolean
uid
number
kubeApi
array

Kube API options for RKE services (list maxitems:1)

admissionConfiguration
array

Admission configuration (map) Cluster admission configuration

kind
string
plugins
array

Admission configuration plugins. (list plugin) Admission configuration plugins

name
string
path
string
auditLog
array

K8s audit log configuration. (list maxitems: 1)

configuration
array

Plugin configuration. (string) Ex:

format
string
maxAge
number
maxBackup
number
maxSize
number
path
string
policy
string
enabled
boolean
eventRateLimit
array

K8s event rate limit configuration. (list maxitems: 1)

enabled
boolean
extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

image
string
secretsEncryptionConfig
array

Encrypt k8s secret data configration. (list maxitem: 1)

enabled
boolean
kubeController
array

Kube Controller options for RKE services (list maxitems:1)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

image
string
kubelet
array

Kubelet options for RKE services (list maxitems:1)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

failSwapOn
boolean
image
string
kubeproxy
array

Kubeproxy options for RKE services (list maxitems:1)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

image
string
scheduler
array

Scheduler options for RKE services (list maxitems:1)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

image
string
upgradeStrategy
array

RKE upgrade strategy (list maxitems:1) RKE upgrade strategy

drain
boolean
drainInput
array

RKE drain node input (list Maxitems: 1)

force
boolean
timeout
number
managementPolicies
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

providerConfigRef
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
writeConnectionSecretToRef
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

ClusterStatus defines the observed state of Cluster.

atProvider
object

(No description available)

agentEnvVars
array

Optional Agent Env Vars for Rancher agent. For Rancher v2.5.6 and above (list) Optional Agent Env Vars for Rancher agent

name
string
value
string
aksConfigV2
array

The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with eks_config_v2, gke_config_v2, k3s_config, oke_config and rke_config (list maxitems:1)

authorizedIpRanges
array

The AKS authorized ip ranges (list) The AKS authorized ip ranges

baseUrl
string
dnsPrefix
string
imported
boolean
monitoring
boolean
name
string
nodePools
array

The AKS nnode pools. Required if imported=false (list) The AKS node pools to use. Required if import=false

availabilityZones
array

The AKS node pool availability zones (list) The AKS node pool availability zones

count
number
labels
object
maxCount
number
maxPods
number
maxSurge
string
minCount
number
mode
string
name
string
osType
string
taints
array

(Optonal) The AKS node pool taints (list) The AKS node pool taints

vmSize
string
subnet
string
tags
object
clusterAgentDeploymentCustomization
array

Optional customization for cluster agent. For Rancher v2.7.5 and above (list) Optional customization for cluster agent

appendTolerations
array

User defined tolerations to append to agent (list) User defined tolerations to append to agent

effect
string
key
string
operator
string
seconds
number
value
string
overrideResourceRequirements
array

User defined resource requirements to set on the agent (list) User defined resource requirements to set on the agent

cpuLimit
string
schedulingCustomization
array

Supported in Rancher 2.11.0 and above. Defines the configuration of a Priority Class and or Pod Disruption Budget. Currently only supported by 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

podDisruptionBudget
array

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

priorityClass
array

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

value
number
clusterAuthEndpoint
array

Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

caCerts
string
enabled
boolean
fqdn
string
clusterRegistrationToken
array

(Computed) Cluster Registration Token generated for the cluster (list maxitems:1)

clusterId
string
command
string
id
string
labels
object
name
string
token
string
clusterTemplateAnswers
array

Cluster template answers. For Rancher v2.3.x and above (list maxitems:1) Cluster template answers

clusterId
string
projectId
string
values
object
clusterTemplateQuestions
array

Cluster template questions. For Rancher v2.3.x and above (list) Cluster template questions

default
string
required
boolean
type
string
variable
string
driver
string
eksConfigV2
array

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with gke_config_v2, k3s_config, oke_config and rke_config. For Rancher v2.5.x and above (list maxitems:1)

imported
boolean
kmsKey
string
loggingTypes
array

The AWS cloudwatch logging types. audit, api, scheduler, controllerManager and authenticator values are allowed (list) The AWS logging types

name
string
nodeGroups
array

The EKS cluster name to import. Required to create a new cluster (list) The AWS node groups to use

diskSize
number
ec2SshKey
string
gpu
boolean
imageId
string
labels
object
launchTemplate
array

The EKS node groups launch template (list Maxitem: 1) The EKS node groups launch template

id
string
name
string
version
number
maxSize
number
minSize
number
name
string
nodeRole
string
spotInstanceTypes
array

The EKS node group sport instace types (list string) The EKS node group spot instance types

subnets
array

List of subnets in the virtual network to use (list) The EKS node group subnets

tags
object
userData
string
version
string
publicAccessSources
array

The EKS cluster public access sources (map) The EKS cluster public access sources

region
string
securityGroups
array

List of security groups to use for the cluster (list) List of security groups to use for the cluster

subnets
array

List of subnets in the virtual network to use (list) List of subnets in the virtual network to use

tags
object
fleetAgentDeploymentCustomization
array

Optional customization for fleet agent. For Rancher v2.7.5 and above (list) Optional customization for fleet agent

appendTolerations
array

User defined tolerations to append to agent (list) User defined tolerations to append to agent

effect
string
key
string
operator
string
seconds
number
value
string
overrideResourceRequirements
array

User defined resource requirements to set on the agent (list) User defined resource requirements to set on the agent

cpuLimit
string
gkeConfigV2
array

The Google GKE V2 configuration for gke Clusters. Conflicts with aks_config_v2, eks_config_v2, k3s_config, oke_config and rke_config. For Rancher v2.5.8 and above (list maxitems:1)

clusterAddons
array

The GKE cluster addons (List maxitems:1) The GKE cluster addons

imported
boolean
ipAllocationPolicy
array

The GKE ip allocation policy (List maxitems:1) The GKE ip allocation policy

labels
object
locations
array

The GKE cluster locations (List) The GKE cluster locations

masterAuthorizedNetworksConfig
array

The GKE cluster master authorized networks config (List maxitems:1) The GKE cluster master authorized networks config

cidrBlocks
array

The GKE master authorized network config cidr blocks (List) The GKE master authorized network config cidr blocks

cidrBlock
string
enabled
boolean
name
string
network
string
nodePools
array

The AKS nnode pools. Required if imported=false (list) The GKE cluster node pools

autoscaling
array

The GKE node pool config autoscaling (List maxitems:1) The GKE node pool config autoscaling

enabled
boolean
config
array

The GKE node pool node config (List maxitems:1) The GKE node pool node config

diskType
string
imageType
string
labels
object
oauthScopes
array

The GKE node config oauth scopes (List) The GKE node config oauth scopes

tags
array

The AKS cluster tags (map) The GKE node config tags

taints
array

(Optonal) The AKS node pool taints (list) The GKE node config taints

effect
string
key
string
value
string
management
array

The GKE node pool config management (List maxitems:1) The GKE node pool config management

autoRepair
boolean
name
string
version
string
privateClusterConfig
array

The GKE private cluster config (List maxitems:1) The GKE private cluster config

projectId
string
region
string
zone
string
id
string
importedConfig
array

The imported configuration for generic imported Clusters. Conflicts with aks_config_v2, eks_config_v2, gke_config_v2, rke_config, rke2_config and k3s_config (list maxitems:1)

k3sConfig
array

The K3S configuration for k3s imported Clusters. Conflicts with aks_config_v2, eks_config_v2, gke_config_v2, oke_config and rke_config (list maxitems:1)

upgradeStrategy
array

RKE upgrade strategy (list maxitems:1) The K3S upgrade strategy

version
string
labels
object
name
string
okeConfig
array

The Oracle OKE configuration for oke Clusters. Conflicts with aks_config_v2, eks_config_v2, gke_config_v2, k3s_config and rke_config (list maxitems:1)

flexOcpus
number
kmsKeyId
string
nodeImage
string
nodeShape
string
podCidr
string
region
string
tenancyId
string
userOcid
string
vcnName
string
rke2Config
array

The RKE2 configuration for rke2 Clusters. Conflicts with aks_config_v2, k3s_config, oke_config and rke_config (list maxitems:1)

upgradeStrategy
array

RKE upgrade strategy (list maxitems:1) The RKE2 upgrade strategy

version
string
rkeConfig
array

The RKE configuration for rke Clusters. Conflicts with aks_config_v2, eks_config_v2, gke_config_v2, oke_config and k3s_config (list maxitems:1)

addons
string
addonsInclude
array

Addons yaml manifests to deploy on RKE cluster (list) Optional addons yaml manisfest to deploy on rke cluster.

authentication
array

Kubernetes cluster authentication (list maxitems:1) Kubernetes cluster authentication

sans
array

RKE sans for authentication ([]string)

strategy
string
authorization
array

Kubernetes cluster authorization (list maxitems:1) Kubernetes cluster authorization

mode
string
options
object
bastionHost
array

RKE bastion host (list maxitems:1) RKE bastion host

address
string
port
string
user
string
cloudProvider
array

RKE cloud provider rke-cloud-providers (list maxitems:1)

awsCloudProvider
array

RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)

global
serviceOverride
array

(list)

region
string
service
string
url
string
azureCloudProvider
name
string
openstackCloudProvider
array

RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)

blockStorage
array

(list maxitems:1)

bsVersion
string
global
array

(list maxitems:1)

authUrl
string
caFile
string
region
string
loadBalancer
metadata
array

(list maxitems:1)

route
array

(list maxitems:1)

routerId
string
vsphereCloudProvider
array

RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument name is required on virtual_center configuration. (list maxitems:1)

disk
array

(list maxitems:1)

global
array

(list maxitems:1)

port
string
network
array

Kubernetes cluster networking (list maxitems:1)

virtualCenter
array

(List)

name
string
port
string
workspace
array

(list maxitems:1)

folder
string
server
string
dns
array

RKE dns add-on. For Rancher v2.2.x (list maxitems:1)

linearAutoscalerParams
array

LinearAutoScalerParams dns config (list Maxitem: 1) Linear Autoscaler Params

max
number
min
number
nodelocal
array

Nodelocal dns config (list Maxitem: 1) Nodelocal dns

ipAddress
string
options
object
provider
string
reverseCidrs
array

DNS add-on reverse cidr (list)

tolerations
array

DNS add-on tolerations (list) DNS service tolerations

effect
string
key
string
operator
string
seconds
number
value
string
updateStrategy
array

DNS update strategy (list Maxitems: 1) Update deployment strategy

rollingUpdate
array

Monitoring daemon set rolling update (list Maxitems: 1) Rolling update for update strategy

maxSurge
number
strategy
string
upstreamNameservers
array

DNS add-on upstream nameservers (list)

ingress
array

Kubernetes ingress configuration (list maxitems:1) Kubernetes ingress configuration

dnsPolicy
string
extraArgs
object
httpPort
number
httpsPort
number
options
object
provider
string
tolerations
array

DNS add-on tolerations (list) Ingress add-on tolerations

effect
string
key
string
operator
string
seconds
number
value
string
updateStrategy
array

DNS update strategy (list Maxitems: 1) Update daemon set strategy

rollingUpdate
array

Monitoring daemon set rolling update (list Maxitems: 1) Rolling update for update strategy

strategy
string
monitoring
array

Kubernetes cluster monitoring (list maxitems:1) Kubernetes cluster monitoring

options
object
provider
string
replicas
number
tolerations
array

DNS add-on tolerations (list) Monitoring add-on tolerations

effect
string
key
string
operator
string
seconds
number
value
string
updateStrategy
array

DNS update strategy (list Maxitems: 1) Update deployment strategy

rollingUpdate
array

Monitoring daemon set rolling update (list Maxitems: 1) Rolling update for update strategy

maxSurge
number
strategy
string
network
array

Kubernetes cluster networking (list maxitems:1) Kubernetes cluster networking

aciNetworkProvider
array

ACI provider config for RKE network (list maxitems:63)

aep
string
apicHosts
array

List of APIC hosts to connect for APIC API (list)

capic
string
encapType
string
infraVlan
string
kafkaBrokers
array

List of Kafka broker hosts (list)

l3out
string
l3outExternalNetworks
array

L3out external networks (list)

systemId
string
tenant
string
vmmDomain
string
vrfName
string
vrfTenant
string
calicoNetworkProvider
array

Calico provider config for RKE network (list maxitems:1)

canalNetworkProvider
array

Canal provider config for RKE network (list maxitems:1)

iface
string
flannelNetworkProvider
array

Flannel provider config for RKE network (list maxitems:1)

iface
string
mtu
number
options
object
plugin
string
tolerations
array

DNS add-on tolerations (list) Network add-on tolerations

effect
string
key
string
operator
string
seconds
number
value
string
weaveNetworkProvider
array

Weave provider config for RKE network (list maxitems:1)

password
string
nodes
array

RKE cluster nodes (list) Optional RKE cluster nodes

address
string
labels
object
nodeId
string
port
string
role
array

(Requires) Roles for the node. controlplane, etcd and worker are supported. (list)

privateRegistries
array

private registries for docker images (list) Optional private registries for docker images

ecrCredentialPlugin
array

ECR credential plugin config (list maxitems:1) ECR credential plugin config

isDefault
boolean
url
string
services
array

Kubernetes cluster services (list maxitems:1) Kubernetes cluster services

etcd
array

Etcd options for RKE services (list maxitems:1)

backupConfig
array

Backup options for etcd service. For Rancher v2.2.x (list maxitems:1)

enabled
boolean
retention
number
s3BackupConfig
array

S3 config options for etcd backup (list maxitems:1)

customCa
string
endpoint
string
folder
string
region
string
timeout
number
caCert
string
creation
string
externalUrls
array

External urls for etcd service (list)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

gid
number
image
string
path
string
retention
string
snapshot
boolean
uid
number
kubeApi
array

Kube API options for RKE services (list maxitems:1)

admissionConfiguration
array

Admission configuration (map) Cluster admission configuration

kind
string
plugins
array

Admission configuration plugins. (list plugin) Admission configuration plugins

name
string
path
string
auditLog
array

K8s audit log configuration. (list maxitems: 1)

configuration
array

Plugin configuration. (string) Ex:

format
string
maxAge
number
maxBackup
number
maxSize
number
path
string
policy
string
enabled
boolean
eventRateLimit
array

K8s event rate limit configuration. (list maxitems: 1)

enabled
boolean
extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

image
string
secretsEncryptionConfig
array

Encrypt k8s secret data configration. (list maxitem: 1)

enabled
boolean
kubeController
array

Kube Controller options for RKE services (list maxitems:1)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

image
string
kubelet
array

Kubelet options for RKE services (list maxitems:1)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

failSwapOn
boolean
image
string
kubeproxy
array

Kubeproxy options for RKE services (list maxitems:1)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

image
string
scheduler
array

Scheduler options for RKE services (list maxitems:1)

extraArgs
object
extraBinds
array

Extra binds for etcd service (list)

extraEnv
array

Extra environment for etcd service (list)

image
string
upgradeStrategy
array

RKE upgrade strategy (list maxitems:1) RKE upgrade strategy

drain
boolean
drainInput
array

RKE drain node input (list Maxitems: 1)

force
boolean
timeout
number
conditions
array

Conditions of the resource.

lastTransitionTime
required
string
message
string
reason
required
string
status
required
string
type
required
string
Discover the building blocks for your internal cloud platform.
© 2026 Upbound, Inc.
Solutions
Learn
Company
Community
More