Rancher2

Pulumi Official
Package maintained by Pulumi
v3.8.0 published on Tuesday, May 31, 2022 by Pulumi

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/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

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

Coming soon!

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",
        },
    },
});

Coming soon!

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/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/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: &ClusterRkeConfigArgs{
				Network: &ClusterRkeConfigNetworkArgs{
					Plugin: pulumi.String("canal"),
				},
			},
			EnableClusterMonitoring: pulumi.Bool(true),
			ClusterMonitoringInput: &ClusterClusterMonitoringInputArgs{
				Answers: pulumi.AnyMap{
					"exporter-kubelets.https":                   pulumi.Any(true),
					"exporter-node.enabled":                     pulumi.Any(true),
					"exporter-node.ports.metrics.port":          pulumi.Any(9796),
					"exporter-node.resources.limits.cpu":        pulumi.Any("200m"),
					"exporter-node.resources.limits.memory":     pulumi.Any("200Mi"),
					"grafana.persistence.enabled":               pulumi.Any(false),
					"grafana.persistence.size":                  pulumi.Any("10Gi"),
					"grafana.persistence.storageClass":          pulumi.Any("default"),
					"operator.resources.limits.memory":          pulumi.Any("500Mi"),
					"prometheus.persistence.enabled":            pulumi.Any("false"),
					"prometheus.persistence.size":               pulumi.Any("50Gi"),
					"prometheus.persistence.storageClass":       pulumi.Any("default"),
					"prometheus.persistent.useReleaseName":      pulumi.Any("true"),
					"prometheus.resources.core.limits.cpu":      pulumi.Any("1000m"),
					"prometheus.resources.core.limits.memory":   pulumi.Any("1500Mi"),
					"prometheus.resources.core.requests.cpu":    pulumi.Any("750m"),
					"prometheus.resources.core.requests.memory": pulumi.Any("750Mi"),
					"prometheus.retention":                      pulumi.Any("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.AnyMap{
				"certmanager.enabled": pulumi.Any(false),
				"enableCRDs":          pulumi.Any(true),
				"galley.enabled":      pulumi.Any(true),
				"gateways.enabled":    pulumi.Any(false),
				"gateways.istio-ingressgateway.resources.limits.cpu":      pulumi.Any("2000m"),
				"gateways.istio-ingressgateway.resources.limits.memory":   pulumi.Any("1024Mi"),
				"gateways.istio-ingressgateway.resources.requests.cpu":    pulumi.Any("100m"),
				"gateways.istio-ingressgateway.resources.requests.memory": pulumi.Any("128Mi"),
				"gateways.istio-ingressgateway.type":                      pulumi.Any("NodePort"),
				"global.monitoring.type":                                  pulumi.Any("cluster-monitoring"),
				"global.rancher.clusterId":                                foo_customClusterSync.ClusterId,
				"istio_cni.enabled":                                       pulumi.Any("false"),
				"istiocoredns.enabled":                                    pulumi.Any("false"),
				"kiali.enabled":                                           pulumi.Any("true"),
				"mixer.enabled":                                           pulumi.Any("true"),
				"mixer.policy.enabled":                                    pulumi.Any("true"),
				"mixer.policy.resources.limits.cpu":                       pulumi.Any("4800m"),
				"mixer.policy.resources.limits.memory":                    pulumi.Any("4096Mi"),
				"mixer.policy.resources.requests.cpu":                     pulumi.Any("1000m"),
				"mixer.policy.resources.requests.memory":                  pulumi.Any("1024Mi"),
				"mixer.telemetry.resources.limits.cpu":                    pulumi.Any("4800m"),
				"mixer.telemetry.resources.limits.memory":                 pulumi.Any("4096Mi"),
				"mixer.telemetry.resources.requests.cpu":                  pulumi.Any("1000m"),
				"mixer.telemetry.resources.requests.memory":               pulumi.Any("1024Mi"),
				"mtls.enabled":                                            pulumi.Any(false),
				"nodeagent.enabled":                                       pulumi.Any(false),
				"pilot.enabled":                                           pulumi.Any(true),
				"pilot.resources.limits.cpu":                              pulumi.Any("1000m"),
				"pilot.resources.limits.memory":                           pulumi.Any("4096Mi"),
				"pilot.resources.requests.cpu":                            pulumi.Any("500m"),
				"pilot.resources.requests.memory":                         pulumi.Any("2048Mi"),
				"pilot.traceSampling":                                     pulumi.Any("1"),
				"security.enabled":                                        pulumi.Any(true),
				"sidecarInjectorWebhook.enabled":                          pulumi.Any(true),
				"tracing.enabled":                                         pulumi.Any(true),
				"tracing.jaeger.resources.limits.cpu":                     pulumi.Any("500m"),
				"tracing.jaeger.resources.limits.memory":                  pulumi.Any("1024Mi"),
				"tracing.jaeger.resources.requests.cpu":                   pulumi.Any("100m"),
				"tracing.jaeger.resources.requests.memory":                pulumi.Any("100Mi"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

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",
    },
});

Coming soon!

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/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/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: &ClusterRkeConfigArgs{
				Network: &ClusterRkeConfigNetworkArgs{
					Plugin: pulumi.String("canal"),
				},
			},
		})
		if err != nil {
			return err
		}
		fooNodeTemplate, err := rancher2.NewNodeTemplate(ctx, "fooNodeTemplate", &rancher2.NodeTemplateArgs{
			Description: pulumi.String("foo test"),
			Amazonec2Config: &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
	})
}

Coming soon!

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,
});

Coming soon!

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/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooClusterTemplate, err := rancher2.NewClusterTemplate(ctx, "fooClusterTemplate", &rancher2.ClusterTemplateArgs{
			Members: ClusterTemplateMemberArray{
				&ClusterTemplateMemberArgs{
					AccessType:      pulumi.String("owner"),
					UserPrincipalId: pulumi.String("local://user-XXXXX"),
				},
			},
			TemplateRevisions: ClusterTemplateTemplateRevisionArray{
				&ClusterTemplateTemplateRevisionArgs{
					Name: pulumi.String("V1"),
					ClusterConfig: &ClusterTemplateTemplateRevisionClusterConfigArgs{
						RkeConfig: &ClusterTemplateTemplateRevisionClusterConfigRkeConfigArgs{
							Network: &ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkArgs{
								Plugin: pulumi.String("canal"),
							},
							Services: &ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesArgs{
								Etcd: &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 []ClusterTemplateTemplateRevision) (string, error) {
				return templateRevisions[0].Id, nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

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=rancher2.ClusterTemplateTemplateRevisionClusterConfigRkeConfigArgs(
                network=rancher2.ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkArgs(
                    plugin="canal",
                ),
                services=rancher2.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesArgs(
                    etcd=rancher2.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdArgs(
                        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),
});

Coming soon!

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/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/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: &ClusterRkeConfigArgs{
				Network: &ClusterRkeConfigNetworkArgs{
					Plugin: pulumi.String("canal"),
				},
				Services: &ClusterRkeConfigServicesArgs{
					Etcd: &ClusterRkeConfigServicesEtcdArgs{
						Creation:  pulumi.String("6h"),
						Retention: pulumi.String("24h"),
					},
					KubeApi: &ClusterRkeConfigServicesKubeApiArgs{
						AuditLog: &ClusterRkeConfigServicesKubeApiAuditLogArgs{
							Configuration: &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: &ClusterRkeConfigUpgradeStrategyArgs{
					Drain:                pulumi.Bool(true),
					MaxUnavailableWorker: pulumi.String(fmt.Sprintf("%v%v", "20", "%")),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

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=rancher2.ClusterRkeConfigUpgradeStrategyArgs(
            drain=True,
            max_unavailable_worker="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%",
        },
    },
});

Coming soon!

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/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/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: &ClusterRkeConfigArgs{
				Network: &ClusterRkeConfigNetworkArgs{
					Plugin: pulumi.String("canal"),
				},
				Services: &ClusterRkeConfigServicesArgs{
					Etcd: &ClusterRkeConfigServicesEtcdArgs{
						Creation:  pulumi.String("6h"),
						Retention: pulumi.String("24h"),
					},
				},
			},
			ScheduledClusterScan: &ClusterScheduledClusterScanArgs{
				Enabled: pulumi.Bool(true),
				ScanConfig: &ClusterScheduledClusterScanScanConfigArgs{
					CisScanConfig: &ClusterScheduledClusterScanScanConfigCisScanConfigArgs{
						DebugMaster: pulumi.Bool(true),
						DebugWorker: pulumi.Bool(true),
					},
				},
				ScheduleConfig: &ClusterScheduledClusterScanScheduleConfigArgs{
					CronSchedule: pulumi.String("30 * * * *"),
					Retention:    pulumi.Int(5),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

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,
        },
    },
});

Coming soon!

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/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/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: &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: &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
	})
}

Coming soon!

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,
    },
});

Coming soon!

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,
                    },
                },
                PrivateAccess = true,
                PublicAccess = false,
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-rancher2/sdk/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/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: &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: &ClusterEksConfigV2Args{
				CloudCredentialId: fooCloudCredential.ID(),
				Region:            pulumi.String("<EKS_REGION>"),
				KubernetesVersion: pulumi.String("1.17"),
				LoggingTypes: pulumi.StringArray{
					pulumi.String("audit"),
					pulumi.String("api"),
				},
				NodeGroups: ClusterEksConfigV2NodeGroupArray{
					&ClusterEksConfigV2NodeGroupArgs{
						Name:         pulumi.String("node_group1"),
						InstanceType: pulumi.String("t3.medium"),
						DesiredSize:  pulumi.Int(3),
						MaxSize:      pulumi.Int(5),
					},
					&ClusterEksConfigV2NodeGroupArgs{
						Name:         pulumi.String("node_group2"),
						InstanceType: pulumi.String("m5.xlarge"),
						DesiredSize:  pulumi.Int(2),
						MaxSize:      pulumi.Int(3),
					},
				},
				PrivateAccess: pulumi.Bool(true),
				PublicAccess:  pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

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,
            ),
        ],
        private_access=True,
        public_access=False,
    ))
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,
            },
        ],
        privateAccess: true,
        publicAccess: false,
    },
});

