Cluster

Provides a Rancher v2 Cluster resource. This can be used to create Clusters for Rancher v2 environments and retrieve their information.

Create a Cluster Resource

new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);

def Cluster(resource_name, opts=None, aks_config=None, annotations=None, cluster_auth_endpoint=None, cluster_monitoring_input=None, cluster_template_answers=None, cluster_template_id=None, cluster_template_questions=None, cluster_template_revision_id=None, default_pod_security_policy_template_id=None, description=None, desired_agent_image=None, desired_auth_image=None, docker_root_dir=None, driver=None, eks_config=None, enable_cluster_alerting=None, enable_cluster_istio=None, enable_cluster_monitoring=None, enable_network_policy=None, gke_config=None, k3s_config=None, labels=None, name=None, rke_config=None, scheduled_cluster_scan=None, windows_prefered_cluster=None, __props__=None);

func NewCluster(ctx *Context, name string, args *ClusterArgs, opts ...ResourceOption) (*Cluster, error)

public Cluster(string name, ClusterArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Cluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Cluster resource accepts the following input properties:

AksConfig ClusterAksConfigArgs: The Azure AKS configuration for aks Clusters. Conflicts with eks_config, gke_config, k3s_config and rke_config (list maxitems:1)
Annotations Dictionary<string, object>: Annotations for cluster registration token object (map)
ClusterAuthEndpoint ClusterClusterAuthEndpointArgs: Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
ClusterMonitoringInput ClusterClusterMonitoringInputArgs: Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
ClusterTemplateAnswers ClusterClusterTemplateAnswersArgs: Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
ClusterTemplateId string: Cluster template ID. Just for Rancher v2.3.x and above (string)
ClusterTemplateQuestions List<ClusterClusterTemplateQuestionArgs>: Cluster template questions. Just for Rancher v2.3.x and above (list)
ClusterTemplateRevisionId string: Cluster template revision ID. Just for Rancher v2.3.x and above (string)
DefaultPodSecurityPolicyTemplateId string: Default pod security policy template id (string)
Description string: An optional description of this cluster (string)
DesiredAgentImage string: Desired agent image. Just for Rancher v2.3.x and above (string)
DesiredAuthImage string: Desired auth image. Just for Rancher v2.3.x and above (string)
DockerRootDir string: Desired auth image. Just for Rancher v2.3.x and above (string)
Driver string: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
EksConfig ClusterEksConfigArgs: The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, gke_config, k3s_config and rke_config (list maxitems:1)
EnableClusterAlerting bool: Enable built-in cluster alerting (bool)
EnableClusterIstio bool: Enable built-in cluster istio. Just for Rancher v2.3.x and above (bool)
EnableClusterMonitoring bool: Enable built-in cluster monitoring (bool)
EnableNetworkPolicy bool: Enable project network isolation (bool)
GkeConfig ClusterGkeConfigArgs: The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config, k3s_config and rke_config (list maxitems:1)
K3sConfig ClusterK3sConfigArgs: The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)
Labels Dictionary<string, object>: Labels for cluster registration token object (map)
Name string: Name of cluster registration token (string)
RkeConfig ClusterRkeConfigArgs: The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config and k3s_config (list maxitems:1)
ScheduledClusterScan ClusterScheduledClusterScanArgs: Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
WindowsPreferedCluster bool: Windows preferred cluster. Default: false (bool)

AksConfig ClusterAksConfig: The Azure AKS configuration for aks Clusters. Conflicts with eks_config, gke_config, k3s_config and rke_config (list maxitems:1)
Annotations map[string]interface{}: Annotations for cluster registration token object (map)
ClusterAuthEndpoint ClusterClusterAuthEndpoint: Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
ClusterMonitoringInput ClusterClusterMonitoringInput: Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
ClusterTemplateAnswers ClusterClusterTemplateAnswers: Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
ClusterTemplateId string: Cluster template ID. Just for Rancher v2.3.x and above (string)
ClusterTemplateQuestions []ClusterClusterTemplateQuestion: Cluster template questions. Just for Rancher v2.3.x and above (list)
ClusterTemplateRevisionId string: Cluster template revision ID. Just for Rancher v2.3.x and above (string)
DefaultPodSecurityPolicyTemplateId string: Default pod security policy template id (string)
Description string: An optional description of this cluster (string)
DesiredAgentImage string: Desired agent image. Just for Rancher v2.3.x and above (string)
DesiredAuthImage string: Desired auth image. Just for Rancher v2.3.x and above (string)
DockerRootDir string: Desired auth image. Just for Rancher v2.3.x and above (string)
Driver string: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
EksConfig ClusterEksConfig: The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, gke_config, k3s_config and rke_config (list maxitems:1)
EnableClusterAlerting bool: Enable built-in cluster alerting (bool)
EnableClusterIstio bool: Enable built-in cluster istio. Just for Rancher v2.3.x and above (bool)
EnableClusterMonitoring bool: Enable built-in cluster monitoring (bool)
EnableNetworkPolicy bool: Enable project network isolation (bool)
GkeConfig ClusterGkeConfig: The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config, k3s_config and rke_config (list maxitems:1)
K3sConfig ClusterK3sConfig: The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)
Labels map[string]interface{}: Labels for cluster registration token object (map)
Name string: Name of cluster registration token (string)
RkeConfig ClusterRkeConfig: The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config and k3s_config (list maxitems:1)
ScheduledClusterScan ClusterScheduledClusterScan: Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
WindowsPreferedCluster bool: Windows preferred cluster. Default: false (bool)

aksConfig ClusterAksConfig: The Azure AKS configuration for aks Clusters. Conflicts with eks_config, gke_config, k3s_config and rke_config (list maxitems:1)
annotations {[key: string]: any}: Annotations for cluster registration token object (map)
clusterAuthEndpoint ClusterClusterAuthEndpoint: Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
clusterMonitoringInput ClusterClusterMonitoringInput: Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
clusterTemplateAnswers ClusterClusterTemplateAnswers: Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
clusterTemplateId string: Cluster template ID. Just for Rancher v2.3.x and above (string)
clusterTemplateQuestions ClusterClusterTemplateQuestion[]: Cluster template questions. Just for Rancher v2.3.x and above (list)
clusterTemplateRevisionId string: Cluster template revision ID. Just for Rancher v2.3.x and above (string)
defaultPodSecurityPolicyTemplateId string: Default pod security policy template id (string)
description string: An optional description of this cluster (string)
desiredAgentImage string: Desired agent image. Just for Rancher v2.3.x and above (string)
desiredAuthImage string: Desired auth image. Just for Rancher v2.3.x and above (string)
dockerRootDir string: Desired auth image. Just for Rancher v2.3.x and above (string)
driver string: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
eksConfig ClusterEksConfig: The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, gke_config, k3s_config and rke_config (list maxitems:1)
enableClusterAlerting boolean: Enable built-in cluster alerting (bool)
enableClusterIstio boolean: Enable built-in cluster istio. Just for Rancher v2.3.x and above (bool)
enableClusterMonitoring boolean: Enable built-in cluster monitoring (bool)
enableNetworkPolicy boolean: Enable project network isolation (bool)
gkeConfig ClusterGkeConfig: The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config, k3s_config and rke_config (list maxitems:1)
k3sConfig ClusterK3sConfig: The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)
labels {[key: string]: any}: Labels for cluster registration token object (map)
name string: Name of cluster registration token (string)
rkeConfig ClusterRkeConfig: The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config and k3s_config (list maxitems:1)
scheduledClusterScan ClusterScheduledClusterScan: Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
windowsPreferedCluster boolean: Windows preferred cluster. Default: false (bool)

aks_config Dict[ClusterAksConfig]: The Azure AKS configuration for aks Clusters. Conflicts with eks_config, gke_config, k3s_config and rke_config (list maxitems:1)
annotations Dict[str, Any]: Annotations for cluster registration token object (map)
cluster_auth_endpoint Dict[ClusterClusterAuthEndpoint]: Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
cluster_monitoring_input Dict[ClusterClusterMonitoringInput]: Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
cluster_template_answers Dict[ClusterClusterTemplateAnswers]: Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
cluster_template_id str: Cluster template ID. Just for Rancher v2.3.x and above (string)
cluster_template_questions List[ClusterClusterTemplateQuestion]: Cluster template questions. Just for Rancher v2.3.x and above (list)
cluster_template_revision_id str: Cluster template revision ID. Just for Rancher v2.3.x and above (string)
default_pod_security_policy_template_id str: Default pod security policy template id (string)
description str: An optional description of this cluster (string)
desired_agent_image str: Desired agent image. Just for Rancher v2.3.x and above (string)
desired_auth_image str: Desired auth image. Just for Rancher v2.3.x and above (string)
docker_root_dir str: Desired auth image. Just for Rancher v2.3.x and above (string)
driver str: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
eks_config Dict[ClusterEksConfig]: The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, gke_config, k3s_config and rke_config (list maxitems:1)
enable_cluster_alerting bool: Enable built-in cluster alerting (bool)
enable_cluster_istio bool: Enable built-in cluster istio. Just for Rancher v2.3.x and above (bool)
enable_cluster_monitoring bool: Enable built-in cluster monitoring (bool)
enable_network_policy bool: Enable project network isolation (bool)
gke_config Dict[ClusterGkeConfig]: The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config, k3s_config and rke_config (list maxitems:1)
k3s_config Dict[ClusterK3sConfig]: The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)
labels Dict[str, Any]: Labels for cluster registration token object (map)
name str: Name of cluster registration token (string)
rke_config Dict[ClusterRkeConfig]: The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config and k3s_config (list maxitems:1)
scheduled_cluster_scan Dict[ClusterScheduledClusterScan]: Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
windows_prefered_cluster bool: Windows preferred cluster. Default: false (bool)

Outputs

All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

ClusterRegistrationToken ClusterClusterRegistrationToken: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
DefaultProjectId string: (Computed) Default project ID for the cluster (string)
Id string: The provider-assigned unique ID for this managed resource.
KubeConfig string: (Computed/Sensitive) Kube Config generated for the cluster (string)
SystemProjectId string: (Computed) System project ID for the cluster (string)

ClusterRegistrationToken ClusterClusterRegistrationToken: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
DefaultProjectId string: (Computed) Default project ID for the cluster (string)
Id string: The provider-assigned unique ID for this managed resource.
KubeConfig string: (Computed/Sensitive) Kube Config generated for the cluster (string)
SystemProjectId string: (Computed) System project ID for the cluster (string)

clusterRegistrationToken ClusterClusterRegistrationToken: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
defaultProjectId string: (Computed) Default project ID for the cluster (string)
id string: The provider-assigned unique ID for this managed resource.
kubeConfig string: (Computed/Sensitive) Kube Config generated for the cluster (string)
systemProjectId string: (Computed) System project ID for the cluster (string)

cluster_registration_token Dict[ClusterClusterRegistrationToken]: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
default_project_id str: (Computed) Default project ID for the cluster (string)
id str: The provider-assigned unique ID for this managed resource.
kube_config str: (Computed/Sensitive) Kube Config generated for the cluster (string)
system_project_id str: (Computed) System project ID for the cluster (string)

Look up an Existing Cluster Resource

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster

static get(resource_name, id, opts=None, aks_config=None, annotations=None, cluster_auth_endpoint=None, cluster_monitoring_input=None, cluster_registration_token=None, cluster_template_answers=None, cluster_template_id=None, cluster_template_questions=None, cluster_template_revision_id=None, default_pod_security_policy_template_id=None, default_project_id=None, description=None, desired_agent_image=None, desired_auth_image=None, docker_root_dir=None, driver=None, eks_config=None, enable_cluster_alerting=None, enable_cluster_istio=None, enable_cluster_monitoring=None, enable_network_policy=None, gke_config=None, k3s_config=None, kube_config=None, labels=None, name=None, rke_config=None, scheduled_cluster_scan=None, system_project_id=None, windows_prefered_cluster=None, __props__=None);

func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)

public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AksConfig ClusterAksConfigArgs: The Azure AKS configuration for aks Clusters. Conflicts with eks_config, gke_config, k3s_config and rke_config (list maxitems:1)
Annotations Dictionary<string, object>: Annotations for cluster registration token object (map)
ClusterAuthEndpoint ClusterClusterAuthEndpointArgs: Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
ClusterMonitoringInput ClusterClusterMonitoringInputArgs: Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
ClusterRegistrationToken ClusterClusterRegistrationTokenArgs: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
ClusterTemplateAnswers ClusterClusterTemplateAnswersArgs: Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
ClusterTemplateId string: Cluster template ID. Just for Rancher v2.3.x and above (string)
ClusterTemplateQuestions List<ClusterClusterTemplateQuestionArgs>: Cluster template questions. Just for Rancher v2.3.x and above (list)
ClusterTemplateRevisionId string: Cluster template revision ID. Just for Rancher v2.3.x and above (string)
DefaultPodSecurityPolicyTemplateId string: Default pod security policy template id (string)
DefaultProjectId string: (Computed) Default project ID for the cluster (string)
Description string: An optional description of this cluster (string)
DesiredAgentImage string: Desired agent image. Just for Rancher v2.3.x and above (string)
DesiredAuthImage string: Desired auth image. Just for Rancher v2.3.x and above (string)
DockerRootDir string: Desired auth image. Just for Rancher v2.3.x and above (string)
Driver string: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
EksConfig ClusterEksConfigArgs: The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, gke_config, k3s_config and rke_config (list maxitems:1)
EnableClusterAlerting bool: Enable built-in cluster alerting (bool)
EnableClusterIstio bool: Enable built-in cluster istio. Just for Rancher v2.3.x and above (bool)
EnableClusterMonitoring bool: Enable built-in cluster monitoring (bool)
EnableNetworkPolicy bool: Enable project network isolation (bool)
GkeConfig ClusterGkeConfigArgs: The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config, k3s_config and rke_config (list maxitems:1)
K3sConfig ClusterK3sConfigArgs: The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)
KubeConfig string: (Computed/Sensitive) Kube Config generated for the cluster (string)
Labels Dictionary<string, object>: Labels for cluster registration token object (map)
Name string: Name of cluster registration token (string)
RkeConfig ClusterRkeConfigArgs: The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config and k3s_config (list maxitems:1)
ScheduledClusterScan ClusterScheduledClusterScanArgs: Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
SystemProjectId string: (Computed) System project ID for the cluster (string)
WindowsPreferedCluster bool: Windows preferred cluster. Default: false (bool)

AksConfig ClusterAksConfig: The Azure AKS configuration for aks Clusters. Conflicts with eks_config, gke_config, k3s_config and rke_config (list maxitems:1)
Annotations map[string]interface{}: Annotations for cluster registration token object (map)
ClusterAuthEndpoint ClusterClusterAuthEndpoint: Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
ClusterMonitoringInput ClusterClusterMonitoringInput: Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
ClusterRegistrationToken ClusterClusterRegistrationToken: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
ClusterTemplateAnswers ClusterClusterTemplateAnswers: Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
ClusterTemplateId string: Cluster template ID. Just for Rancher v2.3.x and above (string)
ClusterTemplateQuestions []ClusterClusterTemplateQuestion: Cluster template questions. Just for Rancher v2.3.x and above (list)
ClusterTemplateRevisionId string: Cluster template revision ID. Just for Rancher v2.3.x and above (string)
DefaultPodSecurityPolicyTemplateId string: Default pod security policy template id (string)
DefaultProjectId string: (Computed) Default project ID for the cluster (string)
Description string: An optional description of this cluster (string)
DesiredAgentImage string: Desired agent image. Just for Rancher v2.3.x and above (string)
DesiredAuthImage string: Desired auth image. Just for Rancher v2.3.x and above (string)
DockerRootDir string: Desired auth image. Just for Rancher v2.3.x and above (string)
Driver string: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
EksConfig ClusterEksConfig: The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, gke_config, k3s_config and rke_config (list maxitems:1)
EnableClusterAlerting bool: Enable built-in cluster alerting (bool)
EnableClusterIstio bool: Enable built-in cluster istio. Just for Rancher v2.3.x and above (bool)
EnableClusterMonitoring bool: Enable built-in cluster monitoring (bool)
EnableNetworkPolicy bool: Enable project network isolation (bool)
GkeConfig ClusterGkeConfig: The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config, k3s_config and rke_config (list maxitems:1)
K3sConfig ClusterK3sConfig: The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)
KubeConfig string: (Computed/Sensitive) Kube Config generated for the cluster (string)
Labels map[string]interface{}: Labels for cluster registration token object (map)
Name string: Name of cluster registration token (string)
RkeConfig ClusterRkeConfig: The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config and k3s_config (list maxitems:1)
ScheduledClusterScan ClusterScheduledClusterScan: Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
SystemProjectId string: (Computed) System project ID for the cluster (string)
WindowsPreferedCluster bool: Windows preferred cluster. Default: false (bool)

