Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. Rancher 2
  5. Cluster

Cluster

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

Example Usage

Creating Rancher v2 RKE cluster enabling and customizing monitoring

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new rancher2 RKE Cluster
        var foo_custom = new Rancher2.Cluster("foo-custom", new Rancher2.ClusterArgs
        {
            ClusterMonitoringInput = new Rancher2.Inputs.ClusterClusterMonitoringInputArgs
            {
                Answers = 
                {
                    { "exporter-kubelets.https", true },
                    { "exporter-node.enabled", true },
                    { "exporter-node.ports.metrics.port", 9796 },
                    { "exporter-node.resources.limits.cpu", "200m" },
                    { "exporter-node.resources.limits.memory", "200Mi" },
                    { "grafana.persistence.enabled", false },
                    { "grafana.persistence.size", "10Gi" },
                    { "grafana.persistence.storageClass", "default" },
                    { "operator.resources.limits.memory", "500Mi" },
                    { "prometheus.persistence.enabled", "false" },
                    { "prometheus.persistence.size", "50Gi" },
                    { "prometheus.persistence.storageClass", "default" },
                    { "prometheus.persistent.useReleaseName", "true" },
                    { "prometheus.resources.core.limits.cpu", "1000m" },
                    { "prometheus.resources.core.limits.memory", "1500Mi" },
                    { "prometheus.resources.core.requests.cpu", "750m" },
                    { "prometheus.resources.core.requests.memory", "750Mi" },
                    { "prometheus.retention", "12h" },
                },
                Version = "0.1.0",
            },
            Description = "Foo rancher2 custom cluster",
            EnableClusterMonitoring = true,
            RkeConfig = new Rancher2.Inputs.ClusterRkeConfigArgs
            {
                Network = new Rancher2.Inputs.ClusterRkeConfigNetworkArgs
                {
                    Plugin = "canal",
                },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rancher2.NewCluster(ctx, "foo_custom", &rancher2.ClusterArgs{
            ClusterMonitoringInput: &rancher2.ClusterClusterMonitoringInputArgs{
                Answers: pulumi.Map{
                    "exporter-kubelets.https":                   pulumi.Bool(true),
                    "exporter-node.enabled":                     pulumi.Bool(true),
                    "exporter-node.ports.metrics.port":          pulumi.Float64(9796),
                    "exporter-node.resources.limits.cpu":        pulumi.String("200m"),
                    "exporter-node.resources.limits.memory":     pulumi.String("200Mi"),
                    "grafana.persistence.enabled":               pulumi.Bool(false),
                    "grafana.persistence.size":                  pulumi.String("10Gi"),
                    "grafana.persistence.storageClass":          pulumi.String("default"),
                    "operator.resources.limits.memory":          pulumi.String("500Mi"),
                    "prometheus.persistence.enabled":            pulumi.String("false"),
                    "prometheus.persistence.size":               pulumi.String("50Gi"),
                    "prometheus.persistence.storageClass":       pulumi.String("default"),
                    "prometheus.persistent.useReleaseName":      pulumi.String("true"),
                    "prometheus.resources.core.limits.cpu":      pulumi.String("1000m"),
                    "prometheus.resources.core.limits.memory":   pulumi.String("1500Mi"),
                    "prometheus.resources.core.requests.cpu":    pulumi.String("750m"),
                    "prometheus.resources.core.requests.memory": pulumi.String("750Mi"),
                    "prometheus.retention":                      pulumi.String("12h"),
                },
                Version: pulumi.String("0.1.0"),
            },
            Description:             pulumi.String("Foo rancher2 custom cluster"),
            EnableClusterMonitoring: pulumi.Bool(true),
            RkeConfig: &rancher2.ClusterRkeConfigArgs{
                Network: &rancher2.ClusterRkeConfigNetworkArgs{
                    Plugin: pulumi.String("canal"),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 RKE Cluster
foo_custom = rancher2.Cluster("foo-custom",
    cluster_monitoring_input=rancher2.ClusterClusterMonitoringInputArgs(
        answers={
            "exporter-kubelets.https": True,
            "exporter-node.enabled": True,
            "exporter-node.ports.metrics.port": 9796,
            "exporter-node.resources.limits.cpu": "200m",
            "exporter-node.resources.limits.memory": "200Mi",
            "grafana.persistence.enabled": False,
            "grafana.persistence.size": "10Gi",
            "grafana.persistence.storageClass": "default",
            "operator.resources.limits.memory": "500Mi",
            "prometheus.persistence.enabled": "false",
            "prometheus.persistence.size": "50Gi",
            "prometheus.persistence.storageClass": "default",
            "prometheus.persistent.useReleaseName": "true",
            "prometheus.resources.core.limits.cpu": "1000m",
            "prometheus.resources.core.limits.memory": "1500Mi",
            "prometheus.resources.core.requests.cpu": "750m",
            "prometheus.resources.core.requests.memory": "750Mi",
            "prometheus.retention": "12h",
        },
        version="0.1.0",
    ),
    description="Foo rancher2 custom cluster",
    enable_cluster_monitoring=True,
    rke_config=rancher2.ClusterRkeConfigArgs(
        network=rancher2.ClusterRkeConfigNetworkArgs(
            plugin="canal",
        ),
    ))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 RKE Cluster
const foo_custom = new rancher2.Cluster("foo-custom", {
    clusterMonitoringInput: {
        answers: {
            "exporter-kubelets.https": true,
            "exporter-node.enabled": true,
            "exporter-node.ports.metrics.port": 9796,
            "exporter-node.resources.limits.cpu": "200m",
            "exporter-node.resources.limits.memory": "200Mi",
            "grafana.persistence.enabled": false,
            "grafana.persistence.size": "10Gi",
            "grafana.persistence.storageClass": "default",
            "operator.resources.limits.memory": "500Mi",
            "prometheus.persistence.enabled": "false",
            "prometheus.persistence.size": "50Gi",
            "prometheus.persistence.storageClass": "default",
            "prometheus.persistent.useReleaseName": "true",
            "prometheus.resources.core.limits.cpu": "1000m",
            "prometheus.resources.core.limits.memory": "1500Mi",
            "prometheus.resources.core.requests.cpu": "750m",
            "prometheus.resources.core.requests.memory": "750Mi",
            "prometheus.retention": "12h",
        },
        version: "0.1.0",
    },
    description: "Foo rancher2 custom cluster",
    enableClusterMonitoring: true,
    rkeConfig: {
        network: {
            plugin: "canal",
        },
    },
});

Creating Rancher v2 RKE cluster enabling/customizing monitoring and istio

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new rancher2 RKE Cluster
        var foo_customCluster = new Rancher2.Cluster("foo-customCluster", new Rancher2.ClusterArgs
        {
            Description = "Foo rancher2 custom cluster",
            RkeConfig = new Rancher2.Inputs.ClusterRkeConfigArgs
            {
                Network = new Rancher2.Inputs.ClusterRkeConfigNetworkArgs
                {
                    Plugin = "canal",
                },
            },
            EnableClusterMonitoring = true,
            ClusterMonitoringInput = new Rancher2.Inputs.ClusterClusterMonitoringInputArgs
            {
                Answers = 
                {
                    { "exporter-kubelets.https", true },
                    { "exporter-node.enabled", true },
                    { "exporter-node.ports.metrics.port", 9796 },
                    { "exporter-node.resources.limits.cpu", "200m" },
                    { "exporter-node.resources.limits.memory", "200Mi" },
                    { "grafana.persistence.enabled", false },
                    { "grafana.persistence.size", "10Gi" },
                    { "grafana.persistence.storageClass", "default" },
                    { "operator.resources.limits.memory", "500Mi" },
                    { "prometheus.persistence.enabled", "false" },
                    { "prometheus.persistence.size", "50Gi" },
                    { "prometheus.persistence.storageClass", "default" },
                    { "prometheus.persistent.useReleaseName", "true" },
                    { "prometheus.resources.core.limits.cpu", "1000m" },
                    { "prometheus.resources.core.limits.memory", "1500Mi" },
                    { "prometheus.resources.core.requests.cpu", "750m" },
                    { "prometheus.resources.core.requests.memory", "750Mi" },
                    { "prometheus.retention", "12h" },
                },
                Version = "0.1.0",
            },
        });
        // Create a new rancher2 Cluster Sync for foo-custom cluster
        var foo_customClusterSync = new Rancher2.ClusterSync("foo-customClusterSync", new Rancher2.ClusterSyncArgs
        {
            ClusterId = foo_customCluster.Id,
            WaitMonitoring = foo_customCluster.EnableClusterMonitoring,
        });
        // Create a new rancher2 Namespace
        var foo_istio = new Rancher2.Namespace("foo-istio", new Rancher2.NamespaceArgs
        {
            ProjectId = foo_customClusterSync.SystemProjectId,
            Description = "istio namespace",
        });
        // Create a new rancher2 App deploying istio (should wait until monitoring is up and running)
        var istio = new Rancher2.App("istio", new Rancher2.AppArgs
        {
            CatalogName = "system-library",
            Description = "Terraform app acceptance test",
            ProjectId = foo_istio.ProjectId,
            TemplateName = "rancher-istio",
            TemplateVersion = "0.1.1",
            TargetNamespace = foo_istio.Id,
            Answers = 
            {
                { "certmanager.enabled", false },
                { "enableCRDs", true },
                { "galley.enabled", true },
                { "gateways.enabled", false },
                { "gateways.istio-ingressgateway.resources.limits.cpu", "2000m" },
                { "gateways.istio-ingressgateway.resources.limits.memory", "1024Mi" },
                { "gateways.istio-ingressgateway.resources.requests.cpu", "100m" },
                { "gateways.istio-ingressgateway.resources.requests.memory", "128Mi" },
                { "gateways.istio-ingressgateway.type", "NodePort" },
                { "global.monitoring.type", "cluster-monitoring" },
                { "global.rancher.clusterId", foo_customClusterSync.ClusterId },
                { "istio_cni.enabled", "false" },
                { "istiocoredns.enabled", "false" },
                { "kiali.enabled", "true" },
                { "mixer.enabled", "true" },
                { "mixer.policy.enabled", "true" },
                { "mixer.policy.resources.limits.cpu", "4800m" },
                { "mixer.policy.resources.limits.memory", "4096Mi" },
                { "mixer.policy.resources.requests.cpu", "1000m" },
                { "mixer.policy.resources.requests.memory", "1024Mi" },
                { "mixer.telemetry.resources.limits.cpu", "4800m" },
                { "mixer.telemetry.resources.limits.memory", "4096Mi" },
                { "mixer.telemetry.resources.requests.cpu", "1000m" },
                { "mixer.telemetry.resources.requests.memory", "1024Mi" },
                { "mtls.enabled", false },
                { "nodeagent.enabled", false },
                { "pilot.enabled", true },
                { "pilot.resources.limits.cpu", "1000m" },
                { "pilot.resources.limits.memory", "4096Mi" },
                { "pilot.resources.requests.cpu", "500m" },
                { "pilot.resources.requests.memory", "2048Mi" },
                { "pilot.traceSampling", "1" },
                { "security.enabled", true },
                { "sidecarInjectorWebhook.enabled", true },
                { "tracing.enabled", true },
                { "tracing.jaeger.resources.limits.cpu", "500m" },
                { "tracing.jaeger.resources.limits.memory", "1024Mi" },
                { "tracing.jaeger.resources.requests.cpu", "100m" },
                { "tracing.jaeger.resources.requests.memory", "100Mi" },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rancher2.NewCluster(ctx, "foo_customCluster", &rancher2.ClusterArgs{
            Description: pulumi.String("Foo rancher2 custom cluster"),
            RkeConfig: &rancher2.ClusterRkeConfigArgs{
                Network: &rancher2.ClusterRkeConfigNetworkArgs{
                    Plugin: pulumi.String("canal"),
                },
            },
            EnableClusterMonitoring: pulumi.Bool(true),
            ClusterMonitoringInput: &rancher2.ClusterClusterMonitoringInputArgs{
                Answers: pulumi.Map{
                    "exporter-kubelets.https":                   pulumi.Bool(true),
                    "exporter-node.enabled":                     pulumi.Bool(true),
                    "exporter-node.ports.metrics.port":          pulumi.Float64(9796),
                    "exporter-node.resources.limits.cpu":        pulumi.String("200m"),
                    "exporter-node.resources.limits.memory":     pulumi.String("200Mi"),
                    "grafana.persistence.enabled":               pulumi.Bool(false),
                    "grafana.persistence.size":                  pulumi.String("10Gi"),
                    "grafana.persistence.storageClass":          pulumi.String("default"),
                    "operator.resources.limits.memory":          pulumi.String("500Mi"),
                    "prometheus.persistence.enabled":            pulumi.String("false"),
                    "prometheus.persistence.size":               pulumi.String("50Gi"),
                    "prometheus.persistence.storageClass":       pulumi.String("default"),
                    "prometheus.persistent.useReleaseName":      pulumi.String("true"),
                    "prometheus.resources.core.limits.cpu":      pulumi.String("1000m"),
                    "prometheus.resources.core.limits.memory":   pulumi.String("1500Mi"),
                    "prometheus.resources.core.requests.cpu":    pulumi.String("750m"),
                    "prometheus.resources.core.requests.memory": pulumi.String("750Mi"),
                    "prometheus.retention":                      pulumi.String("12h"),
                },
                Version: pulumi.String("0.1.0"),
            },
        })
        if err != nil {
            return err
        }
        _, err = rancher2.NewClusterSync(ctx, "foo_customClusterSync", &rancher2.ClusterSyncArgs{
            ClusterId:      foo_customCluster.ID(),
            WaitMonitoring: foo_customCluster.EnableClusterMonitoring,
        })
        if err != nil {
            return err
        }
        _, err = rancher2.NewNamespace(ctx, "foo_istio", &rancher2.NamespaceArgs{
            ProjectId:   foo_customClusterSync.SystemProjectId,
            Description: pulumi.String("istio namespace"),
        })
        if err != nil {
            return err
        }
        _, err = rancher2.NewApp(ctx, "istio", &rancher2.AppArgs{
            CatalogName:     pulumi.String("system-library"),
            Description:     pulumi.String("Terraform app acceptance test"),
            ProjectId:       foo_istio.ProjectId,
            TemplateName:    pulumi.String("rancher-istio"),
            TemplateVersion: pulumi.String("0.1.1"),
            TargetNamespace: foo_istio.ID(),
            Answers: pulumi.Map{
                "certmanager.enabled": pulumi.Bool(false),
                "enableCRDs":          pulumi.Bool(true),
                "galley.enabled":      pulumi.Bool(true),
                "gateways.enabled":    pulumi.Bool(false),
                "gateways.istio-ingressgateway.resources.limits.cpu":      pulumi.String("2000m"),
                "gateways.istio-ingressgateway.resources.limits.memory":   pulumi.String("1024Mi"),
                "gateways.istio-ingressgateway.resources.requests.cpu":    pulumi.String("100m"),
                "gateways.istio-ingressgateway.resources.requests.memory": pulumi.String("128Mi"),
                "gateways.istio-ingressgateway.type":                      pulumi.String("NodePort"),
                "global.monitoring.type":                                  pulumi.String("cluster-monitoring"),
                "global.rancher.clusterId":                                foo_customClusterSync.ClusterId,
                "istio_cni.enabled":                                       pulumi.String("false"),
                "istiocoredns.enabled":                                    pulumi.String("false"),
                "kiali.enabled":                                           pulumi.String("true"),
                "mixer.enabled":                                           pulumi.String("true"),
                "mixer.policy.enabled":                                    pulumi.String("true"),
                "mixer.policy.resources.limits.cpu":                       pulumi.String("4800m"),
                "mixer.policy.resources.limits.memory":                    pulumi.String("4096Mi"),
                "mixer.policy.resources.requests.cpu":                     pulumi.String("1000m"),
                "mixer.policy.resources.requests.memory":                  pulumi.String("1024Mi"),
                "mixer.telemetry.resources.limits.cpu":                    pulumi.String("4800m"),
                "mixer.telemetry.resources.limits.memory":                 pulumi.String("4096Mi"),
                "mixer.telemetry.resources.requests.cpu":                  pulumi.String("1000m"),
                "mixer.telemetry.resources.requests.memory":               pulumi.String("1024Mi"),
                "mtls.enabled":                                            pulumi.Bool(false),
                "nodeagent.enabled":                                       pulumi.Bool(false),
                "pilot.enabled":                                           pulumi.Bool(true),
                "pilot.resources.limits.cpu":                              pulumi.String("1000m"),
                "pilot.resources.limits.memory":                           pulumi.String("4096Mi"),
                "pilot.resources.requests.cpu":                            pulumi.String("500m"),
                "pilot.resources.requests.memory":                         pulumi.String("2048Mi"),
                "pilot.traceSampling":                                     pulumi.String("1"),
                "security.enabled":                                        pulumi.Bool(true),
                "sidecarInjectorWebhook.enabled":                          pulumi.Bool(true),
                "tracing.enabled":                                         pulumi.Bool(true),
                "tracing.jaeger.resources.limits.cpu":                     pulumi.String("500m"),
                "tracing.jaeger.resources.limits.memory":                  pulumi.String("1024Mi"),
                "tracing.jaeger.resources.requests.cpu":                   pulumi.String("100m"),
                "tracing.jaeger.resources.requests.memory":                pulumi.String("100Mi"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 RKE Cluster
foo_custom_cluster = rancher2.Cluster("foo-customCluster",
    description="Foo rancher2 custom cluster",
    rke_config=rancher2.ClusterRkeConfigArgs(
        network=rancher2.ClusterRkeConfigNetworkArgs(
            plugin="canal",
        ),
    ),
    enable_cluster_monitoring=True,
    cluster_monitoring_input=rancher2.ClusterClusterMonitoringInputArgs(
        answers={
            "exporter-kubelets.https": True,
            "exporter-node.enabled": True,
            "exporter-node.ports.metrics.port": 9796,
            "exporter-node.resources.limits.cpu": "200m",
            "exporter-node.resources.limits.memory": "200Mi",
            "grafana.persistence.enabled": False,
            "grafana.persistence.size": "10Gi",
            "grafana.persistence.storageClass": "default",
            "operator.resources.limits.memory": "500Mi",
            "prometheus.persistence.enabled": "false",
            "prometheus.persistence.size": "50Gi",
            "prometheus.persistence.storageClass": "default",
            "prometheus.persistent.useReleaseName": "true",
            "prometheus.resources.core.limits.cpu": "1000m",
            "prometheus.resources.core.limits.memory": "1500Mi",
            "prometheus.resources.core.requests.cpu": "750m",
            "prometheus.resources.core.requests.memory": "750Mi",
            "prometheus.retention": "12h",
        },
        version="0.1.0",
    ))
# Create a new rancher2 Cluster Sync for foo-custom cluster
foo_custom_cluster_sync = rancher2.ClusterSync("foo-customClusterSync",
    cluster_id=foo_custom_cluster.id,
    wait_monitoring=foo_custom_cluster.enable_cluster_monitoring)
# Create a new rancher2 Namespace
foo_istio = rancher2.Namespace("foo-istio",
    project_id=foo_custom_cluster_sync.system_project_id,
    description="istio namespace")
# Create a new rancher2 App deploying istio (should wait until monitoring is up and running)
istio = rancher2.App("istio",
    catalog_name="system-library",
    description="Terraform app acceptance test",
    project_id=foo_istio.project_id,
    template_name="rancher-istio",
    template_version="0.1.1",
    target_namespace=foo_istio.id,
    answers={
        "certmanager.enabled": False,
        "enableCRDs": True,
        "galley.enabled": True,
        "gateways.enabled": False,
        "gateways.istio-ingressgateway.resources.limits.cpu": "2000m",
        "gateways.istio-ingressgateway.resources.limits.memory": "1024Mi",
        "gateways.istio-ingressgateway.resources.requests.cpu": "100m",
        "gateways.istio-ingressgateway.resources.requests.memory": "128Mi",
        "gateways.istio-ingressgateway.type": "NodePort",
        "global.monitoring.type": "cluster-monitoring",
        "global.rancher.clusterId": foo_custom_cluster_sync.cluster_id,
        "istio_cni.enabled": "false",
        "istiocoredns.enabled": "false",
        "kiali.enabled": "true",
        "mixer.enabled": "true",
        "mixer.policy.enabled": "true",
        "mixer.policy.resources.limits.cpu": "4800m",
        "mixer.policy.resources.limits.memory": "4096Mi",
        "mixer.policy.resources.requests.cpu": "1000m",
        "mixer.policy.resources.requests.memory": "1024Mi",
        "mixer.telemetry.resources.limits.cpu": "4800m",
        "mixer.telemetry.resources.limits.memory": "4096Mi",
        "mixer.telemetry.resources.requests.cpu": "1000m",
        "mixer.telemetry.resources.requests.memory": "1024Mi",
        "mtls.enabled": False,
        "nodeagent.enabled": False,
        "pilot.enabled": True,
        "pilot.resources.limits.cpu": "1000m",
        "pilot.resources.limits.memory": "4096Mi",
        "pilot.resources.requests.cpu": "500m",
        "pilot.resources.requests.memory": "2048Mi",
        "pilot.traceSampling": "1",
        "security.enabled": True,
        "sidecarInjectorWebhook.enabled": True,
        "tracing.enabled": True,
        "tracing.jaeger.resources.limits.cpu": "500m",
        "tracing.jaeger.resources.limits.memory": "1024Mi",
        "tracing.jaeger.resources.requests.cpu": "100m",
        "tracing.jaeger.resources.requests.memory": "100Mi",
    })
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 RKE Cluster
const foo_customCluster = new rancher2.Cluster("foo-customCluster", {
    description: "Foo rancher2 custom cluster",
    rkeConfig: {
        network: {
            plugin: "canal",
        },
    },
    enableClusterMonitoring: true,
    clusterMonitoringInput: {
        answers: {
            "exporter-kubelets.https": true,
            "exporter-node.enabled": true,
            "exporter-node.ports.metrics.port": 9796,
            "exporter-node.resources.limits.cpu": "200m",
            "exporter-node.resources.limits.memory": "200Mi",
            "grafana.persistence.enabled": false,
            "grafana.persistence.size": "10Gi",
            "grafana.persistence.storageClass": "default",
            "operator.resources.limits.memory": "500Mi",
            "prometheus.persistence.enabled": "false",
            "prometheus.persistence.size": "50Gi",
            "prometheus.persistence.storageClass": "default",
            "prometheus.persistent.useReleaseName": "true",
            "prometheus.resources.core.limits.cpu": "1000m",
            "prometheus.resources.core.limits.memory": "1500Mi",
            "prometheus.resources.core.requests.cpu": "750m",
            "prometheus.resources.core.requests.memory": "750Mi",
            "prometheus.retention": "12h",
        },
        version: "0.1.0",
    },
});
// Create a new rancher2 Cluster Sync for foo-custom cluster
const foo_customClusterSync = new rancher2.ClusterSync("foo-customClusterSync", {
    clusterId: foo_customCluster.id,
    waitMonitoring: foo_customCluster.enableClusterMonitoring,
});
// Create a new rancher2 Namespace
const foo_istio = new rancher2.Namespace("foo-istio", {
    projectId: foo_customClusterSync.systemProjectId,
    description: "istio namespace",
});
// Create a new rancher2 App deploying istio (should wait until monitoring is up and running)
const istio = new rancher2.App("istio", {
    catalogName: "system-library",
    description: "Terraform app acceptance test",
    projectId: foo_istio.projectId,
    templateName: "rancher-istio",
    templateVersion: "0.1.1",
    targetNamespace: foo_istio.id,
    answers: {
        "certmanager.enabled": false,
        enableCRDs: true,
        "galley.enabled": true,
        "gateways.enabled": false,
        "gateways.istio-ingressgateway.resources.limits.cpu": "2000m",
        "gateways.istio-ingressgateway.resources.limits.memory": "1024Mi",
        "gateways.istio-ingressgateway.resources.requests.cpu": "100m",
        "gateways.istio-ingressgateway.resources.requests.memory": "128Mi",
        "gateways.istio-ingressgateway.type": "NodePort",
        "global.monitoring.type": "cluster-monitoring",
        "global.rancher.clusterId": foo_customClusterSync.clusterId,
        "istio_cni.enabled": "false",
        "istiocoredns.enabled": "false",
        "kiali.enabled": "true",
        "mixer.enabled": "true",
        "mixer.policy.enabled": "true",
        "mixer.policy.resources.limits.cpu": "4800m",
        "mixer.policy.resources.limits.memory": "4096Mi",
        "mixer.policy.resources.requests.cpu": "1000m",
        "mixer.policy.resources.requests.memory": "1024Mi",
        "mixer.telemetry.resources.limits.cpu": "4800m",
        "mixer.telemetry.resources.limits.memory": "4096Mi",
        "mixer.telemetry.resources.requests.cpu": "1000m",
        "mixer.telemetry.resources.requests.memory": "1024Mi",
        "mtls.enabled": false,
        "nodeagent.enabled": false,
        "pilot.enabled": true,
        "pilot.resources.limits.cpu": "1000m",
        "pilot.resources.limits.memory": "4096Mi",
        "pilot.resources.requests.cpu": "500m",
        "pilot.resources.requests.memory": "2048Mi",
        "pilot.traceSampling": "1",
        "security.enabled": true,
        "sidecarInjectorWebhook.enabled": true,
        "tracing.enabled": true,
        "tracing.jaeger.resources.limits.cpu": "500m",
        "tracing.jaeger.resources.limits.memory": "1024Mi",
        "tracing.jaeger.resources.requests.cpu": "100m",
        "tracing.jaeger.resources.requests.memory": "100Mi",
    },
});

Creating Rancher v2 RKE cluster assigning a node pool (overlapped planes)

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new rancher2 RKE Cluster
        var foo_custom = new Rancher2.Cluster("foo-custom", new Rancher2.ClusterArgs
        {
            Description = "Foo rancher2 custom cluster",
            RkeConfig = new Rancher2.Inputs.ClusterRkeConfigArgs
            {
                Network = new Rancher2.Inputs.ClusterRkeConfigNetworkArgs
                {
                    Plugin = "canal",
                },
            },
        });
        // Create a new rancher2 Node Template
        var fooNodeTemplate = new Rancher2.NodeTemplate("fooNodeTemplate", new Rancher2.NodeTemplateArgs
        {
            Description = "foo test",
            Amazonec2Config = new Rancher2.Inputs.NodeTemplateAmazonec2ConfigArgs
            {
                AccessKey = "<AWS_ACCESS_KEY>",
                SecretKey = "<AWS_SECRET_KEY>",
                Ami = "<AMI_ID>",
                Region = "<REGION>",
                SecurityGroups = 
                {
                    "<AWS_SECURITY_GROUP>",
                },
                SubnetId = "<SUBNET_ID>",
                VpcId = "<VPC_ID>",
                Zone = "<ZONE>",
            },
        });
        // Create a new rancher2 Node Pool
        var fooNodePool = new Rancher2.NodePool("fooNodePool", new Rancher2.NodePoolArgs
        {
            ClusterId = foo_custom.Id,
            HostnamePrefix = "foo-cluster-0",
            NodeTemplateId = fooNodeTemplate.Id,
            Quantity = 3,
            ControlPlane = true,
            Etcd = true,
            Worker = true,
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rancher2.NewCluster(ctx, "foo_custom", &rancher2.ClusterArgs{
            Description: pulumi.String("Foo rancher2 custom cluster"),
            RkeConfig: &rancher2.ClusterRkeConfigArgs{
                Network: &rancher2.ClusterRkeConfigNetworkArgs{
                    Plugin: pulumi.String("canal"),
                },
            },
        })
        if err != nil {
            return err
        }
        fooNodeTemplate, err := rancher2.NewNodeTemplate(ctx, "fooNodeTemplate", &rancher2.NodeTemplateArgs{
            Description: pulumi.String("foo test"),
            Amazonec2Config: &rancher2.NodeTemplateAmazonec2ConfigArgs{
                AccessKey: pulumi.String("<AWS_ACCESS_KEY>"),
                SecretKey: pulumi.String("<AWS_SECRET_KEY>"),
                Ami:       pulumi.String("<AMI_ID>"),
                Region:    pulumi.String("<REGION>"),
                SecurityGroups: pulumi.StringArray{
                    pulumi.String("<AWS_SECURITY_GROUP>"),
                },
                SubnetId: pulumi.String("<SUBNET_ID>"),
                VpcId:    pulumi.String("<VPC_ID>"),
                Zone:     pulumi.String("<ZONE>"),
            },
        })
        if err != nil {
            return err
        }
        _, err = rancher2.NewNodePool(ctx, "fooNodePool", &rancher2.NodePoolArgs{
            ClusterId:      foo_custom.ID(),
            HostnamePrefix: pulumi.String("foo-cluster-0"),
            NodeTemplateId: fooNodeTemplate.ID(),
            Quantity:       pulumi.Int(3),
            ControlPlane:   pulumi.Bool(true),
            Etcd:           pulumi.Bool(true),
            Worker:         pulumi.Bool(true),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 RKE Cluster
foo_custom = rancher2.Cluster("foo-custom",
    description="Foo rancher2 custom cluster",
    rke_config=rancher2.ClusterRkeConfigArgs(
        network=rancher2.ClusterRkeConfigNetworkArgs(
            plugin="canal",
        ),
    ))
# Create a new rancher2 Node Template
foo_node_template = rancher2.NodeTemplate("fooNodeTemplate",
    description="foo test",
    amazonec2_config=rancher2.NodeTemplateAmazonec2ConfigArgs(
        access_key="<AWS_ACCESS_KEY>",
        secret_key="<AWS_SECRET_KEY>",
        ami="<AMI_ID>",
        region="<REGION>",
        security_groups=["<AWS_SECURITY_GROUP>"],
        subnet_id="<SUBNET_ID>",
        vpc_id="<VPC_ID>",
        zone="<ZONE>",
    ))
# Create a new rancher2 Node Pool
foo_node_pool = rancher2.NodePool("fooNodePool",
    cluster_id=foo_custom.id,
    hostname_prefix="foo-cluster-0",
    node_template_id=foo_node_template.id,
    quantity=3,
    control_plane=True,
    etcd=True,
    worker=True)
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 RKE Cluster
const foo_custom = new rancher2.Cluster("foo-custom", {
    description: "Foo rancher2 custom cluster",
    rkeConfig: {
        network: {
            plugin: "canal",
        },
    },
});
// Create a new rancher2 Node Template
const fooNodeTemplate = new rancher2.NodeTemplate("fooNodeTemplate", {
    description: "foo test",
    amazonec2Config: {
        accessKey: "<AWS_ACCESS_KEY>",
        secretKey: "<AWS_SECRET_KEY>",
        ami: "<AMI_ID>",
        region: "<REGION>",
        securityGroups: ["<AWS_SECURITY_GROUP>"],
        subnetId: "<SUBNET_ID>",
        vpcId: "<VPC_ID>",
        zone: "<ZONE>",
    },
});
// Create a new rancher2 Node Pool
const fooNodePool = new rancher2.NodePool("fooNodePool", {
    clusterId: foo_custom.id,
    hostnamePrefix: "foo-cluster-0",
    nodeTemplateId: fooNodeTemplate.id,
    quantity: 3,
    controlPlane: true,
    etcd: true,
    worker: true,
});

Creating Rancher v2 RKE cluster from template. For Rancher v2.3.x or above.

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new rancher2 cluster template
        var fooClusterTemplate = new Rancher2.ClusterTemplate("fooClusterTemplate", new Rancher2.ClusterTemplateArgs
        {
            Members = 
            {
                new Rancher2.Inputs.ClusterTemplateMemberArgs
                {
                    AccessType = "owner",
                    UserPrincipalId = "local://user-XXXXX",
                },
            },
            TemplateRevisions = 
            {
                new Rancher2.Inputs.ClusterTemplateTemplateRevisionArgs
                {
                    Name = "V1",
                    ClusterConfig = new Rancher2.Inputs.ClusterTemplateTemplateRevisionClusterConfigArgs
                    {
                        RkeConfig = new Rancher2.Inputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigArgs
                        {
                            Network = new Rancher2.Inputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkArgs
                            {
                                Plugin = "canal",
                            },
                            Services = new Rancher2.Inputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesArgs
                            {
                                Etcd = new Rancher2.Inputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdArgs
                                {
                                    Creation = "6h",
                                    Retention = "24h",
                                },
                            },
                        },
                    },
                    Default = true,
                },
            },
            Description = "Test cluster template v2",
        });
        // Create a new rancher2 RKE Cluster from template
        var fooCluster = new Rancher2.Cluster("fooCluster", new Rancher2.ClusterArgs
        {
            ClusterTemplateId = fooClusterTemplate.Id,
            ClusterTemplateRevisionId = fooClusterTemplate.TemplateRevisions.Apply(templateRevisions => templateRevisions[0].Id),
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        fooClusterTemplate, err := rancher2.NewClusterTemplate(ctx, "fooClusterTemplate", &rancher2.ClusterTemplateArgs{
            Members: rancher2.ClusterTemplateMemberArray{
                &rancher2.ClusterTemplateMemberArgs{
                    AccessType:      pulumi.String("owner"),
                    UserPrincipalId: pulumi.String("local://user-XXXXX"),
                },
            },
            TemplateRevisions: rancher2.ClusterTemplateTemplateRevisionArray{
                &rancher2.ClusterTemplateTemplateRevisionArgs{
                    Name: pulumi.String("V1"),
                    ClusterConfig: &rancher2.ClusterTemplateTemplateRevisionClusterConfigArgs{
                        RkeConfig: &rancher2.ClusterTemplateTemplateRevisionClusterConfigRkeConfigArgs{
                            Network: &rancher2.ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkArgs{
                                Plugin: pulumi.String("canal"),
                            },
                            Services: &rancher2.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesArgs{
                                Etcd: &rancher2.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdArgs{
                                    Creation:  pulumi.String("6h"),
                                    Retention: pulumi.String("24h"),
                                },
                            },
                        },
                    },
                    Default: pulumi.Bool(true),
                },
            },
            Description: pulumi.String("Test cluster template v2"),
        })
        if err != nil {
            return err
        }
        _, err = rancher2.NewCluster(ctx, "fooCluster", &rancher2.ClusterArgs{
            ClusterTemplateId: fooClusterTemplate.ID(),
            ClusterTemplateRevisionId: fooClusterTemplate.TemplateRevisions.ApplyT(func(templateRevisions []rancher2.ClusterTemplateTemplateRevision) (string, error) {
                return templateRevisions[0].Id, nil
            }).(pulumi.StringOutput),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 cluster template
foo_cluster_template = rancher2.ClusterTemplate("fooClusterTemplate",
    members=[rancher2.ClusterTemplateMemberArgs(
        access_type="owner",
        user_principal_id="local://user-XXXXX",
    )],
    template_revisions=[rancher2.ClusterTemplateTemplateRevisionArgs(
        name="V1",
        cluster_config=rancher2.ClusterTemplateTemplateRevisionClusterConfigArgs(
            rke_config={
                "network": {
                    "plugin": "canal",
                },
                "services": {
                    "etcd": {
                        "creation": "6h",
                        "retention": "24h",
                    },
                },
            },
        ),
        default=True,
    )],
    description="Test cluster template v2")
# Create a new rancher2 RKE Cluster from template
foo_cluster = rancher2.Cluster("fooCluster",
    cluster_template_id=foo_cluster_template.id,
    cluster_template_revision_id=foo_cluster_template.template_revisions[0].id)
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 cluster template
const fooClusterTemplate = new rancher2.ClusterTemplate("fooClusterTemplate", {
    members: [{
        accessType: "owner",
        userPrincipalId: "local://user-XXXXX",
    }],
    templateRevisions: [{
        name: "V1",
        clusterConfig: {
            rkeConfig: {
                network: {
                    plugin: "canal",
                },
                services: {
                    etcd: {
                        creation: "6h",
                        retention: "24h",
                    },
                },
            },
        },
        "default": true,
    }],
    description: "Test cluster template v2",
});
// Create a new rancher2 RKE Cluster from template
const fooCluster = new rancher2.Cluster("fooCluster", {
    clusterTemplateId: fooClusterTemplate.id,
    clusterTemplateRevisionId: fooClusterTemplate.templateRevisions.apply(templateRevisions => templateRevisions[0].id),
});

Creating Rancher v2 RKE cluster with upgrade strategy. For Rancher v2.4.x or above.

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = new Rancher2.Cluster("foo", new Rancher2.ClusterArgs
        {
            Description = "Terraform custom cluster",
            RkeConfig = new Rancher2.Inputs.ClusterRkeConfigArgs
            {
                Network = new Rancher2.Inputs.ClusterRkeConfigNetworkArgs
                {
                    Plugin = "canal",
                },
                Services = new Rancher2.Inputs.ClusterRkeConfigServicesArgs
                {
                    Etcd = new Rancher2.Inputs.ClusterRkeConfigServicesEtcdArgs
                    {
                        Creation = "6h",
                        Retention = "24h",
                    },
                    KubeApi = new Rancher2.Inputs.ClusterRkeConfigServicesKubeApiArgs
                    {
                        AuditLog = new Rancher2.Inputs.ClusterRkeConfigServicesKubeApiAuditLogArgs
                        {
                            Configuration = new Rancher2.Inputs.ClusterRkeConfigServicesKubeApiAuditLogConfigurationArgs
                            {
                                Format = "json",
                                MaxAge = 5,
                                MaxBackup = 5,
                                MaxSize = 100,
                                Path = "-",
                                Policy = @"apiVersion: audit.k8s.io/v1
kind: Policy
metadata:
  creationTimestamp: null
omitStages:
- RequestReceived
rules:
- level: RequestResponse
  resources:
  - resources:
    - pods

",
                            },
                            Enabled = true,
                        },
                    },
                },
                UpgradeStrategy = new Rancher2.Inputs.ClusterRkeConfigUpgradeStrategyArgs
                {
                    Drain = true,
                    MaxUnavailableWorker = "20%",
                },
            },
        });
    }

}

package main

import (
    "fmt"

    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rancher2.NewCluster(ctx, "foo", &rancher2.ClusterArgs{
            Description: pulumi.String("Terraform custom cluster"),
            RkeConfig: &rancher2.ClusterRkeConfigArgs{
                Network: &rancher2.ClusterRkeConfigNetworkArgs{
                    Plugin: pulumi.String("canal"),
                },
                Services: &rancher2.ClusterRkeConfigServicesArgs{
                    Etcd: &rancher2.ClusterRkeConfigServicesEtcdArgs{
                        Creation:  pulumi.String("6h"),
                        Retention: pulumi.String("24h"),
                    },
                    KubeApi: &rancher2.ClusterRkeConfigServicesKubeApiArgs{
                        AuditLog: &rancher2.ClusterRkeConfigServicesKubeApiAuditLogArgs{
                            Configuration: &rancher2.ClusterRkeConfigServicesKubeApiAuditLogConfigurationArgs{
                                Format:    pulumi.String("json"),
                                MaxAge:    pulumi.Int(5),
                                MaxBackup: pulumi.Int(5),
                                MaxSize:   pulumi.Int(100),
                                Path:      pulumi.String("-"),
                                Policy:    pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v", "apiVersion: audit.k8s.io/v1\n", "kind: Policy\n", "metadata:\n", "  creationTimestamp: null\n", "omitStages:\n", "- RequestReceived\n", "rules:\n", "- level: RequestResponse\n", "  resources:\n", "  - resources:\n", "    - pods\n", "\n")),
                            },
                            Enabled: pulumi.Bool(true),
                        },
                    },
                },
                UpgradeStrategy: &rancher2.ClusterRkeConfigUpgradeStrategyArgs{
                    Drain:                pulumi.Bool(true),
                    MaxUnavailableWorker: pulumi.String(fmt.Sprintf("%v%v", "20", "%")),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

foo = rancher2.Cluster("foo",
    description="Terraform custom cluster",
    rke_config=rancher2.ClusterRkeConfigArgs(
        network=rancher2.ClusterRkeConfigNetworkArgs(
            plugin="canal",
        ),
        services=rancher2.ClusterRkeConfigServicesArgs(
            etcd=rancher2.ClusterRkeConfigServicesEtcdArgs(
                creation="6h",
                retention="24h",
            ),
            kube_api=rancher2.ClusterRkeConfigServicesKubeApiArgs(
                audit_log=rancher2.ClusterRkeConfigServicesKubeApiAuditLogArgs(
                    configuration=rancher2.ClusterRkeConfigServicesKubeApiAuditLogConfigurationArgs(
                        format="json",
                        max_age=5,
                        max_backup=5,
                        max_size=100,
                        path="-",
                        policy="""apiVersion: audit.k8s.io/v1
kind: Policy
metadata:
  creationTimestamp: null
omitStages:
- RequestReceived
rules:
- level: RequestResponse
  resources:
  - resources:
    - pods

""",
                    ),
                    enabled=True,
                ),
            ),
        ),
        upgrade_strategy={
            "drain": True,
            "maxUnavailableWorker": "20%",
        },
    ))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = new rancher2.Cluster("foo", {
    description: "Terraform custom cluster",
    rkeConfig: {
        network: {
            plugin: "canal",
        },
        services: {
            etcd: {
                creation: "6h",
                retention: "24h",
            },
            kubeApi: {
                auditLog: {
                    configuration: {
                        format: "json",
                        maxAge: 5,
                        maxBackup: 5,
                        maxSize: 100,
                        path: "-",
                        policy: `apiVersion: audit.k8s.io/v1
kind: Policy
metadata:
  creationTimestamp: null
omitStages:
- RequestReceived
rules:
- level: RequestResponse
  resources:
  - resources:
    - pods
`,
                    },
                    enabled: true,
                },
            },
        },
        upgradeStrategy: {
            drain: true,
            maxUnavailableWorker: "20%",
        },
    },
});

Creating Rancher v2 RKE cluster with scheduled cluster scan. For Rancher v2.4.x or above.

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = new Rancher2.Cluster("foo", new Rancher2.ClusterArgs
        {
            Description = "Terraform custom cluster",
            RkeConfig = new Rancher2.Inputs.ClusterRkeConfigArgs
            {
                Network = new Rancher2.Inputs.ClusterRkeConfigNetworkArgs
                {
                    Plugin = "canal",
                },
                Services = new Rancher2.Inputs.ClusterRkeConfigServicesArgs
                {
                    Etcd = new Rancher2.Inputs.ClusterRkeConfigServicesEtcdArgs
                    {
                        Creation = "6h",
                        Retention = "24h",
                    },
                },
            },
            ScheduledClusterScan = new Rancher2.Inputs.ClusterScheduledClusterScanArgs
            {
                Enabled = true,
                ScanConfig = new Rancher2.Inputs.ClusterScheduledClusterScanScanConfigArgs
                {
                    CisScanConfig = new Rancher2.Inputs.ClusterScheduledClusterScanScanConfigCisScanConfigArgs
                    {
                        DebugMaster = true,
                        DebugWorker = true,
                    },
                },
                ScheduleConfig = new Rancher2.Inputs.ClusterScheduledClusterScanScheduleConfigArgs
                {
                    CronSchedule = "30 * * * *",
                    Retention = 5,
                },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rancher2.NewCluster(ctx, "foo", &rancher2.ClusterArgs{
            Description: pulumi.String("Terraform custom cluster"),
            RkeConfig: &rancher2.ClusterRkeConfigArgs{
                Network: &rancher2.ClusterRkeConfigNetworkArgs{
                    Plugin: pulumi.String("canal"),
                },
                Services: &rancher2.ClusterRkeConfigServicesArgs{
                    Etcd: &rancher2.ClusterRkeConfigServicesEtcdArgs{
                        Creation:  pulumi.String("6h"),
                        Retention: pulumi.String("24h"),
                    },
                },
            },
            ScheduledClusterScan: &rancher2.ClusterScheduledClusterScanArgs{
                Enabled: pulumi.Bool(true),
                ScanConfig: &rancher2.ClusterScheduledClusterScanScanConfigArgs{
                    CisScanConfig: &rancher2.ClusterScheduledClusterScanScanConfigCisScanConfigArgs{
                        DebugMaster: pulumi.Bool(true),
                        DebugWorker: pulumi.Bool(true),
                    },
                },
                ScheduleConfig: &rancher2.ClusterScheduledClusterScanScheduleConfigArgs{
                    CronSchedule: pulumi.String("30 * * * *"),
                    Retention:    pulumi.Int(5),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

foo = rancher2.Cluster("foo",
    description="Terraform custom cluster",
    rke_config=rancher2.ClusterRkeConfigArgs(
        network=rancher2.ClusterRkeConfigNetworkArgs(
            plugin="canal",
        ),
        services=rancher2.ClusterRkeConfigServicesArgs(
            etcd=rancher2.ClusterRkeConfigServicesEtcdArgs(
                creation="6h",
                retention="24h",
            ),
        ),
    ),
    scheduled_cluster_scan=rancher2.ClusterScheduledClusterScanArgs(
        enabled=True,
        scan_config=rancher2.ClusterScheduledClusterScanScanConfigArgs(
            cis_scan_config=rancher2.ClusterScheduledClusterScanScanConfigCisScanConfigArgs(
                debug_master=True,
                debug_worker=True,
            ),
        ),
        schedule_config=rancher2.ClusterScheduledClusterScanScheduleConfigArgs(
            cron_schedule="30 * * * *",
            retention=5,
        ),
    ))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = new rancher2.Cluster("foo", {
    description: "Terraform custom cluster",
    rkeConfig: {
        network: {
            plugin: "canal",
        },
        services: {
            etcd: {
                creation: "6h",
                retention: "24h",
            },
        },
    },
    scheduledClusterScan: {
        enabled: true,
        scanConfig: {
            cisScanConfig: {
                debugMaster: true,
                debugWorker: true,
            },
        },
        scheduleConfig: {
            cronSchedule: "30 * * * *",
            retention: 5,
        },
    },
});

Importing EKS cluster to Rancher v2, using eks_config_v2. For Rancher v2.5.x or above.

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        var fooCloudCredential = new Rancher2.CloudCredential("fooCloudCredential", new Rancher2.CloudCredentialArgs
        {
            Description = "foo test",
            Amazonec2CredentialConfig = new Rancher2.Inputs.CloudCredentialAmazonec2CredentialConfigArgs
            {
                AccessKey = "<AWS_ACCESS_KEY>",
                SecretKey = "<AWS_SECRET_KEY>",
            },
        });
        var fooCluster = new Rancher2.Cluster("fooCluster", new Rancher2.ClusterArgs
        {
            Description = "Terraform EKS cluster",
            EksConfigV2 = new Rancher2.Inputs.ClusterEksConfigV2Args
            {
                CloudCredentialId = fooCloudCredential.Id,
                Name = "<CLUSTER_NAME>",
                Region = "<EKS_REGION>",
                Imported = true,
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        fooCloudCredential, err := rancher2.NewCloudCredential(ctx, "fooCloudCredential", &rancher2.CloudCredentialArgs{
            Description: pulumi.String("foo test"),
            Amazonec2CredentialConfig: &rancher2.CloudCredentialAmazonec2CredentialConfigArgs{
                AccessKey: pulumi.String("<AWS_ACCESS_KEY>"),
                SecretKey: pulumi.String("<AWS_SECRET_KEY>"),
            },
        })
        if err != nil {
            return err
        }
        _, err = rancher2.NewCluster(ctx, "fooCluster", &rancher2.ClusterArgs{
            Description: pulumi.String("Terraform EKS cluster"),
            EksConfigV2: &rancher2.ClusterEksConfigV2Args{
                CloudCredentialId: fooCloudCredential.ID(),
                Name:              pulumi.String("<CLUSTER_NAME>"),
                Region:            pulumi.String("<EKS_REGION>"),
                Imported:          pulumi.Bool(true),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

foo_cloud_credential = rancher2.CloudCredential("fooCloudCredential",
    description="foo test",
    amazonec2_credential_config=rancher2.CloudCredentialAmazonec2CredentialConfigArgs(
        access_key="<AWS_ACCESS_KEY>",
        secret_key="<AWS_SECRET_KEY>",
    ))
foo_cluster = rancher2.Cluster("fooCluster",
    description="Terraform EKS cluster",
    eks_config_v2=rancher2.ClusterEksConfigV2Args(
        cloud_credential_id=foo_cloud_credential.id,
        name="<CLUSTER_NAME>",
        region="<EKS_REGION>",
        imported=True,
    ))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const fooCloudCredential = new rancher2.CloudCredential("fooCloudCredential", {
    description: "foo test",
    amazonec2CredentialConfig: {
        accessKey: "<AWS_ACCESS_KEY>",
        secretKey: "<AWS_SECRET_KEY>",
    },
});
const fooCluster = new rancher2.Cluster("fooCluster", {
    description: "Terraform EKS cluster",
    eksConfigV2: {
        cloudCredentialId: fooCloudCredential.id,
        name: "<CLUSTER_NAME>",
        region: "<EKS_REGION>",
        imported: true,
    },
});

Creating EKS cluster from Rancher v2, using eks_config_v2. For Rancher v2.5.x or above.

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        var fooCloudCredential = new Rancher2.CloudCredential("fooCloudCredential", new Rancher2.CloudCredentialArgs
        {
            Description = "foo test",
            Amazonec2CredentialConfig = new Rancher2.Inputs.CloudCredentialAmazonec2CredentialConfigArgs
            {
                AccessKey = "<AWS_ACCESS_KEY>",
                SecretKey = "<AWS_SECRET_KEY>",
            },
        });
        var fooCluster = new Rancher2.Cluster("fooCluster", new Rancher2.ClusterArgs
        {
            Description = "Terraform EKS cluster",
            EksConfigV2 = new Rancher2.Inputs.ClusterEksConfigV2Args
            {
                CloudCredentialId = fooCloudCredential.Id,
                Region = "<EKS_REGION>",
                KubernetesVersion = "1.17",
                LoggingTypes = 
                {
                    "audit",
                    "api",
                },
                NodeGroups = 
                {
                    new Rancher2.Inputs.ClusterEksConfigV2NodeGroupArgs
                    {
                        Name = "node_group1",
                        InstanceType = "t3.medium",
                        DesiredSize = 3,
                        MaxSize = 5,
                    },
                    new Rancher2.Inputs.ClusterEksConfigV2NodeGroupArgs
                    {
                        Name = "node_group2",
                        InstanceType = "m5.xlarge",
                        DesiredSize = 2,
                        MaxSize = 3,
                    },
                },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        fooCloudCredential, err := rancher2.NewCloudCredential(ctx, "fooCloudCredential", &rancher2.CloudCredentialArgs{
            Description: pulumi.String("foo test"),
            Amazonec2CredentialConfig: &rancher2.CloudCredentialAmazonec2CredentialConfigArgs{
                AccessKey: pulumi.String("<AWS_ACCESS_KEY>"),
                SecretKey: pulumi.String("<AWS_SECRET_KEY>"),
            },
        })
        if err != nil {
            return err
        }
        _, err = rancher2.NewCluster(ctx, "fooCluster", &rancher2.ClusterArgs{
            Description: pulumi.String("Terraform EKS cluster"),
            EksConfigV2: &rancher2.ClusterEksConfigV2Args{
                CloudCredentialId: fooCloudCredential.ID(),
                Region:            pulumi.String("<EKS_REGION>"),
                KubernetesVersion: pulumi.String("1.17"),
                LoggingTypes: pulumi.StringArray{
                    pulumi.String("audit"),
                    pulumi.String("api"),
                },
                NodeGroups: rancher2.ClusterEksConfigV2NodeGroupArray{
                    &rancher2.ClusterEksConfigV2NodeGroupArgs{
                        Name:         pulumi.String("node_group1"),
                        InstanceType: pulumi.String("t3.medium"),
                        DesiredSize:  pulumi.Int(3),
                        MaxSize:      pulumi.Int(5),
                    },
                    &rancher2.ClusterEksConfigV2NodeGroupArgs{
                        Name:         pulumi.String("node_group2"),
                        InstanceType: pulumi.String("m5.xlarge"),
                        DesiredSize:  pulumi.Int(2),
                        MaxSize:      pulumi.Int(3),
                    },
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

foo_cloud_credential = rancher2.CloudCredential("fooCloudCredential",
    description="foo test",
    amazonec2_credential_config=rancher2.CloudCredentialAmazonec2CredentialConfigArgs(
        access_key="<AWS_ACCESS_KEY>",
        secret_key="<AWS_SECRET_KEY>",
    ))
foo_cluster = rancher2.Cluster("fooCluster",
    description="Terraform EKS cluster",
    eks_config_v2=rancher2.ClusterEksConfigV2Args(
        cloud_credential_id=foo_cloud_credential.id,
        region="<EKS_REGION>",
        kubernetes_version="1.17",
        logging_types=[
            "audit",
            "api",
        ],
        node_groups=[
            rancher2.ClusterEksConfigV2NodeGroupArgs(
                name="node_group1",
                instance_type="t3.medium",
                desired_size=3,
                max_size=5,
            ),
            rancher2.ClusterEksConfigV2NodeGroupArgs(
                name="node_group2",
                instance_type="m5.xlarge",
                desired_size=2,
                max_size=3,
            ),
        ],
    ))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const fooCloudCredential = new rancher2.CloudCredential("fooCloudCredential", {
    description: "foo test",
    amazonec2CredentialConfig: {
        accessKey: "<AWS_ACCESS_KEY>",
        secretKey: "<AWS_SECRET_KEY>",
    },
});
const fooCluster = new rancher2.Cluster("fooCluster", {
    description: "Terraform EKS cluster",
    eksConfigV2: {
        cloudCredentialId: fooCloudCredential.id,
        region: "<EKS_REGION>",
        kubernetesVersion: "1.17",
        loggingTypes: [
            "audit",
            "api",
        ],
        nodeGroups: [
            {
                name: "node_group1",
                instanceType: "t3.medium",
                desiredSize: 3,
                maxSize: 5,
            },
            {
                name: "node_group2",
                instanceType: "m5.xlarge",
                desiredSize: 2,
                maxSize: 3,
            },
        ],
    },
});

Create a Cluster Resource

new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);
def Cluster(resource_name: str, opts: Optional[ResourceOptions] = None, aks_config: Optional[ClusterAksConfigArgs] = None, annotations: Optional[Mapping[str, Any]] = None, cluster_auth_endpoint: Optional[ClusterClusterAuthEndpointArgs] = None, cluster_monitoring_input: Optional[ClusterClusterMonitoringInputArgs] = None, cluster_template_answers: Optional[ClusterClusterTemplateAnswersArgs] = None, cluster_template_id: Optional[str] = None, cluster_template_questions: Optional[Sequence[ClusterClusterTemplateQuestionArgs]] = None, cluster_template_revision_id: Optional[str] = None, default_pod_security_policy_template_id: Optional[str] = None, description: Optional[str] = None, desired_agent_image: Optional[str] = None, desired_auth_image: Optional[str] = None, docker_root_dir: Optional[str] = None, driver: Optional[str] = None, eks_config: Optional[ClusterEksConfigArgs] = None, eks_config_v2: Optional[ClusterEksConfigV2Args] = None, enable_cluster_alerting: Optional[bool] = None, enable_cluster_monitoring: Optional[bool] = None, enable_network_policy: Optional[bool] = None, gke_config: Optional[ClusterGkeConfigArgs] = None, k3s_config: Optional[ClusterK3sConfigArgs] = None, labels: Optional[Mapping[str, Any]] = None, name: Optional[str] = None, oke_config: Optional[ClusterOkeConfigArgs] = None, rke_config: Optional[ClusterRkeConfigArgs] = None, scheduled_cluster_scan: Optional[ClusterScheduledClusterScanArgs] = None, windows_prefered_cluster: Optional[bool] = 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, eks_config_v2, gke_config, oke_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, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

EksConfigV2 ClusterEksConfigV2Args

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

EnableClusterAlerting bool

Enable built-in cluster alerting (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, eks_import, oke_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, oke_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)

OkeConfig ClusterOkeConfigArgs

The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, eks_config, eks_import, gke_config k3s_config and rke_config (list maxitems:1)

RkeConfig ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config, oke_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, eks_config_v2, gke_config, oke_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, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

EksConfigV2 ClusterEksConfigV2

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

EnableClusterAlerting bool

Enable built-in cluster alerting (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, eks_import, oke_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, oke_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)

OkeConfig ClusterOkeConfig

The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, eks_config, eks_import, gke_config k3s_config and rke_config (list maxitems:1)

RkeConfig ClusterRkeConfig

The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config, oke_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, eks_config_v2, gke_config, oke_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, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

eksConfigV2 ClusterEksConfigV2

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

enableClusterAlerting boolean

Enable built-in cluster alerting (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, eks_import, oke_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, oke_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)

okeConfig ClusterOkeConfig

The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, eks_config, eks_import, gke_config k3s_config and rke_config (list maxitems:1)

rkeConfig ClusterRkeConfig

The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config, oke_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 ClusterAksConfigArgs

The Azure AKS configuration for aks Clusters. Conflicts with eks_config, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

annotations Mapping[str, Any]

Annotations for cluster registration token object (map)

cluster_auth_endpoint ClusterClusterAuthEndpointArgs

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

cluster_monitoring_input ClusterClusterMonitoringInputArgs

Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)

cluster_template_answers ClusterClusterTemplateAnswersArgs

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 Sequence[ClusterClusterTemplateQuestionArgs]

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 ClusterEksConfigArgs

The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

eks_config_v2 ClusterEksConfigV2Args

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

enable_cluster_alerting bool

Enable built-in cluster alerting (bool)

enable_cluster_monitoring bool

Enable built-in cluster monitoring (bool)

enable_network_policy bool

Enable project network isolation (bool)

gke_config ClusterGkeConfigArgs

The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config, eks_import, oke_config k3s_config and rke_config (list maxitems:1)

k3s_config ClusterK3sConfigArgs

The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config, oke_config and rke_config (list maxitems:1)

labels Mapping[str, Any]

Labels for cluster registration token object (map)

name str

Name of cluster registration token (string)

oke_config ClusterOkeConfigArgs

The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, eks_config, eks_import, gke_config k3s_config and rke_config (list maxitems:1)

rke_config ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config, oke_config and k3s_config (list maxitems:1)

scheduled_cluster_scan ClusterScheduledClusterScanArgs

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:

CaCert string

TLS CA certificate for etcd service (string)

ClusterRegistrationToken ClusterClusterRegistrationToken

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

DefaultProjectId string

(Computed) Default project ID for the cluster (string)

EnableClusterIstio bool

Deploy istio on system project and istio-system namespace, using rancher2.App resource instead. See above example.

Deprecated: Deploy istio using rancher2_app resource instead

Id string
The provider-assigned unique ID for this managed resource.
IstioEnabled bool

(Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)

KubeConfig string

(Computed/Sensitive) Kube Config generated for the cluster (string)

SystemProjectId string

(Computed) System project ID for the cluster (string)

CaCert string

TLS CA certificate for etcd service (string)

ClusterRegistrationToken ClusterClusterRegistrationToken

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

DefaultProjectId string

(Computed) Default project ID for the cluster (string)

EnableClusterIstio bool

Deploy istio on system project and istio-system namespace, using rancher2.App resource instead. See above example.

Deprecated: Deploy istio using rancher2_app resource instead

Id string
The provider-assigned unique ID for this managed resource.
IstioEnabled bool

(Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)

KubeConfig string

(Computed/Sensitive) Kube Config generated for the cluster (string)

SystemProjectId string

(Computed) System project ID for the cluster (string)

caCert string

TLS CA certificate for etcd service (string)

clusterRegistrationToken ClusterClusterRegistrationToken

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

defaultProjectId string

(Computed) Default project ID for the cluster (string)

enableClusterIstio boolean

Deploy istio on system project and istio-system namespace, using rancher2.App resource instead. See above example.

Deprecated: Deploy istio using rancher2_app resource instead

id string
The provider-assigned unique ID for this managed resource.
istioEnabled boolean

(Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)

kubeConfig string

(Computed/Sensitive) Kube Config generated for the cluster (string)

systemProjectId string

(Computed) System project ID for the cluster (string)

ca_cert str

TLS CA certificate for etcd service (string)

cluster_registration_token ClusterClusterRegistrationToken

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

default_project_id str

(Computed) Default project ID for the cluster (string)

enable_cluster_istio bool

Deploy istio on system project and istio-system namespace, using rancher2.App resource instead. See above example.

Deprecated: Deploy istio using rancher2_app resource instead

id str
The provider-assigned unique ID for this managed resource.
istio_enabled bool

(Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)

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
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, aks_config: Optional[ClusterAksConfigArgs] = None, annotations: Optional[Mapping[str, Any]] = None, ca_cert: Optional[str] = None, cluster_auth_endpoint: Optional[ClusterClusterAuthEndpointArgs] = None, cluster_monitoring_input: Optional[ClusterClusterMonitoringInputArgs] = None, cluster_registration_token: Optional[ClusterClusterRegistrationTokenArgs] = None, cluster_template_answers: Optional[ClusterClusterTemplateAnswersArgs] = None, cluster_template_id: Optional[str] = None, cluster_template_questions: Optional[Sequence[ClusterClusterTemplateQuestionArgs]] = None, cluster_template_revision_id: Optional[str] = None, default_pod_security_policy_template_id: Optional[str] = None, default_project_id: Optional[str] = None, description: Optional[str] = None, desired_agent_image: Optional[str] = None, desired_auth_image: Optional[str] = None, docker_root_dir: Optional[str] = None, driver: Optional[str] = None, eks_config: Optional[ClusterEksConfigArgs] = None, eks_config_v2: Optional[ClusterEksConfigV2Args] = None, enable_cluster_alerting: Optional[bool] = None, enable_cluster_istio: Optional[bool] = None, enable_cluster_monitoring: Optional[bool] = None, enable_network_policy: Optional[bool] = None, gke_config: Optional[ClusterGkeConfigArgs] = None, istio_enabled: Optional[bool] = None, k3s_config: Optional[ClusterK3sConfigArgs] = None, kube_config: Optional[str] = None, labels: Optional[Mapping[str, Any]] = None, name: Optional[str] = None, oke_config: Optional[ClusterOkeConfigArgs] = None, rke_config: Optional[ClusterRkeConfigArgs] = None, scheduled_cluster_scan: Optional[ClusterScheduledClusterScanArgs] = None, system_project_id: Optional[str] = None, windows_prefered_cluster: Optional[bool] = None) -> Cluster
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, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

Annotations Dictionary<string, object>

Annotations for cluster registration token object (map)

CaCert string

TLS CA certificate for etcd service (string)

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, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

EksConfigV2 ClusterEksConfigV2Args

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

EnableClusterAlerting bool

Enable built-in cluster alerting (bool)

EnableClusterIstio bool

Deploy istio on system project and istio-system namespace, using rancher2.App resource instead. See above example.

Deprecated: Deploy istio using rancher2_app resource instead

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, eks_import, oke_config k3s_config and rke_config (list maxitems:1)

IstioEnabled bool

(Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)

K3sConfig ClusterK3sConfigArgs

The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config, oke_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)

OkeConfig ClusterOkeConfigArgs

The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, eks_config, eks_import, gke_config k3s_config and rke_config (list maxitems:1)

RkeConfig ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config, oke_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, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

Annotations map[string]interface{}

Annotations for cluster registration token object (map)

CaCert string

TLS CA certificate for etcd service (string)

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, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

EksConfigV2 ClusterEksConfigV2

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

EnableClusterAlerting bool

Enable built-in cluster alerting (bool)

EnableClusterIstio bool

Deploy istio on system project and istio-system namespace, using rancher2.App resource instead. See above example.

Deprecated: Deploy istio using rancher2_app resource instead

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, eks_import, oke_config k3s_config and rke_config (list maxitems:1)

IstioEnabled bool

(Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)

K3sConfig ClusterK3sConfig

The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config, oke_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)

OkeConfig ClusterOkeConfig

The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, eks_config, eks_import, gke_config k3s_config and rke_config (list maxitems:1)

RkeConfig ClusterRkeConfig

The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config, oke_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, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

annotations {[key: string]: any}

Annotations for cluster registration token object (map)

caCert string

TLS CA certificate for etcd service (string)

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, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

eksConfigV2 ClusterEksConfigV2

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

enableClusterAlerting boolean

Enable built-in cluster alerting (bool)

enableClusterIstio boolean

Deploy istio on system project and istio-system namespace, using rancher2.App resource instead. See above example.

Deprecated: Deploy istio using rancher2_app resource instead

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, eks_import, oke_config k3s_config and rke_config (list maxitems:1)

istioEnabled boolean

(Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)

k3sConfig ClusterK3sConfig

The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config, oke_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)

okeConfig ClusterOkeConfig

The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, eks_config, eks_import, gke_config k3s_config and rke_config (list maxitems:1)

rkeConfig ClusterRkeConfig

The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config, oke_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 ClusterAksConfigArgs

The Azure AKS configuration for aks Clusters. Conflicts with eks_config, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

annotations Mapping[str, Any]

Annotations for cluster registration token object (map)

ca_cert str

TLS CA certificate for etcd service (string)

cluster_auth_endpoint ClusterClusterAuthEndpointArgs

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

cluster_monitoring_input ClusterClusterMonitoringInputArgs

Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)

cluster_registration_token ClusterClusterRegistrationTokenArgs

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

cluster_template_answers ClusterClusterTemplateAnswersArgs

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 Sequence[ClusterClusterTemplateQuestionArgs]

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 ClusterEksConfigArgs

The Amazon EKS configuration for eks Clusters. Conflicts with aks_config, eks_config_v2, gke_config, oke_config k3s_config and rke_config (list maxitems:1)

eks_config_v2 ClusterEksConfigV2Args

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

enable_cluster_alerting bool

Enable built-in cluster alerting (bool)

enable_cluster_istio bool

Deploy istio on system project and istio-system namespace, using rancher2.App resource instead. See above example.

Deprecated: Deploy istio using rancher2_app resource instead

enable_cluster_monitoring bool

Enable built-in cluster monitoring (bool)

enable_network_policy bool

Enable project network isolation (bool)

gke_config ClusterGkeConfigArgs

The Google GKE configuration for gke Clusters. Conflicts with aks_config, eks_config, eks_import, oke_config k3s_config and rke_config (list maxitems:1)

istio_enabled bool

(Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)

k3s_config ClusterK3sConfigArgs

The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config, oke_config and rke_config (list maxitems:1)

kube_config str

(Computed/Sensitive) Kube Config generated for the cluster (string)

labels Mapping[str, Any]

Labels for cluster registration token object (map)

name str

Name of cluster registration token (string)

oke_config ClusterOkeConfigArgs

The Oracle OKE configuration for oke Clusters. Conflicts with aks_config, eks_config, eks_import, gke_config k3s_config and rke_config (list maxitems:1)

rke_config ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config, gke_config, oke_config and k3s_config (list maxitems:1)

scheduled_cluster_scan ClusterScheduledClusterScanArgs

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 version that will be used for your master and OKE worker nodes (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 version that will be used for your master and OKE worker nodes (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 version that will be used for your master and OKE worker nodes (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)

agent_dns_prefix 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)

kubernetes_version str

The Kubernetes version that will be used for your master and OKE worker nodes (string)

master_dns_prefix str

DNS prefix to use the Kubernetes cluster control pane (string)

resource_group str

The name of the Cluster resource group (string)

ssh_public_key_contents 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)

subscription_id str

Subscription credentials which uniquely identify Microsoft Azure subscription (string)

tenant_id str

Azure tenant ID to use (string)

virtual_network str

The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

virtual_network_resource_group str

The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)

aad_server_app_secret str

The secret of an Azure Active Directory server application (string)

aad_tenant_id str

The ID of an Azure Active Directory tenant (string)

add_client_app_id str

The ID of an Azure Active Directory client application of type \“Native\“. This application is for user login via kubectl (string)

add_server_app_id 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)

admin_username str

The administrator username to use for Linux hosts. Default azureuser (string)

agent_os_disk_size 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)

agent_pool_name str

Name for the agent pool, upto 12 alphanumeric characters. Default agentpool0 (string)

agent_storage_profile str

Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default ManagedDisks (string)

agent_vm_size str

Size of machine in the agent pool. Default Standard_D1_v2 (string)

auth_base_url str

Different authentication API url to use. Default https://login.microsoftonline.com/ (string)

base_url str

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)

dns_service_ip 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)

docker_bridge_cidr 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)

enable_http_application_routing bool

Enable the Kubernetes ingress with automatic public DNS name creation. Default false (bool)

enable_monitoring 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)

log_analytics_workspace 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)

log_analytics_workspace_resource_group 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)

max_pods int

Maximum number of pods that can run on a node. Default 110 (int)

network_plugin str

Network plugin used for building Kubernetes network. Chooses from azure or kubenet. Default azure (string)

network_policy str

Network policy used for building Kubernetes network. Chooses from calico (string)

pod_cidr 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)

service_cidr 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 Mapping[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 Mapping[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 Mapping[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)

insecure_command str

Insecure command to execute in a imported k8s cluster (string)

labels Mapping[str, Any]

Labels for cluster registration token object (map)

manifest_url str

K8s manifest url to execute with kubectl to import an existing k8s cluster (string)

name str

Name of cluster registration token (string)

node_command str

Node command to execute in linux nodes for custom k8s cluster (string)

token str

Token for cluster registration token object (string)

windows_node_command 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 Mapping[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 version that will be used for your master and OKE worker nodes (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)

EbsEncryption bool
InstanceType string

The EKS node group instance type. Default: t3.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

The availability domain within the region to host the cluster. See here for a list of region names. (string)

SecurityGroups List<string>

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

ServiceRole string

The AWS service role to use (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 (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 version that will be used for your master and OKE worker nodes (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)

EbsEncryption bool
InstanceType string

The EKS node group instance type. Default: t3.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

The availability domain within the region to host the cluster. See here for a list of region names. (string)

SecurityGroups []string

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

ServiceRole string

The AWS service role to use (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 (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 version that will be used for your master and OKE worker nodes (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)

ebsEncryption boolean
instanceType string

The EKS node group instance type. Default: t3.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

The availability domain within the region to host the cluster. See here for a list of region names. (string)

securityGroups string[]

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

serviceRole string

The AWS service role to use (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 (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)

kubernetes_version str

The Kubernetes version that will be used for your master and OKE worker nodes (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)

associate_worker_node_public_ip bool

Associate public ip EKS worker nodes. Default true (bool)

desired_nodes int

The desired number of worker nodes. Just for Rancher v2.3.x and above. Default 3 (int)

ebs_encryption bool
instance_type str

The EKS node group instance type. Default: t3.medium (string)

key_pair_name str

Allow user to specify key name to use. Just for Rancher v2.2.7 and above (string)

maximum_nodes int

The maximum number of worker nodes. Default 3 (int)

minimum_nodes int

The minimum number of worker nodes. Default 1 (int)

node_volume_size int

The volume size for each node. Default 20 (int)

region str

The availability domain within the region to host the cluster. See here for a list of region names. (string)

security_groups Sequence[str]

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

service_role str

The AWS service role to use (string)

session_token str

A session token to use with the client key and secret if applicable (string)

subnets Sequence[str]

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

user_data str

Pass user-data to the nodes to perform automated configuration tasks (string)

virtual_network str

The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

ClusterEksConfigV2

CloudCredentialId string

The EKS cloud_credential id (string)

Imported bool

Set to true to import EKS cluster. Default: false (bool)

KmsKey string

The AWS kms key to use (string)

KubernetesVersion string

The Kubernetes version that will be used for your master and OKE worker nodes (string)

LoggingTypes List<string>

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

Name string

Name of cluster registration token (string)

NodeGroups List<ClusterEksConfigV2NodeGroupArgs>

The EKS cluster name to import. Required to create a new cluster (list)

PrivateAccess bool

The EKS cluster has private access. Default: false (bool)

PublicAccess bool

The EKS cluster has public access. Default: true (bool)

PublicAccessSources List<string>

The EKS cluster public access sources (map)

Region string

The availability domain within the region to host the cluster. See here for a list of region names. (string)

SecretsEncryption bool

Enable EKS cluster secret encryption. Default: false (bool)

SecurityGroups List<string>

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

ServiceRole string

The AWS service role to use (string)

Subnets List<string>

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

Tags Dictionary<string, object>

The EKS cluster tags (map)

CloudCredentialId string

The EKS cloud_credential id (string)

Imported bool

Set to true to import EKS cluster. Default: false (bool)

KmsKey string

The AWS kms key to use (string)

KubernetesVersion string

The Kubernetes version that will be used for your master and OKE worker nodes (string)

LoggingTypes []string

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

Name string

Name of cluster registration token (string)

NodeGroups []ClusterEksConfigV2NodeGroup

The EKS cluster name to import. Required to create a new cluster (list)

PrivateAccess bool

The EKS cluster has private access. Default: false (bool)

PublicAccess bool

The EKS cluster has public access. Default: true (bool)

PublicAccessSources []string

The EKS cluster public access sources (map)

Region string

The availability domain within the region to host the cluster. See here for a list of region names. (string)

SecretsEncryption bool

Enable EKS cluster secret encryption. Default: false (bool)

SecurityGroups []string

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

ServiceRole string

The AWS service role to use (string)

Subnets []string

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

Tags map[string]interface{}

The EKS cluster tags (map)

cloudCredentialId string

The EKS cloud_credential id (string)

imported boolean

Set to true to import EKS cluster. Default: false (bool)

kmsKey string

The AWS kms key to use (string)

kubernetesVersion string

The Kubernetes version that will be used for your master and OKE worker nodes (string)

loggingTypes string[]

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

name string

Name of cluster registration token (string)

nodeGroups ClusterEksConfigV2NodeGroup[]

The EKS cluster name to import. Required to create a new cluster (list)

privateAccess boolean

The EKS cluster has private access. Default: false (bool)

publicAccess boolean

The EKS cluster has public access. Default: true (bool)

publicAccessSources string[]

The EKS cluster public access sources (map)

region string

The availability domain within the region to host the cluster. See here for a list of region names. (string)

secretsEncryption boolean

Enable EKS cluster secret encryption. Default: false (bool)

securityGroups string[]

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

serviceRole string

The AWS service role to use (string)

subnets string[]

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

tags {[key: string]: any}

The EKS cluster tags (map)

cloud_credential_id str

The EKS cloud_credential id (string)

imported bool

Set to true to import EKS cluster. Default: false (bool)

kms_key str

The AWS kms key to use (string)

kubernetes_version str

The Kubernetes version that will be used for your master and OKE worker nodes (string)

logging_types Sequence[str]

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

name str

Name of cluster registration token (string)

node_groups Sequence[ClusterEksConfigV2NodeGroupArgs]

The EKS cluster name to import. Required to create a new cluster (list)

private_access bool

The EKS cluster has private access. Default: false (bool)

public_access bool

The EKS cluster has public access. Default: true (bool)

public_access_sources Sequence[str]

The EKS cluster public access sources (map)

region str

The availability domain within the region to host the cluster. See here for a list of region names. (string)

secrets_encryption bool

Enable EKS cluster secret encryption. Default: false (bool)

security_groups Sequence[str]

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

service_role str

The AWS service role to use (string)

subnets Sequence[str]

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

tags Mapping[str, Any]

The EKS cluster tags (map)

ClusterEksConfigV2NodeGroup

Name string

Name of cluster registration token (string)

DesiredSize int

The EKS node group desired size. Default: 2 (int)

DiskSize int

The EKS node group disk size (Gb). Default: 20 (int)

Ec2SshKey string

The EKS node group ssh key (string)

Gpu bool

Set true to EKS use gpu. Default: false (bool)

InstanceType string

The EKS node group instance type. Default: t3.medium (string)

Labels Dictionary<string, object>

Labels for cluster registration token object (map)

MaxSize int

The EKS node group maximum size. Default 2 (int)

MinSize int

The EKS node group maximum size. Default 2 (int)

Tags Dictionary<string, object>

The EKS cluster tags (map)

Name string

Name of cluster registration token (string)

DesiredSize int

The EKS node group desired size. Default: 2 (int)

DiskSize int

The EKS node group disk size (Gb). Default: 20 (int)

Ec2SshKey string

The EKS node group ssh key (string)

Gpu bool

Set true to EKS use gpu. Default: false (bool)

InstanceType string

The EKS node group instance type. Default: t3.medium (string)

Labels map[string]interface{}

Labels for cluster registration token object (map)

MaxSize int

The EKS node group maximum size. Default 2 (int)

MinSize int

The EKS node group maximum size. Default 2 (int)

Tags map[string]interface{}

The EKS cluster tags (map)

name string

Name of cluster registration token (string)

desiredSize number

The EKS node group desired size. Default: 2 (int)

diskSize number

The EKS node group disk size (Gb). Default: 20 (int)

ec2SshKey string

The EKS node group ssh key (string)

gpu boolean

Set true to EKS use gpu. Default: false (bool)

instanceType string

The EKS node group instance type. Default: t3.medium (string)

labels {[key: string]: any}

Labels for cluster registration token object (map)

maxSize number

The EKS node group maximum size. Default 2 (int)

minSize number

The EKS node group maximum size. Default 2 (int)

tags {[key: string]: any}

The EKS cluster tags (map)

name str

Name of cluster registration token (string)

desired_size int

The EKS node group desired size. Default: 2 (int)

disk_size int

The EKS node group disk size (Gb). Default: 20 (int)

ec2_ssh_key str

The EKS node group ssh key (string)

gpu bool

Set true to EKS use gpu. Default: false (bool)

instance_type str

The EKS node group instance type. Default: t3.medium (string)

labels Mapping[str, Any]

Labels for cluster registration token object (map)

max_size int

The EKS node group maximum size. Default 2 (int)

min_size int

The EKS node group maximum size. Default 2 (int)

tags Mapping[str, Any]

The EKS cluster tags (map)

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

Specifies whether to enable the Kubernetes dashboard. Default false (bool)

EnableLegacyAbac bool

Whether to enable legacy abac on the cluster. Default false (bool)

EnableMasterAuthorizedNetwork bool

Enable master authorized network. Set to true if master_authorized_network_cidr_blocks is set. Default false (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

Specifies whether worker nodes will be deployed into a new, private, subnet. 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

The availability domain within the region to host the cluster. See here for a list of region names. (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

Specifies whether to enable the Kubernetes dashboard. Default false (bool)

EnableLegacyAbac bool

Whether to enable legacy abac on the cluster. Default false (bool)

EnableMasterAuthorizedNetwork bool

Enable master authorized network. Set to true if master_authorized_network_cidr_blocks is set. Default false (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

Specifies whether worker nodes will be deployed into a new, private, subnet. 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

The availability domain within the region to host the cluster. See here for a list of region names. (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

Specifies whether to enable the Kubernetes dashboard. Default false (bool)

enableLegacyAbac boolean

Whether to enable legacy abac on the cluster. Default false (bool)

enableMasterAuthorizedNetwork boolean

Enable master authorized network. Set to true if master_authorized_network_cidr_blocks is set. Default false (bool)

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

Specifies whether worker nodes will be deployed into a new, private, subnet. 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

The availability domain within the region to host the cluster. See here for a list of region names. (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)

cluster_ipv4_cidr str

The IP address range of the container pods (string)

credential str

The contents of the GC credential file (string)

disk_type str

Type of the disk attached to each node (string)

image_type str

The image to use for the worker nodes (string)

ip_policy_cluster_ipv4_cidr_block str

The IP address range for the cluster pod IPs (string)

ip_policy_cluster_secondary_range_name str

The name of the secondary range to be used for the cluster CIDR block (string)

ip_policy_node_ipv4_cidr_block str

The IP address range of the instance IPs in this cluster (string)

ip_policy_services_ipv4_cidr_block str

The IP address range of the services IPs in this cluster (string)

ip_policy_services_secondary_range_name str

The name of the secondary range to be used for the services CIDR block (string)

ip_policy_subnetwork_name str

A custom subnetwork name to be used if createSubnetwork is true (string)

locations Sequence[str]

Locations for GKE cluster (list)

machine_type str

Machine type for GKE cluster (string)

maintenance_window str

Maintenance window for GKE cluster (string)

master_ipv4_cidr_block str

The IP range in CIDR notation to use for the hosted master network (string)

master_version str

Master version for GKE cluster (string)

network str

Network for GKE cluster (string)

node_pool str

The ID of the cluster node pool (string)

node_version str

Node version for GKE cluster (string)

oauth_scopes Sequence[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)

service_account str

The Google Cloud Platform Service Account to be used by the node VMs (string)

sub_network str

Subnetwork for GKE cluster (string)

description str

An optional description of this cluster (string)

disk_size_gb int

Size of the disk attached to each node. Default 100 (int)

enable_alpha_feature bool

To enable Kubernetes alpha feature. Default true (bool)

enable_auto_repair bool

Specifies whether the node auto-repair is enabled for the node pool. Default false (bool)

enable_auto_upgrade bool

Specifies whether node auto-upgrade is enabled for the node pool. Default false (bool)

enable_horizontal_pod_autoscaling bool

Enable horizontal pod autoscaling for the cluster. Default true (bool)

enable_http_load_balancing bool

Enable HTTP load balancing on GKE cluster. Default true (bool)

enable_kubernetes_dashboard bool

Specifies whether to enable the Kubernetes dashboard. Default false (bool)

enable_legacy_abac bool

Whether to enable legacy abac on the cluster. Default false (bool)

enable_master_authorized_network bool

Enable master authorized network. Set to true if master_authorized_network_cidr_blocks is set. Default false (bool)

enable_network_policy_config bool

Enable network policy config for the cluster. Default true (bool)

enable_nodepool_autoscaling bool

Enable nodepool autoscaling. Default false (bool)

enable_private_endpoint bool

Whether the master’s internal IP address is used as the cluster endpoint. Default false (bool)

enable_private_nodes bool

Specifies whether worker nodes will be deployed into a new, private, subnet. Default false (bool)

enable_stackdriver_logging bool

Enable stackdriver monitoring. Default true (bool)

enable_stackdriver_monitoring bool

Enable stackdriver monitoring on GKE cluster (bool)

ip_policy_create_subnetwork bool

Whether a new subnetwork will be created automatically for the cluster. Default false (bool)

issue_client_certificate bool

Issue a client certificate. Default false (bool)

kubernetes_dashboard bool

Enable the Kubernetes dashboard. Default false (bool)

labels Mapping[str, Any]

Labels for cluster registration token object (map)

local_ssd_count int

The number of local SSD disks to be attached to the node. Default 0 (int)

master_authorized_network_cidr_blocks Sequence[str]

Define up to 10 external networks that could access Kubernetes master through HTTPS (list)

max_node_count int

Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default 0 (int)

min_node_count int

Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default 0 (int)

node_count int

Node count for GKE cluster. Default 3 (int)

preemptible bool

Whether the nodes are created as preemptible VM instances. Default false (bool)

region str

The availability domain within the region to host the cluster. See here for a list of region names. (string)

resource_labels Mapping[str, Any]

The map of Kubernetes labels to be applied to each cluster (map)

taints Sequence[str]

List of Kubernetes taints to be applied to each node (list)

use_ip_aliases 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 ClusterK3sConfigUpgradeStrategyArgs

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)

drain_server_nodes bool

Drain server nodes. Default: false (bool)

drain_worker_nodes bool

Drain worker nodes. Default: false (bool)

server_concurrency int

Server concurrency. Default: 1 (int)

worker_concurrency int

Worker concurrency. Default: 1 (int)

ClusterOkeConfig

CompartmentId string

The OCID of the compartment in which to create resources OKE cluster and related resources (string)

Fingerprint string

The fingerprint corresponding to the specified user’s private API Key (string)

KubernetesVersion string

The Kubernetes version that will be used for your master and OKE worker nodes (string)

NodeImage string

The Oracle Linux OS image name to use for the OKE node(s). See here for a list of images. (string)

NodeShape string

The shape of the node (determines number of CPUs and amount of memory on each OKE node) (string)

PrivateKeyContents string

The private API key file contents for the specified user, in PEM format (string)

Region string

The availability domain within the region to host the cluster. See here for a list of region names. (string)

TenancyId string

The OCID of the tenancy in which to create resources (string)

UserOcid string

The OCID of a user who has access to the tenancy/compartment (string)

Description string

An optional description of this cluster (string)

EnableKubernetesDashboard bool

Specifies whether to enable the Kubernetes dashboard. Default false (bool)

EnablePrivateNodes bool

Specifies whether worker nodes will be deployed into a new, private, subnet. Default false (bool)

LoadBalancerSubnetName1 string

The name of the first existing subnet to use for Kubernetes services / LB. vcn_name is also required when specifying an existing subnet. (string)

LoadBalancerSubnetName2 string

The name of a second existing subnet to use for Kubernetes services / LB. A second subnet is only required when it is AD-specific (non-regional) (string)

NodePoolDnsDomainName string

Name for DNS domain of node pool subnet. Default nodedns (string)

NodePoolSubnetName string

Name for node pool subnet. Default nodedns (string)

NodePublicKeyContents string

The contents of the SSH public key file to use for the nodes (string)

PrivateKeyPassphrase string

The passphrase (if any) of the private key for the OKE cluster (string)

QuantityOfNodeSubnets int

Number of node subnets. Default 1 (int)

QuantityPerSubnet int

Number of OKE worker nodes in each subnet / availability domain. Default 1 (int)

ServiceDnsDomainName string

Name for DNS domain of service subnet. Default svcdns (string)

SkipVcnDelete bool

Specifies whether to skip deleting the virtual cloud network (VCN) on destroy. Default false (bool)

VcnName string

The name of an existing virtual network to use for the cluster creation. If set, you must also set load_balancer_subnet_name_1. A VCN and subnets will be created if none are specified. (string)

WorkerNodeIngressCidr string

Additional CIDR from which to allow ingress to worker nodes (string)

CompartmentId string

The OCID of the compartment in which to create resources OKE cluster and related resources (string)

Fingerprint string

The fingerprint corresponding to the specified user’s private API Key (string)

KubernetesVersion string

The Kubernetes version that will be used for your master and OKE worker nodes (string)

NodeImage string

The Oracle Linux OS image name to use for the OKE node(s). See here for a list of images. (string)

NodeShape string

The shape of the node (determines number of CPUs and amount of memory on each OKE node) (string)

PrivateKeyContents string

The private API key file contents for the specified user, in PEM format (string)

Region string

The availability domain within the region to host the cluster. See here for a list of region names. (string)

TenancyId string

The OCID of the tenancy in which to create resources (string)

UserOcid string

The OCID of a user who has access to the tenancy/compartment (string)

Description string

An optional description of this cluster (string)

EnableKubernetesDashboard bool

Specifies whether to enable the Kubernetes dashboard. Default false (bool)

EnablePrivateNodes bool

Specifies whether worker nodes will be deployed into a new, private, subnet. Default false (bool)

LoadBalancerSubnetName1 string

The name of the first existing subnet to use for Kubernetes services / LB. vcn_name is also required when specifying an existing subnet. (string)

LoadBalancerSubnetName2 string

The name of a second existing subnet to use for Kubernetes services / LB. A second subnet is only required when it is AD-specific (non-regional) (string)

NodePoolDnsDomainName string

Name for DNS domain of node pool subnet. Default nodedns (string)

NodePoolSubnetName string

Name for node pool subnet. Default nodedns (string)

NodePublicKeyContents string

The contents of the SSH public key file to use for the nodes (string)

PrivateKeyPassphrase string

The passphrase (if any) of the private key for the OKE cluster (string)

QuantityOfNodeSubnets int

Number of node subnets. Default 1 (int)

QuantityPerSubnet int

Number of OKE worker nodes in each subnet / availability domain. Default 1 (int)

ServiceDnsDomainName string

Name for DNS domain of service subnet. Default svcdns (string)

SkipVcnDelete bool

Specifies whether to skip deleting the virtual cloud network (VCN) on destroy. Default false (bool)

VcnName string

The name of an existing virtual network to use for the cluster creation. If set, you must also set load_balancer_subnet_name_1. A VCN and subnets will be created if none are specified. (string)

WorkerNodeIngressCidr string

Additional CIDR from which to allow ingress to worker nodes (string)

compartmentId string

The OCID of the compartment in which to create resources OKE cluster and related resources (string)

fingerprint string

The fingerprint corresponding to the specified user’s private API Key (string)

kubernetesVersion string

The Kubernetes version that will be used for your master and OKE worker nodes (string)

nodeImage string

The Oracle Linux OS image name to use for the OKE node(s). See here for a list of images. (string)

nodeShape string

The shape of the node (determines number of CPUs and amount of memory on each OKE node) (string)

privateKeyContents string

The private API key file contents for the specified user, in PEM format (string)

region string

The availability domain within the region to host the cluster. See here for a list of region names. (string)

tenancyId string

The OCID of the tenancy in which to create resources (string)

userOcid string

The OCID of a user who has access to the tenancy/compartment (string)

description string

An optional description of this cluster (string)

enableKubernetesDashboard boolean

Specifies whether to enable the Kubernetes dashboard. Default false (bool)

enablePrivateNodes boolean

Specifies whether worker nodes will be deployed into a new, private, subnet. Default false (bool)

loadBalancerSubnetName1 string

The name of the first existing subnet to use for Kubernetes services / LB. vcn_name is also required when specifying an existing subnet. (string)

loadBalancerSubnetName2 string

The name of a second existing subnet to use for Kubernetes services / LB. A second subnet is only required when it is AD-specific (non-regional) (string)

nodePoolDnsDomainName string

Name for DNS domain of node pool subnet. Default nodedns (string)

nodePoolSubnetName string

Name for node pool subnet. Default nodedns (string)

nodePublicKeyContents string

The contents of the SSH public key file to use for the nodes (string)

privateKeyPassphrase string

The passphrase (if any) of the private key for the OKE cluster (string)

quantityOfNodeSubnets number

Number of node subnets. Default 1 (int)

quantityPerSubnet number

Number of OKE worker nodes in each subnet / availability domain. Default 1 (int)

serviceDnsDomainName string

Name for DNS domain of service subnet. Default svcdns (string)

skipVcnDelete boolean

Specifies whether to skip deleting the virtual cloud network (VCN) on destroy. Default false (bool)

vcnName string

The name of an existing virtual network to use for the cluster creation. If set, you must also set load_balancer_subnet_name_1. A VCN and subnets will be created if none are specified. (string)

workerNodeIngressCidr string

Additional CIDR from which to allow ingress to worker nodes (string)

compartment_id str

The OCID of the compartment in which to create resources OKE cluster and related resources (string)

fingerprint str

The fingerprint corresponding to the specified user’s private API Key (string)

kubernetes_version str

The Kubernetes version that will be used for your master and OKE worker nodes (string)

node_image str

The Oracle Linux OS image name to use for the OKE node(s). See here for a list of images. (string)

node_shape str

The shape of the node (determines number of CPUs and amount of memory on each OKE node) (string)

private_key_contents str

The private API key file contents for the specified user, in PEM format (string)

region str

The availability domain within the region to host the cluster. See here for a list of region names. (string)

tenancy_id str

The OCID of the tenancy in which to create resources (string)

user_ocid str

The OCID of a user who has access to the tenancy/compartment (string)

description str

An optional description of this cluster (string)

enable_kubernetes_dashboard bool

Specifies whether to enable the Kubernetes dashboard. Default false (bool)

enable_private_nodes bool

Specifies whether worker nodes will be deployed into a new, private, subnet. Default false (bool)

load_balancer_subnet_name1 str

The name of the first existing subnet to use for Kubernetes services / LB. vcn_name is also required when specifying an existing subnet. (string)

load_balancer_subnet_name2 str

The name of a second existing subnet to use for Kubernetes services / LB. A second subnet is only required when it is AD-specific (non-regional) (string)

node_pool_dns_domain_name str

Name for DNS domain of node pool subnet. Default nodedns (string)

node_pool_subnet_name str

Name for node pool subnet. Default nodedns (string)

node_public_key_contents str

The contents of the SSH public key file to use for the nodes (string)

private_key_passphrase str

The passphrase (if any) of the private key for the OKE cluster (string)

quantity_of_node_subnets int

Number of node subnets. Default 1 (int)

quantity_per_subnet int

Number of OKE worker nodes in each subnet / availability domain. Default 1 (int)

service_dns_domain_name str

Name for DNS domain of service subnet. Default svcdns (string)

skip_vcn_delete bool

Specifies whether to skip deleting the virtual cloud network (VCN) on destroy. Default false (bool)

vcn_name str

The name of an existing virtual network to use for the cluster creation. If set, you must also set load_balancer_subnet_name_1. A VCN and subnets will be created if none are specified. (string)

worker_node_ingress_cidr str

Additional CIDR from which to allow ingress to worker nodes (string)

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 version that will be used for your master and OKE worker nodes (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 version that will be used for your master and OKE worker nodes (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 version that will be used for your master and OKE worker nodes (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)

addon_job_timeout int

Duration in seconds of addon job (int)

addons str

Addons descripton to deploy on RKE cluster.

addons_includes Sequence[str]

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)

bastion_host ClusterRkeConfigBastionHostArgs

RKE bastion host (list maxitems:1)

cloud_provider ClusterRkeConfigCloudProviderArgs

RKE options for Calico network provider (string)

dns ClusterRkeConfigDnsArgs

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

ignore_docker_version bool

Ignore docker version. Default true (bool)

ingress ClusterRkeConfigIngressArgs

Kubernetes ingress configuration (list maxitems:1)

kubernetes_version str

The Kubernetes version that will be used for your master and OKE worker nodes (string)

monitoring ClusterRkeConfigMonitoringArgs

Kubernetes cluster monitoring (list maxitems:1)

network ClusterRkeConfigNetworkArgs

Network for GKE cluster (string)

nodes Sequence[ClusterRkeConfigNodeArgs]

RKE cluster nodes (list)

prefix_path str

Prefix to customize Kubernetes path (string)

private_registries Sequence[ClusterRkeConfigPrivateRegistryArgs]

private registries for docker images (list)

services ClusterRkeConfigServicesArgs

Kubernetes cluster services (list maxitems:1)

ssh_agent_auth bool

Use ssh agent auth. Default false (bool)

ssh_cert_path str

Cluster level SSH certificate path (string)

ssh_key_path str

Node SSH private key path (string)

upgrade_strategy ClusterRkeConfigUpgradeStrategyArgs

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 Sequence[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 Mapping[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)

ssh_agent_auth bool

Use ssh agent auth. Default false (bool)

ssh_key str

Node SSH private key (string)

ssh_key_path 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)

aws_cloud_provider ClusterRkeConfigCloudProviderAwsCloudProviderArgs

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

azure_cloud_provider ClusterRkeConfigCloudProviderAzureCloudProviderArgs

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

custom_cloud_provider str

RKE Custom Cloud Provider config for Cloud Provider (string)

name str

Name of cluster registration token (string)

openstack_cloud_provider ClusterRkeConfigCloudProviderOpenstackCloudProviderArgs

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

vsphere_cloud_provider 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)

ClusterRkeConfigCloudProviderAwsCloudProvider

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)

disable_security_group_ingress bool

Default false (bool)

disable_strict_zone_check bool

Default false (bool)

elb_security_group str

(string)

kubernetes_cluster_id str

(string)

kubernetes_cluster_tag str

(string)

role_arn str

(string)

route_table_id str

(string)

subnet_id str

(string)

vpc str

(string)

zone str

GKE cluster zone. Conflicts with region (string)

ClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride

Service string

(string)

Region string

The availability domain within the region to host the cluster. See here for a list of region names. (string)

SigningMethod string

(string)

SigningName string

(string)

SigningRegion string

(string)

Url string

Registry URL (string)

Service string

(string)

Region string

The availability domain within the region to host the cluster. See here for a list of region names. (string)

SigningMethod string

(string)

SigningName string

(string)

SigningRegion string

(string)

Url string

Registry URL (string)

service string

(string)

region string

The availability domain within the region to host the cluster. See here for a list of region names. (string)

signingMethod string

(string)

signingName string

(string)

signingRegion string

(string)

url string

Registry URL (string)

service str

(string)

region str

The availability domain within the region to host the cluster. See here for a list of region names. (string)

signing_method str

(string)

signing_name str

(string)

signing_region 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)

aad_client_id str

(string)

aad_client_secret str

(string)

subscription_id str

Subscription credentials which uniquely identify Microsoft Azure subscription (string)

tenant_id str

Azure tenant ID to use (string)

aad_client_cert_password str

(string)

aad_client_cert_path str

(string)

cloud str

(string)

cloud_provider_backoff bool

(bool)

cloud_provider_backoff_duration int

(int)

cloud_provider_backoff_exponent int

(int)

cloud_provider_backoff_jitter int

(int)

cloud_provider_backoff_retries int

(int)

cloud_provider_rate_limit bool

(bool)

cloud_provider_rate_limit_bucket int

(int)

cloud_provider_rate_limit_qps int

(int)

load_balancer_sku str

Allowed values: basic (default) standard (string)

location str

Azure Kubernetes cluster location. Default eastus (string)

maximum_load_balancer_rule_count int

(int)

primary_availability_set_name str

(string)

primary_scale_set_name str

(string)

resource_group str

The name of the Cluster resource group (string)

route_table_name str

(string)

security_group_name str

(string)

subnet_name str

(string)

use_instance_metadata bool

(bool)

use_managed_identity_extension bool

(bool)

vm_type str

(string)

vnet_name str

(string)

vnet_resource_group str

(string)

ClusterRkeConfigCloudProviderOpenstackCloudProvider

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)

bs_version str

(string)

ignore_volume_az bool

(string)

trust_device_path 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

The availability domain within the region to host the cluster. See here for a list of region names. (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

The availability domain within the region to host the cluster. See here for a list of region names. (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

The availability domain within the region to host the cluster. See here for a list of region names. (string)

tenantId string

Azure tenant ID to use (string)

tenantName string

Required if tenant_id not provided. (string)

trustId string

(string)

auth_url str

(string)

password str

Registry password (string)

username str

(string)

ca_file str

(string)

domain_id str

Required if domain_name not provided. (string)

domain_name str

Required if domain_id not provided. (string)

region str

The availability domain within the region to host the cluster. See here for a list of region names. (string)

tenant_id str

Azure tenant ID to use (string)

tenant_name str

Required if tenant_id not provided. (string)

trust_id 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)

create_monitor bool

(bool)

floating_network_id str

(string)

lb_method str

(string)

lb_provider str

(string)

lb_version str

(string)

manage_security_groups bool

(bool)

monitor_delay str

Default 60s (string)

monitor_max_retries int

Default 5 (int)

monitor_timeout str

Default 30s (string)

subnet_id str

(string)

use_octavia bool

(bool)

ClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata

RequestTimeout int

(int)

SearchOrder string

(string)

RequestTimeout int

(int)

SearchOrder string

(string)

requestTimeout number

(int)

searchOrder string

(string)

request_timeout int

(int)

search_order str

(string)

ClusterRkeConfigCloudProviderOpenstackCloudProviderRoute

RouterId string

(string)

RouterId string

(string)

routerId string

(string)

router_id str

(string)

ClusterRkeConfigCloudProviderVsphereCloudProvider

ClusterRkeConfigCloudProviderVsphereCloudProviderDisk

ScsiControllerType string

(string)

ScsiControllerType string

(string)

scsiControllerType string

(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)

insecure_flag bool

(bool)

password str

Registry password (string)

port str

Port for node. Default 22 (string)

soap_roundtrip_count int

(int)

user str

Registry user (string)

ClusterRkeConfigCloudProviderVsphereCloudProviderNetwork

PublicNetwork string

(string)

PublicNetwork string

(string)

publicNetwork string

(string)

public_network 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)

soap_roundtrip_count int

(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)

default_datastore str

(string)

resourcepool_path str

(string)

ClusterRkeConfigDns

LinearAutoscalerParams ClusterRkeConfigDnsLinearAutoscalerParamsArgs

LinearAutoScalerParams dns config (list Maxitem: 1)

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)

UpdateStrategy ClusterRkeConfigDnsUpdateStrategyArgs

RKE monitoring update strategy (list Maxitems: 1)

UpstreamNameservers List<string>

DNS add-on upstream nameservers (list)

LinearAutoscalerParams ClusterRkeConfigDnsLinearAutoscalerParams

LinearAutoScalerParams dns config (list Maxitem: 1)

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)

UpdateStrategy ClusterRkeConfigDnsUpdateStrategy

RKE monitoring update strategy (list Maxitems: 1)

UpstreamNameservers []string

DNS add-on upstream nameservers (list)

linearAutoscalerParams ClusterRkeConfigDnsLinearAutoscalerParams

LinearAutoScalerParams dns config (list Maxitem: 1)

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)

updateStrategy ClusterRkeConfigDnsUpdateStrategy

RKE monitoring update strategy (list Maxitems: 1)

upstreamNameservers string[]

DNS add-on upstream nameservers (list)

linear_autoscaler_params ClusterRkeConfigDnsLinearAutoscalerParamsArgs

LinearAutoScalerParams dns config (list Maxitem: 1)

node_selector Mapping[str, Any]

RKE monitoring node selector (map)

nodelocal ClusterRkeConfigDnsNodelocalArgs

Nodelocal dns config (list Maxitem: 1)

provider str

RKE monitoring provider (string)

reverse_cidrs Sequence[str]

DNS add-on reverse cidr (list)

update_strategy ClusterRkeConfigDnsUpdateStrategyArgs

RKE monitoring update strategy (list Maxitems: 1)

upstream_nameservers Sequence[str]

DNS add-on upstream nameservers (list)

ClusterRkeConfigDnsLinearAutoscalerParams

CoresPerReplica double

number of replicas per cluster cores (float64)

Max int

maximum number of replicas (int64)

Min int

minimum number of replicas (int64)

NodesPerReplica double

number of replica per cluster nodes (float64)

PreventSinglePointFailure bool

prevent single point of failure

CoresPerReplica float64

number of replicas per cluster cores (float64)

Max int

maximum number of replicas (int64)

Min int

minimum number of replicas (int64)

NodesPerReplica float64

number of replica per cluster nodes (float64)

PreventSinglePointFailure bool

prevent single point of failure

coresPerReplica number

number of replicas per cluster cores (float64)

max number

maximum number of replicas (int64)

min number

minimum number of replicas (int64)

nodesPerReplica number

number of replica per cluster nodes (float64)

preventSinglePointFailure boolean

prevent single point of failure

cores_per_replica float

number of replicas per cluster cores (float64)

max int

maximum number of replicas (int64)

min int

minimum number of replicas (int64)

nodes_per_replica float

number of replica per cluster nodes (float64)

prevent_single_point_failure bool

prevent single point of failure

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)

ip_address str

Nodelocal dns ip address (string)

node_selector Mapping[str, Any]

RKE monitoring node selector (map)

ClusterRkeConfigDnsUpdateStrategy

RollingUpdate ClusterRkeConfigDnsUpdateStrategyRollingUpdateArgs

Monitoring deployment rolling update (list Maxitems: 1)

Strategy string

Monitoring deployment update strategy (string)

RollingUpdate ClusterRkeConfigDnsUpdateStrategyRollingUpdate

Monitoring deployment rolling update (list Maxitems: 1)

Strategy string

Monitoring deployment update strategy (string)

rollingUpdate ClusterRkeConfigDnsUpdateStrategyRollingUpdate

Monitoring deployment rolling update (list Maxitems: 1)

strategy string

Monitoring deployment update strategy (string)

rolling_update ClusterRkeConfigDnsUpdateStrategyRollingUpdateArgs

Monitoring deployment rolling update (list Maxitems: 1)

strategy str

Monitoring deployment update strategy (string)

ClusterRkeConfigDnsUpdateStrategyRollingUpdate

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)

max_surge int

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

max_unavailable int

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

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)

dns_policy str

Ingress controller DNS policy. ClusterFirstWithHostNet, ClusterFirst, Default, and None are supported. K8S dns Policy (string)

extra_args Mapping[str, Any]

Extra arguments for scheduler service (map)

node_selector Mapping[str, Any]

RKE monitoring node selector (map)

options Mapping[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)

node_selector Mapping[str, Any]

RKE monitoring node selector (map)

options Mapping[str, Any]

RKE options for network (map)

provider str

RKE monitoring provider (string)

replicas int

RKE monitoring replicas (int)

update_strategy ClusterRkeConfigMonitoringUpdateStrategyArgs

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)

rolling_update ClusterRkeConfigMonitoringUpdateStrategyRollingUpdateArgs

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)

max_surge int

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

max_unavailable int

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)

calico_network_provider ClusterRkeConfigNetworkCalicoNetworkProviderArgs

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

canal_network_provider ClusterRkeConfigNetworkCanalNetworkProviderArgs

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

flannel_network_provider ClusterRkeConfigNetworkFlannelNetworkProviderArgs

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

mtu int

Network provider MTU. Default 0 (int)

options Mapping[str, Any]

RKE options for network (map)

plugin str

Plugin for RKE network. canal (default), flannel, calico, none and weave are supported. (string)

weave_network_provider ClusterRkeConfigNetworkWeaveNetworkProviderArgs

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)

cloud_provider 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 Sequence[str]

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

user str

Registry user (string)

docker_socket str

Docker socket for node (string)

hostname_override str

Hostname override for node (string)

internal_address str

Internal ip for node (string)

labels Mapping[str, Any]

Labels for cluster registration token object (map)

node_id str

Id for the node (string)

port str

Port for node. Default 22 (string)

ssh_agent_auth bool

Use ssh agent auth. Default false (bool)

ssh_key str

Node SSH private key (string)

ssh_key_path 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)

is_default 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 ClusterRkeConfigServicesEtcdArgs

Etcd options for RKE services (list maxitems:1)

kube_api ClusterRkeConfigServicesKubeApiArgs

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

kube_controller 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)

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 ClusterRkeConfigServicesEtcdBackupConfigArgs

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

ca_cert str

TLS CA certificate for etcd service (string)

cert str

TLS certificate for etcd service (string)

creation str

Creation option for etcd service (string)

external_urls Sequence[str]

External urls for etcd service (list)

extra_args Mapping[str, Any]

Extra arguments for scheduler service (map)

extra_binds Sequence[str]

Extra binds for scheduler service (list)

extra_envs Sequence[str]

Extra environment for scheduler service (list)

gid int

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 int

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)

interval_hours int

Interval hours for etcd backup. Default 12 (int)

retention int

Retention for etcd backup. Default 6 (int)

s3_backup_config ClusterRkeConfigServicesEtcdBackupConfigS3BackupConfigArgs

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

safe_timestamp 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

The availability domain within the region to host the cluster. See here for a list of region names. (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

The availability domain within the region to host the cluster. See here for a list of region names. (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

The availability domain within the region to host the cluster. See here for a list of region names. (string)

secretKey string

The AWS Client Secret associated with the Client ID (string)

bucket_name str

Bucket name for S3 service (string)

endpoint str

Endpoint for S3 service (string)

access_key str

The AWS Client ID to use (string)

custom_ca 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

The availability domain within the region to host the cluster. See here for a list of region names. (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)

admission_configuration Mapping[str, Any]

Admission configuration (map)

always_pull_images bool

Enable AlwaysPullImages Admission controller plugin. Rancher docs Default: false (bool)

audit_log ClusterRkeConfigServicesKubeApiAuditLogArgs

K8s audit log configuration. (list maxitems: 1)

event_rate_limit ClusterRkeConfigServicesKubeApiEventRateLimitArgs

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

extra_args Mapping[str, Any]

Extra arguments for scheduler service (map)

extra_binds Sequence[str]

Extra binds for scheduler service (list)

extra_envs Sequence[str]

Extra environment for scheduler service (list)

image str

Docker image for scheduler service (string)

pod_security_policy bool

Pod Security Policy option for kube API service. Default false (bool)

secrets_encryption_config ClusterRkeConfigServicesKubeApiSecretsEncryptionConfigArgs

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

service_cluster_ip_range str

Service Cluster ip Range option for kube controller service (string)

service_node_port_range str

Service Node Port Range option for kube API service (string)

ClusterRkeConfigServicesKubeApiAuditLog

Configuration ClusterRkeConfigServicesKubeApiAuditLogConfigurationArgs

Event rate limit configuration yaml encoded definition. apiVersion and kind: Configuration" fields are required in the yaml. Ex. "apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n" More info (string)

Enabled bool

Enable scheduled cluster scan. Default: false (bool)

Configuration ClusterRkeConfigServicesKubeApiAuditLogConfiguration

Event rate limit configuration yaml encoded definition. apiVersion and kind: Configuration" fields are required in the yaml. Ex. "apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n" More info (string)

Enabled bool

Enable scheduled cluster scan. Default: false (bool)

configuration ClusterRkeConfigServicesKubeApiAuditLogConfiguration

Event rate limit configuration yaml encoded definition. apiVersion and kind: Configuration" fields are required in the yaml. Ex. "apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n" More info (string)

enabled boolean

Enable scheduled cluster scan. Default: false (bool)

configuration ClusterRkeConfigServicesKubeApiAuditLogConfigurationArgs

Event rate limit configuration yaml encoded definition. apiVersion and kind: Configuration" fields are required in the yaml. Ex. "apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n" More info (string)

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

The EKS node group maximum size. Default 2 (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

The EKS node group maximum size. Default 2 (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

The EKS node group maximum size. Default 2 (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)

max_age int

Audit log max age. Default: 30 (int)

max_backup int

Audit log max backup. Default: 10 (int)

max_size int

The EKS node group maximum size. Default 2 (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 string

Event rate limit configuration yaml encoded definition. apiVersion and kind: Configuration" fields are required in the yaml. Ex. "apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n" More info (string)

Enabled bool

Enable scheduled cluster scan. Default: false (bool)

Configuration string

Event rate limit configuration yaml encoded definition. apiVersion and kind: Configuration" fields are required in the yaml. Ex. "apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n" More info (string)

Enabled bool

Enable scheduled cluster scan. Default: false (bool)

configuration string

Event rate limit configuration yaml encoded definition. apiVersion and kind: Configuration" fields are required in the yaml. Ex. "apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n" More info (string)

enabled boolean

Enable scheduled cluster scan. Default: false (bool)

configuration str

Event rate limit configuration yaml encoded definition. apiVersion and kind: Configuration" fields are required in the yaml. Ex. "apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n" More info (string)

enabled bool

Enable scheduled cluster scan. Default: false (bool)

ClusterRkeConfigServicesKubeApiSecretsEncryptionConfig

CustomConfig string

Secrets encryption yaml encoded custom configuration. "apiVersion" and "kind":"EncryptionConfiguration" fields are required in the yaml. Ex. apiVersion: apiserver.config.k8s.io/v1\nkind: EncryptionConfiguration\nresources:\n- resources:\n - secrets\n providers:\n - aescbc:\n keys:\n - name: k-fw5hn\n secret: RTczRjFDODMwQzAyMDVBREU4NDJBMUZFNDhCNzM5N0I=\n identity: {}\n More info (string)

Enabled bool

Enable scheduled cluster scan. Default: false (bool)

CustomConfig string

Secrets encryption yaml encoded custom configuration. "apiVersion" and "kind":"EncryptionConfiguration" fields are required in the yaml. Ex. apiVersion: apiserver.config.k8s.io/v1\nkind: EncryptionConfiguration\nresources:\n- resources:\n - secrets\n providers:\n - aescbc:\n keys:\n - name: k-fw5hn\n secret: RTczRjFDODMwQzAyMDVBREU4NDJBMUZFNDhCNzM5N0I=\n identity: {}\n More info (string)

Enabled bool

Enable scheduled cluster scan. Default: false (bool)

customConfig string

Secrets encryption yaml encoded custom configuration. "apiVersion" and "kind":"EncryptionConfiguration" fields are required in the yaml. Ex. apiVersion: apiserver.config.k8s.io/v1\nkind: EncryptionConfiguration\nresources:\n- resources:\n - secrets\n providers:\n - aescbc:\n keys:\n - name: k-fw5hn\n secret: RTczRjFDODMwQzAyMDVBREU4NDJBMUZFNDhCNzM5N0I=\n identity: {}\n More info (string)

enabled boolean

Enable scheduled cluster scan. Default: false (bool)

custom_config str

Secrets encryption yaml encoded custom configuration. "apiVersion" and "kind":"EncryptionConfiguration" fields are required in the yaml. Ex. apiVersion: apiserver.config.k8s.io/v1\nkind: EncryptionConfiguration\nresources:\n- resources:\n - secrets\n providers:\n - aescbc:\n keys:\n - name: k-fw5hn\n secret: RTczRjFDODMwQzAyMDVBREU4NDJBMUZFNDhCNzM5N0I=\n identity: {}\n More info (string)

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)

cluster_cidr str

Cluster CIDR option for kube controller service (string)

extra_args Mapping[str, Any]

Extra arguments for scheduler service (map)

extra_binds Sequence[str]

Extra binds for scheduler service (list)

extra_envs Sequence[str]

Extra environment for scheduler service (list)

image str

Docker image for scheduler service (string)

service_cluster_ip_range 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)

cluster_dns_server str

Cluster DNS Server option for kubelet service (string)

cluster_domain str

Cluster Domain option for kubelet service (string)

extra_args Mapping[str, Any]

Extra arguments for scheduler service (map)

extra_binds Sequence[str]

Extra binds for scheduler service (list)

extra_envs Sequence[str]

Extra environment for scheduler service (list)

fail_swap_on bool

Enable or disable failing when swap on is not supported (bool)

generate_serving_certificate bool

Generate a certificate signed by the kube-ca. Default false (bool)

image str

Docker image for scheduler service (string)

infra_container_image 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)

extra_args Mapping[str, Any]

Extra arguments for scheduler service (map)

extra_binds Sequence[str]

Extra binds for scheduler service (list)

extra_envs Sequence[str]</