Coming soon!

Creating EKS cluster from Rancher v2, using eks_config_v2 and launch template. For Rancher v2.5.6 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
                    {
                        DesiredSize = 3,
                        MaxSize = 5,
                        Name = "node_group1",
                        LaunchTemplates = 
                        {
                            new Rancher2.Inputs.ClusterEksConfigV2NodeGroupLaunchTemplateArgs
                            {
                                Id = "<EC2_LAUNCH_TEMPLATE_ID>",
                                Version = 1,
                            },
                        },
                    },
                },
                PrivateAccess = true,
                PublicAccess = true,
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-rancher2/sdk/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/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: &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: &ClusterEksConfigV2Args{
				CloudCredentialId: fooCloudCredential.ID(),
				Region:            pulumi.String("<EKS_REGION>"),
				KubernetesVersion: pulumi.String("1.17"),
				LoggingTypes: pulumi.StringArray{
					pulumi.String("audit"),
					pulumi.String("api"),
				},
				NodeGroups: ClusterEksConfigV2NodeGroupArray{
					&ClusterEksConfigV2NodeGroupArgs{
						DesiredSize: pulumi.Int(3),
						MaxSize:     pulumi.Int(5),
						Name:        pulumi.String("node_group1"),
						LaunchTemplates: ClusterEksConfigV2NodeGroupLaunchTemplateArray{
							&ClusterEksConfigV2NodeGroupLaunchTemplateArgs{
								Id:      pulumi.String("<EC2_LAUNCH_TEMPLATE_ID>"),
								Version: pulumi.Int(1),
							},
						},
					},
				},
				PrivateAccess: pulumi.Bool(true),
				PublicAccess:  pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

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(
            desired_size=3,
            max_size=5,
            name="node_group1",
            launch_templates=[rancher2.ClusterEksConfigV2NodeGroupLaunchTemplateArgs(
                id="<EC2_LAUNCH_TEMPLATE_ID>",
                version=1,
            )],
        )],
        private_access=True,
        public_access=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,
        region: "<EKS_REGION>",
        kubernetesVersion: "1.17",
        loggingTypes: [
            "audit",
            "api",
        ],
        nodeGroups: [{
            desiredSize: 3,
            maxSize: 5,
            name: "node_group1",
            launchTemplates: [{
                id: "<EC2_LAUNCH_TEMPLATE_ID>",
                version: 1,
            }],
        }],
        privateAccess: true,
        publicAccess: true,
    },
});

Coming soon!