aksConfig ClusterAksConfig: The Azure AKS configuration for aks Clusters. Conflicts with eks_config, gke_config, k3s_config and rke_config (list maxitems:1)
annotations {[key: string]: any}: Annotations for cluster registration token object (map)
clusterAuthEndpoint ClusterClusterAuthEndpoint: Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
clusterMonitoringInput ClusterClusterMonitoringInput: Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
clusterRegistrationToken ClusterClusterRegistrationToken: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
clusterTemplateAnswers ClusterClusterTemplateAnswers: Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
clusterTemplateId string: Cluster template ID. Just for Rancher v2.3.x and above (string)
clusterTemplateQuestions ClusterClusterTemplateQuestion[]: Cluster template questions. Just for Rancher v2.3.x and above (list)
clusterTemplateRevisionId string: Cluster template revision ID. Just for Rancher v2.3.x and above (string)
defaultPodSecurityPolicyTemplateId string: Default pod security policy template id (string)
defaultProjectId string: (Computed) Default project ID for the cluster (string)
description string: An optional description of this cluster (string)
desiredAgentImage string: Desired agent image. Just for Rancher v2.3.x and above (string)
desiredAuthImage string: Desired auth image. Just for Rancher v2.3.x and above (string)
dockerRootDir string: Desired auth image. Just for Rancher v2.3.x and above (string)
driver string: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
eksConfig ClusterEksConfig: The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, gke_config, k3s_config and rke_config (list maxitems:1)
enableClusterAlerting boolean: Enable built-in cluster alerting (bool)
enableClusterIstio boolean: Enable built-in cluster istio. Just for Rancher v2.3.x and above (bool)
enableClusterMonitoring boolean: Enable built-in cluster monitoring (bool)
enableNetworkPolicy boolean: Enable project network isolation (bool)
gkeConfig ClusterGkeConfig: The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config, k3s_config and rke_config (list maxitems:1)
k3sConfig ClusterK3sConfig: The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)
kubeConfig string: (Computed/Sensitive) Kube Config generated for the cluster (string)
labels {[key: string]: any}: Labels for cluster registration token object (map)
name string: Name of cluster registration token (string)
rkeConfig ClusterRkeConfig: The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config and k3s_config (list maxitems:1)
scheduledClusterScan ClusterScheduledClusterScan: Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
systemProjectId string: (Computed) System project ID for the cluster (string)
windowsPreferedCluster boolean: Windows preferred cluster. Default: false (bool)

aks_config Dict[ClusterAksConfig]: The Azure AKS configuration for aks Clusters. Conflicts with eks_config, gke_config, k3s_config and rke_config (list maxitems:1)
annotations Dict[str, Any]: Annotations for cluster registration token object (map)
cluster_auth_endpoint Dict[ClusterClusterAuthEndpoint]: Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
cluster_monitoring_input Dict[ClusterClusterMonitoringInput]: Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
cluster_registration_token Dict[ClusterClusterRegistrationToken]: (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
cluster_template_answers Dict[ClusterClusterTemplateAnswers]: Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
cluster_template_id str: Cluster template ID. Just for Rancher v2.3.x and above (string)
cluster_template_questions List[ClusterClusterTemplateQuestion]: Cluster template questions. Just for Rancher v2.3.x and above (list)
cluster_template_revision_id str: Cluster template revision ID. Just for Rancher v2.3.x and above (string)
default_pod_security_policy_template_id str: Default pod security policy template id (string)
default_project_id str: (Computed) Default project ID for the cluster (string)
description str: An optional description of this cluster (string)
desired_agent_image str: Desired agent image. Just for Rancher v2.3.x and above (string)
desired_auth_image str: Desired auth image. Just for Rancher v2.3.x and above (string)
docker_root_dir str: Desired auth image. Just for Rancher v2.3.x and above (string)
driver str: (Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)
eks_config Dict[ClusterEksConfig]: The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, gke_config, k3s_config and rke_config (list maxitems:1)
enable_cluster_alerting bool: Enable built-in cluster alerting (bool)
enable_cluster_istio bool: Enable built-in cluster istio. Just for Rancher v2.3.x and above (bool)
enable_cluster_monitoring bool: Enable built-in cluster monitoring (bool)
enable_network_policy bool: Enable project network isolation (bool)
gke_config Dict[ClusterGkeConfig]: The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config, k3s_config and rke_config (list maxitems:1)
k3s_config Dict[ClusterK3sConfig]: The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)
kube_config str: (Computed/Sensitive) Kube Config generated for the cluster (string)
labels Dict[str, Any]: Labels for cluster registration token object (map)
name str: Name of cluster registration token (string)
rke_config Dict[ClusterRkeConfig]: The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config and k3s_config (list maxitems:1)
scheduled_cluster_scan Dict[ClusterScheduledClusterScan]: Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
system_project_id str: (Computed) System project ID for the cluster (string)
windows_prefered_cluster bool: Windows preferred cluster. Default: false (bool)

Supporting Types

ClusterAksConfig

AgentDnsPrefix string: DNS prefix to be used to create the FQDN for the agent pool (string)
ClientId string: Azure client ID to use (string)
ClientSecret string: Azure client secret associated with the \“client id\” (string)
KubernetesVersion string: The Kubernetes master version (string)
MasterDnsPrefix string: DNS prefix to use the Kubernetes cluster control pane (string)
ResourceGroup string: The name of the Cluster resource group (string)
SshPublicKeyContents string: Contents of the SSH public key used to authenticate with Linux hosts (string)
Subnet string: The name of an existing Azure Virtual Subnet. Composite of agent virtual network subnet ID (string)
SubscriptionId string: Subscription credentials which uniquely identify Microsoft Azure subscription (string)
TenantId string: Azure tenant ID to use (string)
VirtualNetwork string: The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)
VirtualNetworkResourceGroup string: The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)
AadServerAppSecret string: The secret of an Azure Active Directory server application (string)
AadTenantId string: The ID of an Azure Active Directory tenant (string)
AddClientAppId string: The ID of an Azure Active Directory client application of type \“Native\“. This application is for user login via kubectl (string)
AddServerAppId string: The ID of an Azure Active Directory server application of type \“Web app/API\“. This application represents the managed cluster’s apiserver (Server application) (string)
AdminUsername string: The administrator username to use for Linux hosts. Default azureuser (string)
AgentOsDiskSize int: GB size to be used to specify the disk for every machine in the agent pool. If you specify 0, it will apply the default according to the \“agent vm size\” specified. Default 0 (int)
AgentPoolName string: Name for the agent pool, upto 12 alphanumeric characters. Default agentpool0 (string)
AgentStorageProfile string: Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default ManagedDisks (string)
AgentVmSize string: Size of machine in the agent pool. Default Standard_D1_v2 (string)
AuthBaseUrl string: Different authentication API url to use. Default https://login.microsoftonline.com/ (string)
BaseUrl string: Different resource management API url to use. Default https://management.azure.com/ (string)
Count int: Number of machines (VMs) in the agent pool. Allowed values must be in the range of 1 to 100 (inclusive). Default 1 (int)
DnsServiceIp string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes Service address range specified in \“service cidr\“. Default 10.0.0.10 (string)
DockerBridgeCidr string: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes Service address range specified in \“service cidr\“. Default 172.17.0.1/16 (string)
EnableHttpApplicationRouting bool: Enable the Kubernetes ingress with automatic public DNS name creation. Default false (bool)
EnableMonitoring bool: Turn on Azure Log Analytics monitoring. Uses the Log Analytics \“Default\” workspace if it exists, else creates one. if using an existing workspace, specifies \“log analytics workspace resource id\“. Default true (bool)
Location string: Azure Kubernetes cluster location. Default eastus (string)
LogAnalyticsWorkspace string: The name of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses ‘{resource group}-{subscription id}-{location code}’ (string)
LogAnalyticsWorkspaceResourceGroup string: The resource group of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses the ‘Cluster’ resource group (string)
MaxPods int: Maximum number of pods that can run on a node. Default 110 (int)
NetworkPlugin string: Network plugin used for building Kubernetes network. Chooses from azure or kubenet. Default azure (string)
NetworkPolicy string: Network policy used for building Kubernetes network. Chooses from calico (string)
PodCidr string: A CIDR notation IP range from which to assign Kubernetes Pod IPs when \“network plugin\” is specified in \“kubenet\“. Default 172.244.0.0/16 (string)
ServiceCidr string: A CIDR notation IP range from which to assign Kubernetes Service cluster IPs. It must not overlap with any Subnet IP ranges. Default 10.0.0.0/16 (string)
Tag Dictionary<string, object>: Tags for Kubernetes cluster. For example, foo=bar (map)

AgentDnsPrefix string: DNS prefix to be used to create the FQDN for the agent pool (string)
ClientId string: Azure client ID to use (string)
ClientSecret string: Azure client secret associated with the \“client id\” (string)
KubernetesVersion string: The Kubernetes master version (string)
MasterDnsPrefix string: DNS prefix to use the Kubernetes cluster control pane (string)
ResourceGroup string: The name of the Cluster resource group (string)
SshPublicKeyContents string: Contents of the SSH public key used to authenticate with Linux hosts (string)
Subnet string: The name of an existing Azure Virtual Subnet. Composite of agent virtual network subnet ID (string)
SubscriptionId string: Subscription credentials which uniquely identify Microsoft Azure subscription (string)
TenantId string: Azure tenant ID to use (string)
VirtualNetwork string: The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)
VirtualNetworkResourceGroup string: The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)
AadServerAppSecret string: The secret of an Azure Active Directory server application (string)
AadTenantId string: The ID of an Azure Active Directory tenant (string)
AddClientAppId string: The ID of an Azure Active Directory client application of type \“Native\“. This application is for user login via kubectl (string)
AddServerAppId string: The ID of an Azure Active Directory server application of type \“Web app/API\“. This application represents the managed cluster’s apiserver (Server application) (string)
AdminUsername string: The administrator username to use for Linux hosts. Default azureuser (string)
AgentOsDiskSize int: GB size to be used to specify the disk for every machine in the agent pool. If you specify 0, it will apply the default according to the \“agent vm size\” specified. Default 0 (int)
AgentPoolName string: Name for the agent pool, upto 12 alphanumeric characters. Default agentpool0 (string)
AgentStorageProfile string: Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default ManagedDisks (string)
AgentVmSize string: Size of machine in the agent pool. Default Standard_D1_v2 (string)
AuthBaseUrl string: Different authentication API url to use. Default https://login.microsoftonline.com/ (string)
BaseUrl string: Different resource management API url to use. Default https://management.azure.com/ (string)
Count int: Number of machines (VMs) in the agent pool. Allowed values must be in the range of 1 to 100 (inclusive). Default 1 (int)
DnsServiceIp string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes Service address range specified in \“service cidr\“. Default 10.0.0.10 (string)
DockerBridgeCidr string: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes Service address range specified in \“service cidr\“. Default 172.17.0.1/16 (string)
EnableHttpApplicationRouting bool: Enable the Kubernetes ingress with automatic public DNS name creation. Default false (bool)
EnableMonitoring bool: Turn on Azure Log Analytics monitoring. Uses the Log Analytics \“Default\” workspace if it exists, else creates one. if using an existing workspace, specifies \“log analytics workspace resource id\“. Default true (bool)
Location string: Azure Kubernetes cluster location. Default eastus (string)
LogAnalyticsWorkspace string: The name of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses ‘{resource group}-{subscription id}-{location code}’ (string)
LogAnalyticsWorkspaceResourceGroup string: The resource group of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses the ‘Cluster’ resource group (string)
MaxPods int: Maximum number of pods that can run on a node. Default 110 (int)
NetworkPlugin string: Network plugin used for building Kubernetes network. Chooses from azure or kubenet. Default azure (string)
NetworkPolicy string: Network policy used for building Kubernetes network. Chooses from calico (string)
PodCidr string: A CIDR notation IP range from which to assign Kubernetes Pod IPs when \“network plugin\” is specified in \“kubenet\“. Default 172.244.0.0/16 (string)
ServiceCidr string: A CIDR notation IP range from which to assign Kubernetes Service cluster IPs. It must not overlap with any Subnet IP ranges. Default 10.0.0.0/16 (string)
Tag map[string]interface{}: Tags for Kubernetes cluster. For example, foo=bar (map)

agentDnsPrefix string: DNS prefix to be used to create the FQDN for the agent pool (string)
clientId string: Azure client ID to use (string)
clientSecret string: Azure client secret associated with the \“client id\” (string)
kubernetesVersion string: The Kubernetes master version (string)
masterDnsPrefix string: DNS prefix to use the Kubernetes cluster control pane (string)
resourceGroup string: The name of the Cluster resource group (string)
sshPublicKeyContents string: Contents of the SSH public key used to authenticate with Linux hosts (string)
subnet string: The name of an existing Azure Virtual Subnet. Composite of agent virtual network subnet ID (string)
subscriptionId string: Subscription credentials which uniquely identify Microsoft Azure subscription (string)
tenantId string: Azure tenant ID to use (string)
virtualNetwork string: The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)
virtualNetworkResourceGroup string: The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)
aadServerAppSecret string: The secret of an Azure Active Directory server application (string)
aadTenantId string: The ID of an Azure Active Directory tenant (string)
addClientAppId string: The ID of an Azure Active Directory client application of type \“Native\“. This application is for user login via kubectl (string)
addServerAppId string: The ID of an Azure Active Directory server application of type \“Web app/API\“. This application represents the managed cluster’s apiserver (Server application) (string)
adminUsername string: The administrator username to use for Linux hosts. Default azureuser (string)
agentOsDiskSize number: GB size to be used to specify the disk for every machine in the agent pool. If you specify 0, it will apply the default according to the \“agent vm size\” specified. Default 0 (int)
agentPoolName string: Name for the agent pool, upto 12 alphanumeric characters. Default agentpool0 (string)
agentStorageProfile string: Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default ManagedDisks (string)
agentVmSize string: Size of machine in the agent pool. Default Standard_D1_v2 (string)
authBaseUrl string: Different authentication API url to use. Default https://login.microsoftonline.com/ (string)
baseUrl string: Different resource management API url to use. Default https://management.azure.com/ (string)
count number: Number of machines (VMs) in the agent pool. Allowed values must be in the range of 1 to 100 (inclusive). Default 1 (int)
dnsServiceIp string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes Service address range specified in \“service cidr\“. Default 10.0.0.10 (string)
dockerBridgeCidr string: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes Service address range specified in \“service cidr\“. Default 172.17.0.1/16 (string)
enableHttpApplicationRouting boolean: Enable the Kubernetes ingress with automatic public DNS name creation. Default false (bool)
enableMonitoring boolean: Turn on Azure Log Analytics monitoring. Uses the Log Analytics \“Default\” workspace if it exists, else creates one. if using an existing workspace, specifies \“log analytics workspace resource id\“. Default true (bool)
location string: Azure Kubernetes cluster location. Default eastus (string)
logAnalyticsWorkspace string: The name of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses ‘{resource group}-{subscription id}-{location code}’ (string)
logAnalyticsWorkspaceResourceGroup string: The resource group of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses the ‘Cluster’ resource group (string)
maxPods number: Maximum number of pods that can run on a node. Default 110 (int)
networkPlugin string: Network plugin used for building Kubernetes network. Chooses from azure or kubenet. Default azure (string)
networkPolicy string: Network policy used for building Kubernetes network. Chooses from calico (string)
podCidr string: A CIDR notation IP range from which to assign Kubernetes Pod IPs when \“network plugin\” is specified in \“kubenet\“. Default 172.244.0.0/16 (string)
serviceCidr string: A CIDR notation IP range from which to assign Kubernetes Service cluster IPs. It must not overlap with any Subnet IP ranges. Default 10.0.0.0/16 (string)
tag {[key: string]: any}: Tags for Kubernetes cluster. For example, foo=bar (map)

agentDnsPrefix str: DNS prefix to be used to create the FQDN for the agent pool (string)
client_id str: Azure client ID to use (string)
client_secret str: Azure client secret associated with the \“client id\” (string)
kubernetesVersion str: The Kubernetes master version (string)
masterDnsPrefix str: DNS prefix to use the Kubernetes cluster control pane (string)
resourceGroup str: The name of the Cluster resource group (string)
sshPublicKeyContents str: Contents of the SSH public key used to authenticate with Linux hosts (string)
subnet str: The name of an existing Azure Virtual Subnet. Composite of agent virtual network subnet ID (string)
subscriptionId str: Subscription credentials which uniquely identify Microsoft Azure subscription (string)
tenant_id str: Azure tenant ID to use (string)
virtualNetwork str: The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)
virtualNetworkResourceGroup str: The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)
aadServerAppSecret str: The secret of an Azure Active Directory server application (string)
aadTenantId str: The ID of an Azure Active Directory tenant (string)
addClientAppId str: The ID of an Azure Active Directory client application of type \“Native\“. This application is for user login via kubectl (string)
addServerAppId str: The ID of an Azure Active Directory server application of type \“Web app/API\“. This application represents the managed cluster’s apiserver (Server application) (string)
adminUsername str: The administrator username to use for Linux hosts. Default azureuser (string)
agentOsDiskSize float: GB size to be used to specify the disk for every machine in the agent pool. If you specify 0, it will apply the default according to the \“agent vm size\” specified. Default 0 (int)
agentPoolName str: Name for the agent pool, upto 12 alphanumeric characters. Default agentpool0 (string)
agentStorageProfile str: Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default ManagedDisks (string)
agentVmSize str: Size of machine in the agent pool. Default Standard_D1_v2 (string)
authBaseUrl str: Different authentication API url to use. Default https://login.microsoftonline.com/ (string)
baseUrl str: Different resource management API url to use. Default https://management.azure.com/ (string)
count float: Number of machines (VMs) in the agent pool. Allowed values must be in the range of 1 to 100 (inclusive). Default 1 (int)
dnsServiceIp str: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes Service address range specified in \“service cidr\“. Default 10.0.0.10 (string)
dockerBridgeCidr str: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes Service address range specified in \“service cidr\“. Default 172.17.0.1/16 (string)
enableHttpApplicationRouting bool: Enable the Kubernetes ingress with automatic public DNS name creation. Default false (bool)
enableMonitoring bool: Turn on Azure Log Analytics monitoring. Uses the Log Analytics \“Default\” workspace if it exists, else creates one. if using an existing workspace, specifies \“log analytics workspace resource id\“. Default true (bool)
location str: Azure Kubernetes cluster location. Default eastus (string)
logAnalyticsWorkspace str: The name of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses ‘{resource group}-{subscription id}-{location code}’ (string)
logAnalyticsWorkspaceResourceGroup str: The resource group of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses the ‘Cluster’ resource group (string)
maxPods float: Maximum number of pods that can run on a node. Default 110 (int)
networkPlugin str: Network plugin used for building Kubernetes network. Chooses from azure or kubenet. Default azure (string)
networkPolicy str: Network policy used for building Kubernetes network. Chooses from calico (string)
podCidr str: A CIDR notation IP range from which to assign Kubernetes Pod IPs when \“network plugin\” is specified in \“kubenet\“. Default 172.244.0.0/16 (string)
serviceCidr str: A CIDR notation IP range from which to assign Kubernetes Service cluster IPs. It must not overlap with any Subnet IP ranges. Default 10.0.0.0/16 (string)
tag Dict[str, Any]: Tags for Kubernetes cluster. For example, foo=bar (map)

ClusterClusterAuthEndpoint

CaCerts string: CA certs for the authorized cluster endpoint (string)
Enabled bool: Enable scheduled cluster scan. Default: false (bool)
Fqdn string: FQDN for the authorized cluster endpoint (string)

CaCerts string: CA certs for the authorized cluster endpoint (string)
Enabled bool: Enable scheduled cluster scan. Default: false (bool)
Fqdn string: FQDN for the authorized cluster endpoint (string)

caCerts string: CA certs for the authorized cluster endpoint (string)
enabled boolean: Enable scheduled cluster scan. Default: false (bool)
fqdn string: FQDN for the authorized cluster endpoint (string)

ca_certs str: CA certs for the authorized cluster endpoint (string)
enabled bool: Enable scheduled cluster scan. Default: false (bool)
fqdn str: FQDN for the authorized cluster endpoint (string)

ClusterClusterMonitoringInput

Answers Dictionary<string, object>: Key/value answers for monitor input (map)
Version string: rancher-monitoring chart version (string)

Answers map[string]interface{}: Key/value answers for monitor input (map)
Version string: rancher-monitoring chart version (string)

answers {[key: string]: any}: Key/value answers for monitor input (map)
version string: rancher-monitoring chart version (string)

answers Dict[str, Any]: Key/value answers for monitor input (map)
version str: rancher-monitoring chart version (string)

ClusterClusterRegistrationToken

Annotations Dictionary<string, object>: Annotations for cluster registration token object (map)
ClusterId string: Cluster ID (string)
Command string: Command to execute in a imported k8s cluster (string)
Id string: (Computed) The ID of the resource (string)
InsecureCommand string: Insecure command to execute in a imported k8s cluster (string)
Labels Dictionary<string, object>: Labels for cluster registration token object (map)
ManifestUrl string: K8s manifest url to execute with kubectl to import an existing k8s cluster (string)
Name string: Name of cluster registration token (string)
NodeCommand string: Node command to execute in linux nodes for custom k8s cluster (string)
Token string: Token for cluster registration token object (string)
WindowsNodeCommand string: Node command to execute in windows nodes for custom k8s cluster (string)

Annotations map[string]interface{}: Annotations for cluster registration token object (map)
ClusterId string: Cluster ID (string)
Command string: Command to execute in a imported k8s cluster (string)
Id string: (Computed) The ID of the resource (string)
InsecureCommand string: Insecure command to execute in a imported k8s cluster (string)
Labels map[string]interface{}: Labels for cluster registration token object (map)
ManifestUrl string: K8s manifest url to execute with kubectl to import an existing k8s cluster (string)
Name string: Name of cluster registration token (string)
NodeCommand string: Node command to execute in linux nodes for custom k8s cluster (string)
Token string: Token for cluster registration token object (string)
WindowsNodeCommand string: Node command to execute in windows nodes for custom k8s cluster (string)

annotations {[key: string]: any}: Annotations for cluster registration token object (map)
clusterId string: Cluster ID (string)
command string: Command to execute in a imported k8s cluster (string)
id string: (Computed) The ID of the resource (string)
insecureCommand string: Insecure command to execute in a imported k8s cluster (string)
labels {[key: string]: any}: Labels for cluster registration token object (map)
manifestUrl string: K8s manifest url to execute with kubectl to import an existing k8s cluster (string)
name string: Name of cluster registration token (string)
nodeCommand string: Node command to execute in linux nodes for custom k8s cluster (string)
token string: Token for cluster registration token object (string)
windowsNodeCommand string: Node command to execute in windows nodes for custom k8s cluster (string)

annotations Dict[str, Any]: Annotations for cluster registration token object (map)
cluster_id str: Cluster ID (string)
command str: Command to execute in a imported k8s cluster (string)
id str: (Computed) The ID of the resource (string)
insecureCommand str: Insecure command to execute in a imported k8s cluster (string)
labels Dict[str, Any]: Labels for cluster registration token object (map)
manifestUrl str: K8s manifest url to execute with kubectl to import an existing k8s cluster (string)
name str: Name of cluster registration token (string)
nodeCommand str: Node command to execute in linux nodes for custom k8s cluster (string)
token str: Token for cluster registration token object (string)
windowsNodeCommand str: Node command to execute in windows nodes for custom k8s cluster (string)

ClusterClusterTemplateAnswers

ClusterId string: Cluster ID (string)
ProjectId string: Project ID to apply answer (string)
Values Dictionary<string, object>: Key/values for answer (map)

ClusterId string: Cluster ID (string)
ProjectId string: Project ID to apply answer (string)
Values map[string]interface{}: Key/values for answer (map)

clusterId string: Cluster ID (string)
projectId string: Project ID to apply answer (string)
values {[key: string]: any}: Key/values for answer (map)

cluster_id str: Cluster ID (string)
project_id str: Project ID to apply answer (string)
values Dict[str, Any]: Key/values for answer (map)

ClusterClusterTemplateQuestion

Default string: Default variable value (string)
Variable string: Variable name (string)
Required bool: Required variable. Default false (bool)
Type string: Variable type. boolean, int and string are allowed. Default string (string)

Default string: Default variable value (string)
Variable string: Variable name (string)
Required bool: Required variable. Default false (bool)
Type string: Variable type. boolean, int and string are allowed. Default string (string)

default string: Default variable value (string)
variable string: Variable name (string)
required boolean: Required variable. Default false (bool)
type string: Variable type. boolean, int and string are allowed. Default string (string)

default str: Default variable value (string)
variable str: Variable name (string)
required bool: Required variable. Default false (bool)
type str: Variable type. boolean, int and string are allowed. Default string (string)

ClusterEksConfig

AccessKey string: The AWS Client ID to use (string)
KubernetesVersion string: The Kubernetes master version (string)
SecretKey string: The AWS Client Secret associated with the Client ID (string)
Ami string: AMI ID to use for the worker nodes instead of the default (string)
AssociateWorkerNodePublicIp bool: Associate public ip EKS worker nodes. Default true (bool)
DesiredNodes int: The desired number of worker nodes. Just for Rancher v2.3.x and above. Default 3 (int)
InstanceType string: The type of machine to use for worker nodes. Default t2.medium (string)
KeyPairName string: Allow user to specify key name to use. Just for Rancher v2.2.7 and above (string)
MaximumNodes int: The maximum number of worker nodes. Default 3 (int)
MinimumNodes int: The minimum number of worker nodes. Default 1 (int)
NodeVolumeSize int: The volume size for each node. Default 20 (int)
Region string: GKE cluster region. Conflicts with zone (string)
SecurityGroups List<string>: List of security groups to use for the cluster. If it’s not specified Rancher will create a new security group (list)
ServiceRole string: The service role to use to perform the cluster operations in AWS. If it’s not specified Rancher will create a new service role (string)
SessionToken string: A session token to use with the client key and secret if applicable (string)
Subnets List<string>: List of subnets in the virtual network to use. If it’s not specified Rancher will create 3 news subnets (list)
UserData string: Pass user-data to the nodes to perform automated configuration tasks (string)
VirtualNetwork string: The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

AccessKey string: The AWS Client ID to use (string)
KubernetesVersion string: The Kubernetes master version (string)
SecretKey string: The AWS Client Secret associated with the Client ID (string)
Ami string: AMI ID to use for the worker nodes instead of the default (string)
AssociateWorkerNodePublicIp bool: Associate public ip EKS worker nodes. Default true (bool)
DesiredNodes int: The desired number of worker nodes. Just for Rancher v2.3.x and above. Default 3 (int)
InstanceType string: The type of machine to use for worker nodes. Default t2.medium (string)
KeyPairName string: Allow user to specify key name to use. Just for Rancher v2.2.7 and above (string)
MaximumNodes int: The maximum number of worker nodes. Default 3 (int)
MinimumNodes int: The minimum number of worker nodes. Default 1 (int)
NodeVolumeSize int: The volume size for each node. Default 20 (int)
Region string: GKE cluster region. Conflicts with zone (string)
SecurityGroups []string: List of security groups to use for the cluster. If it’s not specified Rancher will create a new security group (list)
ServiceRole string: The service role to use to perform the cluster operations in AWS. If it’s not specified Rancher will create a new service role (string)
SessionToken string: A session token to use with the client key and secret if applicable (string)
Subnets []string: List of subnets in the virtual network to use. If it’s not specified Rancher will create 3 news subnets (list)
UserData string: Pass user-data to the nodes to perform automated configuration tasks (string)
VirtualNetwork string: The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

accessKey string: The AWS Client ID to use (string)
kubernetesVersion string: The Kubernetes master version (string)
secretKey string: The AWS Client Secret associated with the Client ID (string)
ami string: AMI ID to use for the worker nodes instead of the default (string)
associateWorkerNodePublicIp boolean: Associate public ip EKS worker nodes. Default true (bool)
desiredNodes number: The desired number of worker nodes. Just for Rancher v2.3.x and above. Default 3 (int)
instanceType string: The type of machine to use for worker nodes. Default t2.medium (string)
keyPairName string: Allow user to specify key name to use. Just for Rancher v2.2.7 and above (string)
maximumNodes number: The maximum number of worker nodes. Default 3 (int)
minimumNodes number: The minimum number of worker nodes. Default 1 (int)
nodeVolumeSize number: The volume size for each node. Default 20 (int)
region string: GKE cluster region. Conflicts with zone (string)
securityGroups string[]: List of security groups to use for the cluster. If it’s not specified Rancher will create a new security group (list)
serviceRole string: The service role to use to perform the cluster operations in AWS. If it’s not specified Rancher will create a new service role (string)
sessionToken string: A session token to use with the client key and secret if applicable (string)
subnets string[]: List of subnets in the virtual network to use. If it’s not specified Rancher will create 3 news subnets (list)
userData string: Pass user-data to the nodes to perform automated configuration tasks (string)
virtualNetwork string: The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

access_key str: The AWS Client ID to use (string)
kubernetesVersion str: The Kubernetes master version (string)
secret_key str: The AWS Client Secret associated with the Client ID (string)
ami str: AMI ID to use for the worker nodes instead of the default (string)
associateWorkerNodePublicIp bool: Associate public ip EKS worker nodes. Default true (bool)
desiredNodes float: The desired number of worker nodes. Just for Rancher v2.3.x and above. Default 3 (int)
instanceType str: The type of machine to use for worker nodes. Default t2.medium (string)
keyPairName str: Allow user to specify key name to use. Just for Rancher v2.2.7 and above (string)
maximumNodes float: The maximum number of worker nodes. Default 3 (int)
minimumNodes float: The minimum number of worker nodes. Default 1 (int)
nodeVolumeSize float: The volume size for each node. Default 20 (int)
region str: GKE cluster region. Conflicts with zone (string)
securityGroups List[str]: List of security groups to use for the cluster. If it’s not specified Rancher will create a new security group (list)
serviceRole str: The service role to use to perform the cluster operations in AWS. If it’s not specified Rancher will create a new service role (string)
sessionToken str: A session token to use with the client key and secret if applicable (string)
subnets List[str]: List of subnets in the virtual network to use. If it’s not specified Rancher will create 3 news subnets (list)
userData str: Pass user-data to the nodes to perform automated configuration tasks (string)
virtualNetwork str: The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

ClusterGkeConfig

ClusterIpv4Cidr string: The IP address range of the container pods (string)
Credential string: The contents of the GC credential file (string)
DiskType string: Type of the disk attached to each node (string)
ImageType string: The image to use for the worker nodes (string)
IpPolicyClusterIpv4CidrBlock string: The IP address range for the cluster pod IPs (string)
IpPolicyClusterSecondaryRangeName string: The name of the secondary range to be used for the cluster CIDR block (string)
IpPolicyNodeIpv4CidrBlock string: The IP address range of the instance IPs in this cluster (string)
IpPolicyServicesIpv4CidrBlock string: The IP address range of the services IPs in this cluster (string)
IpPolicyServicesSecondaryRangeName string: The name of the secondary range to be used for the services CIDR block (string)
IpPolicySubnetworkName string: A custom subnetwork name to be used if createSubnetwork is true (string)
Locations List<string>: Locations for GKE cluster (list)
MachineType string: Machine type for GKE cluster (string)
MaintenanceWindow string: Maintenance window for GKE cluster (string)
MasterIpv4CidrBlock string: The IP range in CIDR notation to use for the hosted master network (string)
MasterVersion string: Master version for GKE cluster (string)
Network string: Network for GKE cluster (string)
NodePool string: The ID of the cluster node pool (string)
NodeVersion string: Node version for GKE cluster (string)
OauthScopes List<string>: The set of Google API scopes to be made available on all of the node VMs under the default service account (list)
ProjectId string: Project ID to apply answer (string)
ServiceAccount string: The Google Cloud Platform Service Account to be used by the node VMs (string)
SubNetwork string: Subnetwork for GKE cluster (string)
Description string: An optional description of this cluster (string)
DiskSizeGb int: Size of the disk attached to each node. Default 100 (int)
EnableAlphaFeature bool: To enable Kubernetes alpha feature. Default true (bool)
EnableAutoRepair bool: Specifies whether the node auto-repair is enabled for the node pool. Default false (bool)
EnableAutoUpgrade bool: Specifies whether node auto-upgrade is enabled for the node pool. Default false (bool)
EnableHorizontalPodAutoscaling bool: Enable horizontal pod autoscaling for the cluster. Default true (bool)
EnableHttpLoadBalancing bool: Enable HTTP load balancing on GKE cluster. Default true (bool)
EnableKubernetesDashboard bool: Whether to enable the Kubernetes dashboard. Default false (bool)
EnableLegacyAbac bool: Whether to enable legacy abac on the cluster. Default false (bool)
EnableMasterAuthorizedNetwork bool
EnableNetworkPolicyConfig bool: Enable network policy config for the cluster. Default true (bool)
EnableNodepoolAutoscaling bool: Enable nodepool autoscaling. Default false (bool)
EnablePrivateEndpoint bool: Whether the master’s internal IP address is used as the cluster endpoint. Default false (bool)
EnablePrivateNodes bool: Whether nodes have internal IP address only. Default false (bool)
EnableStackdriverLogging bool: Enable stackdriver monitoring. Default true (bool)
EnableStackdriverMonitoring bool: Enable stackdriver monitoring on GKE cluster (bool)
IpPolicyCreateSubnetwork bool: Whether a new subnetwork will be created automatically for the cluster. Default false (bool)
IssueClientCertificate bool: Issue a client certificate. Default false (bool)
KubernetesDashboard bool: Enable the Kubernetes dashboard. Default false (bool)
Labels Dictionary<string, object>: Labels for cluster registration token object (map)
LocalSsdCount int: The number of local SSD disks to be attached to the node. Default 0 (int)
MasterAuthorizedNetworkCidrBlocks List<string>: Define up to 10 external networks that could access Kubernetes master through HTTPS (list)
MaxNodeCount int: Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default 0 (int)
MinNodeCount int: Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default 0 (int)
NodeCount int: Node count for GKE cluster. Default 3 (int)
Preemptible bool: Whether the nodes are created as preemptible VM instances. Default false (bool)
Region string: GKE cluster region. Conflicts with zone (string)
ResourceLabels Dictionary<string, object>: The map of Kubernetes labels to be applied to each cluster (map)
Taints List<string>: List of Kubernetes taints to be applied to each node (list)
UseIpAliases bool: Whether alias IPs will be used for pod IPs in the cluster. Default false (bool)
Zone string: GKE cluster zone. Conflicts with region (string)

ClusterIpv4Cidr string: The IP address range of the container pods (string)
Credential string: The contents of the GC credential file (string)
DiskType string: Type of the disk attached to each node (string)
ImageType string: The image to use for the worker nodes (string)
IpPolicyClusterIpv4CidrBlock string: The IP address range for the cluster pod IPs (string)
IpPolicyClusterSecondaryRangeName string: The name of the secondary range to be used for the cluster CIDR block (string)
IpPolicyNodeIpv4CidrBlock string: The IP address range of the instance IPs in this cluster (string)
IpPolicyServicesIpv4CidrBlock string: The IP address range of the services IPs in this cluster (string)
IpPolicyServicesSecondaryRangeName string: The name of the secondary range to be used for the services CIDR block (string)
IpPolicySubnetworkName string: A custom subnetwork name to be used if createSubnetwork is true (string)
Locations []string: Locations for GKE cluster (list)
MachineType string: Machine type for GKE cluster (string)
MaintenanceWindow string: Maintenance window for GKE cluster (string)
MasterIpv4CidrBlock string: The IP range in CIDR notation to use for the hosted master network (string)
MasterVersion string: Master version for GKE cluster (string)
Network string: Network for GKE cluster (string)
NodePool string: The ID of the cluster node pool (string)
NodeVersion string: Node version for GKE cluster (string)
OauthScopes []string: The set of Google API scopes to be made available on all of the node VMs under the default service account (list)
ProjectId string: Project ID to apply answer (string)
ServiceAccount string: The Google Cloud Platform Service Account to be used by the node VMs (string)
SubNetwork string: Subnetwork for GKE cluster (string)
Description string: An optional description of this cluster (string)
DiskSizeGb int: Size of the disk attached to each node. Default 100 (int)
EnableAlphaFeature bool: To enable Kubernetes alpha feature. Default true (bool)
EnableAutoRepair bool: Specifies whether the node auto-repair is enabled for the node pool. Default false (bool)
EnableAutoUpgrade bool: Specifies whether node auto-upgrade is enabled for the node pool. Default false (bool)
EnableHorizontalPodAutoscaling bool: Enable horizontal pod autoscaling for the cluster. Default true (bool)
EnableHttpLoadBalancing bool: Enable HTTP load balancing on GKE cluster. Default true (bool)
EnableKubernetesDashboard bool: Whether to enable the Kubernetes dashboard. Default false (bool)
EnableLegacyAbac bool: Whether to enable legacy abac on the cluster. Default false (bool)
EnableMasterAuthorizedNetwork bool
EnableNetworkPolicyConfig bool: Enable network policy config for the cluster. Default true (bool)
EnableNodepoolAutoscaling bool: Enable nodepool autoscaling. Default false (bool)
EnablePrivateEndpoint bool: Whether the master’s internal IP address is used as the cluster endpoint. Default false (bool)
EnablePrivateNodes bool: Whether nodes have internal IP address only. Default false (bool)
EnableStackdriverLogging bool: Enable stackdriver monitoring. Default true (bool)
EnableStackdriverMonitoring bool: Enable stackdriver monitoring on GKE cluster (bool)
IpPolicyCreateSubnetwork bool: Whether a new subnetwork will be created automatically for the cluster. Default false (bool)
IssueClientCertificate bool: Issue a client certificate. Default false (bool)
KubernetesDashboard bool: Enable the Kubernetes dashboard. Default false (bool)
Labels map[string]interface{}: Labels for cluster registration token object (map)
LocalSsdCount int: The number of local SSD disks to be attached to the node. Default 0 (int)
MasterAuthorizedNetworkCidrBlocks []string: Define up to 10 external networks that could access Kubernetes master through HTTPS (list)
MaxNodeCount int: Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default 0 (int)
MinNodeCount int: Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default 0 (int)
NodeCount int: Node count for GKE cluster. Default 3 (int)
Preemptible bool: Whether the nodes are created as preemptible VM instances. Default false (bool)
Region string: GKE cluster region. Conflicts with zone (string)
ResourceLabels map[string]interface{}: The map of Kubernetes labels to be applied to each cluster (map)
Taints []string: List of Kubernetes taints to be applied to each node (list)
UseIpAliases bool: Whether alias IPs will be used for pod IPs in the cluster. Default false (bool)
Zone string: GKE cluster zone. Conflicts with region (string)