Creating AKS cluster from Rancher v2, using aks_config_v2. For Rancher v2.6.0 or above (Tech preview)

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        var foo_aks = new Rancher2.CloudCredential("foo-aks", new Rancher2.CloudCredentialArgs
        {
            AzureCredentialConfig = new Rancher2.Inputs.CloudCredentialAzureCredentialConfigArgs
            {
                ClientId = "<CLIENT_ID>",
                ClientSecret = "<CLIENT_SECRET>",
                SubscriptionId = "<SUBSCRIPTION_ID>",
            },
        });
        var foo = new Rancher2.Cluster("foo", new Rancher2.ClusterArgs
        {
            Description = "Terraform AKS cluster",
            AksConfigV2 = new Rancher2.Inputs.ClusterAksConfigV2Args
            {
                CloudCredentialId = foo_aks.Id,
                ResourceGroup = "<RESOURCE_GROUP>",
                ResourceLocation = "<RESOURCE_LOCATION>",
                DnsPrefix = "<DNS_PREFIX>",
                KubernetesVersion = "1.21.2",
                NetworkPlugin = "<NETWORK_PLUGIN>",
                NodePools = 
                {
                    new Rancher2.Inputs.ClusterAksConfigV2NodePoolArgs
                    {
                        AvailabilityZones = 
                        {
                            "1",
                            "2",
                            "3",
                        },
                        Name = "<NODEPOOL_NAME>",
                        Count = 1,
                        OrchestratorVersion = "1.21.2",
                        OsDiskSizeGb = 128,
                        VmSize = "Standard_DS2_v2",
                    },
                },
            },
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.NewCloudCredential(ctx, "foo-aks", &rancher2.CloudCredentialArgs{
			AzureCredentialConfig: &CloudCredentialAzureCredentialConfigArgs{
				ClientId:       pulumi.String("<CLIENT_ID>"),
				ClientSecret:   pulumi.String("<CLIENT_SECRET>"),
				SubscriptionId: pulumi.String("<SUBSCRIPTION_ID>"),
			},
		})
		if err != nil {
			return err
		}
		_, err = rancher2.NewCluster(ctx, "foo", &rancher2.ClusterArgs{
			Description: pulumi.String("Terraform AKS cluster"),
			AksConfigV2: &ClusterAksConfigV2Args{
				CloudCredentialId: foo_aks.ID(),
				ResourceGroup:     pulumi.String("<RESOURCE_GROUP>"),
				ResourceLocation:  pulumi.String("<RESOURCE_LOCATION>"),
				DnsPrefix:         pulumi.String("<DNS_PREFIX>"),
				KubernetesVersion: pulumi.String("1.21.2"),
				NetworkPlugin:     pulumi.String("<NETWORK_PLUGIN>"),
				NodePools: ClusterAksConfigV2NodePoolArray{
					&ClusterAksConfigV2NodePoolArgs{
						AvailabilityZones: pulumi.StringArray{
							pulumi.String("1"),
							pulumi.String("2"),
							pulumi.String("3"),
						},
						Name:                pulumi.String("<NODEPOOL_NAME>"),
						Count:               pulumi.Int(1),
						OrchestratorVersion: pulumi.String("1.21.2"),
						OsDiskSizeGb:        pulumi.Int(128),
						VmSize:              pulumi.String("Standard_DS2_v2"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_rancher2 as rancher2

foo_aks = rancher2.CloudCredential("foo-aks", azure_credential_config=rancher2.CloudCredentialAzureCredentialConfigArgs(
    client_id="<CLIENT_ID>",
    client_secret="<CLIENT_SECRET>",
    subscription_id="<SUBSCRIPTION_ID>",
))
foo = rancher2.Cluster("foo",
    description="Terraform AKS cluster",
    aks_config_v2=rancher2.ClusterAksConfigV2Args(
        cloud_credential_id=foo_aks.id,
        resource_group="<RESOURCE_GROUP>",
        resource_location="<RESOURCE_LOCATION>",
        dns_prefix="<DNS_PREFIX>",
        kubernetes_version="1.21.2",
        network_plugin="<NETWORK_PLUGIN>",
        node_pools=[rancher2.ClusterAksConfigV2NodePoolArgs(
            availability_zones=[
                "1",
                "2",
                "3",
            ],
            name="<NODEPOOL_NAME>",
            count=1,
            orchestrator_version="1.21.2",
            os_disk_size_gb=128,
            vm_size="Standard_DS2_v2",
        )],
    ))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo_aks = new rancher2.CloudCredential("foo-aks", {azureCredentialConfig: {
    clientId: "<CLIENT_ID>",
    clientSecret: "<CLIENT_SECRET>",
    subscriptionId: "<SUBSCRIPTION_ID>",
}});
const foo = new rancher2.Cluster("foo", {
    description: "Terraform AKS cluster",
    aksConfigV2: {
        cloudCredentialId: foo_aks.id,
        resourceGroup: "<RESOURCE_GROUP>",
        resourceLocation: "<RESOURCE_LOCATION>",
        dnsPrefix: "<DNS_PREFIX>",
        kubernetesVersion: "1.21.2",
        networkPlugin: "<NETWORK_PLUGIN>",
        nodePools: [{
            availabilityZones: [
                "1",
                "2",
                "3",
            ],
            name: "<NODEPOOL_NAME>",
            count: 1,
            orchestratorVersion: "1.21.2",
            osDiskSizeGb: 128,
            vmSize: "Standard_DS2_v2",
        }],
    },
});

Coming soon!

Create a Cluster Resource

new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            agent_env_vars: Optional[Sequence[ClusterAgentEnvVarArgs]] = None,
            aks_config: Optional[ClusterAksConfigArgs] = None,
            aks_config_v2: Optional[ClusterAksConfigV2Args] = 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,
            fleet_workspace_name: Optional[str] = None,
            gke_config: Optional[ClusterGkeConfigArgs] = None,
            gke_config_v2: Optional[ClusterGkeConfigV2Args] = None,
            k3s_config: Optional[ClusterK3sConfigArgs] = None,
            labels: Optional[Mapping[str, Any]] = None,
            name: Optional[str] = None,
            oke_config: Optional[ClusterOkeConfigArgs] = None,
            rke2_config: Optional[ClusterRke2ConfigArgs] = None,
            rke_config: Optional[ClusterRkeConfigArgs] = None,
            scheduled_cluster_scan: Optional[ClusterScheduledClusterScanArgs] = None,
            windows_prefered_cluster: Optional[bool] = None)
@overload
def Cluster(resource_name: str,
            args: Optional[ClusterArgs] = None,
            opts: Optional[ResourceOptions] = None)
func NewCluster(ctx *Context, name string, args *ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs? args = null, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
type: rancher2:Cluster
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control 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.
name String
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The Cluster resource accepts the following input properties:

AgentEnvVars List<ClusterAgentEnvVarArgs>

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

AksConfig ClusterAksConfigArgs

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

AksConfigV2 ClusterAksConfigV2Args

The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with aks_config, eks_config, eks_config_v2, gke_config, gke_config_v2, 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, aks_config_v2, eks_config_v2, gke_config, gke_config_v2, oke_config k3s_config and rke_config (list maxitems:1)

EksConfigV2 ClusterEksConfigV2Args

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, eks_config, gke_config, gke_config_v2, 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)

FleetWorkspaceName string

Fleet workspace name (string)

GkeConfig ClusterGkeConfigArgs

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

GkeConfigV2 ClusterGkeConfigV2Args

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

K3sConfig ClusterK3sConfigArgs

The K3S configuration for k3s imported Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, k3s_config and rke_config (list maxitems:1)

Rke2Config ClusterRke2ConfigArgs

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

RkeConfig ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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)

AgentEnvVars []ClusterAgentEnvVarArgs

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

AksConfig ClusterAksConfigArgs

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

AksConfigV2 ClusterAksConfigV2Args

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

Annotations map[string]interface{}

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

EksConfigV2 ClusterEksConfigV2Args

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, eks_config, gke_config, gke_config_v2, 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)

FleetWorkspaceName string

Fleet workspace name (string)

GkeConfig ClusterGkeConfigArgs

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

GkeConfigV2 ClusterGkeConfigV2Args

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

K3sConfig ClusterK3sConfigArgs

The K3S configuration for k3s imported Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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 ClusterOkeConfigArgs

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

Rke2Config ClusterRke2ConfigArgs

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

RkeConfig ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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)

agentEnvVars List<ClusterAgentEnvVarArgs>

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

aksConfig ClusterAksConfigArgs

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

aksConfigV2 ClusterAksConfigV2Args

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

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

eksConfigV2 ClusterEksConfigV2Args

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, eks_config, gke_config, gke_config_v2, 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)

fleetWorkspaceName String

Fleet workspace name (string)

gkeConfig ClusterGkeConfigArgs

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

gkeConfigV2 ClusterGkeConfigV2Args

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

k3sConfig ClusterK3sConfigArgs

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

labels Map<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, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, k3s_config and rke_config (list maxitems:1)

rke2Config ClusterRke2ConfigArgs

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

rkeConfig ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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 Boolean

Windows preferred cluster. Default: false (bool)

agentEnvVars ClusterAgentEnvVarArgs[]

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

aksConfig ClusterAksConfigArgs

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

aksConfigV2 ClusterAksConfigV2Args

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

annotations {[key: string]: any}

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

eksConfigV2 ClusterEksConfigV2Args

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, eks_config, gke_config, gke_config_v2, 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)

fleetWorkspaceName string

Fleet workspace name (string)

gkeConfig ClusterGkeConfigArgs

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

gkeConfigV2 ClusterGkeConfigV2Args

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

k3sConfig ClusterK3sConfigArgs

The K3S configuration for k3s imported Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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 ClusterOkeConfigArgs

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

rke2Config ClusterRke2ConfigArgs

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

rkeConfig ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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 boolean

Windows preferred cluster. Default: false (bool)

agent_env_vars Sequence[ClusterAgentEnvVarArgs]

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

aks_config ClusterAksConfigArgs

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

aks_config_v2 ClusterAksConfigV2Args

The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with aks_config, eks_config, eks_config_v2, gke_config, gke_config_v2, 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, aks_config_v2, eks_config_v2, gke_config, gke_config_v2, oke_config k3s_config and rke_config (list maxitems:1)

eks_config_v2 ClusterEksConfigV2Args

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, eks_config, gke_config, gke_config_v2, 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)

fleet_workspace_name str

Fleet workspace name (string)

gke_config ClusterGkeConfigArgs

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

gke_config_v2 ClusterGkeConfigV2Args

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

k3s_config ClusterK3sConfigArgs

The K3S configuration for k3s imported Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, k3s_config and rke_config (list maxitems:1)

rke2_config ClusterRke2ConfigArgs

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

rke_config ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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)

agentEnvVars List<Property Map>

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

aksConfig Property Map

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

aksConfigV2 Property Map

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

annotations Map<Any>

Annotations for cluster registration token object (map)

clusterAuthEndpoint Property Map

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

clusterMonitoringInput Property Map

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

clusterTemplateAnswers Property Map

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<Property Map>

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 Property Map

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

eksConfigV2 Property Map

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, eks_config, gke_config, gke_config_v2, 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)

fleetWorkspaceName String

Fleet workspace name (string)

gkeConfig Property Map

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

gkeConfigV2 Property Map

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

k3sConfig Property Map

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

labels Map<Any>

Labels for cluster registration token object (map)

name String

Name of cluster registration token (string)

okeConfig Property Map

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

rke2Config Property Map

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

rkeConfig Property Map

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

scheduledClusterScan Property Map

Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)