clusterIpv4Cidr string: The IP address range of the container pods (string)
credential string: The contents of the GC credential file (string)
diskType string: Type of the disk attached to each node (string)
imageType string: The image to use for the worker nodes (string)
ipPolicyClusterIpv4CidrBlock string: The IP address range for the cluster pod IPs (string)
ipPolicyClusterSecondaryRangeName string: The name of the secondary range to be used for the cluster CIDR block (string)
ipPolicyNodeIpv4CidrBlock string: The IP address range of the instance IPs in this cluster (string)
ipPolicyServicesIpv4CidrBlock string: The IP address range of the services IPs in this cluster (string)
ipPolicyServicesSecondaryRangeName string: The name of the secondary range to be used for the services CIDR block (string)
ipPolicySubnetworkName string: A custom subnetwork name to be used if createSubnetwork is true (string)
locations string[]: Locations for GKE cluster (list)
machineType string: Machine type for GKE cluster (string)
maintenanceWindow string: Maintenance window for GKE cluster (string)
masterIpv4CidrBlock string: The IP range in CIDR notation to use for the hosted master network (string)
masterVersion string: Master version for GKE cluster (string)
network string: Network for GKE cluster (string)
nodePool string: The ID of the cluster node pool (string)
nodeVersion string: Node version for GKE cluster (string)
oauthScopes string[]: The set of Google API scopes to be made available on all of the node VMs under the default service account (list)
projectId string: Project ID to apply answer (string)
serviceAccount string: The Google Cloud Platform Service Account to be used by the node VMs (string)
subNetwork string: Subnetwork for GKE cluster (string)
description string: An optional description of this cluster (string)
diskSizeGb number: Size of the disk attached to each node. Default 100 (int)
enableAlphaFeature boolean: To enable Kubernetes alpha feature. Default true (bool)
enableAutoRepair boolean: Specifies whether the node auto-repair is enabled for the node pool. Default false (bool)
enableAutoUpgrade boolean: Specifies whether node auto-upgrade is enabled for the node pool. Default false (bool)
enableHorizontalPodAutoscaling boolean: Enable horizontal pod autoscaling for the cluster. Default true (bool)
enableHttpLoadBalancing boolean: Enable HTTP load balancing on GKE cluster. Default true (bool)
enableKubernetesDashboard boolean: Whether to enable the Kubernetes dashboard. Default false (bool)
enableLegacyAbac boolean: Whether to enable legacy abac on the cluster. Default false (bool)
enableMasterAuthorizedNetwork boolean
enableNetworkPolicyConfig boolean: Enable network policy config for the cluster. Default true (bool)
enableNodepoolAutoscaling boolean: Enable nodepool autoscaling. Default false (bool)
enablePrivateEndpoint boolean: Whether the master’s internal IP address is used as the cluster endpoint. Default false (bool)
enablePrivateNodes boolean: Whether nodes have internal IP address only. Default false (bool)
enableStackdriverLogging boolean: Enable stackdriver monitoring. Default true (bool)
enableStackdriverMonitoring boolean: Enable stackdriver monitoring on GKE cluster (bool)
ipPolicyCreateSubnetwork boolean: Whether a new subnetwork will be created automatically for the cluster. Default false (bool)
issueClientCertificate boolean: Issue a client certificate. Default false (bool)
kubernetesDashboard boolean: Enable the Kubernetes dashboard. Default false (bool)
labels {[key: string]: any}: Labels for cluster registration token object (map)
localSsdCount number: The number of local SSD disks to be attached to the node. Default 0 (int)
masterAuthorizedNetworkCidrBlocks string[]: Define up to 10 external networks that could access Kubernetes master through HTTPS (list)
maxNodeCount number: Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default 0 (int)
minNodeCount number: Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default 0 (int)
nodeCount number: Node count for GKE cluster. Default 3 (int)
preemptible boolean: Whether the nodes are created as preemptible VM instances. Default false (bool)
region string: GKE cluster region. Conflicts with zone (string)
resourceLabels {[key: string]: any}: The map of Kubernetes labels to be applied to each cluster (map)
taints string[]: List of Kubernetes taints to be applied to each node (list)
useIpAliases boolean: Whether alias IPs will be used for pod IPs in the cluster. Default false (bool)
zone string: GKE cluster zone. Conflicts with region (string)

clusterIpv4Cidr str: The IP address range of the container pods (string)
credential str: The contents of the GC credential file (string)
diskType str: Type of the disk attached to each node (string)
imageType str: The image to use for the worker nodes (string)
ipPolicyClusterIpv4CidrBlock str: The IP address range for the cluster pod IPs (string)
ipPolicyClusterSecondaryRangeName str: The name of the secondary range to be used for the cluster CIDR block (string)
ipPolicyNodeIpv4CidrBlock str: The IP address range of the instance IPs in this cluster (string)
ipPolicyServicesIpv4CidrBlock str: The IP address range of the services IPs in this cluster (string)
ipPolicyServicesSecondaryRangeName str: The name of the secondary range to be used for the services CIDR block (string)
ipPolicySubnetworkName str: A custom subnetwork name to be used if createSubnetwork is true (string)
locations List[str]: Locations for GKE cluster (list)
machineType str: Machine type for GKE cluster (string)
maintenanceWindow str: Maintenance window for GKE cluster (string)
masterIpv4CidrBlock str: The IP range in CIDR notation to use for the hosted master network (string)
masterVersion str: Master version for GKE cluster (string)
network str: Network for GKE cluster (string)
nodePool str: The ID of the cluster node pool (string)
nodeVersion str: Node version for GKE cluster (string)
oauthScopes List[str]: The set of Google API scopes to be made available on all of the node VMs under the default service account (list)
project_id str: Project ID to apply answer (string)
serviceAccount str: The Google Cloud Platform Service Account to be used by the node VMs (string)
subNetwork str: Subnetwork for GKE cluster (string)
description str: An optional description of this cluster (string)
diskSizeGb float: Size of the disk attached to each node. Default 100 (int)
enableAlphaFeature bool: To enable Kubernetes alpha feature. Default true (bool)
enableAutoRepair bool: Specifies whether the node auto-repair is enabled for the node pool. Default false (bool)
enableAutoUpgrade bool: Specifies whether node auto-upgrade is enabled for the node pool. Default false (bool)
enableHorizontalPodAutoscaling bool: Enable horizontal pod autoscaling for the cluster. Default true (bool)
enableHttpLoadBalancing bool: Enable HTTP load balancing on GKE cluster. Default true (bool)
enableKubernetesDashboard bool: Whether to enable the Kubernetes dashboard. Default false (bool)
enableLegacyAbac bool: Whether to enable legacy abac on the cluster. Default false (bool)
enableMasterAuthorizedNetwork bool
enableNetworkPolicyConfig bool: Enable network policy config for the cluster. Default true (bool)
enableNodepoolAutoscaling bool: Enable nodepool autoscaling. Default false (bool)
enablePrivateEndpoint bool: Whether the master’s internal IP address is used as the cluster endpoint. Default false (bool)
enablePrivateNodes bool: Whether nodes have internal IP address only. Default false (bool)
enableStackdriverLogging bool: Enable stackdriver monitoring. Default true (bool)
enableStackdriverMonitoring bool: Enable stackdriver monitoring on GKE cluster (bool)
ipPolicyCreateSubnetwork bool: Whether a new subnetwork will be created automatically for the cluster. Default false (bool)
issueClientCertificate bool: Issue a client certificate. Default false (bool)
kubernetesDashboard bool: Enable the Kubernetes dashboard. Default false (bool)
labels Dict[str, Any]: Labels for cluster registration token object (map)
localSsdCount float: The number of local SSD disks to be attached to the node. Default 0 (int)
masterAuthorizedNetworkCidrBlocks List[str]: Define up to 10 external networks that could access Kubernetes master through HTTPS (list)
maxNodeCount float: Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default 0 (int)
minNodeCount float: Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default 0 (int)
nodeCount float: Node count for GKE cluster. Default 3 (int)
preemptible bool: Whether the nodes are created as preemptible VM instances. Default false (bool)
region str: GKE cluster region. Conflicts with zone (string)
resourceLabels Dict[str, Any]: The map of Kubernetes labels to be applied to each cluster (map)
taints List[str]: List of Kubernetes taints to be applied to each node (list)
useIpAliases bool: Whether alias IPs will be used for pod IPs in the cluster. Default false (bool)
zone str: GKE cluster zone. Conflicts with region (string)

ClusterK3sConfig

UpgradeStrategy ClusterK3sConfigUpgradeStrategyArgs: K3S upgrade strategy (List maxitems: 1)
Version string: rancher-monitoring chart version (string)

UpgradeStrategy ClusterK3sConfigUpgradeStrategy: K3S upgrade strategy (List maxitems: 1)
Version string: rancher-monitoring chart version (string)

upgradeStrategy ClusterK3sConfigUpgradeStrategy: K3S upgrade strategy (List maxitems: 1)
version string: rancher-monitoring chart version (string)

upgrade_strategy Dict[ClusterK3sConfigUpgradeStrategy]: K3S upgrade strategy (List maxitems: 1)
version str: rancher-monitoring chart version (string)

ClusterK3sConfigUpgradeStrategy

DrainServerNodes bool: Drain server nodes. Default: false (bool)
DrainWorkerNodes bool: Drain worker nodes. Default: false (bool)
ServerConcurrency int: Server concurrency. Default: 1 (int)
WorkerConcurrency int: Worker concurrency. Default: 1 (int)

DrainServerNodes bool: Drain server nodes. Default: false (bool)
DrainWorkerNodes bool: Drain worker nodes. Default: false (bool)
ServerConcurrency int: Server concurrency. Default: 1 (int)
WorkerConcurrency int: Worker concurrency. Default: 1 (int)

drainServerNodes boolean: Drain server nodes. Default: false (bool)
drainWorkerNodes boolean: Drain worker nodes. Default: false (bool)
serverConcurrency number: Server concurrency. Default: 1 (int)
workerConcurrency number: Worker concurrency. Default: 1 (int)

drainServerNodes bool: Drain server nodes. Default: false (bool)
drainWorkerNodes bool: Drain worker nodes. Default: false (bool)
serverConcurrency float: Server concurrency. Default: 1 (int)
workerConcurrency float: Worker concurrency. Default: 1 (int)

ClusterRkeConfig

AddonJobTimeout int: Duration in seconds of addon job (int)
Addons string: Addons descripton to deploy on RKE cluster.
AddonsIncludes List<string>: Addons yaml manifests to deploy on RKE cluster (list)
Authentication ClusterRkeConfigAuthenticationArgs: Kubernetes cluster authentication (list maxitems:1)
Authorization ClusterRkeConfigAuthorizationArgs: Kubernetes cluster authorization (list maxitems:1)
BastionHost ClusterRkeConfigBastionHostArgs: RKE bastion host (list maxitems:1)
CloudProvider ClusterRkeConfigCloudProviderArgs: RKE options for Calico network provider (string)
Dns ClusterRkeConfigDnsArgs: RKE dns add-on. Just for Rancher v2.2.x (list maxitems:1)
IgnoreDockerVersion bool: Ignore docker version. Default true (bool)
Ingress ClusterRkeConfigIngressArgs: Kubernetes ingress configuration (list maxitems:1)
KubernetesVersion string: The Kubernetes master version (string)
Monitoring ClusterRkeConfigMonitoringArgs: Kubernetes cluster monitoring (list maxitems:1)
Network ClusterRkeConfigNetworkArgs: Network for GKE cluster (string)
Nodes List<ClusterRkeConfigNodeArgs>: RKE cluster nodes (list)
PrefixPath string: Prefix to customize Kubernetes path (string)
PrivateRegistries List<ClusterRkeConfigPrivateRegistryArgs>: private registries for docker images (list)
Services ClusterRkeConfigServicesArgs: Kubernetes cluster services (list maxitems:1)
SshAgentAuth bool: Use ssh agent auth. Default false (bool)
SshCertPath string: Cluster level SSH certificate path (string)
SshKeyPath string: Node SSH private key path (string)
UpgradeStrategy ClusterRkeConfigUpgradeStrategyArgs: K3S upgrade strategy (List maxitems: 1)

AddonJobTimeout int: Duration in seconds of addon job (int)
Addons string: Addons descripton to deploy on RKE cluster.
AddonsIncludes []string: Addons yaml manifests to deploy on RKE cluster (list)
Authentication ClusterRkeConfigAuthentication: Kubernetes cluster authentication (list maxitems:1)
Authorization ClusterRkeConfigAuthorization: Kubernetes cluster authorization (list maxitems:1)
BastionHost ClusterRkeConfigBastionHost: RKE bastion host (list maxitems:1)
CloudProvider ClusterRkeConfigCloudProvider: RKE options for Calico network provider (string)
Dns ClusterRkeConfigDns: RKE dns add-on. Just for Rancher v2.2.x (list maxitems:1)
IgnoreDockerVersion bool: Ignore docker version. Default true (bool)
Ingress ClusterRkeConfigIngress: Kubernetes ingress configuration (list maxitems:1)
KubernetesVersion string: The Kubernetes master version (string)
Monitoring ClusterRkeConfigMonitoring: Kubernetes cluster monitoring (list maxitems:1)
Network ClusterRkeConfigNetwork: Network for GKE cluster (string)
Nodes []ClusterRkeConfigNode: RKE cluster nodes (list)
PrefixPath string: Prefix to customize Kubernetes path (string)
PrivateRegistries []ClusterRkeConfigPrivateRegistry: private registries for docker images (list)
Services ClusterRkeConfigServices: Kubernetes cluster services (list maxitems:1)
SshAgentAuth bool: Use ssh agent auth. Default false (bool)
SshCertPath string: Cluster level SSH certificate path (string)
SshKeyPath string: Node SSH private key path (string)
UpgradeStrategy ClusterRkeConfigUpgradeStrategy: K3S upgrade strategy (List maxitems: 1)

addonJobTimeout number: Duration in seconds of addon job (int)
addons string: Addons descripton to deploy on RKE cluster.
addonsIncludes string[]: Addons yaml manifests to deploy on RKE cluster (list)
authentication ClusterRkeConfigAuthentication: Kubernetes cluster authentication (list maxitems:1)
authorization ClusterRkeConfigAuthorization: Kubernetes cluster authorization (list maxitems:1)
bastionHost ClusterRkeConfigBastionHost: RKE bastion host (list maxitems:1)
cloudProvider ClusterRkeConfigCloudProvider: RKE options for Calico network provider (string)
dns ClusterRkeConfigDns: RKE dns add-on. Just for Rancher v2.2.x (list maxitems:1)
ignoreDockerVersion boolean: Ignore docker version. Default true (bool)
ingress ClusterRkeConfigIngress: Kubernetes ingress configuration (list maxitems:1)
kubernetesVersion string: The Kubernetes master version (string)
monitoring ClusterRkeConfigMonitoring: Kubernetes cluster monitoring (list maxitems:1)
network ClusterRkeConfigNetwork: Network for GKE cluster (string)
nodes ClusterRkeConfigNode[]: RKE cluster nodes (list)
prefixPath string: Prefix to customize Kubernetes path (string)
privateRegistries ClusterRkeConfigPrivateRegistry[]: private registries for docker images (list)
services ClusterRkeConfigServices: Kubernetes cluster services (list maxitems:1)
sshAgentAuth boolean: Use ssh agent auth. Default false (bool)
sshCertPath string: Cluster level SSH certificate path (string)
sshKeyPath string: Node SSH private key path (string)
upgradeStrategy ClusterRkeConfigUpgradeStrategy: K3S upgrade strategy (List maxitems: 1)

addonJobTimeout float: Duration in seconds of addon job (int)
addons str: Addons descripton to deploy on RKE cluster.
addonsIncludes List[str]: Addons yaml manifests to deploy on RKE cluster (list)
authentication Dict[ClusterRkeConfigAuthentication]: Kubernetes cluster authentication (list maxitems:1)
authorization Dict[ClusterRkeConfigAuthorization]: Kubernetes cluster authorization (list maxitems:1)
bastionHost Dict[ClusterRkeConfigBastionHost]: RKE bastion host (list maxitems:1)
cloudProvider Dict[ClusterRkeConfigCloudProvider]: RKE options for Calico network provider (string)
dns Dict[ClusterRkeConfigDns]: RKE dns add-on. Just for Rancher v2.2.x (list maxitems:1)
ignoreDockerVersion bool: Ignore docker version. Default true (bool)
ingress Dict[ClusterRkeConfigIngress]: Kubernetes ingress configuration (list maxitems:1)
kubernetesVersion str: The Kubernetes master version (string)
monitoring Dict[ClusterRkeConfigMonitoring]: Kubernetes cluster monitoring (list maxitems:1)
network Dict[ClusterRkeConfigNetwork]: Network for GKE cluster (string)
nodes List[ClusterRkeConfigNode]: RKE cluster nodes (list)
prefixPath str: Prefix to customize Kubernetes path (string)
privateRegistries List[ClusterRkeConfigPrivateRegistry]: private registries for docker images (list)
services Dict[ClusterRkeConfigServices]: Kubernetes cluster services (list maxitems:1)
sshAgentAuth bool: Use ssh agent auth. Default false (bool)
sshCertPath str: Cluster level SSH certificate path (string)
sshKeyPath str: Node SSH private key path (string)
upgrade_strategy Dict[ClusterRkeConfigUpgradeStrategy]: K3S upgrade strategy (List maxitems: 1)

ClusterRkeConfigAuthentication

Sans List<string>: RKE sans for authentication ([]string)
Strategy string: Monitoring deployment update strategy (string)

Sans []string: RKE sans for authentication ([]string)
Strategy string: Monitoring deployment update strategy (string)

sans string[]: RKE sans for authentication ([]string)
strategy string: Monitoring deployment update strategy (string)

sans List[str]: RKE sans for authentication ([]string)
strategy str: Monitoring deployment update strategy (string)

ClusterRkeConfigAuthorization

Mode string: RKE mode for authorization. rbac and none modes are available. Default rbac (string)
Options Dictionary<string, object>: RKE options for network (map)

Mode string: RKE mode for authorization. rbac and none modes are available. Default rbac (string)
Options map[string]interface{}: RKE options for network (map)

mode string: RKE mode for authorization. rbac and none modes are available. Default rbac (string)
options {[key: string]: any}: RKE options for network (map)

mode str: RKE mode for authorization. rbac and none modes are available. Default rbac (string)
options Dict[str, Any]: RKE options for network (map)

ClusterRkeConfigBastionHost

Address string: Address ip for node (string)
User string: Registry user (string)
Port string: Port for node. Default 22 (string)
SshAgentAuth bool: Use ssh agent auth. Default false (bool)
SshKey string: Node SSH private key (string)
SshKeyPath string: Node SSH private key path (string)

Address string: Address ip for node (string)
User string: Registry user (string)
Port string: Port for node. Default 22 (string)
SshAgentAuth bool: Use ssh agent auth. Default false (bool)
SshKey string: Node SSH private key (string)
SshKeyPath string: Node SSH private key path (string)

address string: Address ip for node (string)
user string: Registry user (string)
port string: Port for node. Default 22 (string)
sshAgentAuth boolean: Use ssh agent auth. Default false (bool)
sshKey string: Node SSH private key (string)
sshKeyPath string: Node SSH private key path (string)

address str: Address ip for node (string)
user str: Registry user (string)
port str: Port for node. Default 22 (string)
sshAgentAuth bool: Use ssh agent auth. Default false (bool)
sshKey str: Node SSH private key (string)
sshKeyPath str: Node SSH private key path (string)

ClusterRkeConfigCloudProvider

AwsCloudProvider ClusterRkeConfigCloudProviderAwsCloudProviderArgs: RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)
AzureCloudProvider ClusterRkeConfigCloudProviderAzureCloudProviderArgs: RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)
CustomCloudProvider string: RKE Custom Cloud Provider config for Cloud Provider (string)
Name string: Name of cluster registration token (string)
OpenstackCloudProvider ClusterRkeConfigCloudProviderOpenstackCloudProviderArgs: RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)
VsphereCloudProvider ClusterRkeConfigCloudProviderVsphereCloudProviderArgs: RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument name is required on virtual_center configuration. (list maxitems:1)

AwsCloudProvider ClusterRkeConfigCloudProviderAwsCloudProvider: RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)
AzureCloudProvider ClusterRkeConfigCloudProviderAzureCloudProvider: RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)
CustomCloudProvider string: RKE Custom Cloud Provider config for Cloud Provider (string)
Name string: Name of cluster registration token (string)
OpenstackCloudProvider ClusterRkeConfigCloudProviderOpenstackCloudProvider: RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)
VsphereCloudProvider ClusterRkeConfigCloudProviderVsphereCloudProvider: RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument name is required on virtual_center configuration. (list maxitems:1)

awsCloudProvider ClusterRkeConfigCloudProviderAwsCloudProvider: RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)
azureCloudProvider ClusterRkeConfigCloudProviderAzureCloudProvider: RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)
customCloudProvider string: RKE Custom Cloud Provider config for Cloud Provider (string)
name string: Name of cluster registration token (string)
openstackCloudProvider ClusterRkeConfigCloudProviderOpenstackCloudProvider: RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)
vsphereCloudProvider ClusterRkeConfigCloudProviderVsphereCloudProvider: RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument name is required on virtual_center configuration. (list maxitems:1)

awsCloudProvider Dict[ClusterRkeConfigCloudProviderAwsCloudProvider]: RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)
azureCloudProvider Dict[ClusterRkeConfigCloudProviderAzureCloudProvider]: RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)
customCloudProvider str: RKE Custom Cloud Provider config for Cloud Provider (string)
name str: Name of cluster registration token (string)
openstackCloudProvider Dict[ClusterRkeConfigCloudProviderOpenstackCloudProvider]: RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)
vsphereCloudProvider Dict[ClusterRkeConfigCloudProviderVsphereCloudProvider]: RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument name is required on virtual_center configuration. (list maxitems:1)

ClusterRkeConfigCloudProviderAwsCloudProvider

Global ClusterRkeConfigCloudProviderAwsCloudProviderGlobalArgs: (list maxitems:1)
ServiceOverrides List<ClusterRkeConfigCloudProviderAwsCloudProviderServiceOverrideArgs>: (list)

Global ClusterRkeConfigCloudProviderAwsCloudProviderGlobal: (list maxitems:1)
ServiceOverrides []ClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride: (list)

global ClusterRkeConfigCloudProviderAwsCloudProviderGlobal: (list maxitems:1)
serviceOverrides ClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride[]: (list)

global Dict[ClusterRkeConfigCloudProviderAwsCloudProviderGlobal]: (list maxitems:1)
serviceOverrides List[ClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride]: (list)

ClusterRkeConfigCloudProviderAwsCloudProviderGlobal

DisableSecurityGroupIngress bool: Default false (bool)
DisableStrictZoneCheck bool: Default false (bool)
ElbSecurityGroup string: (string)
KubernetesClusterId string: (string)
KubernetesClusterTag string: (string)
RoleArn string: (string)
RouteTableId string: (string)
SubnetId string: (string)
Vpc string: (string)
Zone string: GKE cluster zone. Conflicts with region (string)

DisableSecurityGroupIngress bool: Default false (bool)
DisableStrictZoneCheck bool: Default false (bool)
ElbSecurityGroup string: (string)
KubernetesClusterId string: (string)
KubernetesClusterTag string: (string)
RoleArn string: (string)
RouteTableId string: (string)
SubnetId string: (string)
Vpc string: (string)
Zone string: GKE cluster zone. Conflicts with region (string)

disableSecurityGroupIngress boolean: Default false (bool)
disableStrictZoneCheck boolean: Default false (bool)
elbSecurityGroup string: (string)
kubernetesClusterId string: (string)
kubernetesClusterTag string: (string)
roleArn string: (string)
routeTableId string: (string)
subnetId string: (string)
vpc string: (string)
zone string: GKE cluster zone. Conflicts with region (string)

disableSecurityGroupIngress bool: Default false (bool)
disableStrictZoneCheck bool: Default false (bool)
elbSecurityGroup str: (string)
kubernetesClusterId str: (string)
kubernetesClusterTag str: (string)
roleArn str: (string)
routeTableId str: (string)
subnetId str: (string)
vpc str: (string)
zone str: GKE cluster zone. Conflicts with region (string)

ClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride

Service string: (string)
Region string: GKE cluster region. Conflicts with zone (string)
SigningMethod string: (string)
SigningName string: (string)
SigningRegion string: (string)
Url string: Registry URL (string)

Service string: (string)
Region string: GKE cluster region. Conflicts with zone (string)
SigningMethod string: (string)
SigningName string: (string)
SigningRegion string: (string)
Url string: Registry URL (string)

service string: (string)
region string: GKE cluster region. Conflicts with zone (string)
signingMethod string: (string)
signingName string: (string)
signingRegion string: (string)
url string: Registry URL (string)

service str: (string)
region str: GKE cluster region. Conflicts with zone (string)
signingMethod str: (string)
signingName str: (string)
signingRegion str: (string)
url str: Registry URL (string)

ClusterRkeConfigCloudProviderAzureCloudProvider

AadClientId string: (string)
AadClientSecret string: (string)
SubscriptionId string: Subscription credentials which uniquely identify Microsoft Azure subscription (string)
TenantId string: Azure tenant ID to use (string)
AadClientCertPassword string: (string)
AadClientCertPath string: (string)
Cloud string: (string)
CloudProviderBackoff bool: (bool)
CloudProviderBackoffDuration int: (int)
CloudProviderBackoffExponent int: (int)
CloudProviderBackoffJitter int: (int)
CloudProviderBackoffRetries int: (int)
CloudProviderRateLimit bool: (bool)
CloudProviderRateLimitBucket int: (int)
CloudProviderRateLimitQps int: (int)
LoadBalancerSku string: Allowed values: basic (default) standard (string)
Location string: Azure Kubernetes cluster location. Default eastus (string)
MaximumLoadBalancerRuleCount int: (int)
PrimaryAvailabilitySetName string: (string)
PrimaryScaleSetName string: (string)
ResourceGroup string: The name of the Cluster resource group (string)
RouteTableName string: (string)
SecurityGroupName string: (string)
SubnetName string: (string)
UseInstanceMetadata bool: (bool)
UseManagedIdentityExtension bool: (bool)
VmType string: (string)
VnetName string: (string)
VnetResourceGroup string: (string)

AadClientId string: (string)
AadClientSecret string: (string)
SubscriptionId string: Subscription credentials which uniquely identify Microsoft Azure subscription (string)
TenantId string: Azure tenant ID to use (string)
AadClientCertPassword string: (string)
AadClientCertPath string: (string)
Cloud string: (string)
CloudProviderBackoff bool: (bool)
CloudProviderBackoffDuration int: (int)
CloudProviderBackoffExponent int: (int)
CloudProviderBackoffJitter int: (int)
CloudProviderBackoffRetries int: (int)
CloudProviderRateLimit bool: (bool)
CloudProviderRateLimitBucket int: (int)
CloudProviderRateLimitQps int: (int)
LoadBalancerSku string: Allowed values: basic (default) standard (string)
Location string: Azure Kubernetes cluster location. Default eastus (string)
MaximumLoadBalancerRuleCount int: (int)
PrimaryAvailabilitySetName string: (string)
PrimaryScaleSetName string: (string)
ResourceGroup string: The name of the Cluster resource group (string)
RouteTableName string: (string)
SecurityGroupName string: (string)
SubnetName string: (string)
UseInstanceMetadata bool: (bool)
UseManagedIdentityExtension bool: (bool)
VmType string: (string)
VnetName string: (string)
VnetResourceGroup string: (string)

aadClientId string: (string)
aadClientSecret string: (string)
subscriptionId string: Subscription credentials which uniquely identify Microsoft Azure subscription (string)
tenantId string: Azure tenant ID to use (string)
aadClientCertPassword string: (string)
aadClientCertPath string: (string)
cloud string: (string)
cloudProviderBackoff boolean: (bool)
cloudProviderBackoffDuration number: (int)
cloudProviderBackoffExponent number: (int)
cloudProviderBackoffJitter number: (int)
cloudProviderBackoffRetries number: (int)
cloudProviderRateLimit boolean: (bool)
cloudProviderRateLimitBucket number: (int)
cloudProviderRateLimitQps number: (int)
loadBalancerSku string: Allowed values: basic (default) standard (string)
location string: Azure Kubernetes cluster location. Default eastus (string)
maximumLoadBalancerRuleCount number: (int)
primaryAvailabilitySetName string: (string)
primaryScaleSetName string: (string)
resourceGroup string: The name of the Cluster resource group (string)
routeTableName string: (string)
securityGroupName string: (string)
subnetName string: (string)
useInstanceMetadata boolean: (bool)
useManagedIdentityExtension boolean: (bool)
vmType string: (string)
vnetName string: (string)
vnetResourceGroup string: (string)

aadClientId str: (string)
aadClientSecret str: (string)
subscriptionId str: Subscription credentials which uniquely identify Microsoft Azure subscription (string)
tenant_id str: Azure tenant ID to use (string)
aadClientCertPassword str: (string)
aadClientCertPath str: (string)
cloud str: (string)
cloudProviderBackoff bool: (bool)
cloudProviderBackoffDuration float: (int)
cloudProviderBackoffExponent float: (int)
cloudProviderBackoffJitter float: (int)
cloudProviderBackoffRetries float: (int)
cloudProviderRateLimit bool: (bool)
cloudProviderRateLimitBucket float: (int)
cloudProviderRateLimitQps float: (int)
loadBalancerSku str: Allowed values: basic (default) standard (string)
location str: Azure Kubernetes cluster location. Default eastus (string)
maximumLoadBalancerRuleCount float: (int)
primaryAvailabilitySetName str: (string)
primaryScaleSetName str: (string)
resourceGroup str: The name of the Cluster resource group (string)
routeTableName str: (string)
securityGroupName str: (string)
subnetName str: (string)
useInstanceMetadata bool: (bool)
useManagedIdentityExtension bool: (bool)
vmType str: (string)
vnetName str: (string)
vnetResourceGroup str: (string)

ClusterRkeConfigCloudProviderOpenstackCloudProvider

Global ClusterRkeConfigCloudProviderOpenstackCloudProviderGlobalArgs: (list maxitems:1)
BlockStorage ClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorageArgs: (list maxitems:1)
LoadBalancer ClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancerArgs: (list maxitems:1)
Metadata ClusterRkeConfigCloudProviderOpenstackCloudProviderMetadataArgs: (list maxitems:1)
Route ClusterRkeConfigCloudProviderOpenstackCloudProviderRouteArgs: (list maxitems:1)

Global ClusterRkeConfigCloudProviderOpenstackCloudProviderGlobal: (list maxitems:1)
BlockStorage ClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorage: (list maxitems:1)
LoadBalancer ClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer: (list maxitems:1)
Metadata ClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata: (list maxitems:1)
Route ClusterRkeConfigCloudProviderOpenstackCloudProviderRoute: (list maxitems:1)

global ClusterRkeConfigCloudProviderOpenstackCloudProviderGlobal: (list maxitems:1)
blockStorage ClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorage: (list maxitems:1)
loadBalancer ClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer: (list maxitems:1)
metadata ClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata: (list maxitems:1)
route ClusterRkeConfigCloudProviderOpenstackCloudProviderRoute: (list maxitems:1)

global Dict[ClusterRkeConfigCloudProviderOpenstackCloudProviderGlobal]: (list maxitems:1)
blockStorage Dict[ClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorage]: (list maxitems:1)
loadBalancer Dict[ClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer]: (list maxitems:1)
metadata Dict[ClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata]: (list maxitems:1)
route Dict[ClusterRkeConfigCloudProviderOpenstackCloudProviderRoute]: (list maxitems:1)

ClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorage

BsVersion string: (string)
IgnoreVolumeAz bool: (string)
TrustDevicePath bool: (string)

BsVersion string: (string)
IgnoreVolumeAz bool: (string)
TrustDevicePath bool: (string)

bsVersion string: (string)
ignoreVolumeAz boolean: (string)
trustDevicePath boolean: (string)

bsVersion str: (string)
ignoreVolumeAz bool: (string)
trustDevicePath bool: (string)

ClusterRkeConfigCloudProviderOpenstackCloudProviderGlobal

AuthUrl string: (string)
Password string: Registry password (string)
Username string: (string)
CaFile string: (string)
DomainId string: Required if domain_name not provided. (string)
DomainName string: Required if domain_id not provided. (string)
Region string: GKE cluster region. Conflicts with zone (string)
TenantId string: Azure tenant ID to use (string)
TenantName string: Required if tenant_id not provided. (string)
TrustId string: (string)

AuthUrl string: (string)
Password string: Registry password (string)
Username string: (string)
CaFile string: (string)
DomainId string: Required if domain_name not provided. (string)
DomainName string: Required if domain_id not provided. (string)
Region string: GKE cluster region. Conflicts with zone (string)
TenantId string: Azure tenant ID to use (string)
TenantName string: Required if tenant_id not provided. (string)
TrustId string: (string)

authUrl string: (string)
password string: Registry password (string)
username string: (string)
caFile string: (string)
domainId string: Required if domain_name not provided. (string)
domainName string: Required if domain_id not provided. (string)
region string: GKE cluster region. Conflicts with zone (string)
tenantId string: Azure tenant ID to use (string)
tenantName string: Required if tenant_id not provided. (string)
trustId string: (string)

authUrl str: (string)
password str: Registry password (string)
username str: (string)
caFile str: (string)
domainId str: Required if domain_name not provided. (string)
domainName str: Required if domain_id not provided. (string)
region str: GKE cluster region. Conflicts with zone (string)
tenantName str: Required if tenant_id not provided. (string)
tenant_id str: Azure tenant ID to use (string)
trustId str: (string)

ClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer

CreateMonitor bool: (bool)
FloatingNetworkId string: (string)
LbMethod string: (string)
LbProvider string: (string)
LbVersion string: (string)
ManageSecurityGroups bool: (bool)
MonitorDelay string: Default 60s (string)
MonitorMaxRetries int: Default 5 (int)
MonitorTimeout string: Default 30s (string)
SubnetId string: (string)
UseOctavia bool: (bool)

CreateMonitor bool: (bool)
FloatingNetworkId string: (string)
LbMethod string: (string)
LbProvider string: (string)
LbVersion string: (string)
ManageSecurityGroups bool: (bool)
MonitorDelay string: Default 60s (string)
MonitorMaxRetries int: Default 5 (int)
MonitorTimeout string: Default 30s (string)
SubnetId string: (string)
UseOctavia bool: (bool)

createMonitor boolean: (bool)
floatingNetworkId string: (string)
lbMethod string: (string)
lbProvider string: (string)
lbVersion string: (string)
manageSecurityGroups boolean: (bool)
monitorDelay string: Default 60s (string)
monitorMaxRetries number: Default 5 (int)
monitorTimeout string: Default 30s (string)
subnetId string: (string)
useOctavia boolean: (bool)

createMonitor bool: (bool)
floatingNetworkId str: (string)
lbMethod str: (string)
lbProvider str: (string)
lbVersion str: (string)
manageSecurityGroups bool: (bool)
monitorDelay str: Default 60s (string)
monitorMaxRetries float: Default 5 (int)
monitorTimeout str: Default 30s (string)
subnetId str: (string)
useOctavia bool: (bool)

ClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata

RequestTimeout int: (int)
SearchOrder string: (string)

RequestTimeout int: (int)
SearchOrder string: (string)

requestTimeout number: (int)
searchOrder string: (string)

requestTimeout float: (int)
searchOrder str: (string)

ClusterRkeConfigCloudProviderOpenstackCloudProviderRoute

RouterId string: (string)

RouterId string: (string)

routerId string: (string)

routerId str: (string)

ClusterRkeConfigCloudProviderVsphereCloudProvider

VirtualCenters List<ClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenterArgs>: (List)
Workspace ClusterRkeConfigCloudProviderVsphereCloudProviderWorkspaceArgs: (list maxitems:1)
Disk ClusterRkeConfigCloudProviderVsphereCloudProviderDiskArgs: (list maxitems:1)
Global ClusterRkeConfigCloudProviderVsphereCloudProviderGlobalArgs: (list maxitems:1)
Network ClusterRkeConfigCloudProviderVsphereCloudProviderNetworkArgs: Network for GKE cluster (string)

VirtualCenters []ClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenter: (List)
Workspace ClusterRkeConfigCloudProviderVsphereCloudProviderWorkspace: (list maxitems:1)
Disk ClusterRkeConfigCloudProviderVsphereCloudProviderDisk: (list maxitems:1)
Global ClusterRkeConfigCloudProviderVsphereCloudProviderGlobal: (list maxitems:1)
Network ClusterRkeConfigCloudProviderVsphereCloudProviderNetwork: Network for GKE cluster (string)

virtualCenters ClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenter[]: (List)
workspace ClusterRkeConfigCloudProviderVsphereCloudProviderWorkspace: (list maxitems:1)
disk ClusterRkeConfigCloudProviderVsphereCloudProviderDisk: (list maxitems:1)
global ClusterRkeConfigCloudProviderVsphereCloudProviderGlobal: (list maxitems:1)
network ClusterRkeConfigCloudProviderVsphereCloudProviderNetwork: Network for GKE cluster (string)

virtualCenters List[ClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenter]: (List)
workspace Dict[ClusterRkeConfigCloudProviderVsphereCloudProviderWorkspace]: (list maxitems:1)
disk Dict[ClusterRkeConfigCloudProviderVsphereCloudProviderDisk]: (list maxitems:1)
global Dict[ClusterRkeConfigCloudProviderVsphereCloudProviderGlobal]: (list maxitems:1)
network Dict[ClusterRkeConfigCloudProviderVsphereCloudProviderNetwork]: Network for GKE cluster (string)

ClusterRkeConfigCloudProviderVsphereCloudProviderDisk

ScsiControllerType string: (string)

ScsiControllerType string: (string)

scsiControllerType string: (string)

scsiControllerType str: (string)

ClusterRkeConfigCloudProviderVsphereCloudProviderGlobal

Datacenters string: (string)
InsecureFlag bool: (bool)
Password string: Registry password (string)
Port string: Port for node. Default 22 (string)
SoapRoundtripCount int: (int)
User string: Registry user (string)

Datacenters string: (string)
InsecureFlag bool: (bool)
Password string: Registry password (string)
Port string: Port for node. Default 22 (string)
SoapRoundtripCount int: (int)
User string: Registry user (string)

datacenters string: (string)
insecureFlag boolean: (bool)
password string: Registry password (string)
port string: Port for node. Default 22 (string)
soapRoundtripCount number: (int)
user string: Registry user (string)

datacenters str: (string)
insecureFlag bool: (bool)
password str: Registry password (string)
port str: Port for node. Default 22 (string)
soapRoundtripCount float: (int)
user str: Registry user (string)

ClusterRkeConfigCloudProviderVsphereCloudProviderNetwork

PublicNetwork string: (string)

PublicNetwork string: (string)

publicNetwork string: (string)

publicNetwork str: (string)

ClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenter

Datacenters string: (string)
Name string: Name of cluster registration token (string)
Password string: Registry password (string)
User string: Registry user (string)
Port string: Port for node. Default 22 (string)
SoapRoundtripCount int: (int)

Datacenters string: (string)
Name string: Name of cluster registration token (string)
Password string: Registry password (string)
User string: Registry user (string)
Port string: Port for node. Default 22 (string)
SoapRoundtripCount int: (int)

datacenters string: (string)
name string: Name of cluster registration token (string)
password string: Registry password (string)
user string: Registry user (string)
port string: Port for node. Default 22 (string)
soapRoundtripCount number: (int)

datacenters str: (string)
name str: Name of cluster registration token (string)
password str: Registry password (string)
user str: Registry user (string)
port str: Port for node. Default 22 (string)
soapRoundtripCount float: (int)

ClusterRkeConfigCloudProviderVsphereCloudProviderWorkspace

Datacenter string: (string)
Folder string: Folder for S3 service. Available from Rancher v2.2.7 (string)
Server string: (string)
DefaultDatastore string: (string)
ResourcepoolPath string: (string)

Datacenter string: (string)
Folder string: Folder for S3 service. Available from Rancher v2.2.7 (string)
Server string: (string)
DefaultDatastore string: (string)
ResourcepoolPath string: (string)

datacenter string: (string)
folder string: Folder for S3 service. Available from Rancher v2.2.7 (string)
server string: (string)
defaultDatastore string: (string)
resourcepoolPath string: (string)

datacenter str: (string)
folder str: Folder for S3 service. Available from Rancher v2.2.7 (string)
server str: (string)
defaultDatastore str: (string)
resourcepoolPath str: (string)

ClusterRkeConfigDns

NodeSelector Dictionary<string, object>: RKE monitoring node selector (map)
Nodelocal ClusterRkeConfigDnsNodelocalArgs: Nodelocal dns config (list Maxitem: 1)
Provider string: RKE monitoring provider (string)
ReverseCidrs List<string>: DNS add-on reverse cidr (list)
UpstreamNameservers List<string>: DNS add-on upstream nameservers (list)

NodeSelector map[string]interface{}: RKE monitoring node selector (map)
Nodelocal ClusterRkeConfigDnsNodelocal: Nodelocal dns config (list Maxitem: 1)
Provider string: RKE monitoring provider (string)
ReverseCidrs []string: DNS add-on reverse cidr (list)
UpstreamNameservers []string: DNS add-on upstream nameservers (list)

nodeSelector {[key: string]: any}: RKE monitoring node selector (map)
nodelocal ClusterRkeConfigDnsNodelocal: Nodelocal dns config (list Maxitem: 1)
provider string: RKE monitoring provider (string)
reverseCidrs string[]: DNS add-on reverse cidr (list)
upstreamNameservers string[]: DNS add-on upstream nameservers (list)

nodeSelector Dict[str, Any]: RKE monitoring node selector (map)
nodelocal Dict[ClusterRkeConfigDnsNodelocal]: Nodelocal dns config (list Maxitem: 1)
provider str: RKE monitoring provider (string)
reverseCidrs List[str]: DNS add-on reverse cidr (list)
upstreamNameservers List[str]: DNS add-on upstream nameservers (list)

ClusterRkeConfigDnsNodelocal

IpAddress string: Nodelocal dns ip address (string)
NodeSelector Dictionary<string, object>: RKE monitoring node selector (map)

IpAddress string: Nodelocal dns ip address (string)
NodeSelector map[string]interface{}: RKE monitoring node selector (map)

ipAddress string: Nodelocal dns ip address (string)
nodeSelector {[key: string]: any}: RKE monitoring node selector (map)

ipAddress str: Nodelocal dns ip address (string)
nodeSelector Dict[str, Any]: RKE monitoring node selector (map)

ClusterRkeConfigIngress

DnsPolicy string: Ingress controller DNS policy. ClusterFirstWithHostNet, ClusterFirst, Default, and None are supported. K8S dns Policy (string)
ExtraArgs Dictionary<string, object>: Extra arguments for scheduler service (map)
NodeSelector Dictionary<string, object>: RKE monitoring node selector (map)
Options Dictionary<string, object>: RKE options for network (map)
Provider string: RKE monitoring provider (string)

DnsPolicy string: Ingress controller DNS policy. ClusterFirstWithHostNet, ClusterFirst, Default, and None are supported. K8S dns Policy (string)
ExtraArgs map[string]interface{}: Extra arguments for scheduler service (map)
NodeSelector map[string]interface{}: RKE monitoring node selector (map)
Options map[string]interface{}: RKE options for network (map)
Provider string: RKE monitoring provider (string)

dnsPolicy string: Ingress controller DNS policy. ClusterFirstWithHostNet, ClusterFirst, Default, and None are supported. K8S dns Policy (string)
extraArgs {[key: string]: any}: Extra arguments for scheduler service (map)
nodeSelector {[key: string]: any}: RKE monitoring node selector (map)
options {[key: string]: any}: RKE options for network (map)
provider string: RKE monitoring provider (string)

dnsPolicy str: Ingress controller DNS policy. ClusterFirstWithHostNet, ClusterFirst, Default, and None are supported. K8S dns Policy (string)
extraArgs Dict[str, Any]: Extra arguments for scheduler service (map)
nodeSelector Dict[str, Any]: RKE monitoring node selector (map)
options Dict[str, Any]: RKE options for network (map)
provider str: RKE monitoring provider (string)

ClusterRkeConfigMonitoring

NodeSelector Dictionary<string, object>: RKE monitoring node selector (map)
Options Dictionary<string, object>: RKE options for network (map)
Provider string: RKE monitoring provider (string)
Replicas int: RKE monitoring replicas (int)
UpdateStrategy ClusterRkeConfigMonitoringUpdateStrategyArgs: RKE monitoring update strategy (list Maxitems: 1)

NodeSelector map[string]interface{}: RKE monitoring node selector (map)
Options map[string]interface{}: RKE options for network (map)
Provider string: RKE monitoring provider (string)
Replicas int: RKE monitoring replicas (int)
UpdateStrategy ClusterRkeConfigMonitoringUpdateStrategy: RKE monitoring update strategy (list Maxitems: 1)

nodeSelector {[key: string]: any}: RKE monitoring node selector (map)
options {[key: string]: any}: RKE options for network (map)
provider string: RKE monitoring provider (string)
replicas number: RKE monitoring replicas (int)
updateStrategy ClusterRkeConfigMonitoringUpdateStrategy: RKE monitoring update strategy (list Maxitems: 1)

nodeSelector Dict[str, Any]: RKE monitoring node selector (map)
options Dict[str, Any]: RKE options for network (map)
provider str: RKE monitoring provider (string)
replicas float: RKE monitoring replicas (int)
updateStrategy Dict[ClusterRkeConfigMonitoringUpdateStrategy]: RKE monitoring update strategy (list Maxitems: 1)

ClusterRkeConfigMonitoringUpdateStrategy

RollingUpdate ClusterRkeConfigMonitoringUpdateStrategyRollingUpdateArgs: Monitoring deployment rolling update (list Maxitems: 1)
Strategy string: Monitoring deployment update strategy (string)

RollingUpdate ClusterRkeConfigMonitoringUpdateStrategyRollingUpdate: Monitoring deployment rolling update (list Maxitems: 1)
Strategy string: Monitoring deployment update strategy (string)

rollingUpdate ClusterRkeConfigMonitoringUpdateStrategyRollingUpdate: Monitoring deployment rolling update (list Maxitems: 1)
strategy string: Monitoring deployment update strategy (string)

rollingUpdate Dict[ClusterRkeConfigMonitoringUpdateStrategyRollingUpdate]: Monitoring deployment rolling update (list Maxitems: 1)
strategy str: Monitoring deployment update strategy (string)

ClusterRkeConfigMonitoringUpdateStrategyRollingUpdate

MaxSurge int: Monitoring deployment rolling update max surge. Default: 1 (int)
MaxUnavailable int: Monitoring deployment rolling update max unavailable. Default: 1 (int)

MaxSurge int: Monitoring deployment rolling update max surge. Default: 1 (int)
MaxUnavailable int: Monitoring deployment rolling update max unavailable. Default: 1 (int)

maxSurge number: Monitoring deployment rolling update max surge. Default: 1 (int)
maxUnavailable number: Monitoring deployment rolling update max unavailable. Default: 1 (int)

maxSurge float: Monitoring deployment rolling update max surge. Default: 1 (int)
maxUnavailable float: Monitoring deployment rolling update max unavailable. Default: 1 (int)

ClusterRkeConfigNetwork

CalicoNetworkProvider ClusterRkeConfigNetworkCalicoNetworkProviderArgs: Calico provider config for RKE network (list maxitems:1)
CanalNetworkProvider ClusterRkeConfigNetworkCanalNetworkProviderArgs: Canal provider config for RKE network (list maxitems:1)
FlannelNetworkProvider ClusterRkeConfigNetworkFlannelNetworkProviderArgs: Flannel provider config for RKE network (list maxitems:1)
Mtu int: Network provider MTU. Default 0 (int)
Options Dictionary<string, object>: RKE options for network (map)
Plugin string: Plugin for RKE network. canal (default), flannel, calico, none and weave are supported. (string)
WeaveNetworkProvider ClusterRkeConfigNetworkWeaveNetworkProviderArgs: Weave provider config for RKE network (list maxitems:1)

CalicoNetworkProvider ClusterRkeConfigNetworkCalicoNetworkProvider: Calico provider config for RKE network (list maxitems:1)
CanalNetworkProvider ClusterRkeConfigNetworkCanalNetworkProvider: Canal provider config for RKE network (list maxitems:1)
FlannelNetworkProvider ClusterRkeConfigNetworkFlannelNetworkProvider: Flannel provider config for RKE network (list maxitems:1)
Mtu int: Network provider MTU. Default 0 (int)
Options map[string]interface{}: RKE options for network (map)
Plugin string: Plugin for RKE network. canal (default), flannel, calico, none and weave are supported. (string)
WeaveNetworkProvider ClusterRkeConfigNetworkWeaveNetworkProvider: Weave provider config for RKE network (list maxitems:1)

calicoNetworkProvider ClusterRkeConfigNetworkCalicoNetworkProvider: Calico provider config for RKE network (list maxitems:1)
canalNetworkProvider ClusterRkeConfigNetworkCanalNetworkProvider: Canal provider config for RKE network (list maxitems:1)
flannelNetworkProvider ClusterRkeConfigNetworkFlannelNetworkProvider: Flannel provider config for RKE network (list maxitems:1)
mtu number: Network provider MTU. Default 0 (int)
options {[key: string]: any}: RKE options for network (map)
plugin string: Plugin for RKE network. canal (default), flannel, calico, none and weave are supported. (string)
weaveNetworkProvider ClusterRkeConfigNetworkWeaveNetworkProvider: Weave provider config for RKE network (list maxitems:1)

calicoNetworkProvider Dict[ClusterRkeConfigNetworkCalicoNetworkProvider]: Calico provider config for RKE network (list maxitems:1)
canalNetworkProvider Dict[ClusterRkeConfigNetworkCanalNetworkProvider]: Canal provider config for RKE network (list maxitems:1)
flannelNetworkProvider Dict[ClusterRkeConfigNetworkFlannelNetworkProvider]: Flannel provider config for RKE network (list maxitems:1)
mtu float: Network provider MTU. Default 0 (int)
options Dict[str, Any]: RKE options for network (map)
plugin str: Plugin for RKE network. canal (default), flannel, calico, none and weave are supported. (string)
weaveNetworkProvider Dict[ClusterRkeConfigNetworkWeaveNetworkProvider]: Weave provider config for RKE network (list maxitems:1)

ClusterRkeConfigNetworkCalicoNetworkProvider

CloudProvider string: RKE options for Calico network provider (string)

CloudProvider string: RKE options for Calico network provider (string)

cloudProvider string: RKE options for Calico network provider (string)

cloudProvider str: RKE options for Calico network provider (string)

ClusterRkeConfigNetworkCanalNetworkProvider

Iface string: Iface config Flannel network provider (string)

Iface string: Iface config Flannel network provider (string)

iface string: Iface config Flannel network provider (string)

iface str: Iface config Flannel network provider (string)

ClusterRkeConfigNetworkFlannelNetworkProvider

Iface string: Iface config Flannel network provider (string)

Iface string: Iface config Flannel network provider (string)

iface string: Iface config Flannel network provider (string)