windowsPreferedCluster Boolean

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. Note: For Rancher 2.6.0 and above, when the cluster has cluster_auth_endpoint enabled, the kube_config will not be available until the cluster is connected (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. Note: For Rancher 2.6.0 and above, when the cluster has cluster_auth_endpoint enabled, the kube_config will not be available until the cluster is connected (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. Note: For Rancher 2.6.0 and above, when the cluster has cluster_auth_endpoint enabled, the kube_config will not be available until the cluster is connected (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. Note: For Rancher 2.6.0 and above, when the cluster has cluster_auth_endpoint enabled, the kube_config will not be available until the cluster is connected (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. Note: For Rancher 2.6.0 and above, when the cluster has cluster_auth_endpoint enabled, the kube_config will not be available until the cluster is connected (string)

system_project_id str

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

caCert String

TLS CA certificate for etcd service (string)

clusterRegistrationToken Property Map

(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. Note: For Rancher 2.6.0 and above, when the cluster has cluster_auth_endpoint enabled, the kube_config will not be available until the cluster is connected (string)

systemProjectId String

(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,
        agent_env_vars: Optional[Sequence[ClusterAgentEnvVarArgs]] = None,
        aks_config: Optional[ClusterAksConfigArgs] = None,
        aks_config_v2: Optional[ClusterAksConfigV2Args] = 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,
        fleet_workspace_name: Optional[str] = None,
        gke_config: Optional[ClusterGkeConfigArgs] = None,
        gke_config_v2: Optional[ClusterGkeConfigV2Args] = 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,
        rke2_config: Optional[ClusterRke2ConfigArgs] = 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)
public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
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:
AgentEnvVars List<ClusterAgentEnvVarArgs>

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

AksConfig ClusterAksConfigArgs

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

AksConfigV2 ClusterAksConfigV2Args

The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with aks_config, eks_config, eks_config_v2, gke_config, gke_config_v2, 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, aks_config_v2, eks_config_v2, gke_config, gke_config_v2, oke_config k3s_config and rke_config (list maxitems:1)

EksConfigV2 ClusterEksConfigV2Args

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, eks_config, gke_config, gke_config_v2, 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)

FleetWorkspaceName string

Fleet workspace name (string)

GkeConfig ClusterGkeConfigArgs

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

GkeConfigV2 ClusterGkeConfigV2Args

The Google GKE V2 configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, oke_config, k3s_config and rke_config. For Rancher v2.5.8 or above (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, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and rke_config (list maxitems:1)

KubeConfig string

(Computed/Sensitive) Kube Config generated for the cluster. Note: For Rancher 2.6.0 and above, when the cluster has cluster_auth_endpoint enabled, the kube_config will not be available until the cluster is connected (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, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, k3s_config and rke_config (list maxitems:1)

Rke2Config ClusterRke2ConfigArgs

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

RkeConfig ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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)

AgentEnvVars []ClusterAgentEnvVarArgs

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

AksConfig ClusterAksConfigArgs

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

AksConfigV2 ClusterAksConfigV2Args

The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with aks_config, eks_config, eks_config_v2, gke_config, gke_config_v2, 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 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 []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, aks_config_v2, eks_config_v2, gke_config, gke_config_v2, oke_config k3s_config and rke_config (list maxitems:1)

EksConfigV2 ClusterEksConfigV2Args

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, eks_config, gke_config, gke_config_v2, 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)

FleetWorkspaceName string

Fleet workspace name (string)

GkeConfig ClusterGkeConfigArgs

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

GkeConfigV2 ClusterGkeConfigV2Args

The Google GKE V2 configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, oke_config, k3s_config and rke_config. For Rancher v2.5.8 or above (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, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and rke_config (list maxitems:1)

KubeConfig string

(Computed/Sensitive) Kube Config generated for the cluster. Note: For Rancher 2.6.0 and above, when the cluster has cluster_auth_endpoint enabled, the kube_config will not be available until the cluster is connected (string)

Labels map[string]interface{}

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

Rke2Config ClusterRke2ConfigArgs

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

RkeConfig ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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)

agentEnvVars List<ClusterAgentEnvVarArgs>

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

aksConfig ClusterAksConfigArgs

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

aksConfigV2 ClusterAksConfigV2Args

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

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

eksConfigV2 ClusterEksConfigV2Args

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, eks_config, gke_config, gke_config_v2, 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)

fleetWorkspaceName String

Fleet workspace name (string)

gkeConfig ClusterGkeConfigArgs

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

gkeConfigV2 ClusterGkeConfigV2Args

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

istioEnabled Boolean

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

kubeConfig String

(Computed/Sensitive) Kube Config generated for the cluster. Note: For Rancher 2.6.0 and above, when the cluster has cluster_auth_endpoint enabled, the kube_config will not be available until the cluster is connected (string)

labels Map<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, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, k3s_config and rke_config (list maxitems:1)

rke2Config ClusterRke2ConfigArgs

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

rkeConfig ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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 Boolean

Windows preferred cluster. Default: false (bool)

agentEnvVars ClusterAgentEnvVarArgs[]

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

aksConfig ClusterAksConfigArgs

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

aksConfigV2 ClusterAksConfigV2Args

The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with aks_config, eks_config, eks_config_v2, gke_config, gke_config_v2, 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 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 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, aks_config_v2, eks_config_v2, gke_config, gke_config_v2, oke_config k3s_config and rke_config (list maxitems:1)

eksConfigV2 ClusterEksConfigV2Args

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, eks_config, gke_config, gke_config_v2, 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)

fleetWorkspaceName string

Fleet workspace name (string)

gkeConfig ClusterGkeConfigArgs

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

gkeConfigV2 ClusterGkeConfigV2Args

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

istioEnabled boolean

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

kubeConfig string

(Computed/Sensitive) Kube Config generated for the cluster. Note: For Rancher 2.6.0 and above, when the cluster has cluster_auth_endpoint enabled, the kube_config will not be available until the cluster is connected (string)

labels {[key: string]: any}

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

rke2Config ClusterRke2ConfigArgs

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

rkeConfig ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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 boolean

Windows preferred cluster. Default: false (bool)

agent_env_vars Sequence[ClusterAgentEnvVarArgs]

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

aks_config ClusterAksConfigArgs

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

aks_config_v2 ClusterAksConfigV2Args

The Azure AKS v2 configuration for creating/import aks Clusters. Conflicts with aks_config, eks_config, eks_config_v2, gke_config, gke_config_v2, 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, aks_config_v2, eks_config_v2, gke_config, gke_config_v2, oke_config k3s_config and rke_config (list maxitems:1)

eks_config_v2 ClusterEksConfigV2Args

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, eks_config, gke_config, gke_config_v2, 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)

fleet_workspace_name str

Fleet workspace name (string)

gke_config ClusterGkeConfigArgs

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

gke_config_v2 ClusterGkeConfigV2Args

The Google GKE V2 configuration for gke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, oke_config, k3s_config and rke_config. For Rancher v2.5.8 or above (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, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, oke_config and rke_config (list maxitems:1)

kube_config str

(Computed/Sensitive) Kube Config generated for the cluster. Note: For Rancher 2.6.0 and above, when the cluster has cluster_auth_endpoint enabled, the kube_config will not be available until the cluster is connected (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, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, k3s_config and rke_config (list maxitems:1)

rke2_config ClusterRke2ConfigArgs

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

rke_config ClusterRkeConfigArgs

The RKE configuration for rke Clusters. Conflicts with aks_config, aks_config_v2, eks_config, eks_config_v2, gke_config, gke_config_v2, 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)

agentEnvVars List<Property Map>

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

aksConfig Property Map

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

aksConfigV2 Property Map

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

annotations Map<Any>

Annotations for cluster registration token object (map)

caCert String

TLS CA certificate for etcd service (string)

clusterAuthEndpoint Property Map

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

clusterMonitoringInput Property Map

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

clusterRegistrationToken Property Map

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

clusterTemplateAnswers Property Map

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<Property Map>

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 Property Map

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

eksConfigV2 Property Map

The Amazon EKS V2 configuration to create or import eks Clusters. Conflicts with aks_config, eks_config, gke_config, gke_config_v2, 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)

fleetWorkspaceName String

Fleet workspace name (string)

gkeConfig Property Map

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

gkeConfigV2 Property Map

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

istioEnabled Boolean

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

k3sConfig Property Map

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

kubeConfig String

(Computed/Sensitive) Kube Config generated for the cluster. Note: For Rancher 2.6.0 and above, when the cluster has cluster_auth_endpoint enabled, the kube_config will not be available until the cluster is connected (string)

labels Map<Any>

Labels for cluster registration token object (map)

name String

Name of cluster registration token (string)

okeConfig Property Map

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

rke2Config Property Map

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

rkeConfig Property Map

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

scheduledClusterScan Property Map

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)