iface str: Iface config Flannel network provider (string)

ClusterRkeConfigNetworkWeaveNetworkProvider

Password string: Registry password (string)

Password string: Registry password (string)

password string: Registry password (string)

password str: Registry password (string)

ClusterRkeConfigNode

Address string: Address ip for node (string)
Roles List<string>: Roles for the node. controlplane, etcd and worker are supported. (list)
User string: Registry user (string)
DockerSocket string: Docker socket for node (string)
HostnameOverride string: Hostname override for node (string)
InternalAddress string: Internal ip for node (string)
Labels Dictionary<string, object>: Labels for cluster registration token object (map)
NodeId string: Id for the node (string)
Port string: Port for node. Default 22 (string)
SshAgentAuth bool: Use ssh agent auth. Default false (bool)
SshKey string: Node SSH private key (string)
SshKeyPath string: Node SSH private key path (string)

Address string: Address ip for node (string)
Roles []string: Roles for the node. controlplane, etcd and worker are supported. (list)
User string: Registry user (string)
DockerSocket string: Docker socket for node (string)
HostnameOverride string: Hostname override for node (string)
InternalAddress string: Internal ip for node (string)
Labels map[string]interface{}: Labels for cluster registration token object (map)
NodeId string: Id for the node (string)
Port string: Port for node. Default 22 (string)
SshAgentAuth bool: Use ssh agent auth. Default false (bool)
SshKey string: Node SSH private key (string)
SshKeyPath string: Node SSH private key path (string)

address string: Address ip for node (string)
roles string[]: Roles for the node. controlplane, etcd and worker are supported. (list)
user string: Registry user (string)
dockerSocket string: Docker socket for node (string)
hostnameOverride string: Hostname override for node (string)
internalAddress string: Internal ip for node (string)
labels {[key: string]: any}: Labels for cluster registration token object (map)
nodeId string: Id for the node (string)
port string: Port for node. Default 22 (string)
sshAgentAuth boolean: Use ssh agent auth. Default false (bool)
sshKey string: Node SSH private key (string)
sshKeyPath string: Node SSH private key path (string)

address str: Address ip for node (string)
roles List[str]: Roles for the node. controlplane, etcd and worker are supported. (list)
user str: Registry user (string)
dockerSocket str: Docker socket for node (string)
hostnameOverride str: Hostname override for node (string)
internalAddress str: Internal ip for node (string)
labels Dict[str, Any]: Labels for cluster registration token object (map)
nodeId str: Id for the node (string)
port str: Port for node. Default 22 (string)
sshAgentAuth bool: Use ssh agent auth. Default false (bool)
sshKey str: Node SSH private key (string)
sshKeyPath str: Node SSH private key path (string)

ClusterRkeConfigPrivateRegistry

Url string: Registry URL (string)
IsDefault bool: Set as default registry. Default false (bool)
Password string: Registry password (string)
User string: Registry user (string)

Url string: Registry URL (string)
IsDefault bool: Set as default registry. Default false (bool)
Password string: Registry password (string)
User string: Registry user (string)

url string: Registry URL (string)
isDefault boolean: Set as default registry. Default false (bool)
password string: Registry password (string)
user string: Registry user (string)

url str: Registry URL (string)
isDefault bool: Set as default registry. Default false (bool)
password str: Registry password (string)
user str: Registry user (string)

ClusterRkeConfigServices

Etcd ClusterRkeConfigServicesEtcdArgs: Etcd options for RKE services (list maxitems:1)
KubeApi ClusterRkeConfigServicesKubeApiArgs: Kube API options for RKE services (list maxitems:1)
KubeController ClusterRkeConfigServicesKubeControllerArgs: Kube Controller options for RKE services (list maxitems:1)
Kubelet ClusterRkeConfigServicesKubeletArgs: Kubelet options for RKE services (list maxitems:1)
Kubeproxy ClusterRkeConfigServicesKubeproxyArgs: Kubeproxy options for RKE services (list maxitems:1)
Scheduler ClusterRkeConfigServicesSchedulerArgs: Scheduler options for RKE services (list maxitems:1)

Etcd ClusterRkeConfigServicesEtcd: Etcd options for RKE services (list maxitems:1)
KubeApi ClusterRkeConfigServicesKubeApi: Kube API options for RKE services (list maxitems:1)
KubeController ClusterRkeConfigServicesKubeController: Kube Controller options for RKE services (list maxitems:1)
Kubelet ClusterRkeConfigServicesKubelet: Kubelet options for RKE services (list maxitems:1)
Kubeproxy ClusterRkeConfigServicesKubeproxy: Kubeproxy options for RKE services (list maxitems:1)
Scheduler ClusterRkeConfigServicesScheduler: Scheduler options for RKE services (list maxitems:1)

etcd ClusterRkeConfigServicesEtcd: Etcd options for RKE services (list maxitems:1)
kubeApi ClusterRkeConfigServicesKubeApi: Kube API options for RKE services (list maxitems:1)
kubeController ClusterRkeConfigServicesKubeController: Kube Controller options for RKE services (list maxitems:1)
kubelet ClusterRkeConfigServicesKubelet: Kubelet options for RKE services (list maxitems:1)
kubeproxy ClusterRkeConfigServicesKubeproxy: Kubeproxy options for RKE services (list maxitems:1)
scheduler ClusterRkeConfigServicesScheduler: Scheduler options for RKE services (list maxitems:1)

etcd Dict[ClusterRkeConfigServicesEtcd]: Etcd options for RKE services (list maxitems:1)
kubeApi Dict[ClusterRkeConfigServicesKubeApi]: Kube API options for RKE services (list maxitems:1)
kubeController Dict[ClusterRkeConfigServicesKubeController]: Kube Controller options for RKE services (list maxitems:1)
kubelet Dict[ClusterRkeConfigServicesKubelet]: Kubelet options for RKE services (list maxitems:1)
kubeproxy Dict[ClusterRkeConfigServicesKubeproxy]: Kubeproxy options for RKE services (list maxitems:1)
scheduler Dict[ClusterRkeConfigServicesScheduler]: Scheduler options for RKE services (list maxitems:1)

ClusterRkeConfigServicesEtcd

BackupConfig ClusterRkeConfigServicesEtcdBackupConfigArgs: Backup options for etcd service. Just for Rancher v2.2.x (list maxitems:1)
CaCert string: TLS CA certificate for etcd service (string)
Cert string: TLS certificate for etcd service (string)
Creation string: Creation option for etcd service (string)
ExternalUrls List<string>: External urls for etcd service (list)
ExtraArgs Dictionary<string, object>: Extra arguments for scheduler service (map)
ExtraBinds List<string>: Extra binds for scheduler service (list)
ExtraEnvs List<string>: Extra environment for scheduler service (list)
Gid int: Etcd service GID. Default: 0. For Rancher v2.3.x or above (int)
Image string: Docker image for scheduler service (string)
Key string: TLS key for etcd service (string)
Path string: (Optional) Audit log path. Default: /var/log/kube-audit/audit-log.json (string)
Retention string: Retention for etcd backup. Default 6 (int)
Snapshot bool: Snapshot option for etcd service (bool)
Uid int: Etcd service UID. Default: 0. For Rancher v2.3.x or above (int)

BackupConfig ClusterRkeConfigServicesEtcdBackupConfig: Backup options for etcd service. Just for Rancher v2.2.x (list maxitems:1)
CaCert string: TLS CA certificate for etcd service (string)
Cert string: TLS certificate for etcd service (string)
Creation string: Creation option for etcd service (string)
ExternalUrls []string: External urls for etcd service (list)
ExtraArgs map[string]interface{}: Extra arguments for scheduler service (map)
ExtraBinds []string: Extra binds for scheduler service (list)
ExtraEnvs []string: Extra environment for scheduler service (list)
Gid int: Etcd service GID. Default: 0. For Rancher v2.3.x or above (int)
Image string: Docker image for scheduler service (string)
Key string: TLS key for etcd service (string)
Path string: (Optional) Audit log path. Default: /var/log/kube-audit/audit-log.json (string)
Retention string: Retention for etcd backup. Default 6 (int)
Snapshot bool: Snapshot option for etcd service (bool)
Uid int: Etcd service UID. Default: 0. For Rancher v2.3.x or above (int)

backupConfig ClusterRkeConfigServicesEtcdBackupConfig: Backup options for etcd service. Just for Rancher v2.2.x (list maxitems:1)
caCert string: TLS CA certificate for etcd service (string)
cert string: TLS certificate for etcd service (string)
creation string: Creation option for etcd service (string)
externalUrls string[]: External urls for etcd service (list)
extraArgs {[key: string]: any}: Extra arguments for scheduler service (map)
extraBinds string[]: Extra binds for scheduler service (list)
extraEnvs string[]: Extra environment for scheduler service (list)
gid number: Etcd service GID. Default: 0. For Rancher v2.3.x or above (int)
image string: Docker image for scheduler service (string)
key string: TLS key for etcd service (string)
path string: (Optional) Audit log path. Default: /var/log/kube-audit/audit-log.json (string)
retention string: Retention for etcd backup. Default 6 (int)
snapshot boolean: Snapshot option for etcd service (bool)
uid number: Etcd service UID. Default: 0. For Rancher v2.3.x or above (int)

backup_config Dict[ClusterRkeConfigServicesEtcdBackupConfig]: Backup options for etcd service. Just for Rancher v2.2.x (list maxitems:1)
caCert str: TLS CA certificate for etcd service (string)
cert str: TLS certificate for etcd service (string)
creation str: Creation option for etcd service (string)
externalUrls List[str]: External urls for etcd service (list)
extraArgs Dict[str, Any]: Extra arguments for scheduler service (map)
extraBinds List[str]: Extra binds for scheduler service (list)
extraEnvs List[str]: Extra environment for scheduler service (list)
gid float: Etcd service GID. Default: 0. For Rancher v2.3.x or above (int)
image str: Docker image for scheduler service (string)
key str: TLS key for etcd service (string)
path str: (Optional) Audit log path. Default: /var/log/kube-audit/audit-log.json (string)
retention str: Retention for etcd backup. Default 6 (int)
snapshot bool: Snapshot option for etcd service (bool)
uid float: Etcd service UID. Default: 0. For Rancher v2.3.x or above (int)

ClusterRkeConfigServicesEtcdBackupConfig

Enabled bool: Enable scheduled cluster scan. Default: false (bool)
IntervalHours int: Interval hours for etcd backup. Default 12 (int)
Retention int: Retention for etcd backup. Default 6 (int)
S3BackupConfig ClusterRkeConfigServicesEtcdBackupConfigS3BackupConfigArgs: S3 config options for etcd backup (list maxitems:1)
SafeTimestamp bool: Safe timestamp for etcd backup. Default: false (bool)

Enabled bool: Enable scheduled cluster scan. Default: false (bool)
IntervalHours int: Interval hours for etcd backup. Default 12 (int)
Retention int: Retention for etcd backup. Default 6 (int)
S3BackupConfig ClusterRkeConfigServicesEtcdBackupConfigS3BackupConfig: S3 config options for etcd backup (list maxitems:1)
SafeTimestamp bool: Safe timestamp for etcd backup. Default: false (bool)

enabled boolean: Enable scheduled cluster scan. Default: false (bool)
intervalHours number: Interval hours for etcd backup. Default 12 (int)
retention number: Retention for etcd backup. Default 6 (int)
s3BackupConfig ClusterRkeConfigServicesEtcdBackupConfigS3BackupConfig: S3 config options for etcd backup (list maxitems:1)
safeTimestamp boolean: Safe timestamp for etcd backup. Default: false (bool)

enabled bool: Enable scheduled cluster scan. Default: false (bool)
intervalHours float: Interval hours for etcd backup. Default 12 (int)
retention float: Retention for etcd backup. Default 6 (int)
s3BackupConfig Dict[ClusterRkeConfigServicesEtcdBackupConfigS3BackupConfig]: S3 config options for etcd backup (list maxitems:1)
safeTimestamp bool: Safe timestamp for etcd backup. Default: false (bool)

ClusterRkeConfigServicesEtcdBackupConfigS3BackupConfig

BucketName string: Bucket name for S3 service (string)
Endpoint string: Endpoint for S3 service (string)
AccessKey string: The AWS Client ID to use (string)
CustomCa string: Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)
Folder string: Folder for S3 service. Available from Rancher v2.2.7 (string)
Region string: GKE cluster region. Conflicts with zone (string)
SecretKey string: The AWS Client Secret associated with the Client ID (string)

BucketName string: Bucket name for S3 service (string)
Endpoint string: Endpoint for S3 service (string)
AccessKey string: The AWS Client ID to use (string)
CustomCa string: Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)
Folder string: Folder for S3 service. Available from Rancher v2.2.7 (string)
Region string: GKE cluster region. Conflicts with zone (string)
SecretKey string: The AWS Client Secret associated with the Client ID (string)

bucketName string: Bucket name for S3 service (string)
endpoint string: Endpoint for S3 service (string)
accessKey string: The AWS Client ID to use (string)
customCa string: Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)
folder string: Folder for S3 service. Available from Rancher v2.2.7 (string)
region string: GKE cluster region. Conflicts with zone (string)
secretKey string: The AWS Client Secret associated with the Client ID (string)

bucketName str: Bucket name for S3 service (string)
endpoint str: Endpoint for S3 service (string)
access_key str: The AWS Client ID to use (string)
customCa str: Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)
folder str: Folder for S3 service. Available from Rancher v2.2.7 (string)
region str: GKE cluster region. Conflicts with zone (string)
secret_key str: The AWS Client Secret associated with the Client ID (string)

ClusterRkeConfigServicesKubeApi

AdmissionConfiguration Dictionary<string, object>: Admission configuration (map)
AlwaysPullImages bool: Enable AlwaysPullImages Admission controller plugin. Rancher docs Default: false (bool)
AuditLog ClusterRkeConfigServicesKubeApiAuditLogArgs: K8s audit log configuration. (list maxitems: 1)
EventRateLimit ClusterRkeConfigServicesKubeApiEventRateLimitArgs: K8s event rate limit configuration. (list maxitems: 1)
ExtraArgs Dictionary<string, object>: Extra arguments for scheduler service (map)
ExtraBinds List<string>: Extra binds for scheduler service (list)
ExtraEnvs List<string>: Extra environment for scheduler service (list)
Image string: Docker image for scheduler service (string)
PodSecurityPolicy bool: Pod Security Policy option for kube API service. Default false (bool)
SecretsEncryptionConfig ClusterRkeConfigServicesKubeApiSecretsEncryptionConfigArgs: Encrypt k8s secret data configration. (list maxitem: 1)
ServiceClusterIpRange string: Service Cluster ip Range option for kube controller service (string)
ServiceNodePortRange string: Service Node Port Range option for kube API service (string)

AdmissionConfiguration map[string]interface{}: Admission configuration (map)
AlwaysPullImages bool: Enable AlwaysPullImages Admission controller plugin. Rancher docs Default: false (bool)
AuditLog ClusterRkeConfigServicesKubeApiAuditLog: K8s audit log configuration. (list maxitems: 1)
EventRateLimit ClusterRkeConfigServicesKubeApiEventRateLimit: K8s event rate limit configuration. (list maxitems: 1)
ExtraArgs map[string]interface{}: Extra arguments for scheduler service (map)
ExtraBinds []string: Extra binds for scheduler service (list)
ExtraEnvs []string: Extra environment for scheduler service (list)
Image string: Docker image for scheduler service (string)
PodSecurityPolicy bool: Pod Security Policy option for kube API service. Default false (bool)
SecretsEncryptionConfig ClusterRkeConfigServicesKubeApiSecretsEncryptionConfig: Encrypt k8s secret data configration. (list maxitem: 1)
ServiceClusterIpRange string: Service Cluster ip Range option for kube controller service (string)
ServiceNodePortRange string: Service Node Port Range option for kube API service (string)

admissionConfiguration {[key: string]: any}: Admission configuration (map)
alwaysPullImages boolean: Enable AlwaysPullImages Admission controller plugin. Rancher docs Default: false (bool)
auditLog ClusterRkeConfigServicesKubeApiAuditLog: K8s audit log configuration. (list maxitems: 1)
eventRateLimit ClusterRkeConfigServicesKubeApiEventRateLimit: K8s event rate limit configuration. (list maxitems: 1)
extraArgs {[key: string]: any}: Extra arguments for scheduler service (map)
extraBinds string[]: Extra binds for scheduler service (list)
extraEnvs string[]: Extra environment for scheduler service (list)
image string: Docker image for scheduler service (string)
podSecurityPolicy boolean: Pod Security Policy option for kube API service. Default false (bool)
secretsEncryptionConfig ClusterRkeConfigServicesKubeApiSecretsEncryptionConfig: Encrypt k8s secret data configration. (list maxitem: 1)
serviceClusterIpRange string: Service Cluster ip Range option for kube controller service (string)
serviceNodePortRange string: Service Node Port Range option for kube API service (string)

admissionConfiguration Dict[str, Any]: Admission configuration (map)
alwaysPullImages bool: Enable AlwaysPullImages Admission controller plugin. Rancher docs Default: false (bool)
auditLog Dict[ClusterRkeConfigServicesKubeApiAuditLog]: K8s audit log configuration. (list maxitems: 1)
eventRateLimit Dict[ClusterRkeConfigServicesKubeApiEventRateLimit]: K8s event rate limit configuration. (list maxitems: 1)
extraArgs Dict[str, Any]: Extra arguments for scheduler service (map)
extraBinds List[str]: Extra binds for scheduler service (list)
extraEnvs List[str]: Extra environment for scheduler service (list)
image str: Docker image for scheduler service (string)
podSecurityPolicy bool: Pod Security Policy option for kube API service. Default false (bool)
secretsEncryptionConfig Dict[ClusterRkeConfigServicesKubeApiSecretsEncryptionConfig]: Encrypt k8s secret data configration. (list maxitem: 1)
serviceClusterIpRange str: Service Cluster ip Range option for kube controller service (string)
serviceNodePortRange str: Service Node Port Range option for kube API service (string)