Supporting Types

ClusterAgentEnvVar

Name string

Name of cluster registration token (string)

Value string

The GKE taint value (string)

Name string

Name of cluster registration token (string)

Value string

The GKE taint value (string)

name String

Name of cluster registration token (string)

value String

The GKE taint value (string)

name string

Name of cluster registration token (string)

value string

The GKE taint value (string)

name str

Name of cluster registration token (string)

value str

The GKE taint value (string)

name String

Name of cluster registration token (string)

value String

The GKE taint value (string)

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 AKS resource group (string)

SshPublicKeyContents string

Contents of the SSH public key used to authenticate with Linux hosts (string)

Subnet string

The AKS subnet (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 AKS virtual network resource group (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

The AKS auth base url (string)

BaseUrl string

The AKS base url (string)

Count int

The AKS node pool count. 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)

LoadBalancerSku string

The AKS load balancer sku (string)

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

The AKS node pool max pods. Default: 110 (int)

NetworkPlugin string

The AKS network plugin. Required if imported=false (string)

NetworkPolicy string

The AKS network policy (string)

PodCidr string

A CIDR IP range from which to assign Kubernetes Pod IPs (string)

ServiceCidr string

A CIDR IP range from which to assign Kubernetes Service IPs (string)

Tag Dictionary<string, object>

Use tags argument instead as []string

Deprecated:

Use tags argument instead as []string

Tags List<string>

The GKE node config tags (List)

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 AKS resource group (string)

SshPublicKeyContents string

Contents of the SSH public key used to authenticate with Linux hosts (string)

Subnet string

The AKS subnet (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 AKS virtual network resource group (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

The AKS auth base url (string)

BaseUrl string

The AKS base url (string)

Count int

The AKS node pool count. 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)

LoadBalancerSku string

The AKS load balancer sku (string)

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

The AKS node pool max pods. Default: 110 (int)

NetworkPlugin string

The AKS network plugin. Required if imported=false (string)

NetworkPolicy string

The AKS network policy (string)

PodCidr string

A CIDR IP range from which to assign Kubernetes Pod IPs (string)

ServiceCidr string

A CIDR IP range from which to assign Kubernetes Service IPs (string)

Tag map[string]interface{}

Use tags argument instead as []string

Deprecated:

Use tags argument instead as []string

Tags []string

The GKE node config tags (List)

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 AKS resource group (string)

sshPublicKeyContents String

Contents of the SSH public key used to authenticate with Linux hosts (string)

subnet String

The AKS subnet (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 AKS virtual network resource group (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 Integer

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

The AKS auth base url (string)

baseUrl String

The AKS base url (string)

count Integer

The AKS node pool count. 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)

loadBalancerSku String

The AKS load balancer sku (string)

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 Integer

The AKS node pool max pods. Default: 110 (int)

networkPlugin String

The AKS network plugin. Required if imported=false (string)

networkPolicy String

The AKS network policy (string)

podCidr String

A CIDR IP range from which to assign Kubernetes Pod IPs (string)

serviceCidr String

A CIDR IP range from which to assign Kubernetes Service IPs (string)

tag Map<String,Object>

Use tags argument instead as []string

Deprecated:

Use tags argument instead as []string

tags List<String>

The GKE node config tags (List)

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 AKS resource group (string)

sshPublicKeyContents string

Contents of the SSH public key used to authenticate with Linux hosts (string)

subnet string

The AKS subnet (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 AKS virtual network resource group (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

The AKS auth base url (string)

baseUrl string

The AKS base url (string)

count number

The AKS node pool count. 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)

loadBalancerSku string

The AKS load balancer sku (string)

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

The AKS node pool max pods. Default: 110 (int)

networkPlugin string

The AKS network plugin. Required if imported=false (string)

networkPolicy string

The AKS network policy (string)

podCidr string

A CIDR IP range from which to assign Kubernetes Pod IPs (string)

serviceCidr string

A CIDR IP range from which to assign Kubernetes Service IPs (string)

tag {[key: string]: any}

Use tags argument instead as []string

Deprecated:

Use tags argument instead as []string

tags string[]

The GKE node config tags (List)

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 AKS resource group (string)

ssh_public_key_contents str

Contents of the SSH public key used to authenticate with Linux hosts (string)

subnet str

The AKS subnet (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 AKS virtual network resource group (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

The AKS auth base url (string)

base_url str

The AKS base url (string)

count int

The AKS node pool count. 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)

load_balancer_sku str

The AKS load balancer sku (string)

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

The AKS node pool max pods. Default: 110 (int)

network_plugin str

The AKS network plugin. Required if imported=false (string)

network_policy str

The AKS network policy (string)

pod_cidr str

A CIDR IP range from which to assign Kubernetes Pod IPs (string)

service_cidr str

A CIDR IP range from which to assign Kubernetes Service IPs (string)

tag Mapping[str, Any]

Use tags argument instead as []string

Deprecated:

Use tags argument instead as []string

tags Sequence[str]

The GKE node config tags (List)

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 AKS resource group (string)

sshPublicKeyContents String

Contents of the SSH public key used to authenticate with Linux hosts (string)

subnet String

The AKS subnet (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 AKS virtual network resource group (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

The AKS auth base url (string)

baseUrl String

The AKS base url (string)

count Number

The AKS node pool count. 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)

loadBalancerSku String

The AKS load balancer sku (string)

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

The AKS node pool max pods. Default: 110 (int)

networkPlugin String

The AKS network plugin. Required if imported=false (string)

networkPolicy String

The AKS network policy (string)

podCidr String

A CIDR IP range from which to assign Kubernetes Pod IPs (string)

serviceCidr String

A CIDR IP range from which to assign Kubernetes Service IPs (string)

tag Map<Any>

Use tags argument instead as []string

Deprecated:

Use tags argument instead as []string

tags List<String>

The GKE node config tags (List)

ClusterAksConfigV2

CloudCredentialId string

The EKS cloud_credential id (string)

ResourceGroup string

The AKS resource group (string)

ResourceLocation string

The AKS resource location (string)

AuthBaseUrl string

The AKS auth base url (string)

AuthorizedIpRanges List<string>

The AKS authorized ip ranges (list)

BaseUrl string

The AKS base url (string)

DnsPrefix string

The AKS dns prefix. Required if imported=false (string)

HttpApplicationRouting bool

Enable AKS http application routing? (bool)

Imported bool

Is GKE cluster imported? Default: false (bool)

KubernetesVersion string

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

LinuxAdminUsername string

The AKS linux admin username (string)

LinuxSshPublicKey string

The AKS linux ssh public key (string)

LoadBalancerSku string

The AKS load balancer sku (string)

LogAnalyticsWorkspaceGroup string

The AKS log analytics workspace group (string)

LogAnalyticsWorkspaceName string

The AKS log analytics workspace name (string)

Monitoring bool

Is AKS cluster monitoring enabled? (bool)

Name string

Name of cluster registration token (string)

NetworkDnsServiceIp string

The AKS network dns service ip (string)

NetworkDockerBridgeCidr string

The AKS network docker bridge cidr (string)

NetworkPlugin string

The AKS network plugin. Required if imported=false (string)

NetworkPodCidr string

The AKS network pod cidr (string)

NetworkPolicy string

The AKS network policy (string)

NetworkServiceCidr string

The AKS network service cidr (string)

NodePools List<ClusterAksConfigV2NodePool>

The GKE cluster node pools. Required for create new cluster (List)

PrivateCluster bool

Is AKS cluster private? (bool)

Subnet string

The AKS subnet (string)

Tags Dictionary<string, object>

The GKE node config tags (List)

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 AKS virtual network resource group (string)

CloudCredentialId string

The EKS cloud_credential id (string)

ResourceGroup string

The AKS resource group (string)

ResourceLocation string

The AKS resource location (string)

AuthBaseUrl string

The AKS auth base url (string)

AuthorizedIpRanges []string

The AKS authorized ip ranges (list)

BaseUrl string

The AKS base url (string)

DnsPrefix string

The AKS dns prefix. Required if imported=false (string)

HttpApplicationRouting bool

Enable AKS http application routing? (bool)

Imported bool

Is GKE cluster imported? Default: false (bool)

KubernetesVersion string

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

LinuxAdminUsername string

The AKS linux admin username (string)

LinuxSshPublicKey string

The AKS linux ssh public key (string)

LoadBalancerSku string

The AKS load balancer sku (string)

LogAnalyticsWorkspaceGroup string

The AKS log analytics workspace group (string)

LogAnalyticsWorkspaceName string

The AKS log analytics workspace name (string)

Monitoring bool

Is AKS cluster monitoring enabled? (bool)

Name string

Name of cluster registration token (string)

NetworkDnsServiceIp string

The AKS network dns service ip (string)

NetworkDockerBridgeCidr string

The AKS network docker bridge cidr (string)

NetworkPlugin string

The AKS network plugin. Required if imported=false (string)

NetworkPodCidr string

The AKS network pod cidr (string)

NetworkPolicy string

The AKS network policy (string)

NetworkServiceCidr string

The AKS network service cidr (string)

NodePools []ClusterAksConfigV2NodePool

The GKE cluster node pools. Required for create new cluster (List)

PrivateCluster bool

Is AKS cluster private? (bool)

Subnet string

The AKS subnet (string)

Tags map[string]interface{}

The GKE node config tags (List)

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 AKS virtual network resource group (string)

cloudCredentialId String

The EKS cloud_credential id (string)

resourceGroup String

The AKS resource group (string)

resourceLocation String

The AKS resource location (string)

authBaseUrl String

The AKS auth base url (string)

authorizedIpRanges List<String>

The AKS authorized ip ranges (list)

baseUrl String

The AKS base url (string)

dnsPrefix String

The AKS dns prefix. Required if imported=false (string)

httpApplicationRouting Boolean

Enable AKS http application routing? (bool)

imported Boolean

Is GKE cluster imported? Default: false (bool)

kubernetesVersion String

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

linuxAdminUsername String

The AKS linux admin username (string)

linuxSshPublicKey String

The AKS linux ssh public key (string)

loadBalancerSku String

The AKS load balancer sku (string)

logAnalyticsWorkspaceGroup String

The AKS log analytics workspace group (string)

logAnalyticsWorkspaceName String

The AKS log analytics workspace name (string)

monitoring Boolean

Is AKS cluster monitoring enabled? (bool)

name String

Name of cluster registration token (string)

networkDnsServiceIp String

The AKS network dns service ip (string)

networkDockerBridgeCidr String

The AKS network docker bridge cidr (string)

networkPlugin String

The AKS network plugin. Required if imported=false (string)

networkPodCidr String

The AKS network pod cidr (string)

networkPolicy String

The AKS network policy (string)

networkServiceCidr String

The AKS network service cidr (string)

nodePools List<ClusterAksConfigV2NodePool>

The GKE cluster node pools. Required for create new cluster (List)

privateCluster Boolean

Is AKS cluster private? (bool)

subnet String

The AKS subnet (string)

tags Map<String,Object>

The GKE node config tags (List)

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 AKS virtual network resource group (string)

cloudCredentialId string

The EKS cloud_credential id (string)

resourceGroup string

The AKS resource group (string)

resourceLocation string

The AKS resource location (string)

authBaseUrl string

The AKS auth base url (string)

authorizedIpRanges string[]

The AKS authorized ip ranges (list)

baseUrl string

The AKS base url (string)

dnsPrefix string

The AKS dns prefix. Required if imported=false (string)

httpApplicationRouting boolean

Enable AKS http application routing? (bool)

imported boolean

Is GKE cluster imported? Default: false (bool)

kubernetesVersion string

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

linuxAdminUsername string

The AKS linux admin username (string)

linuxSshPublicKey string

The AKS linux ssh public key (string)

loadBalancerSku string

The AKS load balancer sku (string)

logAnalyticsWorkspaceGroup string

The AKS log analytics workspace group (string)

logAnalyticsWorkspaceName string

The AKS log analytics workspace name (string)

monitoring boolean

Is AKS cluster monitoring enabled? (bool)

name string

Name of cluster registration token (string)

networkDnsServiceIp string

The AKS network dns service ip (string)

networkDockerBridgeCidr string

The AKS network docker bridge cidr (string)

networkPlugin string

The AKS network plugin. Required if imported=false (string)

networkPodCidr string

The AKS network pod cidr (string)

networkPolicy string

The AKS network policy (string)

networkServiceCidr string

The AKS network service cidr (string)

nodePools ClusterAksConfigV2NodePool[]

The GKE cluster node pools. Required for create new cluster (List)

privateCluster boolean

Is AKS cluster private? (bool)

subnet string

The AKS subnet (string)

tags {[key: string]: any}

The GKE node config tags (List)

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 AKS virtual network resource group (string)

cloud_credential_id str

The EKS cloud_credential id (string)

resource_group str

The AKS resource group (string)

resource_location str

The AKS resource location (string)

auth_base_url str

The AKS auth base url (string)

authorized_ip_ranges Sequence[str]

The AKS authorized ip ranges (list)

base_url str

The AKS base url (string)

dns_prefix str

The AKS dns prefix. Required if imported=false (string)

http_application_routing bool

Enable AKS http application routing? (bool)

imported bool

Is GKE cluster imported? Default: false (bool)

kubernetes_version str

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

linux_admin_username str

The AKS linux admin username (string)

linux_ssh_public_key str

The AKS linux ssh public key (string)

load_balancer_sku str

The AKS load balancer sku (string)

log_analytics_workspace_group str

The AKS log analytics workspace group (string)

log_analytics_workspace_name str

The AKS log analytics workspace name (string)

monitoring bool

Is AKS cluster monitoring enabled? (bool)

name str

Name of cluster registration token (string)

network_dns_service_ip str

The AKS network dns service ip (string)

network_docker_bridge_cidr str

The AKS network docker bridge cidr (string)

network_plugin str

The AKS network plugin. Required if imported=false (string)

network_pod_cidr str

The AKS network pod cidr (string)

network_policy str

The AKS network policy (string)

network_service_cidr str

The AKS network service cidr (string)

node_pools Sequence[ClusterAksConfigV2NodePool]

The GKE cluster node pools. Required for create new cluster (List)

private_cluster bool

Is AKS cluster private? (bool)

subnet str

The AKS subnet (string)

tags Mapping[str, Any]

The GKE node config tags (List)

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 AKS virtual network resource group (string)

cloudCredentialId String

The EKS cloud_credential id (string)

resourceGroup String

The AKS resource group (string)

resourceLocation String

The AKS resource location (string)

authBaseUrl String

The AKS auth base url (string)

authorizedIpRanges List<String>

The AKS authorized ip ranges (list)

baseUrl String

The AKS base url (string)

dnsPrefix String

The AKS dns prefix. Required if imported=false (string)

httpApplicationRouting Boolean

Enable AKS http application routing? (bool)

imported Boolean

Is GKE cluster imported? Default: false (bool)

kubernetesVersion String

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

linuxAdminUsername String

The AKS linux admin username (string)

linuxSshPublicKey String

The AKS linux ssh public key (string)

loadBalancerSku String

The AKS load balancer sku (string)

logAnalyticsWorkspaceGroup String

The AKS log analytics workspace group (string)

logAnalyticsWorkspaceName String

The AKS log analytics workspace name (string)

monitoring Boolean

Is AKS cluster monitoring enabled? (bool)

name String

Name of cluster registration token (string)

networkDnsServiceIp String

The AKS network dns service ip (string)

networkDockerBridgeCidr String

The AKS network docker bridge cidr (string)

networkPlugin String

The AKS network plugin. Required if imported=false (string)

networkPodCidr String

The AKS network pod cidr (string)

networkPolicy String

The AKS network policy (string)

networkServiceCidr String

The AKS network service cidr (string)

nodePools List<Property Map>

The GKE cluster node pools. Required for create new cluster (List)

privateCluster Boolean

Is AKS cluster private? (bool)

subnet String

The AKS subnet (string)

tags Map<Any>

The GKE node config tags (List)

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 AKS virtual network resource group (string)

ClusterAksConfigV2NodePool

Name string

Name of cluster registration token (string)

AvailabilityZones List<string>

The AKS node pool availability zones (list)

Count int

The AKS node pool count. Default: 1 (int)

EnableAutoScaling bool

Is AKS node pool auto scaling enabled? Default: false (bool)

MaxCount int

The AKS node pool max count. Required if enable_auto_scaling=true (int)

MaxPods int

The AKS node pool max pods. Default: 110 (int)

MinCount int

The AKS node pool min count. Required if enable_auto_scaling=true (int)

Mode string

The AKS node group mode. Default: System (string)

OrchestratorVersion string

The AKS node pool orchestrator version (string)

OsDiskSizeGb int

The AKS node pool os disk size gb. Default: 128 (int)

OsDiskType string

The AKS node pool os disk type. Default: Managed (string)

OsType string

The AKS node pool os type. Default: Linux (string)

VmSize string

The AKS node pool orchestrator version (string)

Name string

Name of cluster registration token (string)

AvailabilityZones []string

The AKS node pool availability zones (list)

Count int

The AKS node pool count. Default: 1 (int)

EnableAutoScaling bool

Is AKS node pool auto scaling enabled? Default: false (bool)

MaxCount int

The AKS node pool max count. Required if enable_auto_scaling=true (int)

MaxPods int

The AKS node pool max pods. Default: 110 (int)

MinCount int

The AKS node pool min count. Required if enable_auto_scaling=true (int)

Mode string

The AKS node group mode. Default: System (string)

OrchestratorVersion string

The AKS node pool orchestrator version (string)

OsDiskSizeGb int

The AKS node pool os disk size gb. Default: 128 (int)

OsDiskType string

The AKS node pool os disk type. Default: Managed (string)

OsType string

The AKS node pool os type. Default: Linux (string)

VmSize string

The AKS node pool orchestrator version (string)

name String

Name of cluster registration token (string)

availabilityZones List<String>

The AKS node pool availability zones (list)

count Integer

The AKS node pool count. Default: 1 (int)

enableAutoScaling Boolean

Is AKS node pool auto scaling enabled? Default: false (bool)

maxCount Integer

The AKS node pool max count. Required if enable_auto_scaling=true (int)

maxPods Integer

The AKS node pool max pods. Default: 110 (int)

minCount Integer

The AKS node pool min count. Required if enable_auto_scaling=true (int)

mode String

The AKS node group mode. Default: System (string)

orchestratorVersion String

The AKS node pool orchestrator version (string)

osDiskSizeGb Integer

The AKS node pool os disk size gb. Default: 128 (int)

osDiskType String

The AKS node pool os disk type. Default: Managed (string)

osType String

The AKS node pool os type. Default: Linux (string)

vmSize String

The AKS node pool orchestrator version (string)

name string

Name of cluster registration token (string)

availabilityZones string[]

The AKS node pool availability zones (list)

count number

The AKS node pool count. Default: 1 (int)

enableAutoScaling boolean

Is AKS node pool auto scaling enabled? Default: false (bool)

maxCount number

The AKS node pool max count. Required if enable_auto_scaling=true (int)

maxPods number

The AKS node pool max pods. Default: 110 (int)

minCount number

The AKS node pool min count. Required if enable_auto_scaling=true (int)

mode string

The AKS node group mode. Default: System (string)

orchestratorVersion string

The AKS node pool orchestrator version (string)

osDiskSizeGb number

The AKS node pool os disk size gb. Default: 128 (int)

osDiskType string

The AKS node pool os disk type. Default: Managed (string)

osType string

The AKS node pool os type. Default: Linux (string)

vmSize string

The AKS node pool orchestrator version (string)

name str

Name of cluster registration token (string)

availability_zones Sequence[str]

The AKS node pool availability zones (list)

count int

The AKS node pool count. Default: 1 (int)

enable_auto_scaling bool

Is AKS node pool auto scaling enabled? Default: false (bool)

max_count int

The AKS node pool max count. Required if enable_auto_scaling=true (int)

max_pods int

The AKS node pool max pods. Default: 110 (int)

min_count int

The AKS node pool min count. Required if enable_auto_scaling=true (int)

mode str

The AKS node group mode. Default: System (string)

orchestrator_version str

The AKS node pool orchestrator version (string)

os_disk_size_gb int

The AKS node pool os disk size gb. Default: 128 (int)

os_disk_type str

The AKS node pool os disk type. Default: Managed (string)

os_type str

The AKS node pool os type. Default: Linux (string)

vm_size str

The AKS node pool orchestrator version (string)

name String

Name of cluster registration token (string)

availabilityZones List<String>

The AKS node pool availability zones (list)

count Number

The AKS node pool count. Default: 1 (int)

enableAutoScaling Boolean

Is AKS node pool auto scaling enabled? Default: false (bool)

maxCount Number

The AKS node pool max count. Required if enable_auto_scaling=true (int)

maxPods Number

The AKS node pool max pods. Default: 110 (int)

minCount Number

The AKS node pool min count. Required if enable_auto_scaling=true (int)

mode String

The AKS node group mode. Default: System (string)

orchestratorVersion String

The AKS node pool orchestrator version (string)

osDiskSizeGb Number

The AKS node pool os disk size gb. Default: 128 (int)

osDiskType String

The AKS node pool os disk type. Default: Managed (string)

osType String

The AKS node pool os type. Default: Linux (string)

vmSize String

The AKS node pool orchestrator version (string)

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)

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)

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)

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 Map<String,Object>

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)

answers Map<Any>

Key/value answers for monitor input (map)

version String

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

The EKS node group launch template ID (string)

InsecureCommand string

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

InsecureNodeCommand string

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

InsecureWindowsNodeCommand string

Insecure windows 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

The EKS node group launch template ID (string)

InsecureCommand string

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

InsecureNodeCommand string

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

InsecureWindowsNodeCommand string

Insecure windows 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 Map<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

The EKS node group launch template ID (string)

insecureCommand String

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

insecureNodeCommand String

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

insecureWindowsNodeCommand String

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

labels Map<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 {[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

The EKS node group launch template ID (string)

insecureCommand string

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

insecureNodeCommand string

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

insecureWindowsNodeCommand string

Insecure windows 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

The EKS node group launch template ID (string)

insecure_command str

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

insecure_node_command str

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

insecure_windows_node_command str

Insecure windows 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)

annotations Map<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

The EKS node group launch template ID (string)

insecureCommand String

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

insecureNodeCommand String

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

insecureWindowsNodeCommand String

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

labels Map<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)

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 Map<String,Object>

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)

clusterId String

Cluster ID (string)

projectId String

Project ID to apply answer (string)

values Map<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, password, 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, password, 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, password, 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, password, 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, password, 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, password, 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>

The EKS node group subnets (list string)

UserData string

The EKS node group user data (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

The EKS node group subnets (list string)

UserData string

The EKS node group user data (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 Integer

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 Integer

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

minimumNodes Integer

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

nodeVolumeSize Integer

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>

The EKS node group subnets (list string)

userData String

The EKS node group user data (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[]

The EKS node group subnets (list string)

userData string

The EKS node group user data (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]

The EKS node group subnets (list string)

user_data str

The EKS node group user data (string)

virtual_network str

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

The EKS node group subnets (list string)

userData String

The EKS node group user data (string)

virtualNetwork String

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

Is GKE cluster imported? 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<ClusterEksConfigV2NodeGroup>

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

PrivateAccess bool

The EKS cluster has private access (bool)

PublicAccess bool

The EKS cluster has public access (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 (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>

The EKS node group subnets (list string)

Tags Dictionary<string, object>

The GKE node config tags (List)

CloudCredentialId string

The EKS cloud_credential id (string)

Imported bool

Is GKE cluster imported? 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 (bool)

PublicAccess bool

The EKS cluster has public access (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 (bool)

SecurityGroups []string

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

ServiceRole string

The AWS service role to use (string)

Subnets []string

The EKS node group subnets (list string)

Tags map[string]interface{}

The GKE node config tags (List)

cloudCredentialId String

The EKS cloud_credential id (string)

imported Boolean

Is GKE cluster imported? 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<ClusterEksConfigV2NodeGroup>

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

privateAccess Boolean

The EKS cluster has private access (bool)

publicAccess Boolean

The EKS cluster has public access (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 Boolean

Enable EKS cluster secret encryption (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>

The EKS node group subnets (list string)

tags Map<String,Object>

The GKE node config tags (List)

cloudCredentialId string

The EKS cloud_credential id (string)

imported boolean

Is GKE cluster imported? 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 (bool)

publicAccess boolean

The EKS cluster has public access (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 (bool)

securityGroups string[]

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

serviceRole string

The AWS service role to use (string)

subnets string[]

The EKS node group subnets (list string)

tags {[key: string]: any}

The GKE node config tags (List)

cloud_credential_id str

The EKS cloud_credential id (string)

imported bool

Is GKE cluster imported? 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[ClusterEksConfigV2NodeGroup]

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

private_access bool

The EKS cluster has private access (bool)

public_access bool

The EKS cluster has public access (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 (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]

The EKS node group subnets (list string)

tags Mapping[str, Any]

The GKE node config tags (List)

cloudCredentialId String

The EKS cloud_credential id (string)

imported Boolean

Is GKE cluster imported? 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<Property Map>

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

privateAccess Boolean

The EKS cluster has private access (bool)

publicAccess Boolean

The EKS cluster has public access (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 Boolean

Enable EKS cluster secret encryption (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>

The EKS node group subnets (list string)

tags Map<Any>

The GKE node config tags (List)

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)

ImageId string

The EKS node group image ID (string)

InstanceType string

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

Labels Dictionary<string, object>

Labels for cluster registration token object (map)

LaunchTemplates List<ClusterEksConfigV2NodeGroupLaunchTemplate>

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

MaxSize int

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

MinSize int

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

RequestSpotInstances bool

Enable EKS node group request spot instances (bool)

ResourceTags Dictionary<string, object>

The EKS node group resource tags (map)

SpotInstanceTypes List<string>

The EKS node group sport instace types (list string)

Subnets List<string>

The EKS node group subnets (list string)

Tags Dictionary<string, object>

The GKE node config tags (List)

UserData string

The EKS node group user data (string)

Version string

rancher-monitoring chart version (string)

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)

ImageId string

The EKS node group image ID (string)

InstanceType string

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

Labels map[string]interface{}

Labels for cluster registration token object (map)

LaunchTemplates []ClusterEksConfigV2NodeGroupLaunchTemplate

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

MaxSize int

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

MinSize int

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

RequestSpotInstances bool

Enable EKS node group request spot instances (bool)

ResourceTags map[string]interface{}

The EKS node group resource tags (map)

SpotInstanceTypes []string

The EKS node group sport instace types (list string)

Subnets []string

The EKS node group subnets (list string)

Tags map[string]interface{}

The GKE node config tags (List)

UserData string

The EKS node group user data (string)

Version string

rancher-monitoring chart version (string)

name String

Name of cluster registration token (string)

desiredSize Integer

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

diskSize Integer

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)

imageId String

The EKS node group image ID (string)

instanceType String

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

labels Map<String,Object>

Labels for cluster registration token object (map)

launchTemplates List<ClusterEksConfigV2NodeGroupLaunchTemplate>

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

maxSize Integer

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

minSize Integer

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

requestSpotInstances Boolean

Enable EKS node group request spot instances (bool)

resourceTags Map<String,Object>

The EKS node group resource tags (map)

spotInstanceTypes List<String>

The EKS node group sport instace types (list string)

subnets List<String>

The EKS node group subnets (list string)

tags Map<String,Object>

The GKE node config tags (List)

userData String

The EKS node group user data (string)

version String

rancher-monitoring chart version (string)

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)

imageId string

The EKS node group image ID (string)

instanceType string

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

labels {[key: string]: any}

Labels for cluster registration token object (map)

launchTemplates ClusterEksConfigV2NodeGroupLaunchTemplate[]

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

maxSize number

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

minSize number

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

requestSpotInstances boolean

Enable EKS node group request spot instances (bool)

resourceTags {[key: string]: any}

The EKS node group resource tags (map)

spotInstanceTypes string[]

The EKS node group sport instace types (list string)

subnets string[]

The EKS node group subnets (list string)

tags {[key: string]: any}

The GKE node config tags (List)

userData string

The EKS node group user data (string)

version string

rancher-monitoring chart version (string)

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)

image_id str

The EKS node group image ID (string)

instance_type str

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

labels Mapping[str, Any]

Labels for cluster registration token object (map)

launch_templates Sequence[ClusterEksConfigV2NodeGroupLaunchTemplate]

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

max_size int

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

min_size int

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

request_spot_instances bool

Enable EKS node group request spot instances (bool)

resource_tags Mapping[str, Any]

The EKS node group resource tags (map)

spot_instance_types Sequence[str]

The EKS node group sport instace types (list string)

subnets Sequence[str]

The EKS node group subnets (list string)

tags Mapping[str, Any]

The GKE node config tags (List)

user_data str

The EKS node group user data (string)

version str

rancher-monitoring chart version (string)

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)

imageId String

The EKS node group image ID (string)

instanceType String

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

labels Map<Any>

Labels for cluster registration token object (map)

launchTemplates List<Property Map>

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

maxSize Number

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

minSize Number

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

requestSpotInstances Boolean

Enable EKS node group request spot instances (bool)

resourceTags Map<Any>

The EKS node group resource tags (map)

spotInstanceTypes List<String>

The EKS node group sport instace types (list string)

subnets List<String>

The EKS node group subnets (list string)

tags Map<Any>

The GKE node config tags (List)

userData String

The EKS node group user data (string)

version String

rancher-monitoring chart version (string)

ClusterEksConfigV2NodeGroupLaunchTemplate

Id string

The EKS node group launch template ID (string)

Name string

Name of cluster registration token (string)

Version int

rancher-monitoring chart version (string)

Id string

The EKS node group launch template ID (string)

Name string

Name of cluster registration token (string)

Version int

rancher-monitoring chart version (string)

id String

The EKS node group launch template ID (string)

name String

Name of cluster registration token (string)

version Integer

rancher-monitoring chart version (string)

id string

The EKS node group launch template ID (string)

name string

Name of cluster registration token (string)

version number

rancher-monitoring chart version (string)

id str

The EKS node group launch template ID (string)

name str

Name of cluster registration token (string)

version int

rancher-monitoring chart version (string)

id String

The EKS node group launch template ID (string)

name String

Name of cluster registration token (string)

version Number

rancher-monitoring chart version (string)

ClusterGkeConfig

ClusterIpv4Cidr string

The IP address range of the container pods (string)

Credential string

The contents of the GC credential file (string)

DiskType string

The GKE node config disk type (string)

ImageType string

The GKE node config image type (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>

The GKE cluster locations (List)

MachineType string

The GKE node config machine type (string)

MaintenanceWindow string

The GKE cluster maintenance window (string)

MasterIpv4CidrBlock string

The GKE cluster private master ip v4 cidr block (string)

MasterVersion string

Master version for GKE cluster (string)

Network string

The GKE cluster network. Required for create new cluster (string)

NodePool string

The ID of the cluster node pool (string)

NodeVersion string

Node version for GKE cluster (string)

OauthScopes List<string>

The GKE node config oauth scopes (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

The GKE node config disk size Gb (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

Enable GKE cluster private 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 GKE node config local ssd count (int)

MasterAuthorizedNetworkCidrBlocks List<string>

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

MaxNodeCount int

The GKE node pool config max node count (int)

MinNodeCount int

The GKE node pool config min node count (int)

NodeCount int

Node count for GKE cluster. Default 3 (int)

Preemptible bool

Enable GKE node config preemptible. 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>

The GKE node config taints (List)