ClusterRkeConfigServicesKubeApiAuditLog

Configuration ClusterRkeConfigServicesKubeApiAuditLogConfigurationArgs: Event rate limit configuration. (map)
Enabled bool: Enable scheduled cluster scan. Default: false (bool)

Configuration ClusterRkeConfigServicesKubeApiAuditLogConfiguration: Event rate limit configuration. (map)
Enabled bool: Enable scheduled cluster scan. Default: false (bool)

configuration ClusterRkeConfigServicesKubeApiAuditLogConfiguration: Event rate limit configuration. (map)
enabled boolean: Enable scheduled cluster scan. Default: false (bool)

configuration Dict[ClusterRkeConfigServicesKubeApiAuditLogConfiguration]: Event rate limit configuration. (map)
enabled bool: Enable scheduled cluster scan. Default: false (bool)

ClusterRkeConfigServicesKubeApiAuditLogConfiguration

Format string: Audit log format. Default: ‘json’ (string)
MaxAge int: Audit log max age. Default: 30 (int)
MaxBackup int: Audit log max backup. Default: 10 (int)
MaxSize int: Audit log max size. Default: 100 (int)
Path string: (Optional) Audit log path. Default: /var/log/kube-audit/audit-log.json (string)
Policy string: Audit policy yaml encoded definition. apiVersion and kind: Policy\nrules:" fields are required in the yaml. Ex. "apiVersion: audit.k8s.io/v1\nkind: Policy\nrules:\n- level: RequestResponse\n resources:\n - resources:\n - pods\n" More info (string)

Format string: Audit log format. Default: ‘json’ (string)
MaxAge int: Audit log max age. Default: 30 (int)
MaxBackup int: Audit log max backup. Default: 10 (int)
MaxSize int: Audit log max size. Default: 100 (int)
Path string: (Optional) Audit log path. Default: /var/log/kube-audit/audit-log.json (string)
Policy string: Audit policy yaml encoded definition. apiVersion and kind: Policy\nrules:" fields are required in the yaml. Ex. "apiVersion: audit.k8s.io/v1\nkind: Policy\nrules:\n- level: RequestResponse\n resources:\n - resources:\n - pods\n" More info (string)

format string: Audit log format. Default: ‘json’ (string)
maxAge number: Audit log max age. Default: 30 (int)
maxBackup number: Audit log max backup. Default: 10 (int)
maxSize number: Audit log max size. Default: 100 (int)
path string: (Optional) Audit log path. Default: /var/log/kube-audit/audit-log.json (string)
policy string: Audit policy yaml encoded definition. apiVersion and kind: Policy\nrules:" fields are required in the yaml. Ex. "apiVersion: audit.k8s.io/v1\nkind: Policy\nrules:\n- level: RequestResponse\n resources:\n - resources:\n - pods\n" More info (string)

format str: Audit log format. Default: ‘json’ (string)
maxAge float: Audit log max age. Default: 30 (int)
maxBackup float: Audit log max backup. Default: 10 (int)
maxSize float: Audit log max size. Default: 100 (int)
path str: (Optional) Audit log path. Default: /var/log/kube-audit/audit-log.json (string)
policy str: Audit policy yaml encoded definition. apiVersion and kind: Policy\nrules:" fields are required in the yaml. Ex. "apiVersion: audit.k8s.io/v1\nkind: Policy\nrules:\n- level: RequestResponse\n resources:\n - resources:\n - pods\n" More info (string)

ClusterRkeConfigServicesKubeApiEventRateLimit

Configuration Dictionary<string, object>: Event rate limit configuration. (map)
Enabled bool: Enable scheduled cluster scan. Default: false (bool)

Configuration map[string]interface{}: Event rate limit configuration. (map)
Enabled bool: Enable scheduled cluster scan. Default: false (bool)

configuration {[key: string]: any}: Event rate limit configuration. (map)
enabled boolean: Enable scheduled cluster scan. Default: false (bool)

configuration Dict[str, Any]: Event rate limit configuration. (map)
enabled bool: Enable scheduled cluster scan. Default: false (bool)

ClusterRkeConfigServicesKubeApiSecretsEncryptionConfig

CustomConfig Dictionary<string, object>: Secrets encryption configuration. (map)
Enabled bool: Enable scheduled cluster scan. Default: false (bool)

CustomConfig map[string]interface{}: Secrets encryption configuration. (map)
Enabled bool: Enable scheduled cluster scan. Default: false (bool)

customConfig {[key: string]: any}: Secrets encryption configuration. (map)
enabled boolean: Enable scheduled cluster scan. Default: false (bool)

customConfig Dict[str, Any]: Secrets encryption configuration. (map)
enabled bool: Enable scheduled cluster scan. Default: false (bool)

ClusterRkeConfigServicesKubeController

ClusterCidr string: Cluster CIDR option for kube controller service (string)
ExtraArgs Dictionary<string, object>: Extra arguments for scheduler service (map)
ExtraBinds List<string>: Extra binds for scheduler service (list)
ExtraEnvs List<string>: Extra environment for scheduler service (list)
Image string: Docker image for scheduler service (string)
ServiceClusterIpRange string: Service Cluster ip Range option for kube controller service (string)

ClusterCidr string: Cluster CIDR option for kube controller service (string)
ExtraArgs map[string]interface{}: Extra arguments for scheduler service (map)
ExtraBinds []string: Extra binds for scheduler service (list)
ExtraEnvs []string: Extra environment for scheduler service (list)
Image string: Docker image for scheduler service (string)
ServiceClusterIpRange string: Service Cluster ip Range option for kube controller service (string)

clusterCidr string: Cluster CIDR option for kube controller service (string)
extraArgs {[key: string]: any}: Extra arguments for scheduler service (map)
extraBinds string[]: Extra binds for scheduler service (list)
extraEnvs string[]: Extra environment for scheduler service (list)
image string: Docker image for scheduler service (string)
serviceClusterIpRange string: Service Cluster ip Range option for kube controller service (string)

clusterCidr str: Cluster CIDR option for kube controller service (string)
extraArgs Dict[str, Any]: Extra arguments for scheduler service (map)
extraBinds List[str]: Extra binds for scheduler service (list)
extraEnvs List[str]: Extra environment for scheduler service (list)
image str: Docker image for scheduler service (string)
serviceClusterIpRange str: Service Cluster ip Range option for kube controller service (string)

ClusterRkeConfigServicesKubelet

ClusterDnsServer string: Cluster DNS Server option for kubelet service (string)
ClusterDomain string: Cluster Domain option for kubelet service (string)
ExtraArgs Dictionary<string, object>: Extra arguments for scheduler service (map)
ExtraBinds List<string>: Extra binds for scheduler service (list)
ExtraEnvs List<string>: Extra environment for scheduler service (list)
FailSwapOn bool: Enable or disable failing when swap on is not supported (bool)
GenerateServingCertificate bool: Generate a certificate signed by the kube-ca. Default false (bool)
Image string: Docker image for scheduler service (string)
InfraContainerImage string: Infra container image for kubelet service (string)

ClusterDnsServer string: Cluster DNS Server option for kubelet service (string)
ClusterDomain string: Cluster Domain option for kubelet service (string)
ExtraArgs map[string]interface{}: Extra arguments for scheduler service (map)
ExtraBinds []string: Extra binds for scheduler service (list)
ExtraEnvs []string: Extra environment for scheduler service (list)
FailSwapOn bool: Enable or disable failing when swap on is not supported (bool)
GenerateServingCertificate bool: Generate a certificate signed by the kube-ca. Default false (bool)
Image string: Docker image for scheduler service (string)
InfraContainerImage string: Infra container image for kubelet service (string)

clusterDnsServer string: Cluster DNS Server option for kubelet service (string)
clusterDomain string: Cluster Domain option for kubelet service (string)
extraArgs {[key: string]: any}: Extra arguments for scheduler service (map)
extraBinds string[]: Extra binds for scheduler service (list)
extraEnvs string[]: Extra environment for scheduler service (list)
failSwapOn boolean: Enable or disable failing when swap on is not supported (bool)
generateServingCertificate boolean: Generate a certificate signed by the kube-ca. Default false (bool)
image string: Docker image for scheduler service (string)
infraContainerImage string: Infra container image for kubelet service (string)

clusterDnsServer str: Cluster DNS Server option for kubelet service (string)
clusterDomain str: Cluster Domain option for kubelet service (string)
extraArgs Dict[str, Any]: Extra arguments for scheduler service (map)
extraBinds List[str]: Extra binds for scheduler service (list)
extraEnvs List[str]: Extra environment for scheduler service (list)
failSwapOn bool: Enable or disable failing when swap on is not supported (bool)
generateServingCertificate bool: Generate a certificate signed by the kube-ca. Default false (bool)
image str: Docker image for scheduler service (string)
infraContainerImage str: Infra container image for kubelet service (string)

ClusterRkeConfigServicesKubeproxy

ExtraArgs Dictionary<string, object>: Extra arguments for scheduler service (map)
ExtraBinds List<string>: Extra binds for scheduler service (list)
ExtraEnvs List<string>: Extra environment for scheduler service (list)
Image string: Docker image for scheduler service (string)

ExtraArgs map[string]interface{}: Extra arguments for scheduler service (map)
ExtraBinds []string: Extra binds for scheduler service (list)
ExtraEnvs []string: Extra environment for scheduler service (list)
Image string: Docker image for scheduler service (string)

extraArgs {[key: string]: any}: Extra arguments for scheduler service (map)
extraBinds string[]: Extra binds for scheduler service (list)
extraEnvs string[]: Extra environment for scheduler service (list)
image string: Docker image for scheduler service (string)

extraArgs Dict[str, Any]: Extra arguments for scheduler service (map)
extraBinds List[str]: Extra binds for scheduler service (list)
extraEnvs List[str]: Extra environment for scheduler service (list)
image str: Docker image for scheduler service (string)

ClusterRkeConfigServicesScheduler

ExtraArgs Dictionary<string, object>: Extra arguments for scheduler service (map)
ExtraBinds List<string>: Extra binds for scheduler service (list)
ExtraEnvs List<string>: Extra environment for scheduler service (list)
Image string: Docker image for scheduler service (string)

ExtraArgs map[string]interface{}: Extra arguments for scheduler service (map)
ExtraBinds []string: Extra binds for scheduler service (list)
ExtraEnvs []string: Extra environment for scheduler service (list)
Image string: Docker image for scheduler service (string)

extraArgs {[key: string]: any}: Extra arguments for scheduler service (map)
extraBinds string[]: Extra binds for scheduler service (list)
extraEnvs string[]: Extra environment for scheduler service (list)
image string: Docker image for scheduler service (string)

extraArgs Dict[str, Any]: Extra arguments for scheduler service (map)
extraBinds List[str]: Extra binds for scheduler service (list)
extraEnvs List[str]: Extra environment for scheduler service (list)
image str: Docker image for scheduler service (string)

ClusterRkeConfigUpgradeStrategy

Drain bool: RKE drain nodes. Default: false (bool)
DrainInput ClusterRkeConfigUpgradeStrategyDrainInputArgs: RKE drain node input (list Maxitems: 1)
MaxUnavailableControlplane string: RKE max unavailable controlplane nodes. Default: 1 (string)
MaxUnavailableWorker string: RKE max unavailable worker nodes. Default: 10% (string)

Drain bool: RKE drain nodes. Default: false (bool)
DrainInput ClusterRkeConfigUpgradeStrategyDrainInput: RKE drain node input (list Maxitems: 1)
MaxUnavailableControlplane string: RKE max unavailable controlplane nodes. Default: 1 (string)
MaxUnavailableWorker string: RKE max unavailable worker nodes. Default: 10% (string)

drain boolean: RKE drain nodes. Default: false (bool)
drainInput ClusterRkeConfigUpgradeStrategyDrainInput: RKE drain node input (list Maxitems: 1)
maxUnavailableControlplane string: RKE max unavailable controlplane nodes. Default: 1 (string)
maxUnavailableWorker string: RKE max unavailable worker nodes. Default: 10% (string)

drain bool: RKE drain nodes. Default: false (bool)
drainInput Dict[ClusterRkeConfigUpgradeStrategyDrainInput]: RKE drain node input (list Maxitems: 1)
maxUnavailableControlplane str: RKE max unavailable controlplane nodes. Default: 1 (string)
maxUnavailableWorker str: RKE max unavailable worker nodes. Default: 10% (string)

ClusterRkeConfigUpgradeStrategyDrainInput

DeleteLocalData bool: Delete RKE node local data. Default: false (bool)
Force bool: Force RKE node drain. Default: false (bool)
GracePeriod int: RKE node drain grace period. Default: -1 (int)
IgnoreDaemonSets bool: Ignore RKE daemon sets. Default: true (bool)
Timeout int: RKE node drain timeout. Default: 60 (int)

DeleteLocalData bool: Delete RKE node local data. Default: false (bool)
Force bool: Force RKE node drain. Default: false (bool)
GracePeriod int: RKE node drain grace period. Default: -1 (int)
IgnoreDaemonSets bool: Ignore RKE daemon sets. Default: true (bool)
Timeout int: RKE node drain timeout. Default: 60 (int)

deleteLocalData boolean: Delete RKE node local data. Default: false (bool)
force boolean: Force RKE node drain. Default: false (bool)
gracePeriod number: RKE node drain grace period. Default: -1 (int)
ignoreDaemonSets boolean: Ignore RKE daemon sets. Default: true (bool)
timeout number: RKE node drain timeout. Default: 60 (int)

deleteLocalData bool: Delete RKE node local data. Default: false (bool)
force bool: Force RKE node drain. Default: false (bool)
gracePeriod float: RKE node drain grace period. Default: -1 (int)
ignoreDaemonSets bool: Ignore RKE daemon sets. Default: true (bool)
timeout float: RKE node drain timeout. Default: 60 (int)

ClusterScheduledClusterScan

ScanConfig ClusterScheduledClusterScanScanConfigArgs: Cluster scan config (List maxitems:1)
ScheduleConfig ClusterScheduledClusterScanScheduleConfigArgs: Cluster scan schedule config (list maxitems:1)
Enabled bool: Enable scheduled cluster scan. Default: false (bool)

ScanConfig ClusterScheduledClusterScanScanConfig: Cluster scan config (List maxitems:1)
ScheduleConfig ClusterScheduledClusterScanScheduleConfig: Cluster scan schedule config (list maxitems:1)
Enabled bool: Enable scheduled cluster scan. Default: false (bool)

scanConfig ClusterScheduledClusterScanScanConfig: Cluster scan config (List maxitems:1)
scheduleConfig ClusterScheduledClusterScanScheduleConfig: Cluster scan schedule config (list maxitems:1)
enabled boolean: Enable scheduled cluster scan. Default: false (bool)

scanConfig Dict[ClusterScheduledClusterScanScanConfig]: Cluster scan config (List maxitems:1)
scheduleConfig Dict[ClusterScheduledClusterScanScheduleConfig]: Cluster scan schedule config (list maxitems:1)
enabled bool: Enable scheduled cluster scan. Default: false (bool)

ClusterScheduledClusterScanScanConfig

CisScanConfig ClusterScheduledClusterScanScanConfigCisScanConfigArgs: Cluster Cis Scan config (List maxitems:1)

CisScanConfig ClusterScheduledClusterScanScanConfigCisScanConfig: Cluster Cis Scan config (List maxitems:1)

cisScanConfig ClusterScheduledClusterScanScanConfigCisScanConfig: Cluster Cis Scan config (List maxitems:1)

cisScanConfig Dict[ClusterScheduledClusterScanScanConfigCisScanConfig]: Cluster Cis Scan config (List maxitems:1)

ClusterScheduledClusterScanScanConfigCisScanConfig

DebugMaster bool: Debug master. Default: false (bool)
DebugWorker bool: Debug worker. Default: false (bool)
OverrideBenchmarkVersion string: Override benchmark version (string)
OverrideSkips List<string>: Override skip (string)
Profile string: Cis scan profile. Allowed values: "permissive" (default) || "hardened" (string)

DebugMaster bool: Debug master. Default: false (bool)
DebugWorker bool: Debug worker. Default: false (bool)
OverrideBenchmarkVersion string: Override benchmark version (string)
OverrideSkips []string: Override skip (string)
Profile string: Cis scan profile. Allowed values: "permissive" (default) || "hardened" (string)

debugMaster boolean: Debug master. Default: false (bool)
debugWorker boolean: Debug worker. Default: false (bool)
overrideBenchmarkVersion string: Override benchmark version (string)
overrideSkips string[]: Override skip (string)
profile string: Cis scan profile. Allowed values: "permissive" (default) || "hardened" (string)

debugMaster bool: Debug master. Default: false (bool)
debugWorker bool: Debug worker. Default: false (bool)
overrideBenchmarkVersion str: Override benchmark version (string)
overrideSkips List[str]: Override skip (string)
profile str: Cis scan profile. Allowed values: "permissive" (default) || "hardened" (string)

ClusterScheduledClusterScanScheduleConfig

CronSchedule string: Crontab schedule. It should contains 5 fields "<min> <hour> <month_day> <month> <week_day>" (string)
Retention int: Retention for etcd backup. Default 6 (int)

CronSchedule string: Crontab schedule. It should contains 5 fields "<min> <hour> <month_day> <month> <week_day>" (string)
Retention int: Retention for etcd backup. Default 6 (int)

cronSchedule string: Crontab schedule. It should contains 5 fields "<min> <hour> <month_day> <month> <week_day>" (string)
retention number: Retention for etcd backup. Default 6 (int)

cronSchedule str: Crontab schedule. It should contains 5 fields "<min> <hour> <month_day> <month> <week_day>" (string)
retention float: Retention for etcd backup. Default 6 (int)

Package Details

Repository: https://github.com/pulumi/pulumi-rancher2
License: Apache-2.0
Notes: This Pulumi package is based on the rancher2 Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud