Cluster
Provides a Rancher v2 Cluster resource. This can be used to create Clusters for Rancher v2 environments and retrieve their information.
Example Usage
Creating Rancher v2 RKE cluster enabling and customizing monitoring
using Pulumi;
using Rancher2 = Pulumi.Rancher2;
class MyStack : Stack
{
public MyStack()
{
// Create a new rancher2 RKE Cluster
var foo_custom = new Rancher2.Cluster("foo-custom", new Rancher2.ClusterArgs
{
ClusterMonitoringInput = new Rancher2.Inputs.ClusterClusterMonitoringInputArgs
{
Answers =
{
{ "exporter-kubelets.https", true },
{ "exporter-node.enabled", true },
{ "exporter-node.ports.metrics.port", 9796 },
{ "exporter-node.resources.limits.cpu", "200m" },
{ "exporter-node.resources.limits.memory", "200Mi" },
{ "grafana.persistence.enabled", false },
{ "grafana.persistence.size", "10Gi" },
{ "grafana.persistence.storageClass", "default" },
{ "operator.resources.limits.memory", "500Mi" },
{ "prometheus.persistence.enabled", "false" },
{ "prometheus.persistence.size", "50Gi" },
{ "prometheus.persistence.storageClass", "default" },
{ "prometheus.persistent.useReleaseName", "true" },
{ "prometheus.resources.core.limits.cpu", "1000m" },
{ "prometheus.resources.core.limits.memory", "1500Mi" },
{ "prometheus.resources.core.requests.cpu", "750m" },
{ "prometheus.resources.core.requests.memory", "750Mi" },
{ "prometheus.retention", "12h" },
},
Version = "0.1.0",
},
Description = "Foo rancher2 custom cluster",
EnableClusterMonitoring = true,
RkeConfig = new Rancher2.Inputs.ClusterRkeConfigArgs
{
Network = new Rancher2.Inputs.ClusterRkeConfigNetworkArgs
{
Plugin = "canal",
},
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rancher2.NewCluster(ctx, "foo_custom", &rancher2.ClusterArgs{
ClusterMonitoringInput: &rancher2.ClusterClusterMonitoringInputArgs{
Answers: pulumi.Map{
"exporter-kubelets.https": pulumi.Bool(true),
"exporter-node.enabled": pulumi.Bool(true),
"exporter-node.ports.metrics.port": pulumi.Float64(9796),
"exporter-node.resources.limits.cpu": pulumi.String("200m"),
"exporter-node.resources.limits.memory": pulumi.String("200Mi"),
"grafana.persistence.enabled": pulumi.Bool(false),
"grafana.persistence.size": pulumi.String("10Gi"),
"grafana.persistence.storageClass": pulumi.String("default"),
"operator.resources.limits.memory": pulumi.String("500Mi"),
"prometheus.persistence.enabled": pulumi.String("false"),
"prometheus.persistence.size": pulumi.String("50Gi"),
"prometheus.persistence.storageClass": pulumi.String("default"),
"prometheus.persistent.useReleaseName": pulumi.String("true"),
"prometheus.resources.core.limits.cpu": pulumi.String("1000m"),
"prometheus.resources.core.limits.memory": pulumi.String("1500Mi"),
"prometheus.resources.core.requests.cpu": pulumi.String("750m"),
"prometheus.resources.core.requests.memory": pulumi.String("750Mi"),
"prometheus.retention": pulumi.String("12h"),
},
Version: pulumi.String("0.1.0"),
},
Description: pulumi.String("Foo rancher2 custom cluster"),
EnableClusterMonitoring: pulumi.Bool(true),
RkeConfig: &rancher2.ClusterRkeConfigArgs{
Network: &rancher2.ClusterRkeConfigNetworkArgs{
Plugin: pulumi.String("canal"),
},
},
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_rancher2 as rancher2
# Create a new rancher2 RKE Cluster
foo_custom = rancher2.Cluster("foo-custom",
cluster_monitoring_input=rancher2.ClusterClusterMonitoringInputArgs(
answers={
"exporter-kubelets.https": True,
"exporter-node.enabled": True,
"exporter-node.ports.metrics.port": 9796,
"exporter-node.resources.limits.cpu": "200m",
"exporter-node.resources.limits.memory": "200Mi",
"grafana.persistence.enabled": False,
"grafana.persistence.size": "10Gi",
"grafana.persistence.storageClass": "default",
"operator.resources.limits.memory": "500Mi",
"prometheus.persistence.enabled": "false",
"prometheus.persistence.size": "50Gi",
"prometheus.persistence.storageClass": "default",
"prometheus.persistent.useReleaseName": "true",
"prometheus.resources.core.limits.cpu": "1000m",
"prometheus.resources.core.limits.memory": "1500Mi",
"prometheus.resources.core.requests.cpu": "750m",
"prometheus.resources.core.requests.memory": "750Mi",
"prometheus.retention": "12h",
},
version="0.1.0",
),
description="Foo rancher2 custom cluster",
enable_cluster_monitoring=True,
rke_config=rancher2.ClusterRkeConfigArgs(
network=rancher2.ClusterRkeConfigNetworkArgs(
plugin="canal",
),
))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";
// Create a new rancher2 RKE Cluster
const foo_custom = new rancher2.Cluster("foo-custom", {
clusterMonitoringInput: {
answers: {
"exporter-kubelets.https": true,
"exporter-node.enabled": true,
"exporter-node.ports.metrics.port": 9796,
"exporter-node.resources.limits.cpu": "200m",
"exporter-node.resources.limits.memory": "200Mi",
"grafana.persistence.enabled": false,
"grafana.persistence.size": "10Gi",
"grafana.persistence.storageClass": "default",
"operator.resources.limits.memory": "500Mi",
"prometheus.persistence.enabled": "false",
"prometheus.persistence.size": "50Gi",
"prometheus.persistence.storageClass": "default",
"prometheus.persistent.useReleaseName": "true",
"prometheus.resources.core.limits.cpu": "1000m",
"prometheus.resources.core.limits.memory": "1500Mi",
"prometheus.resources.core.requests.cpu": "750m",
"prometheus.resources.core.requests.memory": "750Mi",
"prometheus.retention": "12h",
},
version: "0.1.0",
},
description: "Foo rancher2 custom cluster",
enableClusterMonitoring: true,
rkeConfig: {
network: {
plugin: "canal",
},
},
});
Creating Rancher v2 RKE cluster enabling/customizing monitoring and istio
using Pulumi;
using Rancher2 = Pulumi.Rancher2;
class MyStack : Stack
{
public MyStack()
{
// Create a new rancher2 RKE Cluster
var foo_customCluster = new Rancher2.Cluster("foo-customCluster", new Rancher2.ClusterArgs
{
Description = "Foo rancher2 custom cluster",
RkeConfig = new Rancher2.Inputs.ClusterRkeConfigArgs
{
Network = new Rancher2.Inputs.ClusterRkeConfigNetworkArgs
{
Plugin = "canal",
},
},
EnableClusterMonitoring = true,
ClusterMonitoringInput = new Rancher2.Inputs.ClusterClusterMonitoringInputArgs
{
Answers =
{
{ "exporter-kubelets.https", true },
{ "exporter-node.enabled", true },
{ "exporter-node.ports.metrics.port", 9796 },
{ "exporter-node.resources.limits.cpu", "200m" },
{ "exporter-node.resources.limits.memory", "200Mi" },
{ "grafana.persistence.enabled", false },
{ "grafana.persistence.size", "10Gi" },
{ "grafana.persistence.storageClass", "default" },
{ "operator.resources.limits.memory", "500Mi" },
{ "prometheus.persistence.enabled", "false" },
{ "prometheus.persistence.size", "50Gi" },
{ "prometheus.persistence.storageClass", "default" },
{ "prometheus.persistent.useReleaseName", "true" },
{ "prometheus.resources.core.limits.cpu", "1000m" },
{ "prometheus.resources.core.limits.memory", "1500Mi" },
{ "prometheus.resources.core.requests.cpu", "750m" },
{ "prometheus.resources.core.requests.memory", "750Mi" },
{ "prometheus.retention", "12h" },
},
Version = "0.1.0",
},
});
// Create a new rancher2 Cluster Sync for foo-custom cluster
var foo_customClusterSync = new Rancher2.ClusterSync("foo-customClusterSync", new Rancher2.ClusterSyncArgs
{
ClusterId = foo_customCluster.Id,
WaitMonitoring = foo_customCluster.EnableClusterMonitoring,
});
// Create a new rancher2 Namespace
var foo_istio = new Rancher2.Namespace("foo-istio", new Rancher2.NamespaceArgs
{
ProjectId = foo_customClusterSync.SystemProjectId,
Description = "istio namespace",
});
// Create a new rancher2 App deploying istio (should wait until monitoring is up and running)
var istio = new Rancher2.App("istio", new Rancher2.AppArgs
{
CatalogName = "system-library",
Description = "Terraform app acceptance test",
ProjectId = foo_istio.ProjectId,
TemplateName = "rancher-istio",
TemplateVersion = "0.1.1",
TargetNamespace = foo_istio.Id,
Answers =
{
{ "certmanager.enabled", false },
{ "enableCRDs", true },
{ "galley.enabled", true },
{ "gateways.enabled", false },
{ "gateways.istio-ingressgateway.resources.limits.cpu", "2000m" },
{ "gateways.istio-ingressgateway.resources.limits.memory", "1024Mi" },
{ "gateways.istio-ingressgateway.resources.requests.cpu", "100m" },
{ "gateways.istio-ingressgateway.resources.requests.memory", "128Mi" },
{ "gateways.istio-ingressgateway.type", "NodePort" },
{ "global.monitoring.type", "cluster-monitoring" },
{ "global.rancher.clusterId", foo_customClusterSync.ClusterId },
{ "istio_cni.enabled", "false" },
{ "istiocoredns.enabled", "false" },
{ "kiali.enabled", "true" },
{ "mixer.enabled", "true" },
{ "mixer.policy.enabled", "true" },
{ "mixer.policy.resources.limits.cpu", "4800m" },
{ "mixer.policy.resources.limits.memory", "4096Mi" },
{ "mixer.policy.resources.requests.cpu", "1000m" },
{ "mixer.policy.resources.requests.memory", "1024Mi" },
{ "mixer.telemetry.resources.limits.cpu", "4800m" },
{ "mixer.telemetry.resources.limits.memory", "4096Mi" },
{ "mixer.telemetry.resources.requests.cpu", "1000m" },
{ "mixer.telemetry.resources.requests.memory", "1024Mi" },
{ "mtls.enabled", false },
{ "nodeagent.enabled", false },
{ "pilot.enabled", true },
{ "pilot.resources.limits.cpu", "1000m" },
{ "pilot.resources.limits.memory", "4096Mi" },
{ "pilot.resources.requests.cpu", "500m" },
{ "pilot.resources.requests.memory", "2048Mi" },
{ "pilot.traceSampling", "1" },
{ "security.enabled", true },
{ "sidecarInjectorWebhook.enabled", true },
{ "tracing.enabled", true },
{ "tracing.jaeger.resources.limits.cpu", "500m" },
{ "tracing.jaeger.resources.limits.memory", "1024Mi" },
{ "tracing.jaeger.resources.requests.cpu", "100m" },
{ "tracing.jaeger.resources.requests.memory", "100Mi" },
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rancher2.NewCluster(ctx, "foo_customCluster", &rancher2.ClusterArgs{
Description: pulumi.String("Foo rancher2 custom cluster"),
RkeConfig: &rancher2.ClusterRkeConfigArgs{
Network: &rancher2.ClusterRkeConfigNetworkArgs{
Plugin: pulumi.String("canal"),
},
},
EnableClusterMonitoring: pulumi.Bool(true),
ClusterMonitoringInput: &rancher2.ClusterClusterMonitoringInputArgs{
Answers: pulumi.Map{
"exporter-kubelets.https": pulumi.Bool(true),
"exporter-node.enabled": pulumi.Bool(true),
"exporter-node.ports.metrics.port": pulumi.Float64(9796),
"exporter-node.resources.limits.cpu": pulumi.String("200m"),
"exporter-node.resources.limits.memory": pulumi.String("200Mi"),
"grafana.persistence.enabled": pulumi.Bool(false),
"grafana.persistence.size": pulumi.String("10Gi"),
"grafana.persistence.storageClass": pulumi.String("default"),
"operator.resources.limits.memory": pulumi.String("500Mi"),
"prometheus.persistence.enabled": pulumi.String("false"),
"prometheus.persistence.size": pulumi.String("50Gi"),
"prometheus.persistence.storageClass": pulumi.String("default"),
"prometheus.persistent.useReleaseName": pulumi.String("true"),
"prometheus.resources.core.limits.cpu": pulumi.String("1000m"),
"prometheus.resources.core.limits.memory": pulumi.String("1500Mi"),
"prometheus.resources.core.requests.cpu": pulumi.String("750m"),
"prometheus.resources.core.requests.memory": pulumi.String("750Mi"),
"prometheus.retention": pulumi.String("12h"),
},
Version: pulumi.String("0.1.0"),
},
})
if err != nil {
return err
}
_, err = rancher2.NewClusterSync(ctx, "foo_customClusterSync", &rancher2.ClusterSyncArgs{
ClusterId: foo_customCluster.ID(),
WaitMonitoring: foo_customCluster.EnableClusterMonitoring,
})
if err != nil {
return err
}
_, err = rancher2.NewNamespace(ctx, "foo_istio", &rancher2.NamespaceArgs{
ProjectId: foo_customClusterSync.SystemProjectId,
Description: pulumi.String("istio namespace"),
})
if err != nil {
return err
}
_, err = rancher2.NewApp(ctx, "istio", &rancher2.AppArgs{
CatalogName: pulumi.String("system-library"),
Description: pulumi.String("Terraform app acceptance test"),
ProjectId: foo_istio.ProjectId,
TemplateName: pulumi.String("rancher-istio"),
TemplateVersion: pulumi.String("0.1.1"),
TargetNamespace: foo_istio.ID(),
Answers: pulumi.Map{
"certmanager.enabled": pulumi.Bool(false),
"enableCRDs": pulumi.Bool(true),
"galley.enabled": pulumi.Bool(true),
"gateways.enabled": pulumi.Bool(false),
"gateways.istio-ingressgateway.resources.limits.cpu": pulumi.String("2000m"),
"gateways.istio-ingressgateway.resources.limits.memory": pulumi.String("1024Mi"),
"gateways.istio-ingressgateway.resources.requests.cpu": pulumi.String("100m"),
"gateways.istio-ingressgateway.resources.requests.memory": pulumi.String("128Mi"),
"gateways.istio-ingressgateway.type": pulumi.String("NodePort"),
"global.monitoring.type": pulumi.String("cluster-monitoring"),
"global.rancher.clusterId": foo_customClusterSync.ClusterId,
"istio_cni.enabled": pulumi.String("false"),
"istiocoredns.enabled": pulumi.String("false"),
"kiali.enabled": pulumi.String("true"),
"mixer.enabled": pulumi.String("true"),
"mixer.policy.enabled": pulumi.String("true"),
"mixer.policy.resources.limits.cpu": pulumi.String("4800m"),
"mixer.policy.resources.limits.memory": pulumi.String("4096Mi"),
"mixer.policy.resources.requests.cpu": pulumi.String("1000m"),
"mixer.policy.resources.requests.memory": pulumi.String("1024Mi"),
"mixer.telemetry.resources.limits.cpu": pulumi.String("4800m"),
"mixer.telemetry.resources.limits.memory": pulumi.String("4096Mi"),
"mixer.telemetry.resources.requests.cpu": pulumi.String("1000m"),
"mixer.telemetry.resources.requests.memory": pulumi.String("1024Mi"),
"mtls.enabled": pulumi.Bool(false),
"nodeagent.enabled": pulumi.Bool(false),
"pilot.enabled": pulumi.Bool(true),
"pilot.resources.limits.cpu": pulumi.String("1000m"),
"pilot.resources.limits.memory": pulumi.String("4096Mi"),
"pilot.resources.requests.cpu": pulumi.String("500m"),
"pilot.resources.requests.memory": pulumi.String("2048Mi"),
"pilot.traceSampling": pulumi.String("1"),
"security.enabled": pulumi.Bool(true),
"sidecarInjectorWebhook.enabled": pulumi.Bool(true),
"tracing.enabled": pulumi.Bool(true),
"tracing.jaeger.resources.limits.cpu": pulumi.String("500m"),
"tracing.jaeger.resources.limits.memory": pulumi.String("1024Mi"),
"tracing.jaeger.resources.requests.cpu": pulumi.String("100m"),
"tracing.jaeger.resources.requests.memory": pulumi.String("100Mi"),
},
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_rancher2 as rancher2
# Create a new rancher2 RKE Cluster
foo_custom_cluster = rancher2.Cluster("foo-customCluster",
description="Foo rancher2 custom cluster",
rke_config=rancher2.ClusterRkeConfigArgs(
network=rancher2.ClusterRkeConfigNetworkArgs(
plugin="canal",
),
),
enable_cluster_monitoring=True,
cluster_monitoring_input=rancher2.ClusterClusterMonitoringInputArgs(
answers={
"exporter-kubelets.https": True,
"exporter-node.enabled": True,
"exporter-node.ports.metrics.port": 9796,
"exporter-node.resources.limits.cpu": "200m",
"exporter-node.resources.limits.memory": "200Mi",
"grafana.persistence.enabled": False,
"grafana.persistence.size": "10Gi",
"grafana.persistence.storageClass": "default",
"operator.resources.limits.memory": "500Mi",
"prometheus.persistence.enabled": "false",
"prometheus.persistence.size": "50Gi",
"prometheus.persistence.storageClass": "default",
"prometheus.persistent.useReleaseName": "true",
"prometheus.resources.core.limits.cpu": "1000m",
"prometheus.resources.core.limits.memory": "1500Mi",
"prometheus.resources.core.requests.cpu": "750m",
"prometheus.resources.core.requests.memory": "750Mi",
"prometheus.retention": "12h",
},
version="0.1.0",
))
# Create a new rancher2 Cluster Sync for foo-custom cluster
foo_custom_cluster_sync = rancher2.ClusterSync("foo-customClusterSync",
cluster_id=foo_custom_cluster.id,
wait_monitoring=foo_custom_cluster.enable_cluster_monitoring)
# Create a new rancher2 Namespace
foo_istio = rancher2.Namespace("foo-istio",
project_id=foo_custom_cluster_sync.system_project_id,
description="istio namespace")
# Create a new rancher2 App deploying istio (should wait until monitoring is up and running)
istio = rancher2.App("istio",
catalog_name="system-library",
description="Terraform app acceptance test",
project_id=foo_istio.project_id,
template_name="rancher-istio",
template_version="0.1.1",
target_namespace=foo_istio.id,
answers={
"certmanager.enabled": False,
"enableCRDs": True,
"galley.enabled": True,
"gateways.enabled": False,
"gateways.istio-ingressgateway.resources.limits.cpu": "2000m",
"gateways.istio-ingressgateway.resources.limits.memory": "1024Mi",
"gateways.istio-ingressgateway.resources.requests.cpu": "100m",
"gateways.istio-ingressgateway.resources.requests.memory": "128Mi",
"gateways.istio-ingressgateway.type": "NodePort",
"global.monitoring.type": "cluster-monitoring",
"global.rancher.clusterId": foo_custom_cluster_sync.cluster_id,
"istio_cni.enabled": "false",
"istiocoredns.enabled": "false",
"kiali.enabled": "true",
"mixer.enabled": "true",
"mixer.policy.enabled": "true",
"mixer.policy.resources.limits.cpu": "4800m",
"mixer.policy.resources.limits.memory": "4096Mi",
"mixer.policy.resources.requests.cpu": "1000m",
"mixer.policy.resources.requests.memory": "1024Mi",
"mixer.telemetry.resources.limits.cpu": "4800m",
"mixer.telemetry.resources.limits.memory": "4096Mi",
"mixer.telemetry.resources.requests.cpu": "1000m",
"mixer.telemetry.resources.requests.memory": "1024Mi",
"mtls.enabled": False,
"nodeagent.enabled": False,
"pilot.enabled": True,
"pilot.resources.limits.cpu": "1000m",
"pilot.resources.limits.memory": "4096Mi",
"pilot.resources.requests.cpu": "500m",
"pilot.resources.requests.memory": "2048Mi",
"pilot.traceSampling": "1",
"security.enabled": True,
"sidecarInjectorWebhook.enabled": True,
"tracing.enabled": True,
"tracing.jaeger.resources.limits.cpu": "500m",
"tracing.jaeger.resources.limits.memory": "1024Mi",
"tracing.jaeger.resources.requests.cpu": "100m",
"tracing.jaeger.resources.requests.memory": "100Mi",
})
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";
// Create a new rancher2 RKE Cluster
const foo_customCluster = new rancher2.Cluster("foo-customCluster", {
description: "Foo rancher2 custom cluster",
rkeConfig: {
network: {
plugin: "canal",
},
},
enableClusterMonitoring: true,
clusterMonitoringInput: {
answers: {
"exporter-kubelets.https": true,
"exporter-node.enabled": true,
"exporter-node.ports.metrics.port": 9796,
"exporter-node.resources.limits.cpu": "200m",
"exporter-node.resources.limits.memory": "200Mi",
"grafana.persistence.enabled": false,
"grafana.persistence.size": "10Gi",
"grafana.persistence.storageClass": "default",
"operator.resources.limits.memory": "500Mi",
"prometheus.persistence.enabled": "false",
"prometheus.persistence.size": "50Gi",
"prometheus.persistence.storageClass": "default",
"prometheus.persistent.useReleaseName": "true",
"prometheus.resources.core.limits.cpu": "1000m",
"prometheus.resources.core.limits.memory": "1500Mi",
"prometheus.resources.core.requests.cpu": "750m",
"prometheus.resources.core.requests.memory": "750Mi",
"prometheus.retention": "12h",
},
version: "0.1.0",
},
});
// Create a new rancher2 Cluster Sync for foo-custom cluster
const foo_customClusterSync = new rancher2.ClusterSync("foo-customClusterSync", {
clusterId: foo_customCluster.id,
waitMonitoring: foo_customCluster.enableClusterMonitoring,
});
// Create a new rancher2 Namespace
const foo_istio = new rancher2.Namespace("foo-istio", {
projectId: foo_customClusterSync.systemProjectId,
description: "istio namespace",
});
// Create a new rancher2 App deploying istio (should wait until monitoring is up and running)
const istio = new rancher2.App("istio", {
catalogName: "system-library",
description: "Terraform app acceptance test",
projectId: foo_istio.projectId,
templateName: "rancher-istio",
templateVersion: "0.1.1",
targetNamespace: foo_istio.id,
answers: {
"certmanager.enabled": false,
enableCRDs: true,
"galley.enabled": true,
"gateways.enabled": false,
"gateways.istio-ingressgateway.resources.limits.cpu": "2000m",
"gateways.istio-ingressgateway.resources.limits.memory": "1024Mi",
"gateways.istio-ingressgateway.resources.requests.cpu": "100m",
"gateways.istio-ingressgateway.resources.requests.memory": "128Mi",
"gateways.istio-ingressgateway.type": "NodePort",
"global.monitoring.type": "cluster-monitoring",
"global.rancher.clusterId": foo_customClusterSync.clusterId,
"istio_cni.enabled": "false",
"istiocoredns.enabled": "false",
"kiali.enabled": "true",
"mixer.enabled": "true",
"mixer.policy.enabled": "true",
"mixer.policy.resources.limits.cpu": "4800m",
"mixer.policy.resources.limits.memory": "4096Mi",
"mixer.policy.resources.requests.cpu": "1000m",
"mixer.policy.resources.requests.memory": "1024Mi",
"mixer.telemetry.resources.limits.cpu": "4800m",
"mixer.telemetry.resources.limits.memory": "4096Mi",
"mixer.telemetry.resources.requests.cpu": "1000m",
"mixer.telemetry.resources.requests.memory": "1024Mi",
"mtls.enabled": false,
"nodeagent.enabled": false,
"pilot.enabled": true,
"pilot.resources.limits.cpu": "1000m",
"pilot.resources.limits.memory": "4096Mi",
"pilot.resources.requests.cpu": "500m",
"pilot.resources.requests.memory": "2048Mi",
"pilot.traceSampling": "1",
"security.enabled": true,
"sidecarInjectorWebhook.enabled": true,
"tracing.enabled": true,
"tracing.jaeger.resources.limits.cpu": "500m",
"tracing.jaeger.resources.limits.memory": "1024Mi",
"tracing.jaeger.resources.requests.cpu": "100m",
"tracing.jaeger.resources.requests.memory": "100Mi",
},
});
Creating Rancher v2 RKE cluster assigning a node pool (overlapped planes)
using Pulumi;
using Rancher2 = Pulumi.Rancher2;
class MyStack : Stack
{
public MyStack()
{
// Create a new rancher2 RKE Cluster
var foo_custom = new Rancher2.Cluster("foo-custom", new Rancher2.ClusterArgs
{
Description = "Foo rancher2 custom cluster",
RkeConfig = new Rancher2.Inputs.ClusterRkeConfigArgs
{
Network = new Rancher2.Inputs.ClusterRkeConfigNetworkArgs
{
Plugin = "canal",
},
},
});
// Create a new rancher2 Node Template
var fooNodeTemplate = new Rancher2.NodeTemplate("fooNodeTemplate", new Rancher2.NodeTemplateArgs
{
Description = "foo test",
Amazonec2Config = new Rancher2.Inputs.NodeTemplateAmazonec2ConfigArgs
{
AccessKey = "<AWS_ACCESS_KEY>",
SecretKey = "<AWS_SECRET_KEY>",
Ami = "<AMI_ID>",
Region = "<REGION>",
SecurityGroups =
{
"<AWS_SECURITY_GROUP>",
},
SubnetId = "<SUBNET_ID>",
VpcId = "<VPC_ID>",
Zone = "<ZONE>",
},
});
// Create a new rancher2 Node Pool
var fooNodePool = new Rancher2.NodePool("fooNodePool", new Rancher2.NodePoolArgs
{
ClusterId = foo_custom.Id,
HostnamePrefix = "foo-cluster-0",
NodeTemplateId = fooNodeTemplate.Id,
Quantity = 3,
ControlPlane = true,
Etcd = true,
Worker = true,
});
}
}
package main
import (
"github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rancher2.NewCluster(ctx, "foo_custom", &rancher2.ClusterArgs{
Description: pulumi.String("Foo rancher2 custom cluster"),
RkeConfig: &rancher2.ClusterRkeConfigArgs{
Network: &rancher2.ClusterRkeConfigNetworkArgs{
Plugin: pulumi.String("canal"),
},
},
})
if err != nil {
return err
}
fooNodeTemplate, err := rancher2.NewNodeTemplate(ctx, "fooNodeTemplate", &rancher2.NodeTemplateArgs{
Description: pulumi.String("foo test"),
Amazonec2Config: &rancher2.NodeTemplateAmazonec2ConfigArgs{
AccessKey: pulumi.String("<AWS_ACCESS_KEY>"),
SecretKey: pulumi.String("<AWS_SECRET_KEY>"),
Ami: pulumi.String("<AMI_ID>"),
Region: pulumi.String("<REGION>"),
SecurityGroups: pulumi.StringArray{
pulumi.String("<AWS_SECURITY_GROUP>"),
},
SubnetId: pulumi.String("<SUBNET_ID>"),
VpcId: pulumi.String("<VPC_ID>"),
Zone: pulumi.String("<ZONE>"),
},
})
if err != nil {
return err
}
_, err = rancher2.NewNodePool(ctx, "fooNodePool", &rancher2.NodePoolArgs{
ClusterId: foo_custom.ID(),
HostnamePrefix: pulumi.String("foo-cluster-0"),
NodeTemplateId: fooNodeTemplate.ID(),
Quantity: pulumi.Int(3),
ControlPlane: pulumi.Bool(true),
Etcd: pulumi.Bool(true),
Worker: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_rancher2 as rancher2
# Create a new rancher2 RKE Cluster
foo_custom = rancher2.Cluster("foo-custom",
description="Foo rancher2 custom cluster",
rke_config=rancher2.ClusterRkeConfigArgs(
network=rancher2.ClusterRkeConfigNetworkArgs(
plugin="canal",
),
))
# Create a new rancher2 Node Template
foo_node_template = rancher2.NodeTemplate("fooNodeTemplate",
description="foo test",
amazonec2_config=rancher2.NodeTemplateAmazonec2ConfigArgs(
access_key="<AWS_ACCESS_KEY>",
secret_key="<AWS_SECRET_KEY>",
ami="<AMI_ID>",
region="<REGION>",
security_groups=["<AWS_SECURITY_GROUP>"],
subnet_id="<SUBNET_ID>",
vpc_id="<VPC_ID>",
zone="<ZONE>",
))
# Create a new rancher2 Node Pool
foo_node_pool = rancher2.NodePool("fooNodePool",
cluster_id=foo_custom.id,
hostname_prefix="foo-cluster-0",
node_template_id=foo_node_template.id,
quantity=3,
control_plane=True,
etcd=True,
worker=True)
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";
// Create a new rancher2 RKE Cluster
const foo_custom = new rancher2.Cluster("foo-custom", {
description: "Foo rancher2 custom cluster",
rkeConfig: {
network: {
plugin: "canal",
},
},
});
// Create a new rancher2 Node Template
const fooNodeTemplate = new rancher2.NodeTemplate("fooNodeTemplate", {
description: "foo test",
amazonec2Config: {
accessKey: "<AWS_ACCESS_KEY>",
secretKey: "<AWS_SECRET_KEY>",
ami: "<AMI_ID>",
region: "<REGION>",
securityGroups: ["<AWS_SECURITY_GROUP>"],
subnetId: "<SUBNET_ID>",
vpcId: "<VPC_ID>",
zone: "<ZONE>",
},
});
// Create a new rancher2 Node Pool
const fooNodePool = new rancher2.NodePool("fooNodePool", {
clusterId: foo_custom.id,
hostnamePrefix: "foo-cluster-0",
nodeTemplateId: fooNodeTemplate.id,
quantity: 3,
controlPlane: true,
etcd: true,
worker: true,
});
Creating Rancher v2 RKE cluster from template. For Rancher v2.3.x or above.
using Pulumi;
using Rancher2 = Pulumi.Rancher2;
class MyStack : Stack
{
public MyStack()
{
// Create a new rancher2 cluster template
var fooClusterTemplate = new Rancher2.ClusterTemplate("fooClusterTemplate", new Rancher2.ClusterTemplateArgs
{
Members =
{
new Rancher2.Inputs.ClusterTemplateMemberArgs
{
AccessType = "owner",
UserPrincipalId = "local://user-XXXXX",
},
},
TemplateRevisions =
{
new Rancher2.Inputs.ClusterTemplateTemplateRevisionArgs
{
Name = "V1",
ClusterConfig = new Rancher2.Inputs.ClusterTemplateTemplateRevisionClusterConfigArgs
{
RkeConfig = new Rancher2.Inputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigArgs
{
Network = new Rancher2.Inputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkArgs
{
Plugin = "canal",
},
Services = new Rancher2.Inputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesArgs
{
Etcd = new Rancher2.Inputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdArgs
{
Creation = "6h",
Retention = "24h",
},
},
},
},
Default = true,
},
},
Description = "Test cluster template v2",
});
// Create a new rancher2 RKE Cluster from template
var fooCluster = new Rancher2.Cluster("fooCluster", new Rancher2.ClusterArgs
{
ClusterTemplateId = fooClusterTemplate.Id,
ClusterTemplateRevisionId = fooClusterTemplate.TemplateRevisions.Apply(templateRevisions => templateRevisions[0].Id),
});
}
}
package main
import (
"github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
fooClusterTemplate, err := rancher2.NewClusterTemplate(ctx, "fooClusterTemplate", &rancher2.ClusterTemplateArgs{
Members: rancher2.ClusterTemplateMemberArray{
&rancher2.ClusterTemplateMemberArgs{
AccessType: pulumi.String("owner"),
UserPrincipalId: pulumi.String("local://user-XXXXX"),
},
},
TemplateRevisions: rancher2.ClusterTemplateTemplateRevisionArray{
&rancher2.ClusterTemplateTemplateRevisionArgs{
Name: pulumi.String("V1"),
ClusterConfig: &rancher2.ClusterTemplateTemplateRevisionClusterConfigArgs{
RkeConfig: &rancher2.ClusterTemplateTemplateRevisionClusterConfigRkeConfigArgs{
Network: &rancher2.ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkArgs{
Plugin: pulumi.String("canal"),
},
Services: &rancher2.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesArgs{
Etcd: &rancher2.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdArgs{
Creation: pulumi.String("6h"),
Retention: pulumi.String("24h"),
},
},
},
},
Default: pulumi.Bool(true),
},
},
Description: pulumi.String("Test cluster template v2"),
})
if err != nil {
return err
}
_, err = rancher2.NewCluster(ctx, "fooCluster", &rancher2.ClusterArgs{
ClusterTemplateId: fooClusterTemplate.ID(),
ClusterTemplateRevisionId: fooClusterTemplate.TemplateRevisions.ApplyT(func(templateRevisions []rancher2.ClusterTemplateTemplateRevision) (string, error) {
return templateRevisions[0].Id, nil
}).(pulumi.StringOutput),
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_rancher2 as rancher2
# Create a new rancher2 cluster template
foo_cluster_template = rancher2.ClusterTemplate("fooClusterTemplate",
members=[rancher2.ClusterTemplateMemberArgs(
access_type="owner",
user_principal_id="local://user-XXXXX",
)],
template_revisions=[rancher2.ClusterTemplateTemplateRevisionArgs(
name="V1",
cluster_config=rancher2.ClusterTemplateTemplateRevisionClusterConfigArgs(
rke_config={
"network": {
"plugin": "canal",
},
"services": {
"etcd": {
"creation": "6h",
"retention": "24h",
},
},
},
),
default=True,
)],
description="Test cluster template v2")
# Create a new rancher2 RKE Cluster from template
foo_cluster = rancher2.Cluster("fooCluster",
cluster_template_id=foo_cluster_template.id,
cluster_template_revision_id=foo_cluster_template.template_revisions[0].id)
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";
// Create a new rancher2 cluster template
const fooClusterTemplate = new rancher2.ClusterTemplate("fooClusterTemplate", {
members: [{
accessType: "owner",
userPrincipalId: "local://user-XXXXX",
}],
templateRevisions: [{
name: "V1",
clusterConfig: {
rkeConfig: {
network: {
plugin: "canal",
},
services: {
etcd: {
creation: "6h",
retention: "24h",
},
},
},
},
"default": true,
}],
description: "Test cluster template v2",
});
// Create a new rancher2 RKE Cluster from template
const fooCluster = new rancher2.Cluster("fooCluster", {
clusterTemplateId: fooClusterTemplate.id,
clusterTemplateRevisionId: fooClusterTemplate.templateRevisions.apply(templateRevisions => templateRevisions[0].id),
});
Creating Rancher v2 RKE cluster with upgrade strategy. For Rancher v2.4.x or above.
using Pulumi;
using Rancher2 = Pulumi.Rancher2;
class MyStack : Stack
{
public MyStack()
{
var foo = new Rancher2.Cluster("foo", new Rancher2.ClusterArgs
{
Description = "Terraform custom cluster",
RkeConfig = new Rancher2.Inputs.ClusterRkeConfigArgs
{
Network = new Rancher2.Inputs.ClusterRkeConfigNetworkArgs
{
Plugin = "canal",
},
Services = new Rancher2.Inputs.ClusterRkeConfigServicesArgs
{
Etcd = new Rancher2.Inputs.ClusterRkeConfigServicesEtcdArgs
{
Creation = "6h",
Retention = "24h",
},
KubeApi = new Rancher2.Inputs.ClusterRkeConfigServicesKubeApiArgs
{
AuditLog = new Rancher2.Inputs.ClusterRkeConfigServicesKubeApiAuditLogArgs
{
Configuration = new Rancher2.Inputs.ClusterRkeConfigServicesKubeApiAuditLogConfigurationArgs
{
Format = "json",
MaxAge = 5,
MaxBackup = 5,
MaxSize = 100,
Path = "-",
Policy = @"apiVersion: audit.k8s.io/v1
kind: Policy
metadata:
creationTimestamp: null
omitStages:
- RequestReceived
rules:
- level: RequestResponse
resources:
- resources:
- pods
",
},
Enabled = true,
},
},
},
UpgradeStrategy = new Rancher2.Inputs.ClusterRkeConfigUpgradeStrategyArgs
{
Drain = true,
MaxUnavailableWorker = "20%",
},
},
});
}
}
package main
import (
"fmt"
"github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rancher2.NewCluster(ctx, "foo", &rancher2.ClusterArgs{
Description: pulumi.String("Terraform custom cluster"),
RkeConfig: &rancher2.ClusterRkeConfigArgs{
Network: &rancher2.ClusterRkeConfigNetworkArgs{
Plugin: pulumi.String("canal"),
},
Services: &rancher2.ClusterRkeConfigServicesArgs{
Etcd: &rancher2.ClusterRkeConfigServicesEtcdArgs{
Creation: pulumi.String("6h"),
Retention: pulumi.String("24h"),
},
KubeApi: &rancher2.ClusterRkeConfigServicesKubeApiArgs{
AuditLog: &rancher2.ClusterRkeConfigServicesKubeApiAuditLogArgs{
Configuration: &rancher2.ClusterRkeConfigServicesKubeApiAuditLogConfigurationArgs{
Format: pulumi.String("json"),
MaxAge: pulumi.Int(5),
MaxBackup: pulumi.Int(5),
MaxSize: pulumi.Int(100),
Path: pulumi.String("-"),
Policy: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v", "apiVersion: audit.k8s.io/v1\n", "kind: Policy\n", "metadata:\n", " creationTimestamp: null\n", "omitStages:\n", "- RequestReceived\n", "rules:\n", "- level: RequestResponse\n", " resources:\n", " - resources:\n", " - pods\n", "\n")),
},
Enabled: pulumi.Bool(true),
},
},
},
UpgradeStrategy: &rancher2.ClusterRkeConfigUpgradeStrategyArgs{
Drain: pulumi.Bool(true),
MaxUnavailableWorker: pulumi.String(fmt.Sprintf("%v%v", "20", "%")),
},
},
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_rancher2 as rancher2
foo = rancher2.Cluster("foo",
description="Terraform custom cluster",
rke_config=rancher2.ClusterRkeConfigArgs(
network=rancher2.ClusterRkeConfigNetworkArgs(
plugin="canal",
),
services=rancher2.ClusterRkeConfigServicesArgs(
etcd=rancher2.ClusterRkeConfigServicesEtcdArgs(
creation="6h",
retention="24h",
),
kube_api=rancher2.ClusterRkeConfigServicesKubeApiArgs(
audit_log=rancher2.ClusterRkeConfigServicesKubeApiAuditLogArgs(
configuration=rancher2.ClusterRkeConfigServicesKubeApiAuditLogConfigurationArgs(
format="json",
max_age=5,
max_backup=5,
max_size=100,
path="-",
policy="""apiVersion: audit.k8s.io/v1
kind: Policy
metadata:
creationTimestamp: null
omitStages:
- RequestReceived
rules:
- level: RequestResponse
resources:
- resources:
- pods
""",
),
enabled=True,
),
),
),
upgrade_strategy={
"drain": True,
"maxUnavailableWorker": "20%",
},
))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";
const foo = new rancher2.Cluster("foo", {
description: "Terraform custom cluster",
rkeConfig: {
network: {
plugin: "canal",
},
services: {
etcd: {
creation: "6h",
retention: "24h",
},
kubeApi: {
auditLog: {
configuration: {
format: "json",
maxAge: 5,
maxBackup: 5,
maxSize: 100,
path: "-",
policy: `apiVersion: audit.k8s.io/v1
kind: Policy
metadata:
creationTimestamp: null
omitStages:
- RequestReceived
rules:
- level: RequestResponse
resources:
- resources:
- pods
`,
},
enabled: true,
},
},
},
upgradeStrategy: {
drain: true,
maxUnavailableWorker: "20%",
},
},
});
Creating Rancher v2 RKE cluster with scheduled cluster scan. For Rancher v2.4.x or above.
using Pulumi;
using Rancher2 = Pulumi.Rancher2;
class MyStack : Stack
{
public MyStack()
{
var foo = new Rancher2.Cluster("foo", new Rancher2.ClusterArgs
{
Description = "Terraform custom cluster",
RkeConfig = new Rancher2.Inputs.ClusterRkeConfigArgs
{
Network = new Rancher2.Inputs.ClusterRkeConfigNetworkArgs
{
Plugin = "canal",
},
Services = new Rancher2.Inputs.ClusterRkeConfigServicesArgs
{
Etcd = new Rancher2.Inputs.ClusterRkeConfigServicesEtcdArgs
{
Creation = "6h",
Retention = "24h",
},
},
},
ScheduledClusterScan = new Rancher2.Inputs.ClusterScheduledClusterScanArgs
{
Enabled = true,
ScanConfig = new Rancher2.Inputs.ClusterScheduledClusterScanScanConfigArgs
{
CisScanConfig = new Rancher2.Inputs.ClusterScheduledClusterScanScanConfigCisScanConfigArgs
{
DebugMaster = true,
DebugWorker = true,
},
},
ScheduleConfig = new Rancher2.Inputs.ClusterScheduledClusterScanScheduleConfigArgs
{
CronSchedule = "30 * * * *",
Retention = 5,
},
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rancher2.NewCluster(ctx, "foo", &rancher2.ClusterArgs{
Description: pulumi.String("Terraform custom cluster"),
RkeConfig: &rancher2.ClusterRkeConfigArgs{
Network: &rancher2.ClusterRkeConfigNetworkArgs{
Plugin: pulumi.String("canal"),
},
Services: &rancher2.ClusterRkeConfigServicesArgs{
Etcd: &rancher2.ClusterRkeConfigServicesEtcdArgs{
Creation: pulumi.String("6h"),
Retention: pulumi.String("24h"),
},
},
},
ScheduledClusterScan: &rancher2.ClusterScheduledClusterScanArgs{
Enabled: pulumi.Bool(true),
ScanConfig: &rancher2.ClusterScheduledClusterScanScanConfigArgs{
CisScanConfig: &rancher2.ClusterScheduledClusterScanScanConfigCisScanConfigArgs{
DebugMaster: pulumi.Bool(true),
DebugWorker: pulumi.Bool(true),
},
},
ScheduleConfig: &rancher2.ClusterScheduledClusterScanScheduleConfigArgs{
CronSchedule: pulumi.String("30 * * * *"),
Retention: pulumi.Int(5),
},
},
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_rancher2 as rancher2
foo = rancher2.Cluster("foo",
description="Terraform custom cluster",
rke_config=rancher2.ClusterRkeConfigArgs(
network=rancher2.ClusterRkeConfigNetworkArgs(
plugin="canal",
),
services=rancher2.ClusterRkeConfigServicesArgs(
etcd=rancher2.ClusterRkeConfigServicesEtcdArgs(
creation="6h",
retention="24h",
),
),
),
scheduled_cluster_scan=rancher2.ClusterScheduledClusterScanArgs(
enabled=True,
scan_config=rancher2.ClusterScheduledClusterScanScanConfigArgs(
cis_scan_config=rancher2.ClusterScheduledClusterScanScanConfigCisScanConfigArgs(
debug_master=True,
debug_worker=True,
),
),
schedule_config=rancher2.ClusterScheduledClusterScanScheduleConfigArgs(
cron_schedule="30 * * * *",
retention=5,
),
))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";
const foo = new rancher2.Cluster("foo", {
description: "Terraform custom cluster",
rkeConfig: {
network: {
plugin: "canal",
},
services: {
etcd: {
creation: "6h",
retention: "24h",
},
},
},
scheduledClusterScan: {
enabled: true,
scanConfig: {
cisScanConfig: {
debugMaster: true,
debugWorker: true,
},
},
scheduleConfig: {
cronSchedule: "30 * * * *",
retention: 5,
},
},
});
Importing EKS cluster to Rancher v2, using eks_config_v2
. For Rancher v2.5.x or above.
using Pulumi;
using Rancher2 = Pulumi.Rancher2;
class MyStack : Stack
{
public MyStack()
{
var fooCloudCredential = new Rancher2.CloudCredential("fooCloudCredential", new Rancher2.CloudCredentialArgs
{
Description = "foo test",
Amazonec2CredentialConfig = new Rancher2.Inputs.CloudCredentialAmazonec2CredentialConfigArgs
{
AccessKey = "<AWS_ACCESS_KEY>",
SecretKey = "<AWS_SECRET_KEY>",
},
});
var fooCluster = new Rancher2.Cluster("fooCluster", new Rancher2.ClusterArgs
{
Description = "Terraform EKS cluster",
EksConfigV2 = new Rancher2.Inputs.ClusterEksConfigV2Args
{
CloudCredentialId = fooCloudCredential.Id,
Name = "<CLUSTER_NAME>",
Region = "<EKS_REGION>",
Imported = true,
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
fooCloudCredential, err := rancher2.NewCloudCredential(ctx, "fooCloudCredential", &rancher2.CloudCredentialArgs{
Description: pulumi.String("foo test"),
Amazonec2CredentialConfig: &rancher2.CloudCredentialAmazonec2CredentialConfigArgs{
AccessKey: pulumi.String("<AWS_ACCESS_KEY>"),
SecretKey: pulumi.String("<AWS_SECRET_KEY>"),
},
})
if err != nil {
return err
}
_, err = rancher2.NewCluster(ctx, "fooCluster", &rancher2.ClusterArgs{
Description: pulumi.String("Terraform EKS cluster"),
EksConfigV2: &rancher2.ClusterEksConfigV2Args{
CloudCredentialId: fooCloudCredential.ID(),
Name: pulumi.String("<CLUSTER_NAME>"),
Region: pulumi.String("<EKS_REGION>"),
Imported: pulumi.Bool(true),
},
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_rancher2 as rancher2
foo_cloud_credential = rancher2.CloudCredential("fooCloudCredential",
description="foo test",
amazonec2_credential_config=rancher2.CloudCredentialAmazonec2CredentialConfigArgs(
access_key="<AWS_ACCESS_KEY>",
secret_key="<AWS_SECRET_KEY>",
))
foo_cluster = rancher2.Cluster("fooCluster",
description="Terraform EKS cluster",
eks_config_v2=rancher2.ClusterEksConfigV2Args(
cloud_credential_id=foo_cloud_credential.id,
name="<CLUSTER_NAME>",
region="<EKS_REGION>",
imported=True,
))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";
const fooCloudCredential = new rancher2.CloudCredential("fooCloudCredential", {
description: "foo test",
amazonec2CredentialConfig: {
accessKey: "<AWS_ACCESS_KEY>",
secretKey: "<AWS_SECRET_KEY>",
},
});
const fooCluster = new rancher2.Cluster("fooCluster", {
description: "Terraform EKS cluster",
eksConfigV2: {
cloudCredentialId: fooCloudCredential.id,
name: "<CLUSTER_NAME>",
region: "<EKS_REGION>",
imported: true,
},
});
Creating EKS cluster from Rancher v2, using eks_config_v2
. For Rancher v2.5.x or above.
using Pulumi;
using Rancher2 = Pulumi.Rancher2;
class MyStack : Stack
{
public MyStack()
{
var fooCloudCredential = new Rancher2.CloudCredential("fooCloudCredential", new Rancher2.CloudCredentialArgs
{
Description = "foo test",
Amazonec2CredentialConfig = new Rancher2.Inputs.CloudCredentialAmazonec2CredentialConfigArgs
{
AccessKey = "<AWS_ACCESS_KEY>",
SecretKey = "<AWS_SECRET_KEY>",
},
});
var fooCluster = new Rancher2.Cluster("fooCluster", new Rancher2.ClusterArgs
{
Description = "Terraform EKS cluster",
EksConfigV2 = new Rancher2.Inputs.ClusterEksConfigV2Args
{
CloudCredentialId = fooCloudCredential.Id,
Region = "<EKS_REGION>",
KubernetesVersion = "1.17",
LoggingTypes =
{
"audit",
"api",
},
NodeGroups =
{
new Rancher2.Inputs.ClusterEksConfigV2NodeGroupArgs
{
Name = "node_group1",
InstanceType = "t3.medium",
DesiredSize = 3,
MaxSize = 5,
},
new Rancher2.Inputs.ClusterEksConfigV2NodeGroupArgs
{
Name = "node_group2",
InstanceType = "m5.xlarge",
DesiredSize = 2,
MaxSize = 3,
},
},
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
fooCloudCredential, err := rancher2.NewCloudCredential(ctx, "fooCloudCredential", &rancher2.CloudCredentialArgs{
Description: pulumi.String("foo test"),
Amazonec2CredentialConfig: &rancher2.CloudCredentialAmazonec2CredentialConfigArgs{
AccessKey: pulumi.String("<AWS_ACCESS_KEY>"),
SecretKey: pulumi.String("<AWS_SECRET_KEY>"),
},
})
if err != nil {
return err
}
_, err = rancher2.NewCluster(ctx, "fooCluster", &rancher2.ClusterArgs{
Description: pulumi.String("Terraform EKS cluster"),
EksConfigV2: &rancher2.ClusterEksConfigV2Args{
CloudCredentialId: fooCloudCredential.ID(),
Region: pulumi.String("<EKS_REGION>"),
KubernetesVersion: pulumi.String("1.17"),
LoggingTypes: pulumi.StringArray{
pulumi.String("audit"),
pulumi.String("api"),
},
NodeGroups: rancher2.ClusterEksConfigV2NodeGroupArray{
&rancher2.ClusterEksConfigV2NodeGroupArgs{
Name: pulumi.String("node_group1"),
InstanceType: pulumi.String("t3.medium"),
DesiredSize: pulumi.Int(3),
MaxSize: pulumi.Int(5),
},
&rancher2.ClusterEksConfigV2NodeGroupArgs{
Name: pulumi.String("node_group2"),
InstanceType: pulumi.String("m5.xlarge"),
DesiredSize: pulumi.Int(2),
MaxSize: pulumi.Int(3),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_rancher2 as rancher2
foo_cloud_credential = rancher2.CloudCredential("fooCloudCredential",
description="foo test",
amazonec2_credential_config=rancher2.CloudCredentialAmazonec2CredentialConfigArgs(
access_key="<AWS_ACCESS_KEY>",
secret_key="<AWS_SECRET_KEY>",
))
foo_cluster = rancher2.Cluster("fooCluster",
description="Terraform EKS cluster",
eks_config_v2=rancher2.ClusterEksConfigV2Args(
cloud_credential_id=foo_cloud_credential.id,
region="<EKS_REGION>",
kubernetes_version="1.17",
logging_types=[
"audit",
"api",
],
node_groups=[
rancher2.ClusterEksConfigV2NodeGroupArgs(
name="node_group1",
instance_type="t3.medium",
desired_size=3,
max_size=5,
),
rancher2.ClusterEksConfigV2NodeGroupArgs(
name="node_group2",
instance_type="m5.xlarge",
desired_size=2,
max_size=3,
),
],
))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";
const fooCloudCredential = new rancher2.CloudCredential("fooCloudCredential", {
description: "foo test",
amazonec2CredentialConfig: {
accessKey: "<AWS_ACCESS_KEY>",
secretKey: "<AWS_SECRET_KEY>",
},
});
const fooCluster = new rancher2.Cluster("fooCluster", {
description: "Terraform EKS cluster",
eksConfigV2: {
cloudCredentialId: fooCloudCredential.id,
region: "<EKS_REGION>",
kubernetesVersion: "1.17",
loggingTypes: [
"audit",
"api",
],
nodeGroups: [
{
name: "node_group1",
instanceType: "t3.medium",
desiredSize: 3,
maxSize: 5,
},
{
name: "node_group2",
instanceType: "m5.xlarge",
desiredSize: 2,
maxSize: 3,
},
],
},
});
Create a Cluster Resource
new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);
def Cluster(resource_name: str, opts: Optional[ResourceOptions] = None, aks_config: Optional[ClusterAksConfigArgs] = None, annotations: Optional[Mapping[str, Any]] = None, cluster_auth_endpoint: Optional[ClusterClusterAuthEndpointArgs] = None, cluster_monitoring_input: Optional[ClusterClusterMonitoringInputArgs] = None, cluster_template_answers: Optional[ClusterClusterTemplateAnswersArgs] = None, cluster_template_id: Optional[str] = None, cluster_template_questions: Optional[Sequence[ClusterClusterTemplateQuestionArgs]] = None, cluster_template_revision_id: Optional[str] = None, default_pod_security_policy_template_id: Optional[str] = None, description: Optional[str] = None, desired_agent_image: Optional[str] = None, desired_auth_image: Optional[str] = None, docker_root_dir: Optional[str] = None, driver: Optional[str] = None, eks_config: Optional[ClusterEksConfigArgs] = None, eks_config_v2: Optional[ClusterEksConfigV2Args] = None, enable_cluster_alerting: Optional[bool] = None, enable_cluster_monitoring: Optional[bool] = None, enable_network_policy: Optional[bool] = None, gke_config: Optional[ClusterGkeConfigArgs] = None, k3s_config: Optional[ClusterK3sConfigArgs] = None, labels: Optional[Mapping[str, Any]] = None, name: Optional[str] = None, oke_config: Optional[ClusterOkeConfigArgs] = None, rke_config: Optional[ClusterRkeConfigArgs] = None, scheduled_cluster_scan: Optional[ClusterScheduledClusterScanArgs] = None, windows_prefered_cluster: Optional[bool] = None)
func NewCluster(ctx *Context, name string, args *ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs? args = null, CustomResourceOptions? opts = null)
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
Cluster Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The Cluster resource accepts the following input properties:
- Aks
Config ClusterAks Config Args The Azure AKS configuration for
aks
Clusters. Conflicts witheks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- Annotations Dictionary<string, object>
Annotations for cluster registration token object (map)
- Cluster
Auth ClusterEndpoint Cluster Auth Endpoint Args Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
- Cluster
Monitoring ClusterInput Cluster Monitoring Input Args Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
- Cluster
Template ClusterAnswers Cluster Template Answers Args Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
- Cluster
Template stringId Cluster template ID. Just for Rancher v2.3.x and above (string)
- Cluster
Template List<ClusterQuestions Cluster Template Question Args> Cluster template questions. Just for Rancher v2.3.x and above (list)
- Cluster
Template stringRevision Id Cluster template revision ID. Just for Rancher v2.3.x and above (string)
- Default
Pod stringSecurity Policy Template Id - Description string
An optional description of this cluster (string)
- Desired
Agent stringImage Desired agent image. Just for Rancher v2.3.x and above (string)
- Desired
Auth stringImage Desired auth image. Just for Rancher v2.3.x and above (string)
- Docker
Root stringDir 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
andrancherKubernetesEngine
are supported (string)- Eks
Config ClusterEks Config Args The Amazon EKS configuration for
eks
Clusters. Conflicts withaks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- Eks
Config ClusterV2 Eks Config V2Args The Amazon EKS configuration to create or import
eks
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
k3s_config
andrke_config
. For Rancher v2.5.x or above (list maxitems:1)- Enable
Cluster boolAlerting Enable built-in cluster alerting (bool)
- Enable
Cluster boolMonitoring Enable built-in cluster monitoring (bool)
- Enable
Network boolPolicy Enable project network isolation (bool)
- Gke
Config ClusterGke Config Args The Google GKE configuration for
gke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,oke_config
k3s_config
andrke_config
(list maxitems:1)- K3s
Config ClusterK3s Config Args The K3S configuration for
k3s
imported Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andrke_config
(list maxitems:1)- Labels Dictionary<string, object>
Labels for cluster registration token object (map)
- Name string
Name of cluster registration token (string)
- Oke
Config ClusterOke Config Args The Oracle OKE configuration for
oke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,gke_config
k3s_config
andrke_config
(list maxitems:1)- Rke
Config ClusterRke Config Args The RKE configuration for
rke
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andk3s_config
(list maxitems:1)- Scheduled
Cluster ClusterScan Scheduled Cluster Scan Args Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
- Windows
Prefered boolCluster Windows preferred cluster. Default:
false
(bool)
- Aks
Config ClusterAks Config The Azure AKS configuration for
aks
Clusters. Conflicts witheks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- Annotations map[string]interface{}
Annotations for cluster registration token object (map)
- Cluster
Auth ClusterEndpoint Cluster Auth Endpoint Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
- Cluster
Monitoring ClusterInput Cluster Monitoring Input Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
- Cluster
Template ClusterAnswers Cluster Template Answers Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
- Cluster
Template stringId Cluster template ID. Just for Rancher v2.3.x and above (string)
- Cluster
Template []ClusterQuestions Cluster Template Question Cluster template questions. Just for Rancher v2.3.x and above (list)
- Cluster
Template stringRevision Id Cluster template revision ID. Just for Rancher v2.3.x and above (string)
- Default
Pod stringSecurity Policy Template Id - Description string
An optional description of this cluster (string)
- Desired
Agent stringImage Desired agent image. Just for Rancher v2.3.x and above (string)
- Desired
Auth stringImage Desired auth image. Just for Rancher v2.3.x and above (string)
- Docker
Root stringDir 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
andrancherKubernetesEngine
are supported (string)- Eks
Config ClusterEks Config The Amazon EKS configuration for
eks
Clusters. Conflicts withaks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- Eks
Config ClusterV2 Eks Config V2 The Amazon EKS configuration to create or import
eks
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
k3s_config
andrke_config
. For Rancher v2.5.x or above (list maxitems:1)- Enable
Cluster boolAlerting Enable built-in cluster alerting (bool)
- Enable
Cluster boolMonitoring Enable built-in cluster monitoring (bool)
- Enable
Network boolPolicy Enable project network isolation (bool)
- Gke
Config ClusterGke Config The Google GKE configuration for
gke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,oke_config
k3s_config
andrke_config
(list maxitems:1)- K3s
Config ClusterK3s Config The K3S configuration for
k3s
imported Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andrke_config
(list maxitems:1)- Labels map[string]interface{}
Labels for cluster registration token object (map)
- Name string
Name of cluster registration token (string)
- Oke
Config ClusterOke Config The Oracle OKE configuration for
oke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,gke_config
k3s_config
andrke_config
(list maxitems:1)- Rke
Config ClusterRke Config The RKE configuration for
rke
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andk3s_config
(list maxitems:1)- Scheduled
Cluster ClusterScan Scheduled Cluster Scan Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
- Windows
Prefered boolCluster Windows preferred cluster. Default:
false
(bool)
- aks
Config ClusterAks Config The Azure AKS configuration for
aks
Clusters. Conflicts witheks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- annotations {[key: string]: any}
Annotations for cluster registration token object (map)
- cluster
Auth ClusterEndpoint Cluster Auth Endpoint Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
- cluster
Monitoring ClusterInput Cluster Monitoring Input Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
- cluster
Template ClusterAnswers Cluster Template Answers Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
- cluster
Template stringId Cluster template ID. Just for Rancher v2.3.x and above (string)
- cluster
Template ClusterQuestions Cluster Template Question[] Cluster template questions. Just for Rancher v2.3.x and above (list)
- cluster
Template stringRevision Id Cluster template revision ID. Just for Rancher v2.3.x and above (string)
- default
Pod stringSecurity Policy Template Id - description string
An optional description of this cluster (string)
- desired
Agent stringImage Desired agent image. Just for Rancher v2.3.x and above (string)
- desired
Auth stringImage Desired auth image. Just for Rancher v2.3.x and above (string)
- docker
Root stringDir 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
andrancherKubernetesEngine
are supported (string)- eks
Config ClusterEks Config The Amazon EKS configuration for
eks
Clusters. Conflicts withaks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- eks
Config ClusterV2 Eks Config V2 The Amazon EKS configuration to create or import
eks
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
k3s_config
andrke_config
. For Rancher v2.5.x or above (list maxitems:1)- enable
Cluster booleanAlerting Enable built-in cluster alerting (bool)
- enable
Cluster booleanMonitoring Enable built-in cluster monitoring (bool)
- enable
Network booleanPolicy Enable project network isolation (bool)
- gke
Config ClusterGke Config The Google GKE configuration for
gke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,oke_config
k3s_config
andrke_config
(list maxitems:1)- k3s
Config ClusterK3s Config The K3S configuration for
k3s
imported Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andrke_config
(list maxitems:1)- labels {[key: string]: any}
Labels for cluster registration token object (map)
- name string
Name of cluster registration token (string)
- oke
Config ClusterOke Config The Oracle OKE configuration for
oke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,gke_config
k3s_config
andrke_config
(list maxitems:1)- rke
Config ClusterRke Config The RKE configuration for
rke
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andk3s_config
(list maxitems:1)- scheduled
Cluster ClusterScan Scheduled Cluster Scan Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
- windows
Prefered booleanCluster Windows preferred cluster. Default:
false
(bool)
- aks_
config ClusterAks Config Args The Azure AKS configuration for
aks
Clusters. Conflicts witheks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- annotations Mapping[str, Any]
Annotations for cluster registration token object (map)
- cluster_
auth_ Clusterendpoint Cluster Auth Endpoint Args Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
- cluster_
monitoring_ Clusterinput Cluster Monitoring Input Args Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
- cluster_
template_ Clusteranswers Cluster Template Answers Args Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
- cluster_
template_ strid Cluster template ID. Just for Rancher v2.3.x and above (string)
- cluster_
template_ Sequence[Clusterquestions Cluster Template Question Args] Cluster template questions. Just for Rancher v2.3.x and above (list)
- cluster_
template_ strrevision_ id Cluster template revision ID. Just for Rancher v2.3.x and above (string)
- default_
pod_ strsecurity_ policy_ template_ id - description str
An optional description of this cluster (string)
- desired_
agent_ strimage Desired agent image. Just for Rancher v2.3.x and above (string)
- desired_
auth_ strimage Desired auth image. Just for Rancher v2.3.x and above (string)
- docker_
root_ strdir 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
andrancherKubernetesEngine
are supported (string)- eks_
config ClusterEks Config Args The Amazon EKS configuration for
eks
Clusters. Conflicts withaks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- eks_
config_ Clusterv2 Eks Config V2Args The Amazon EKS configuration to create or import
eks
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
k3s_config
andrke_config
. For Rancher v2.5.x or above (list maxitems:1)- enable_
cluster_ boolalerting Enable built-in cluster alerting (bool)
- enable_
cluster_ boolmonitoring Enable built-in cluster monitoring (bool)
- enable_
network_ boolpolicy Enable project network isolation (bool)
- gke_
config ClusterGke Config Args The Google GKE configuration for
gke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,oke_config
k3s_config
andrke_config
(list maxitems:1)- k3s_
config ClusterK3s Config Args The K3S configuration for
k3s
imported Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andrke_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 ClusterOke Config Args The Oracle OKE configuration for
oke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,gke_config
k3s_config
andrke_config
(list maxitems:1)- rke_
config ClusterRke Config Args The RKE configuration for
rke
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andk3s_config
(list maxitems:1)- scheduled_
cluster_ Clusterscan Scheduled Cluster Scan Args Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
- windows_
prefered_ boolcluster 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:
- Ca
Cert string TLS CA certificate for etcd service (string)
- Cluster
Registration ClusterToken Cluster Registration Token (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
- Default
Project stringId (Computed) Default project ID for the cluster (string)
- Enable
Cluster boolIstio Deploy istio on
system
project andistio-system
namespace, using rancher2.App resource instead. See above example.- Id string
- 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 string (Computed/Sensitive) Kube Config generated for the cluster (string)
- System
Project stringId (Computed) System project ID for the cluster (string)
- Ca
Cert string TLS CA certificate for etcd service (string)
- Cluster
Registration ClusterToken Cluster Registration Token (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
- Default
Project stringId (Computed) Default project ID for the cluster (string)
- Enable
Cluster boolIstio Deploy istio on
system
project andistio-system
namespace, using rancher2.App resource instead. See above example.- Id string
- 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 string (Computed/Sensitive) Kube Config generated for the cluster (string)
- System
Project stringId (Computed) System project ID for the cluster (string)
- ca
Cert string TLS CA certificate for etcd service (string)
- cluster
Registration ClusterToken Cluster Registration Token (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
- default
Project stringId (Computed) Default project ID for the cluster (string)
- enable
Cluster booleanIstio Deploy istio on
system
project andistio-system
namespace, using rancher2.App resource instead. See above example.- id string
- The provider-assigned unique ID for this managed resource.
- istio
Enabled boolean (Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)
- kube
Config string (Computed/Sensitive) Kube Config generated for the cluster (string)
- system
Project stringId (Computed) System project ID for the cluster (string)
- ca_
cert str TLS CA certificate for etcd service (string)
- cluster_
registration_ Clustertoken Cluster Registration Token (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
- default_
project_ strid (Computed) Default project ID for the cluster (string)
- enable_
cluster_ boolistio Deploy istio on
system
project andistio-system
namespace, using rancher2.App resource instead. See above example.- id str
- The provider-assigned unique ID for this managed resource.
- istio_
enabled bool (Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)
- kube_
config str (Computed/Sensitive) Kube Config generated for the cluster (string)
- system_
project_ strid (Computed) System project ID for the cluster (string)
Look up an Existing Cluster Resource
Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, aks_config: Optional[ClusterAksConfigArgs] = None, annotations: Optional[Mapping[str, Any]] = None, ca_cert: Optional[str] = None, cluster_auth_endpoint: Optional[ClusterClusterAuthEndpointArgs] = None, cluster_monitoring_input: Optional[ClusterClusterMonitoringInputArgs] = None, cluster_registration_token: Optional[ClusterClusterRegistrationTokenArgs] = None, cluster_template_answers: Optional[ClusterClusterTemplateAnswersArgs] = None, cluster_template_id: Optional[str] = None, cluster_template_questions: Optional[Sequence[ClusterClusterTemplateQuestionArgs]] = None, cluster_template_revision_id: Optional[str] = None, default_pod_security_policy_template_id: Optional[str] = None, default_project_id: Optional[str] = None, description: Optional[str] = None, desired_agent_image: Optional[str] = None, desired_auth_image: Optional[str] = None, docker_root_dir: Optional[str] = None, driver: Optional[str] = None, eks_config: Optional[ClusterEksConfigArgs] = None, eks_config_v2: Optional[ClusterEksConfigV2Args] = None, enable_cluster_alerting: Optional[bool] = None, enable_cluster_istio: Optional[bool] = None, enable_cluster_monitoring: Optional[bool] = None, enable_network_policy: Optional[bool] = None, gke_config: Optional[ClusterGkeConfigArgs] = None, istio_enabled: Optional[bool] = None, k3s_config: Optional[ClusterK3sConfigArgs] = None, kube_config: Optional[str] = None, labels: Optional[Mapping[str, Any]] = None, name: Optional[str] = None, oke_config: Optional[ClusterOkeConfigArgs] = None, rke_config: Optional[ClusterRkeConfigArgs] = None, scheduled_cluster_scan: Optional[ClusterScheduledClusterScanArgs] = None, system_project_id: Optional[str] = None, windows_prefered_cluster: Optional[bool] = None) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Aks
Config ClusterAks Config Args The Azure AKS configuration for
aks
Clusters. Conflicts witheks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- Annotations Dictionary<string, object>
Annotations for cluster registration token object (map)
- Ca
Cert string TLS CA certificate for etcd service (string)
- Cluster
Auth ClusterEndpoint Cluster Auth Endpoint Args Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
- Cluster
Monitoring ClusterInput Cluster Monitoring Input Args Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
- Cluster
Registration ClusterToken Cluster Registration Token Args (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
- Cluster
Template ClusterAnswers Cluster Template Answers Args Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
- Cluster
Template stringId Cluster template ID. Just for Rancher v2.3.x and above (string)
- Cluster
Template List<ClusterQuestions Cluster Template Question Args> Cluster template questions. Just for Rancher v2.3.x and above (list)
- Cluster
Template stringRevision Id Cluster template revision ID. Just for Rancher v2.3.x and above (string)
- Default
Pod stringSecurity Policy Template Id - Default
Project stringId (Computed) Default project ID for the cluster (string)
- Description string
An optional description of this cluster (string)
- Desired
Agent stringImage Desired agent image. Just for Rancher v2.3.x and above (string)
- Desired
Auth stringImage Desired auth image. Just for Rancher v2.3.x and above (string)
- Docker
Root stringDir 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
andrancherKubernetesEngine
are supported (string)- Eks
Config ClusterEks Config Args The Amazon EKS configuration for
eks
Clusters. Conflicts withaks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- Eks
Config ClusterV2 Eks Config V2Args The Amazon EKS configuration to create or import
eks
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
k3s_config
andrke_config
. For Rancher v2.5.x or above (list maxitems:1)- Enable
Cluster boolAlerting Enable built-in cluster alerting (bool)
- Enable
Cluster boolIstio Deploy istio on
system
project andistio-system
namespace, using rancher2.App resource instead. See above example.- Enable
Cluster boolMonitoring Enable built-in cluster monitoring (bool)
- Enable
Network boolPolicy Enable project network isolation (bool)
- Gke
Config ClusterGke Config Args The Google GKE configuration for
gke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,oke_config
k3s_config
andrke_config
(list maxitems:1)- Istio
Enabled bool (Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)
- K3s
Config ClusterK3s Config Args The K3S configuration for
k3s
imported Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andrke_config
(list maxitems:1)- Kube
Config string (Computed/Sensitive) Kube Config generated for the cluster (string)
- Labels Dictionary<string, object>
Labels for cluster registration token object (map)
- Name string
Name of cluster registration token (string)
- Oke
Config ClusterOke Config Args The Oracle OKE configuration for
oke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,gke_config
k3s_config
andrke_config
(list maxitems:1)- Rke
Config ClusterRke Config Args The RKE configuration for
rke
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andk3s_config
(list maxitems:1)- Scheduled
Cluster ClusterScan Scheduled Cluster Scan Args Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
- System
Project stringId (Computed) System project ID for the cluster (string)
- Windows
Prefered boolCluster Windows preferred cluster. Default:
false
(bool)
- Aks
Config ClusterAks Config The Azure AKS configuration for
aks
Clusters. Conflicts witheks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- Annotations map[string]interface{}
Annotations for cluster registration token object (map)
- Ca
Cert string TLS CA certificate for etcd service (string)
- Cluster
Auth ClusterEndpoint Cluster Auth Endpoint Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
- Cluster
Monitoring ClusterInput Cluster Monitoring Input Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
- Cluster
Registration ClusterToken Cluster Registration Token (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
- Cluster
Template ClusterAnswers Cluster Template Answers Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
- Cluster
Template stringId Cluster template ID. Just for Rancher v2.3.x and above (string)
- Cluster
Template []ClusterQuestions Cluster Template Question Cluster template questions. Just for Rancher v2.3.x and above (list)
- Cluster
Template stringRevision Id Cluster template revision ID. Just for Rancher v2.3.x and above (string)
- Default
Pod stringSecurity Policy Template Id - Default
Project stringId (Computed) Default project ID for the cluster (string)
- Description string
An optional description of this cluster (string)
- Desired
Agent stringImage Desired agent image. Just for Rancher v2.3.x and above (string)
- Desired
Auth stringImage Desired auth image. Just for Rancher v2.3.x and above (string)
- Docker
Root stringDir 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
andrancherKubernetesEngine
are supported (string)- Eks
Config ClusterEks Config The Amazon EKS configuration for
eks
Clusters. Conflicts withaks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- Eks
Config ClusterV2 Eks Config V2 The Amazon EKS configuration to create or import
eks
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
k3s_config
andrke_config
. For Rancher v2.5.x or above (list maxitems:1)- Enable
Cluster boolAlerting Enable built-in cluster alerting (bool)
- Enable
Cluster boolIstio Deploy istio on
system
project andistio-system
namespace, using rancher2.App resource instead. See above example.- Enable
Cluster boolMonitoring Enable built-in cluster monitoring (bool)
- Enable
Network boolPolicy Enable project network isolation (bool)
- Gke
Config ClusterGke Config The Google GKE configuration for
gke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,oke_config
k3s_config
andrke_config
(list maxitems:1)- Istio
Enabled bool (Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)
- K3s
Config ClusterK3s Config The K3S configuration for
k3s
imported Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andrke_config
(list maxitems:1)- Kube
Config string (Computed/Sensitive) Kube Config generated for the cluster (string)
- Labels map[string]interface{}
Labels for cluster registration token object (map)
- Name string
Name of cluster registration token (string)
- Oke
Config ClusterOke Config The Oracle OKE configuration for
oke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,gke_config
k3s_config
andrke_config
(list maxitems:1)- Rke
Config ClusterRke Config The RKE configuration for
rke
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andk3s_config
(list maxitems:1)- Scheduled
Cluster ClusterScan Scheduled Cluster Scan Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
- System
Project stringId (Computed) System project ID for the cluster (string)
- Windows
Prefered boolCluster Windows preferred cluster. Default:
false
(bool)
- aks
Config ClusterAks Config The Azure AKS configuration for
aks
Clusters. Conflicts witheks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- annotations {[key: string]: any}
Annotations for cluster registration token object (map)
- ca
Cert string TLS CA certificate for etcd service (string)
- cluster
Auth ClusterEndpoint Cluster Auth Endpoint Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
- cluster
Monitoring ClusterInput Cluster Monitoring Input Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
- cluster
Registration ClusterToken Cluster Registration Token (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
- cluster
Template ClusterAnswers Cluster Template Answers Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
- cluster
Template stringId Cluster template ID. Just for Rancher v2.3.x and above (string)
- cluster
Template ClusterQuestions Cluster Template Question[] Cluster template questions. Just for Rancher v2.3.x and above (list)
- cluster
Template stringRevision Id Cluster template revision ID. Just for Rancher v2.3.x and above (string)
- default
Pod stringSecurity Policy Template Id - default
Project stringId (Computed) Default project ID for the cluster (string)
- description string
An optional description of this cluster (string)
- desired
Agent stringImage Desired agent image. Just for Rancher v2.3.x and above (string)
- desired
Auth stringImage Desired auth image. Just for Rancher v2.3.x and above (string)
- docker
Root stringDir 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
andrancherKubernetesEngine
are supported (string)- eks
Config ClusterEks Config The Amazon EKS configuration for
eks
Clusters. Conflicts withaks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- eks
Config ClusterV2 Eks Config V2 The Amazon EKS configuration to create or import
eks
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
k3s_config
andrke_config
. For Rancher v2.5.x or above (list maxitems:1)- enable
Cluster booleanAlerting Enable built-in cluster alerting (bool)
- enable
Cluster booleanIstio Deploy istio on
system
project andistio-system
namespace, using rancher2.App resource instead. See above example.- enable
Cluster booleanMonitoring Enable built-in cluster monitoring (bool)
- enable
Network booleanPolicy Enable project network isolation (bool)
- gke
Config ClusterGke Config The Google GKE configuration for
gke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,oke_config
k3s_config
andrke_config
(list maxitems:1)- istio
Enabled boolean (Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)
- k3s
Config ClusterK3s Config The K3S configuration for
k3s
imported Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andrke_config
(list maxitems:1)- kube
Config string (Computed/Sensitive) Kube Config generated for the cluster (string)
- labels {[key: string]: any}
Labels for cluster registration token object (map)
- name string
Name of cluster registration token (string)
- oke
Config ClusterOke Config The Oracle OKE configuration for
oke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,gke_config
k3s_config
andrke_config
(list maxitems:1)- rke
Config ClusterRke Config The RKE configuration for
rke
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andk3s_config
(list maxitems:1)- scheduled
Cluster ClusterScan Scheduled Cluster Scan Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
- system
Project stringId (Computed) System project ID for the cluster (string)
- windows
Prefered booleanCluster Windows preferred cluster. Default:
false
(bool)
- aks_
config ClusterAks Config Args The Azure AKS configuration for
aks
Clusters. Conflicts witheks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_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_ Clusterendpoint Cluster Auth Endpoint Args Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)
- cluster_
monitoring_ Clusterinput Cluster Monitoring Input Args Cluster monitoring config. Any parameter defined in rancher-monitoring charts could be configured (list maxitems:1)
- cluster_
registration_ Clustertoken Cluster Registration Token Args (Computed) Cluster Registration Token generated for the cluster (list maxitems:1)
- cluster_
template_ Clusteranswers Cluster Template Answers Args Cluster template answers. Just for Rancher v2.3.x and above (list maxitems:1)
- cluster_
template_ strid Cluster template ID. Just for Rancher v2.3.x and above (string)
- cluster_
template_ Sequence[Clusterquestions Cluster Template Question Args] Cluster template questions. Just for Rancher v2.3.x and above (list)
- cluster_
template_ strrevision_ id Cluster template revision ID. Just for Rancher v2.3.x and above (string)
- default_
pod_ strsecurity_ policy_ template_ id - default_
project_ strid (Computed) Default project ID for the cluster (string)
- description str
An optional description of this cluster (string)
- desired_
agent_ strimage Desired agent image. Just for Rancher v2.3.x and above (string)
- desired_
auth_ strimage Desired auth image. Just for Rancher v2.3.x and above (string)
- docker_
root_ strdir 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
andrancherKubernetesEngine
are supported (string)- eks_
config ClusterEks Config Args The Amazon EKS configuration for
eks
Clusters. Conflicts withaks_config
,eks_config_v2
,gke_config
,oke_config
k3s_config
andrke_config
(list maxitems:1)- eks_
config_ Clusterv2 Eks Config V2Args The Amazon EKS configuration to create or import
eks
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
k3s_config
andrke_config
. For Rancher v2.5.x or above (list maxitems:1)- enable_
cluster_ boolalerting Enable built-in cluster alerting (bool)
- enable_
cluster_ boolistio Deploy istio on
system
project andistio-system
namespace, using rancher2.App resource instead. See above example.- enable_
cluster_ boolmonitoring Enable built-in cluster monitoring (bool)
- enable_
network_ boolpolicy Enable project network isolation (bool)
- gke_
config ClusterGke Config Args The Google GKE configuration for
gke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,oke_config
k3s_config
andrke_config
(list maxitems:1)- istio_
enabled bool (Computed) Is istio enabled at cluster? Just for Rancher v2.3.x and above (bool)
- k3s_
config ClusterK3s Config Args The K3S configuration for
k3s
imported Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andrke_config
(list maxitems:1)- kube_
config str (Computed/Sensitive) Kube Config generated for the cluster (string)
- labels Mapping[str, Any]
Labels for cluster registration token object (map)
- name str
Name of cluster registration token (string)
- oke_
config ClusterOke Config Args The Oracle OKE configuration for
oke
Clusters. Conflicts withaks_config
,eks_config
,eks_import
,gke_config
k3s_config
andrke_config
(list maxitems:1)- rke_
config ClusterRke Config Args The RKE configuration for
rke
Clusters. Conflicts withaks_config
,eks_config
,gke_config
,oke_config
andk3s_config
(list maxitems:1)- scheduled_
cluster_ Clusterscan Scheduled Cluster Scan Args Cluster scheduled cis scan. For Rancher v2.4.0 or above (List maxitems:1)
- system_
project_ strid (Computed) System project ID for the cluster (string)
- windows_
prefered_ boolcluster Windows preferred cluster. Default:
false
(bool)
Supporting Types
ClusterAksConfig
- Agent
Dns stringPrefix DNS prefix to be used to create the FQDN for the agent pool (string)
- Client
Id string Azure client ID to use (string)
- Client
Secret string Azure client secret associated with the \“client id\” (string)
- Kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- Master
Dns stringPrefix DNS prefix to use the Kubernetes cluster control pane (string)
- Resource
Group string The name of the Cluster resource group (string)
- Ssh
Public stringKey Contents Contents of the SSH public key used to authenticate with Linux hosts (string)
- Subnet string
The name of an existing Azure Virtual Subnet. Composite of agent virtual network subnet ID (string)
- Subscription
Id string Subscription credentials which uniquely identify Microsoft Azure subscription (string)
- Tenant
Id string Azure tenant ID to use (string)
- Virtual
Network string The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)
- Virtual
Network stringResource Group The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)
- Aad
Server stringApp Secret The secret of an Azure Active Directory server application (string)
- Aad
Tenant stringId The ID of an Azure Active Directory tenant (string)
- Add
Client stringApp Id The ID of an Azure Active Directory client application of type \“Native\“. This application is for user login via kubectl (string)
- Add
Server stringApp Id 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 string The administrator username to use for Linux hosts. Default
azureuser
(string)- Agent
Os intDisk Size 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 stringName Name for the agent pool, upto 12 alphanumeric characters. Default
agentpool0
(string)- Agent
Storage stringProfile Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default
ManagedDisks
(string)- Agent
Vm stringSize Size of machine in the agent pool. Default
Standard_D1_v2
(string)- Auth
Base stringUrl Different authentication API url to use. Default
https://login.microsoftonline.com/
(string)- Base
Url string Different resource management API url to use. Default
https://management.azure.com/
(string)- Count int
Number of machines (VMs) in the agent pool. Allowed values must be in the range of 1 to 100 (inclusive). Default
1
(int)- Dns
Service stringIp 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 stringCidr 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 boolApplication Routing Enable the Kubernetes ingress with automatic public DNS name creation. Default
false
(bool)- Enable
Monitoring bool Turn on Azure Log Analytics monitoring. Uses the Log Analytics \“Default\” workspace if it exists, else creates one. if using an existing workspace, specifies \“log analytics workspace resource id\“. Default
true
(bool)- Location string
Azure Kubernetes cluster location. Default
eastus
(string)- Log
Analytics stringWorkspace 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 stringWorkspace Resource Group The resource group of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses the ‘Cluster’ resource group (string)
- Max
Pods int Maximum number of pods that can run on a node. Default
110
(int)- Network
Plugin string Network plugin used for building Kubernetes network. Chooses from
azure
orkubenet
. Defaultazure
(string)- Network
Policy string Network policy used for building Kubernetes network. Chooses from
calico
(string)- Pod
Cidr string A CIDR notation IP range from which to assign Kubernetes Pod IPs when \“network plugin\” is specified in \“kubenet\“. Default
172.244.0.0/16
(string)- Service
Cidr string A CIDR notation IP range from which to assign Kubernetes Service cluster IPs. It must not overlap with any Subnet IP ranges. Default
10.0.0.0/16
(string)- Tag Dictionary<string, object>
Tags for Kubernetes cluster. For example, foo=bar (map)
- Agent
Dns stringPrefix DNS prefix to be used to create the FQDN for the agent pool (string)
- Client
Id string Azure client ID to use (string)
- Client
Secret string Azure client secret associated with the \“client id\” (string)
- Kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- Master
Dns stringPrefix DNS prefix to use the Kubernetes cluster control pane (string)
- Resource
Group string The name of the Cluster resource group (string)
- Ssh
Public stringKey Contents Contents of the SSH public key used to authenticate with Linux hosts (string)
- Subnet string
The name of an existing Azure Virtual Subnet. Composite of agent virtual network subnet ID (string)
- Subscription
Id string Subscription credentials which uniquely identify Microsoft Azure subscription (string)
- Tenant
Id string Azure tenant ID to use (string)
- Virtual
Network string The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)
- Virtual
Network stringResource Group The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)
- Aad
Server stringApp Secret The secret of an Azure Active Directory server application (string)
- Aad
Tenant stringId The ID of an Azure Active Directory tenant (string)
- Add
Client stringApp Id The ID of an Azure Active Directory client application of type \“Native\“. This application is for user login via kubectl (string)
- Add
Server stringApp Id 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 string The administrator username to use for Linux hosts. Default
azureuser
(string)- Agent
Os intDisk Size 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 stringName Name for the agent pool, upto 12 alphanumeric characters. Default
agentpool0
(string)- Agent
Storage stringProfile Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default
ManagedDisks
(string)- Agent
Vm stringSize Size of machine in the agent pool. Default
Standard_D1_v2
(string)- Auth
Base stringUrl Different authentication API url to use. Default
https://login.microsoftonline.com/
(string)- Base
Url string Different resource management API url to use. Default
https://management.azure.com/
(string)- Count int
Number of machines (VMs) in the agent pool. Allowed values must be in the range of 1 to 100 (inclusive). Default
1
(int)- Dns
Service stringIp 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 stringCidr 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 boolApplication Routing Enable the Kubernetes ingress with automatic public DNS name creation. Default
false
(bool)- Enable
Monitoring bool Turn on Azure Log Analytics monitoring. Uses the Log Analytics \“Default\” workspace if it exists, else creates one. if using an existing workspace, specifies \“log analytics workspace resource id\“. Default
true
(bool)- Location string
Azure Kubernetes cluster location. Default
eastus
(string)- Log
Analytics stringWorkspace 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 stringWorkspace Resource Group The resource group of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses the ‘Cluster’ resource group (string)
- Max
Pods int Maximum number of pods that can run on a node. Default
110
(int)- Network
Plugin string Network plugin used for building Kubernetes network. Chooses from
azure
orkubenet
. Defaultazure
(string)- Network
Policy string Network policy used for building Kubernetes network. Chooses from
calico
(string)- Pod
Cidr string A CIDR notation IP range from which to assign Kubernetes Pod IPs when \“network plugin\” is specified in \“kubenet\“. Default
172.244.0.0/16
(string)- Service
Cidr string A CIDR notation IP range from which to assign Kubernetes Service cluster IPs. It must not overlap with any Subnet IP ranges. Default
10.0.0.0/16
(string)- Tag map[string]interface{}
Tags for Kubernetes cluster. For example, foo=bar (map)
- agent
Dns stringPrefix DNS prefix to be used to create the FQDN for the agent pool (string)
- client
Id string Azure client ID to use (string)
- client
Secret string Azure client secret associated with the \“client id\” (string)
- kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- master
Dns stringPrefix DNS prefix to use the Kubernetes cluster control pane (string)
- resource
Group string The name of the Cluster resource group (string)
- ssh
Public stringKey Contents Contents of the SSH public key used to authenticate with Linux hosts (string)
- subnet string
The name of an existing Azure Virtual Subnet. Composite of agent virtual network subnet ID (string)
- subscription
Id string Subscription credentials which uniquely identify Microsoft Azure subscription (string)
- tenant
Id string Azure tenant ID to use (string)
- virtual
Network string The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)
- virtual
Network stringResource Group The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)
- aad
Server stringApp Secret The secret of an Azure Active Directory server application (string)
- aad
Tenant stringId The ID of an Azure Active Directory tenant (string)
- add
Client stringApp Id The ID of an Azure Active Directory client application of type \“Native\“. This application is for user login via kubectl (string)
- add
Server stringApp Id 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 string The administrator username to use for Linux hosts. Default
azureuser
(string)- agent
Os numberDisk Size 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 stringName Name for the agent pool, upto 12 alphanumeric characters. Default
agentpool0
(string)- agent
Storage stringProfile Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default
ManagedDisks
(string)- agent
Vm stringSize Size of machine in the agent pool. Default
Standard_D1_v2
(string)- auth
Base stringUrl Different authentication API url to use. Default
https://login.microsoftonline.com/
(string)- base
Url string Different resource management API url to use. Default
https://management.azure.com/
(string)- count number
Number of machines (VMs) in the agent pool. Allowed values must be in the range of 1 to 100 (inclusive). Default
1
(int)- dns
Service stringIp 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 stringCidr 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 booleanApplication Routing Enable the Kubernetes ingress with automatic public DNS name creation. Default
false
(bool)- enable
Monitoring boolean Turn on Azure Log Analytics monitoring. Uses the Log Analytics \“Default\” workspace if it exists, else creates one. if using an existing workspace, specifies \“log analytics workspace resource id\“. Default
true
(bool)- location string
Azure Kubernetes cluster location. Default
eastus
(string)- log
Analytics stringWorkspace 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 stringWorkspace Resource Group 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 number Maximum number of pods that can run on a node. Default
110
(int)- network
Plugin string Network plugin used for building Kubernetes network. Chooses from
azure
orkubenet
. Defaultazure
(string)- network
Policy string Network policy used for building Kubernetes network. Chooses from
calico
(string)- pod
Cidr string A CIDR notation IP range from which to assign Kubernetes Pod IPs when \“network plugin\” is specified in \“kubenet\“. Default
172.244.0.0/16
(string)- service
Cidr string A CIDR notation IP range from which to assign Kubernetes Service cluster IPs. It must not overlap with any Subnet IP ranges. Default
10.0.0.0/16
(string)- tag {[key: string]: any}
Tags for Kubernetes cluster. For example, foo=bar (map)
- agent_
dns_ strprefix 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_ strprefix DNS prefix to use the Kubernetes cluster control pane (string)
- resource_
group str The name of the Cluster resource group (string)
- ssh_
public_ strkey_ contents Contents of the SSH public key used to authenticate with Linux hosts (string)
- subnet str
The name of an existing Azure Virtual Subnet. Composite of agent virtual network subnet ID (string)
- subscription_
id str Subscription credentials which uniquely identify Microsoft Azure subscription (string)
- tenant_
id str Azure tenant ID to use (string)
- virtual_
network str The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)
- virtual_
network_ strresource_ group The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)
- aad_
server_ strapp_ secret The secret of an Azure Active Directory server application (string)
- aad_
tenant_ strid The ID of an Azure Active Directory tenant (string)
- add_
client_ strapp_ id The ID of an Azure Active Directory client application of type \“Native\“. This application is for user login via kubectl (string)
- add_
server_ strapp_ id 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_ intdisk_ size 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_ strname Name for the agent pool, upto 12 alphanumeric characters. Default
agentpool0
(string)- agent_
storage_ strprofile Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default
ManagedDisks
(string)- agent_
vm_ strsize Size of machine in the agent pool. Default
Standard_D1_v2
(string)- auth_
base_ strurl Different authentication API url to use. Default
https://login.microsoftonline.com/
(string)- base_
url str Different resource management API url to use. Default
https://management.azure.com/
(string)- count int
Number of machines (VMs) in the agent pool. Allowed values must be in the range of 1 to 100 (inclusive). Default
1
(int)- dns_
service_ strip 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_ strcidr 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_ boolapplication_ routing Enable the Kubernetes ingress with automatic public DNS name creation. Default
false
(bool)- enable_
monitoring bool Turn on Azure Log Analytics monitoring. Uses the Log Analytics \“Default\” workspace if it exists, else creates one. if using an existing workspace, specifies \“log analytics workspace resource id\“. Default
true
(bool)- location str
Azure Kubernetes cluster location. Default
eastus
(string)- log_
analytics_ strworkspace 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_ strworkspace_ resource_ group The resource group of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses the ‘Cluster’ resource group (string)
- max_
pods int Maximum number of pods that can run on a node. Default
110
(int)- network_
plugin str Network plugin used for building Kubernetes network. Chooses from
azure
orkubenet
. Defaultazure
(string)- network_
policy str Network policy used for building Kubernetes network. Chooses from
calico
(string)- pod_
cidr str A CIDR notation IP range from which to assign Kubernetes Pod IPs when \“network plugin\” is specified in \“kubenet\“. Default
172.244.0.0/16
(string)- service_
cidr str A CIDR notation IP range from which to assign Kubernetes Service cluster IPs. It must not overlap with any Subnet IP ranges. Default
10.0.0.0/16
(string)- tag Mapping[str, Any]
Tags for Kubernetes cluster. For example, foo=bar (map)
ClusterClusterAuthEndpoint
ClusterClusterMonitoringInput
ClusterClusterRegistrationToken
- Annotations Dictionary<string, object>
Annotations for cluster registration token object (map)
- Cluster
Id string Cluster ID (string)
- Command string
Command to execute in a imported k8s cluster (string)
- Id string
(Computed) The ID of the resource (string)
- Insecure
Command string Insecure command to execute in a imported k8s cluster (string)
- Labels Dictionary<string, object>
Labels for cluster registration token object (map)
- Manifest
Url string K8s manifest url to execute with
kubectl
to import an existing k8s cluster (string)- Name string
Name of cluster registration token (string)
- Node
Command string Node command to execute in linux nodes for custom k8s cluster (string)
- Token string
Token for cluster registration token object (string)
- Windows
Node stringCommand Node command to execute in windows nodes for custom k8s cluster (string)
- Annotations map[string]interface{}
Annotations for cluster registration token object (map)
- Cluster
Id string Cluster ID (string)
- Command string
Command to execute in a imported k8s cluster (string)
- Id string
(Computed) The ID of the resource (string)
- Insecure
Command string Insecure command to execute in a imported k8s cluster (string)
- Labels map[string]interface{}
Labels for cluster registration token object (map)
- Manifest
Url string K8s manifest url to execute with
kubectl
to import an existing k8s cluster (string)- Name string
Name of cluster registration token (string)
- Node
Command string Node command to execute in linux nodes for custom k8s cluster (string)
- Token string
Token for cluster registration token object (string)
- Windows
Node stringCommand Node command to execute in windows nodes for custom k8s cluster (string)
- annotations {[key: string]: any}
Annotations for cluster registration token object (map)
- cluster
Id string Cluster ID (string)
- command string
Command to execute in a imported k8s cluster (string)
- id string
(Computed) The ID of the resource (string)
- insecure
Command string Insecure command to execute in a imported k8s cluster (string)
- labels {[key: string]: any}
Labels for cluster registration token object (map)
- manifest
Url string K8s manifest url to execute with
kubectl
to import an existing k8s cluster (string)- name string
Name of cluster registration token (string)
- node
Command string Node command to execute in linux nodes for custom k8s cluster (string)
- token string
Token for cluster registration token object (string)
- windows
Node stringCommand Node command to execute in windows nodes for custom k8s cluster (string)
- annotations Mapping[str, Any]
Annotations for cluster registration token object (map)
- cluster_
id str Cluster ID (string)
- command str
Command to execute in a imported k8s cluster (string)
- id str
(Computed) The ID of the resource (string)
- insecure_
command str Insecure command to execute in a imported k8s cluster (string)
- labels Mapping[str, Any]
Labels for cluster registration token object (map)
- manifest_
url str K8s manifest url to execute with
kubectl
to import an existing k8s cluster (string)- name str
Name of cluster registration token (string)
- node_
command str Node command to execute in linux nodes for custom k8s cluster (string)
- token str
Token for cluster registration token object (string)
- windows_
node_ strcommand Node command to execute in windows nodes for custom k8s cluster (string)
ClusterClusterTemplateAnswers
- cluster_
id str Cluster ID (string)
- project_
id str Project ID to apply answer (string)
- values Mapping[str, Any]
Key/values for answer (map)
ClusterClusterTemplateQuestion
ClusterEksConfig
- Access
Key string The AWS Client ID to use (string)
- Kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- Secret
Key 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)
- Associate
Worker boolNode Public Ip 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 string The EKS node group instance type. Default:
t3.medium
(string)- Key
Pair stringName 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 intSize 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)
- Security
Groups List<string> List of security groups to use for the cluster (list)
- Service
Role string The AWS service role to use (string)
- Session
Token string A session token to use with the client key and secret if applicable (string)
- Subnets List<string>
List of subnets in the virtual network to use (list)
- User
Data string Pass user-data to the nodes to perform automated configuration tasks (string)
- Virtual
Network string The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)
- Access
Key string The AWS Client ID to use (string)
- Kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- Secret
Key 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)
- Associate
Worker boolNode Public Ip 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 string The EKS node group instance type. Default:
t3.medium
(string)- Key
Pair stringName 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 intSize 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)
- Security
Groups []string List of security groups to use for the cluster (list)
- Service
Role string The AWS service role to use (string)
- Session
Token string A session token to use with the client key and secret if applicable (string)
- Subnets []string
List of subnets in the virtual network to use (list)
- User
Data string Pass user-data to the nodes to perform automated configuration tasks (string)
- Virtual
Network string The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)
- access
Key string The AWS Client ID to use (string)
- kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- secret
Key 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)
- associate
Worker booleanNode Public Ip Associate public ip EKS worker nodes. Default
true
(bool)- desired
Nodes number The desired number of worker nodes. Just for Rancher v2.3.x and above. Default
3
(int)- ebs
Encryption boolean - instance
Type string The EKS node group instance type. Default:
t3.medium
(string)- key
Pair stringName Allow user to specify key name to use. Just for Rancher v2.2.7 and above (string)
- maximum
Nodes number The maximum number of worker nodes. Default
3
(int)- minimum
Nodes number The minimum number of worker nodes. Default
1
(int)- node
Volume numberSize 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)
- security
Groups string[] List of security groups to use for the cluster (list)
- service
Role string The AWS service role to use (string)
- session
Token string A session token to use with the client key and secret if applicable (string)
- subnets string[]
List of subnets in the virtual network to use (list)
- user
Data string Pass user-data to the nodes to perform automated configuration tasks (string)
- virtual
Network 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_ boolnode_ public_ ip 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_ strname 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_ intsize The volume size for each node. Default
20
(int)- region str
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- security_
groups Sequence[str] List of security groups to use for the cluster (list)
- service_
role str The AWS service role to use (string)
- session_
token str A session token to use with the client key and secret if applicable (string)
- subnets Sequence[str]
List of subnets in the virtual network to use (list)
- user_
data str Pass user-data to the nodes to perform automated configuration tasks (string)
- virtual_
network str The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)
ClusterEksConfigV2
- Cloud
Credential stringId The EKS cloud_credential id (string)
- Imported bool
Set to
true
to import EKS cluster. Default:false
(bool)- Kms
Key string The AWS kms key to use (string)
- Kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- Logging
Types List<string> The AWS cloudwatch logging types.
audit
,api
,scheduler
,controllerManager
andauthenticator
values are allowed (list)- Name string
Name of cluster registration token (string)
- Node
Groups List<ClusterEks Config V2Node Group Args> The EKS cluster name to import. Required to create a new cluster (list)
- Private
Access bool The EKS cluster has private access. Default:
false
(bool)- Public
Access bool The EKS cluster has public access. Default:
true
(bool)- Public
Access List<string>Sources 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)
- Secrets
Encryption bool Enable EKS cluster secret encryption. Default:
false
(bool)- Security
Groups List<string> List of security groups to use for the cluster (list)
- Service
Role string The AWS service role to use (string)
- Subnets List<string>
List of subnets in the virtual network to use (list)
- Dictionary<string, object>
The EKS cluster tags (map)
- Cloud
Credential stringId The EKS cloud_credential id (string)
- Imported bool
Set to
true
to import EKS cluster. Default:false
(bool)- Kms
Key string The AWS kms key to use (string)
- Kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- Logging
Types []string The AWS cloudwatch logging types.
audit
,api
,scheduler
,controllerManager
andauthenticator
values are allowed (list)- Name string
Name of cluster registration token (string)
- Node
Groups []ClusterEks Config V2Node Group The EKS cluster name to import. Required to create a new cluster (list)
- Private
Access bool The EKS cluster has private access. Default:
false
(bool)- Public
Access bool The EKS cluster has public access. Default:
true
(bool)- Public
Access []stringSources 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)
- Secrets
Encryption bool Enable EKS cluster secret encryption. Default:
false
(bool)- Security
Groups []string List of security groups to use for the cluster (list)
- Service
Role string The AWS service role to use (string)
- Subnets []string
List of subnets in the virtual network to use (list)
- map[string]interface{}
The EKS cluster tags (map)
- cloud
Credential stringId The EKS cloud_credential id (string)
- imported boolean
Set to
true
to import EKS cluster. Default:false
(bool)- kms
Key string The AWS kms key to use (string)
- kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- logging
Types string[] The AWS cloudwatch logging types.
audit
,api
,scheduler
,controllerManager
andauthenticator
values are allowed (list)- name string
Name of cluster registration token (string)
- node
Groups ClusterEks Config V2Node Group[] The EKS cluster name to import. Required to create a new cluster (list)
- private
Access boolean The EKS cluster has private access. Default:
false
(bool)- public
Access boolean The EKS cluster has public access. Default:
true
(bool)- public
Access string[]Sources 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)
- secrets
Encryption boolean Enable EKS cluster secret encryption. Default:
false
(bool)- security
Groups string[] List of security groups to use for the cluster (list)
- service
Role string The AWS service role to use (string)
- subnets string[]
List of subnets in the virtual network to use (list)
- {[key: string]: any}
The EKS cluster tags (map)
- cloud_
credential_ strid The EKS cloud_credential id (string)
- imported bool
Set to
true
to import EKS cluster. Default:false
(bool)- kms_
key str The AWS kms key to use (string)
- kubernetes_
version str The Kubernetes version that will be used for your master and OKE worker nodes (string)
- logging_
types Sequence[str] The AWS cloudwatch logging types.
audit
,api
,scheduler
,controllerManager
andauthenticator
values are allowed (list)- name str
Name of cluster registration token (string)
- node_
groups Sequence[ClusterEks Config V2Node Group Args] The EKS cluster name to import. Required to create a new cluster (list)
- private_
access bool The EKS cluster has private access. Default:
false
(bool)- public_
access bool The EKS cluster has public access. Default:
true
(bool)- public_
access_ Sequence[str]sources The EKS cluster public access sources (map)
- region str
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- secrets_
encryption bool Enable EKS cluster secret encryption. Default:
false
(bool)- security_
groups Sequence[str] List of security groups to use for the cluster (list)
- service_
role str The AWS service role to use (string)
- subnets Sequence[str]
List of subnets in the virtual network to use (list)
- Mapping[str, Any]
The EKS cluster tags (map)
ClusterEksConfigV2NodeGroup
- Name string
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)- Ec2Ssh
Key string The EKS node group ssh key (string)
- Gpu bool
Set true to EKS use gpu. Default:
false
(bool)- Instance
Type string The EKS node group instance type. Default:
t3.medium
(string)- Labels Dictionary<string, object>
Labels for cluster registration token object (map)
- Max
Size int The EKS node group maximum size. Default
2
(int)- Min
Size int The EKS node group maximum size. Default
2
(int)- Dictionary<string, object>
The EKS cluster tags (map)
- Name string
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)- Ec2Ssh
Key string The EKS node group ssh key (string)
- Gpu bool
Set true to EKS use gpu. Default:
false
(bool)- Instance
Type string The EKS node group instance type. Default:
t3.medium
(string)- Labels map[string]interface{}
Labels for cluster registration token object (map)
- Max
Size int The EKS node group maximum size. Default
2
(int)- Min
Size int The EKS node group maximum size. Default
2
(int)- map[string]interface{}
The EKS cluster tags (map)
- name string
Name of cluster registration token (string)
- desired
Size number The EKS node group desired size. Default:
2
(int)- disk
Size number The EKS node group disk size (Gb). Default:
20
(int)- ec2Ssh
Key string The EKS node group ssh key (string)
- gpu boolean
Set true to EKS use gpu. Default:
false
(bool)- instance
Type string The EKS node group instance type. Default:
t3.medium
(string)- labels {[key: string]: any}
Labels for cluster registration token object (map)
- max
Size number The EKS node group maximum size. Default
2
(int)- min
Size number The EKS node group maximum size. Default
2
(int)- {[key: string]: any}
The EKS cluster tags (map)
- name str
Name of cluster registration token (string)
- desired_
size int The EKS node group desired size. Default:
2
(int)- disk_
size int The EKS node group disk size (Gb). Default:
20
(int)- ec2_
ssh_ strkey The EKS node group ssh key (string)
- gpu bool
Set true to EKS use gpu. Default:
false
(bool)- instance_
type str The EKS node group instance type. Default:
t3.medium
(string)- labels Mapping[str, Any]
Labels for cluster registration token object (map)
- max_
size int The EKS node group maximum size. Default
2
(int)- min_
size int The EKS node group maximum size. Default
2
(int)- Mapping[str, Any]
The EKS cluster tags (map)
ClusterGkeConfig
- Cluster
Ipv4Cidr string The IP address range of the container pods (string)
- Credential string
The contents of the GC credential file (string)
- Disk
Type string Type of the disk attached to each node (string)
- Image
Type string The image to use for the worker nodes (string)
- Ip
Policy stringCluster Ipv4Cidr Block The IP address range for the cluster pod IPs (string)
- Ip
Policy stringCluster Secondary Range Name The name of the secondary range to be used for the cluster CIDR block (string)
- Ip
Policy stringNode Ipv4Cidr Block The IP address range of the instance IPs in this cluster (string)
- Ip
Policy stringServices Ipv4Cidr Block The IP address range of the services IPs in this cluster (string)
- Ip
Policy stringServices Secondary Range Name The name of the secondary range to be used for the services CIDR block (string)
- Ip
Policy stringSubnetwork Name A custom subnetwork name to be used if createSubnetwork is true (string)
- Locations List<string>
Locations for GKE cluster (list)
- Machine
Type string Machine type for GKE cluster (string)
- Maintenance
Window string Maintenance window for GKE cluster (string)
- Master
Ipv4Cidr stringBlock The IP range in CIDR notation to use for the hosted master network (string)
- Master
Version string Master version for GKE cluster (string)
- Network string
Network for GKE cluster (string)
- Node
Pool string The ID of the cluster node pool (string)
- Node
Version string Node version for GKE cluster (string)
- Oauth
Scopes List<string> The set of Google API scopes to be made available on all of the node VMs under the default service account (list)
- Project
Id string Project ID to apply answer (string)
- Service
Account string The Google Cloud Platform Service Account to be used by the node VMs (string)
- Sub
Network string Subnetwork for GKE cluster (string)
- Description string
An optional description of this cluster (string)
- Disk
Size intGb Size of the disk attached to each node. Default
100
(int)- Enable
Alpha boolFeature To enable Kubernetes alpha feature. Default
true
(bool)- Enable
Auto boolRepair Specifies whether the node auto-repair is enabled for the node pool. Default
false
(bool)- Enable
Auto boolUpgrade Specifies whether node auto-upgrade is enabled for the node pool. Default
false
(bool)- Enable
Horizontal boolPod Autoscaling Enable horizontal pod autoscaling for the cluster. Default
true
(bool)- Enable
Http boolLoad Balancing Enable HTTP load balancing on GKE cluster. Default
true
(bool)- Enable
Kubernetes boolDashboard Specifies whether to enable the Kubernetes dashboard. Default
false
(bool)- Enable
Legacy boolAbac Whether to enable legacy abac on the cluster. Default
false
(bool)- bool
Enable master authorized network. Set to
true
ifmaster_authorized_network_cidr_blocks
is set. Defaultfalse
(bool)- Enable
Network boolPolicy Config Enable network policy config for the cluster. Default
true
(bool)- Enable
Nodepool boolAutoscaling Enable nodepool autoscaling. Default
false
(bool)- Enable
Private boolEndpoint Whether the master’s internal IP address is used as the cluster endpoint. Default
false
(bool)- Enable
Private boolNodes Specifies whether worker nodes will be deployed into a new, private, subnet. Default
false
(bool)- Enable
Stackdriver boolLogging Enable stackdriver monitoring. Default
true
(bool)- Enable
Stackdriver boolMonitoring Enable stackdriver monitoring on GKE cluster (bool)
- Ip
Policy boolCreate Subnetwork Whether a new subnetwork will be created automatically for the cluster. Default
false
(bool)- Issue
Client boolCertificate Issue a client certificate. Default
false
(bool)- Kubernetes
Dashboard bool Enable the Kubernetes dashboard. Default
false
(bool)- Labels Dictionary<string, object>
Labels for cluster registration token object (map)
- Local
Ssd intCount The number of local SSD disks to be attached to the node. Default
0
(int)- List<string>
Define up to 10 external networks that could access Kubernetes master through HTTPS (list)
- Max
Node intCount Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default
0
(int)- Min
Node intCount Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default
0
(int)- Node
Count int Node count for GKE cluster. Default
3
(int)- Preemptible bool
Whether the nodes are created as preemptible VM instances. Default
false
(bool)- Region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- Resource
Labels Dictionary<string, object> The map of Kubernetes labels to be applied to each cluster (map)
- Taints List<string>
List of Kubernetes taints to be applied to each node (list)
- Use
Ip boolAliases Whether alias IPs will be used for pod IPs in the cluster. Default
false
(bool)- Zone string
GKE cluster zone. Conflicts with
region
(string)
- Cluster
Ipv4Cidr string The IP address range of the container pods (string)
- Credential string
The contents of the GC credential file (string)
- Disk
Type string Type of the disk attached to each node (string)
- Image
Type string The image to use for the worker nodes (string)
- Ip
Policy stringCluster Ipv4Cidr Block The IP address range for the cluster pod IPs (string)
- Ip
Policy stringCluster Secondary Range Name The name of the secondary range to be used for the cluster CIDR block (string)
- Ip
Policy stringNode Ipv4Cidr Block The IP address range of the instance IPs in this cluster (string)
- Ip
Policy stringServices Ipv4Cidr Block The IP address range of the services IPs in this cluster (string)
- Ip
Policy stringServices Secondary Range Name The name of the secondary range to be used for the services CIDR block (string)
- Ip
Policy stringSubnetwork Name A custom subnetwork name to be used if createSubnetwork is true (string)
- Locations []string
Locations for GKE cluster (list)
- Machine
Type string Machine type for GKE cluster (string)
- Maintenance
Window string Maintenance window for GKE cluster (string)
- Master
Ipv4Cidr stringBlock The IP range in CIDR notation to use for the hosted master network (string)
- Master
Version string Master version for GKE cluster (string)
- Network string
Network for GKE cluster (string)
- Node
Pool string The ID of the cluster node pool (string)
- Node
Version string Node version for GKE cluster (string)
- Oauth
Scopes []string The set of Google API scopes to be made available on all of the node VMs under the default service account (list)
- Project
Id string Project ID to apply answer (string)
- Service
Account string The Google Cloud Platform Service Account to be used by the node VMs (string)
- Sub
Network string Subnetwork for GKE cluster (string)
- Description string
An optional description of this cluster (string)
- Disk
Size intGb Size of the disk attached to each node. Default
100
(int)- Enable
Alpha boolFeature To enable Kubernetes alpha feature. Default
true
(bool)- Enable
Auto boolRepair Specifies whether the node auto-repair is enabled for the node pool. Default
false
(bool)- Enable
Auto boolUpgrade Specifies whether node auto-upgrade is enabled for the node pool. Default
false
(bool)- Enable
Horizontal boolPod Autoscaling Enable horizontal pod autoscaling for the cluster. Default
true
(bool)- Enable
Http boolLoad Balancing Enable HTTP load balancing on GKE cluster. Default
true
(bool)- Enable
Kubernetes boolDashboard Specifies whether to enable the Kubernetes dashboard. Default
false
(bool)- Enable
Legacy boolAbac Whether to enable legacy abac on the cluster. Default
false
(bool)- bool
Enable master authorized network. Set to
true
ifmaster_authorized_network_cidr_blocks
is set. Defaultfalse
(bool)- Enable
Network boolPolicy Config Enable network policy config for the cluster. Default
true
(bool)- Enable
Nodepool boolAutoscaling Enable nodepool autoscaling. Default
false
(bool)- Enable
Private boolEndpoint Whether the master’s internal IP address is used as the cluster endpoint. Default
false
(bool)- Enable
Private boolNodes Specifies whether worker nodes will be deployed into a new, private, subnet. Default
false
(bool)- Enable
Stackdriver boolLogging Enable stackdriver monitoring. Default
true
(bool)- Enable
Stackdriver boolMonitoring Enable stackdriver monitoring on GKE cluster (bool)
- Ip
Policy boolCreate Subnetwork Whether a new subnetwork will be created automatically for the cluster. Default
false
(bool)- Issue
Client boolCertificate Issue a client certificate. Default
false
(bool)- Kubernetes
Dashboard bool Enable the Kubernetes dashboard. Default
false
(bool)- Labels map[string]interface{}
Labels for cluster registration token object (map)
- Local
Ssd intCount The number of local SSD disks to be attached to the node. Default
0
(int)- []string
Define up to 10 external networks that could access Kubernetes master through HTTPS (list)
- Max
Node intCount Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default
0
(int)- Min
Node intCount Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default
0
(int)- Node
Count int Node count for GKE cluster. Default
3
(int)- Preemptible bool
Whether the nodes are created as preemptible VM instances. Default
false
(bool)- Region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- Resource
Labels map[string]interface{} The map of Kubernetes labels to be applied to each cluster (map)
- Taints []string
List of Kubernetes taints to be applied to each node (list)
- Use
Ip boolAliases Whether alias IPs will be used for pod IPs in the cluster. Default
false
(bool)- Zone string
GKE cluster zone. Conflicts with
region
(string)
- cluster
Ipv4Cidr string The IP address range of the container pods (string)
- credential string
The contents of the GC credential file (string)
- disk
Type string Type of the disk attached to each node (string)
- image
Type string The image to use for the worker nodes (string)
- ip
Policy stringCluster Ipv4Cidr Block The IP address range for the cluster pod IPs (string)
- ip
Policy stringCluster Secondary Range Name The name of the secondary range to be used for the cluster CIDR block (string)
- ip
Policy stringNode Ipv4Cidr Block The IP address range of the instance IPs in this cluster (string)
- ip
Policy stringServices Ipv4Cidr Block The IP address range of the services IPs in this cluster (string)
- ip
Policy stringServices Secondary Range Name The name of the secondary range to be used for the services CIDR block (string)
- ip
Policy stringSubnetwork Name A custom subnetwork name to be used if createSubnetwork is true (string)
- locations string[]
Locations for GKE cluster (list)
- machine
Type string Machine type for GKE cluster (string)
- maintenance
Window string Maintenance window for GKE cluster (string)
- master
Ipv4Cidr stringBlock The IP range in CIDR notation to use for the hosted master network (string)
- master
Version string Master version for GKE cluster (string)
- network string
Network for GKE cluster (string)
- node
Pool string The ID of the cluster node pool (string)
- node
Version string Node version for GKE cluster (string)
- oauth
Scopes string[] The set of Google API scopes to be made available on all of the node VMs under the default service account (list)
- project
Id string Project ID to apply answer (string)
- service
Account string The Google Cloud Platform Service Account to be used by the node VMs (string)
- sub
Network string Subnetwork for GKE cluster (string)
- description string
An optional description of this cluster (string)
- disk
Size numberGb Size of the disk attached to each node. Default
100
(int)- enable
Alpha booleanFeature To enable Kubernetes alpha feature. Default
true
(bool)- enable
Auto booleanRepair Specifies whether the node auto-repair is enabled for the node pool. Default
false
(bool)- enable
Auto booleanUpgrade Specifies whether node auto-upgrade is enabled for the node pool. Default
false
(bool)- enable
Horizontal booleanPod Autoscaling Enable horizontal pod autoscaling for the cluster. Default
true
(bool)- enable
Http booleanLoad Balancing Enable HTTP load balancing on GKE cluster. Default
true
(bool)- enable
Kubernetes booleanDashboard Specifies whether to enable the Kubernetes dashboard. Default
false
(bool)- enable
Legacy booleanAbac Whether to enable legacy abac on the cluster. Default
false
(bool)- boolean
Enable master authorized network. Set to
true
ifmaster_authorized_network_cidr_blocks
is set. Defaultfalse
(bool)- enable
Network booleanPolicy Config Enable network policy config for the cluster. Default
true
(bool)- enable
Nodepool booleanAutoscaling Enable nodepool autoscaling. Default
false
(bool)- enable
Private booleanEndpoint Whether the master’s internal IP address is used as the cluster endpoint. Default
false
(bool)- enable
Private booleanNodes Specifies whether worker nodes will be deployed into a new, private, subnet. Default
false
(bool)- enable
Stackdriver booleanLogging Enable stackdriver monitoring. Default
true
(bool)- enable
Stackdriver booleanMonitoring Enable stackdriver monitoring on GKE cluster (bool)
- ip
Policy booleanCreate Subnetwork Whether a new subnetwork will be created automatically for the cluster. Default
false
(bool)- issue
Client booleanCertificate Issue a client certificate. Default
false
(bool)- kubernetes
Dashboard boolean Enable the Kubernetes dashboard. Default
false
(bool)- labels {[key: string]: any}
Labels for cluster registration token object (map)
- local
Ssd numberCount The number of local SSD disks to be attached to the node. Default
0
(int)- string[]
Define up to 10 external networks that could access Kubernetes master through HTTPS (list)
- max
Node numberCount Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default
0
(int)- min
Node numberCount Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default
0
(int)- node
Count number Node count for GKE cluster. Default
3
(int)- preemptible boolean
Whether the nodes are created as preemptible VM instances. Default
false
(bool)- region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- resource
Labels {[key: string]: any} The map of Kubernetes labels to be applied to each cluster (map)
- taints string[]
List of Kubernetes taints to be applied to each node (list)
- use
Ip booleanAliases Whether alias IPs will be used for pod IPs in the cluster. Default
false
(bool)- zone string
GKE cluster zone. Conflicts with
region
(string)
- cluster_
ipv4_ strcidr The IP address range of the container pods (string)
- credential str
The contents of the GC credential file (string)
- disk_
type str Type of the disk attached to each node (string)
- image_
type str The image to use for the worker nodes (string)
- ip_
policy_ strcluster_ ipv4_ cidr_ block The IP address range for the cluster pod IPs (string)
- ip_
policy_ strcluster_ secondary_ range_ name The name of the secondary range to be used for the cluster CIDR block (string)
- ip_
policy_ strnode_ ipv4_ cidr_ block The IP address range of the instance IPs in this cluster (string)
- ip_
policy_ strservices_ ipv4_ cidr_ block The IP address range of the services IPs in this cluster (string)
- ip_
policy_ strservices_ secondary_ range_ name The name of the secondary range to be used for the services CIDR block (string)
- ip_
policy_ strsubnetwork_ name A custom subnetwork name to be used if createSubnetwork is true (string)
- locations Sequence[str]
Locations for GKE cluster (list)
- machine_
type str Machine type for GKE cluster (string)
- maintenance_
window str Maintenance window for GKE cluster (string)
- master_
ipv4_ strcidr_ block The IP range in CIDR notation to use for the hosted master network (string)
- master_
version str Master version for GKE cluster (string)
- network str
Network for GKE cluster (string)
- node_
pool str The ID of the cluster node pool (string)
- node_
version str Node version for GKE cluster (string)
- oauth_
scopes Sequence[str] The set of Google API scopes to be made available on all of the node VMs under the default service account (list)
- project_
id str Project ID to apply answer (string)
- service_
account str The Google Cloud Platform Service Account to be used by the node VMs (string)
- sub_
network str Subnetwork for GKE cluster (string)
- description str
An optional description of this cluster (string)
- disk_
size_ intgb Size of the disk attached to each node. Default
100
(int)- enable_
alpha_ boolfeature To enable Kubernetes alpha feature. Default
true
(bool)- enable_
auto_ boolrepair Specifies whether the node auto-repair is enabled for the node pool. Default
false
(bool)- enable_
auto_ boolupgrade Specifies whether node auto-upgrade is enabled for the node pool. Default
false
(bool)- enable_
horizontal_ boolpod_ autoscaling Enable horizontal pod autoscaling for the cluster. Default
true
(bool)- enable_
http_ boolload_ balancing Enable HTTP load balancing on GKE cluster. Default
true
(bool)- enable_
kubernetes_ booldashboard Specifies whether to enable the Kubernetes dashboard. Default
false
(bool)- enable_
legacy_ boolabac Whether to enable legacy abac on the cluster. Default
false
(bool)- bool
Enable master authorized network. Set to
true
ifmaster_authorized_network_cidr_blocks
is set. Defaultfalse
(bool)- enable_
network_ boolpolicy_ config Enable network policy config for the cluster. Default
true
(bool)- enable_
nodepool_ boolautoscaling Enable nodepool autoscaling. Default
false
(bool)- enable_
private_ boolendpoint Whether the master’s internal IP address is used as the cluster endpoint. Default
false
(bool)- enable_
private_ boolnodes Specifies whether worker nodes will be deployed into a new, private, subnet. Default
false
(bool)- enable_
stackdriver_ boollogging Enable stackdriver monitoring. Default
true
(bool)- enable_
stackdriver_ boolmonitoring Enable stackdriver monitoring on GKE cluster (bool)
- ip_
policy_ boolcreate_ subnetwork Whether a new subnetwork will be created automatically for the cluster. Default
false
(bool)- issue_
client_ boolcertificate Issue a client certificate. Default
false
(bool)- kubernetes_
dashboard bool Enable the Kubernetes dashboard. Default
false
(bool)- labels Mapping[str, Any]
Labels for cluster registration token object (map)
- local_
ssd_ intcount The number of local SSD disks to be attached to the node. Default
0
(int)- Sequence[str]
Define up to 10 external networks that could access Kubernetes master through HTTPS (list)
- max_
node_ intcount Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default
0
(int)- min_
node_ intcount Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default
0
(int)- node_
count int Node count for GKE cluster. Default
3
(int)- preemptible bool
Whether the nodes are created as preemptible VM instances. Default
false
(bool)- region str
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- resource_
labels Mapping[str, Any] The map of Kubernetes labels to be applied to each cluster (map)
- taints Sequence[str]
List of Kubernetes taints to be applied to each node (list)
- use_
ip_ boolaliases Whether alias IPs will be used for pod IPs in the cluster. Default
false
(bool)- zone str
GKE cluster zone. Conflicts with
region
(string)
ClusterK3sConfig
- Upgrade
Strategy ClusterK3s Config Upgrade Strategy Args K3S upgrade strategy (List maxitems: 1)
- Version string
rancher-monitoring chart version (string)
- Upgrade
Strategy ClusterK3s Config Upgrade Strategy K3S upgrade strategy (List maxitems: 1)
- Version string
rancher-monitoring chart version (string)
- upgrade
Strategy ClusterK3s Config Upgrade Strategy K3S upgrade strategy (List maxitems: 1)
- version string
rancher-monitoring chart version (string)
- upgrade_
strategy ClusterK3s Config Upgrade Strategy Args K3S upgrade strategy (List maxitems: 1)
- version str
rancher-monitoring chart version (string)
ClusterK3sConfigUpgradeStrategy
- Drain
Server boolNodes Drain server nodes. Default:
false
(bool)- Drain
Worker boolNodes Drain worker nodes. Default:
false
(bool)- Server
Concurrency int Server concurrency. Default:
1
(int)- Worker
Concurrency int Worker concurrency. Default:
1
(int)
- Drain
Server boolNodes Drain server nodes. Default:
false
(bool)- Drain
Worker boolNodes Drain worker nodes. Default:
false
(bool)- Server
Concurrency int Server concurrency. Default:
1
(int)- Worker
Concurrency int Worker concurrency. Default:
1
(int)
- drain
Server booleanNodes Drain server nodes. Default:
false
(bool)- drain
Worker booleanNodes Drain worker nodes. Default:
false
(bool)- server
Concurrency number Server concurrency. Default:
1
(int)- worker
Concurrency number Worker concurrency. Default:
1
(int)
- drain_
server_ boolnodes Drain server nodes. Default:
false
(bool)- drain_
worker_ boolnodes Drain worker nodes. Default:
false
(bool)- server_
concurrency int Server concurrency. Default:
1
(int)- worker_
concurrency int Worker concurrency. Default:
1
(int)
ClusterOkeConfig
- Compartment
Id string The OCID of the compartment in which to create resources OKE cluster and related resources (string)
- Fingerprint string
The fingerprint corresponding to the specified user’s private API Key (string)
- Kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- Node
Image string The Oracle Linux OS image name to use for the OKE node(s). See here for a list of images. (string)
- Node
Shape string The shape of the node (determines number of CPUs and amount of memory on each OKE node) (string)
- Private
Key stringContents The private API key file contents for the specified user, in PEM format (string)
- Region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- Tenancy
Id string The OCID of the tenancy in which to create resources (string)
- User
Ocid string The OCID of a user who has access to the tenancy/compartment (string)
- Description string
An optional description of this cluster (string)
- Enable
Kubernetes boolDashboard Specifies whether to enable the Kubernetes dashboard. Default
false
(bool)- Enable
Private boolNodes Specifies whether worker nodes will be deployed into a new, private, subnet. Default
false
(bool)- Load
Balancer stringSubnet Name1 The name of the first existing subnet to use for Kubernetes services / LB.
vcn_name
is also required when specifying an existing subnet. (string)- Load
Balancer stringSubnet Name2 The name of a second existing subnet to use for Kubernetes services / LB. A second subnet is only required when it is AD-specific (non-regional) (string)
- Node
Pool stringDns Domain Name Name for DNS domain of node pool subnet. Default
nodedns
(string)- Node
Pool stringSubnet Name Name for node pool subnet. Default
nodedns
(string)- Node
Public stringKey Contents The contents of the SSH public key file to use for the nodes (string)
- Private
Key stringPassphrase The passphrase (if any) of the private key for the OKE cluster (string)
- Quantity
Of intNode Subnets Number of node subnets. Default
1
(int)- Quantity
Per intSubnet Number of OKE worker nodes in each subnet / availability domain. Default
1
(int)- Service
Dns stringDomain Name Name for DNS domain of service subnet. Default
svcdns
(string)- Skip
Vcn boolDelete Specifies whether to skip deleting the virtual cloud network (VCN) on destroy. Default
false
(bool)- Vcn
Name string The name of an existing virtual network to use for the cluster creation. If set, you must also set
load_balancer_subnet_name_1
. A VCN and subnets will be created if none are specified. (string)- Worker
Node stringIngress Cidr Additional CIDR from which to allow ingress to worker nodes (string)
- Compartment
Id string The OCID of the compartment in which to create resources OKE cluster and related resources (string)
- Fingerprint string
The fingerprint corresponding to the specified user’s private API Key (string)
- Kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- Node
Image string The Oracle Linux OS image name to use for the OKE node(s). See here for a list of images. (string)
- Node
Shape string The shape of the node (determines number of CPUs and amount of memory on each OKE node) (string)
- Private
Key stringContents The private API key file contents for the specified user, in PEM format (string)
- Region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- Tenancy
Id string The OCID of the tenancy in which to create resources (string)
- User
Ocid string The OCID of a user who has access to the tenancy/compartment (string)
- Description string
An optional description of this cluster (string)
- Enable
Kubernetes boolDashboard Specifies whether to enable the Kubernetes dashboard. Default
false
(bool)- Enable
Private boolNodes Specifies whether worker nodes will be deployed into a new, private, subnet. Default
false
(bool)- Load
Balancer stringSubnet Name1 The name of the first existing subnet to use for Kubernetes services / LB.
vcn_name
is also required when specifying an existing subnet. (string)- Load
Balancer stringSubnet Name2 The name of a second existing subnet to use for Kubernetes services / LB. A second subnet is only required when it is AD-specific (non-regional) (string)
- Node
Pool stringDns Domain Name Name for DNS domain of node pool subnet. Default
nodedns
(string)- Node
Pool stringSubnet Name Name for node pool subnet. Default
nodedns
(string)- Node
Public stringKey Contents The contents of the SSH public key file to use for the nodes (string)
- Private
Key stringPassphrase The passphrase (if any) of the private key for the OKE cluster (string)
- Quantity
Of intNode Subnets Number of node subnets. Default
1
(int)- Quantity
Per intSubnet Number of OKE worker nodes in each subnet / availability domain. Default
1
(int)- Service
Dns stringDomain Name Name for DNS domain of service subnet. Default
svcdns
(string)- Skip
Vcn boolDelete Specifies whether to skip deleting the virtual cloud network (VCN) on destroy. Default
false
(bool)- Vcn
Name string The name of an existing virtual network to use for the cluster creation. If set, you must also set
load_balancer_subnet_name_1
. A VCN and subnets will be created if none are specified. (string)- Worker
Node stringIngress Cidr Additional CIDR from which to allow ingress to worker nodes (string)
- compartment
Id string The OCID of the compartment in which to create resources OKE cluster and related resources (string)
- fingerprint string
The fingerprint corresponding to the specified user’s private API Key (string)
- kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- node
Image string The Oracle Linux OS image name to use for the OKE node(s). See here for a list of images. (string)
- node
Shape string The shape of the node (determines number of CPUs and amount of memory on each OKE node) (string)
- private
Key stringContents The private API key file contents for the specified user, in PEM format (string)
- region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- tenancy
Id string The OCID of the tenancy in which to create resources (string)
- user
Ocid string The OCID of a user who has access to the tenancy/compartment (string)
- description string
An optional description of this cluster (string)
- enable
Kubernetes booleanDashboard Specifies whether to enable the Kubernetes dashboard. Default
false
(bool)- enable
Private booleanNodes Specifies whether worker nodes will be deployed into a new, private, subnet. Default
false
(bool)- load
Balancer stringSubnet Name1 The name of the first existing subnet to use for Kubernetes services / LB.
vcn_name
is also required when specifying an existing subnet. (string)- load
Balancer stringSubnet Name2 The name of a second existing subnet to use for Kubernetes services / LB. A second subnet is only required when it is AD-specific (non-regional) (string)
- node
Pool stringDns Domain Name Name for DNS domain of node pool subnet. Default
nodedns
(string)- node
Pool stringSubnet Name Name for node pool subnet. Default
nodedns
(string)- node
Public stringKey Contents The contents of the SSH public key file to use for the nodes (string)
- private
Key stringPassphrase The passphrase (if any) of the private key for the OKE cluster (string)
- quantity
Of numberNode Subnets Number of node subnets. Default
1
(int)- quantity
Per numberSubnet Number of OKE worker nodes in each subnet / availability domain. Default
1
(int)- service
Dns stringDomain Name Name for DNS domain of service subnet. Default
svcdns
(string)- skip
Vcn booleanDelete Specifies whether to skip deleting the virtual cloud network (VCN) on destroy. Default
false
(bool)- vcn
Name string The name of an existing virtual network to use for the cluster creation. If set, you must also set
load_balancer_subnet_name_1
. A VCN and subnets will be created if none are specified. (string)- worker
Node stringIngress Cidr Additional CIDR from which to allow ingress to worker nodes (string)
- compartment_
id str The OCID of the compartment in which to create resources OKE cluster and related resources (string)
- fingerprint str
The fingerprint corresponding to the specified user’s private API Key (string)
- kubernetes_
version str The Kubernetes version that will be used for your master and OKE worker nodes (string)
- node_
image str The Oracle Linux OS image name to use for the OKE node(s). See here for a list of images. (string)
- node_
shape str The shape of the node (determines number of CPUs and amount of memory on each OKE node) (string)
- private_
key_ strcontents The private API key file contents for the specified user, in PEM format (string)
- region str
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- tenancy_
id str The OCID of the tenancy in which to create resources (string)
- user_
ocid str The OCID of a user who has access to the tenancy/compartment (string)
- description str
An optional description of this cluster (string)
- enable_
kubernetes_ booldashboard Specifies whether to enable the Kubernetes dashboard. Default
false
(bool)- enable_
private_ boolnodes Specifies whether worker nodes will be deployed into a new, private, subnet. Default
false
(bool)- load_
balancer_ strsubnet_ name1 The name of the first existing subnet to use for Kubernetes services / LB.
vcn_name
is also required when specifying an existing subnet. (string)- load_
balancer_ strsubnet_ name2 The name of a second existing subnet to use for Kubernetes services / LB. A second subnet is only required when it is AD-specific (non-regional) (string)
- node_
pool_ strdns_ domain_ name Name for DNS domain of node pool subnet. Default
nodedns
(string)- node_
pool_ strsubnet_ name Name for node pool subnet. Default
nodedns
(string)- node_
public_ strkey_ contents The contents of the SSH public key file to use for the nodes (string)
- private_
key_ strpassphrase The passphrase (if any) of the private key for the OKE cluster (string)
- quantity_
of_ intnode_ subnets Number of node subnets. Default
1
(int)- quantity_
per_ intsubnet Number of OKE worker nodes in each subnet / availability domain. Default
1
(int)- service_
dns_ strdomain_ name Name for DNS domain of service subnet. Default
svcdns
(string)- skip_
vcn_ booldelete Specifies whether to skip deleting the virtual cloud network (VCN) on destroy. Default
false
(bool)- vcn_
name str The name of an existing virtual network to use for the cluster creation. If set, you must also set
load_balancer_subnet_name_1
. A VCN and subnets will be created if none are specified. (string)- worker_
node_ stringress_ cidr Additional CIDR from which to allow ingress to worker nodes (string)
ClusterRkeConfig
- Addon
Job intTimeout Duration in seconds of addon job (int)
- Addons string
Addons descripton to deploy on RKE cluster.
- Addons
Includes List<string> Addons yaml manifests to deploy on RKE cluster (list)
- Authentication
Cluster
Rke Config Authentication Args Kubernetes cluster authentication (list maxitems:1)
- Cluster
Rke Config Authorization Args Kubernetes cluster authorization (list maxitems:1)
- Bastion
Host ClusterRke Config Bastion Host Args RKE bastion host (list maxitems:1)
- Cloud
Provider ClusterRke Config Cloud Provider Args RKE options for Calico network provider (string)
- Dns
Cluster
Rke Config Dns Args RKE dns add-on. Just for Rancher v2.2.x (list maxitems:1)
- Ignore
Docker boolVersion Ignore docker version. Default
true
(bool)- Ingress
Cluster
Rke Config Ingress Args Kubernetes ingress configuration (list maxitems:1)
- Kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- Monitoring
Cluster
Rke Config Monitoring Args Kubernetes cluster monitoring (list maxitems:1)
- Network
Cluster
Rke Config Network Args Network for GKE cluster (string)
- Nodes
List<Cluster
Rke Config Node Args> RKE cluster nodes (list)
- Prefix
Path string Prefix to customize Kubernetes path (string)
- Private
Registries List<ClusterRke Config Private Registry Args> private registries for docker images (list)
- Services
Cluster
Rke Config Services Args Kubernetes cluster services (list maxitems:1)
- Ssh
Agent boolAuth Use ssh agent auth. Default
false
(bool)- Ssh
Cert stringPath Cluster level SSH certificate path (string)
- Ssh
Key stringPath Node SSH private key path (string)
- Upgrade
Strategy ClusterRke Config Upgrade Strategy Args K3S upgrade strategy (List maxitems: 1)
- Addon
Job intTimeout Duration in seconds of addon job (int)
- Addons string
Addons descripton to deploy on RKE cluster.
- Addons
Includes []string Addons yaml manifests to deploy on RKE cluster (list)
- Authentication
Cluster
Rke Config Authentication Kubernetes cluster authentication (list maxitems:1)
- Cluster
Rke Config Authorization Kubernetes cluster authorization (list maxitems:1)
- Bastion
Host ClusterRke Config Bastion Host RKE bastion host (list maxitems:1)
- Cloud
Provider ClusterRke Config Cloud Provider RKE options for Calico network provider (string)
- Dns
Cluster
Rke Config Dns RKE dns add-on. Just for Rancher v2.2.x (list maxitems:1)
- Ignore
Docker boolVersion Ignore docker version. Default
true
(bool)- Ingress
Cluster
Rke Config Ingress Kubernetes ingress configuration (list maxitems:1)
- Kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- Monitoring
Cluster
Rke Config Monitoring Kubernetes cluster monitoring (list maxitems:1)
- Network
Cluster
Rke Config Network Network for GKE cluster (string)
- Nodes
[]Cluster
Rke Config Node RKE cluster nodes (list)
- Prefix
Path string Prefix to customize Kubernetes path (string)
- Private
Registries []ClusterRke Config Private Registry private registries for docker images (list)
- Services
Cluster
Rke Config Services Kubernetes cluster services (list maxitems:1)
- Ssh
Agent boolAuth Use ssh agent auth. Default
false
(bool)- Ssh
Cert stringPath Cluster level SSH certificate path (string)
- Ssh
Key stringPath Node SSH private key path (string)
- Upgrade
Strategy ClusterRke Config Upgrade Strategy K3S upgrade strategy (List maxitems: 1)
- addon
Job numberTimeout Duration in seconds of addon job (int)
- addons string
Addons descripton to deploy on RKE cluster.
- addons
Includes string[] Addons yaml manifests to deploy on RKE cluster (list)
- authentication
Cluster
Rke Config Authentication Kubernetes cluster authentication (list maxitems:1)
- Cluster
Rke Config Authorization Kubernetes cluster authorization (list maxitems:1)
- bastion
Host ClusterRke Config Bastion Host RKE bastion host (list maxitems:1)
- cloud
Provider ClusterRke Config Cloud Provider RKE options for Calico network provider (string)
- dns
Cluster
Rke Config Dns RKE dns add-on. Just for Rancher v2.2.x (list maxitems:1)
- ignore
Docker booleanVersion Ignore docker version. Default
true
(bool)- ingress
Cluster
Rke Config Ingress Kubernetes ingress configuration (list maxitems:1)
- kubernetes
Version string The Kubernetes version that will be used for your master and OKE worker nodes (string)
- monitoring
Cluster
Rke Config Monitoring Kubernetes cluster monitoring (list maxitems:1)
- network
Cluster
Rke Config Network Network for GKE cluster (string)
- nodes
Cluster
Rke Config Node[] RKE cluster nodes (list)
- prefix
Path string Prefix to customize Kubernetes path (string)
- private
Registries ClusterRke Config Private Registry[] private registries for docker images (list)
- services
Cluster
Rke Config Services Kubernetes cluster services (list maxitems:1)
- ssh
Agent booleanAuth Use ssh agent auth. Default
false
(bool)- ssh
Cert stringPath Cluster level SSH certificate path (string)
- ssh
Key stringPath Node SSH private key path (string)
- upgrade
Strategy ClusterRke Config Upgrade Strategy K3S upgrade strategy (List maxitems: 1)
- addon_
job_ inttimeout Duration in seconds of addon job (int)
- addons str
Addons descripton to deploy on RKE cluster.
- addons_
includes Sequence[str] Addons yaml manifests to deploy on RKE cluster (list)
- authentication
Cluster
Rke Config Authentication Args Kubernetes cluster authentication (list maxitems:1)
- Cluster
Rke Config Authorization Args Kubernetes cluster authorization (list maxitems:1)
- bastion_
host ClusterRke Config Bastion Host Args RKE bastion host (list maxitems:1)
- cloud_
provider ClusterRke Config Cloud Provider Args RKE options for Calico network provider (string)
- dns
Cluster
Rke Config Dns Args RKE dns add-on. Just for Rancher v2.2.x (list maxitems:1)
- ignore_
docker_ boolversion Ignore docker version. Default
true
(bool)- ingress
Cluster
Rke Config Ingress Args Kubernetes ingress configuration (list maxitems:1)
- kubernetes_
version str The Kubernetes version that will be used for your master and OKE worker nodes (string)
- monitoring
Cluster
Rke Config Monitoring Args Kubernetes cluster monitoring (list maxitems:1)
- network
Cluster
Rke Config Network Args Network for GKE cluster (string)
- nodes
Sequence[Cluster
Rke Config Node Args] RKE cluster nodes (list)
- prefix_
path str Prefix to customize Kubernetes path (string)
- private_
registries Sequence[ClusterRke Config Private Registry Args] private registries for docker images (list)
- services
Cluster
Rke Config Services Args Kubernetes cluster services (list maxitems:1)
- ssh_
agent_ boolauth Use ssh agent auth. Default
false
(bool)- ssh_
cert_ strpath Cluster level SSH certificate path (string)
- ssh_
key_ strpath Node SSH private key path (string)
- upgrade_
strategy ClusterRke Config Upgrade Strategy Args K3S upgrade strategy (List maxitems: 1)
ClusterRkeConfigAuthentication
ClusterRkeConfigAuthorization
ClusterRkeConfigBastionHost
- Address string
Address ip for node (string)
- User string
Registry user (string)
- Port string
Port for node. Default
22
(string)- Ssh
Agent boolAuth Use ssh agent auth. Default
false
(bool)- Ssh
Key string Node SSH private key (string)
- Ssh
Key stringPath Node SSH private key path (string)
- Address string
Address ip for node (string)
- User string
Registry user (string)
- Port string
Port for node. Default
22
(string)- Ssh
Agent boolAuth Use ssh agent auth. Default
false
(bool)- Ssh
Key string Node SSH private key (string)
- Ssh
Key stringPath Node SSH private key path (string)
- address string
Address ip for node (string)
- user string
Registry user (string)
- port string
Port for node. Default
22
(string)- ssh
Agent booleanAuth Use ssh agent auth. Default
false
(bool)- ssh
Key string Node SSH private key (string)
- ssh
Key stringPath Node SSH private key path (string)
- address str
Address ip for node (string)
- user str
Registry user (string)
- port str
Port for node. Default
22
(string)- ssh_
agent_ boolauth Use ssh agent auth. Default
false
(bool)- ssh_
key str Node SSH private key (string)
- ssh_
key_ strpath Node SSH private key path (string)
ClusterRkeConfigCloudProvider
- Aws
Cloud ClusterProvider Rke Config Cloud Provider Aws Cloud Provider Args RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)
- Azure
Cloud ClusterProvider Rke Config Cloud Provider Azure Cloud Provider Args RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)
- Custom
Cloud stringProvider RKE Custom Cloud Provider config for Cloud Provider (string)
- Name string
Name of cluster registration token (string)
- Openstack
Cloud ClusterProvider Rke Config Cloud Provider Openstack Cloud Provider Args RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)
- Vsphere
Cloud ClusterProvider Rke Config Cloud Provider Vsphere Cloud Provider Args RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument
name
is required onvirtual_center
configuration. (list maxitems:1)
- Aws
Cloud ClusterProvider Rke Config Cloud Provider Aws Cloud Provider RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)
- Azure
Cloud ClusterProvider Rke Config Cloud Provider Azure Cloud Provider RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)
- Custom
Cloud stringProvider RKE Custom Cloud Provider config for Cloud Provider (string)
- Name string
Name of cluster registration token (string)
- Openstack
Cloud ClusterProvider Rke Config Cloud Provider Openstack Cloud Provider RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)
- Vsphere
Cloud ClusterProvider Rke Config Cloud Provider Vsphere Cloud Provider RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument
name
is required onvirtual_center
configuration. (list maxitems:1)
- aws
Cloud ClusterProvider Rke Config Cloud Provider Aws Cloud Provider RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)
- azure
Cloud ClusterProvider Rke Config Cloud Provider Azure Cloud Provider RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)
- custom
Cloud stringProvider RKE Custom Cloud Provider config for Cloud Provider (string)
- name string
Name of cluster registration token (string)
- openstack
Cloud ClusterProvider Rke Config Cloud Provider Openstack Cloud Provider RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)
- vsphere
Cloud ClusterProvider Rke Config Cloud Provider Vsphere Cloud Provider RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument
name
is required onvirtual_center
configuration. (list maxitems:1)
- aws_
cloud_ Clusterprovider Rke Config Cloud Provider Aws Cloud Provider Args RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)
- azure_
cloud_ Clusterprovider Rke Config Cloud Provider Azure Cloud Provider Args RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)
- custom_
cloud_ strprovider RKE Custom Cloud Provider config for Cloud Provider (string)
- name str
Name of cluster registration token (string)
- openstack_
cloud_ Clusterprovider Rke Config Cloud Provider Openstack Cloud Provider Args RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)
- vsphere_
cloud_ Clusterprovider Rke Config Cloud Provider Vsphere Cloud Provider Args RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument
name
is required onvirtual_center
configuration. (list maxitems:1)
ClusterRkeConfigCloudProviderAwsCloudProvider
ClusterRkeConfigCloudProviderAwsCloudProviderGlobal
- Disable
Security boolGroup Ingress Default
false
(bool)- Disable
Strict boolZone Check Default
false
(bool)- Elb
Security stringGroup (string)
- Kubernetes
Cluster stringId (string)
- Kubernetes
Cluster stringTag (string)
- Role
Arn string (string)
- Route
Table stringId (string)
- Subnet
Id string (string)
- Vpc string
(string)
- Zone string
GKE cluster zone. Conflicts with
region
(string)
- Disable
Security boolGroup Ingress Default
false
(bool)- Disable
Strict boolZone Check Default
false
(bool)- Elb
Security stringGroup (string)
- Kubernetes
Cluster stringId (string)
- Kubernetes
Cluster stringTag (string)
- Role
Arn string (string)
- Route
Table stringId (string)
- Subnet
Id string (string)
- Vpc string
(string)
- Zone string
GKE cluster zone. Conflicts with
region
(string)
- disable
Security booleanGroup Ingress Default
false
(bool)- disable
Strict booleanZone Check Default
false
(bool)- elb
Security stringGroup (string)
- kubernetes
Cluster stringId (string)
- kubernetes
Cluster stringTag (string)
- role
Arn string (string)
- route
Table stringId (string)
- subnet
Id string (string)
- vpc string
(string)
- zone string
GKE cluster zone. Conflicts with
region
(string)
- disable_
security_ boolgroup_ ingress Default
false
(bool)- disable_
strict_ boolzone_ check Default
false
(bool)- elb_
security_ strgroup (string)
- kubernetes_
cluster_ strid (string)
- kubernetes_
cluster_ strtag (string)
- role_
arn str (string)
- route_
table_ strid (string)
- subnet_
id str (string)
- vpc str
(string)
- zone str
GKE cluster zone. Conflicts with
region
(string)
ClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride
- Service string
(string)
- Region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- Signing
Method string (string)
- Signing
Name string (string)
- Signing
Region string (string)
- Url string
Registry URL (string)
- Service string
(string)
- Region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- Signing
Method string (string)
- Signing
Name string (string)
- Signing
Region string (string)
- Url string
Registry URL (string)
- service string
(string)
- region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- signing
Method string (string)
- signing
Name string (string)
- signing
Region string (string)
- url string
Registry URL (string)
- service str
(string)
- region str
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- signing_
method str (string)
- signing_
name str (string)
- signing_
region str (string)
- url str
Registry URL (string)
ClusterRkeConfigCloudProviderAzureCloudProvider
- Aad
Client stringId (string)
- Aad
Client stringSecret (string)
- Subscription
Id string Subscription credentials which uniquely identify Microsoft Azure subscription (string)
- Tenant
Id string Azure tenant ID to use (string)
- Aad
Client stringCert Password (string)
- Aad
Client stringCert Path (string)
- Cloud string
(string)
- Cloud
Provider boolBackoff (bool)
- Cloud
Provider intBackoff Duration (int)
- Cloud
Provider intBackoff Exponent (int)
- Cloud
Provider intBackoff Jitter (int)
- Cloud
Provider intBackoff Retries (int)
- Cloud
Provider boolRate Limit (bool)
- Cloud
Provider intRate Limit Bucket (int)
- Cloud
Provider intRate Limit Qps (int)
- Load
Balancer stringSku Allowed values:
basic
(default)standard
(string)- Location string
Azure Kubernetes cluster location. Default
eastus
(string)- Maximum
Load intBalancer Rule Count (int)
- Primary
Availability stringSet Name (string)
- Primary
Scale stringSet Name (string)
- Resource
Group string The name of the Cluster resource group (string)
- Route
Table stringName (string)
- Security
Group stringName (string)
- Subnet
Name string (string)
- Use
Instance boolMetadata (bool)
- Use
Managed boolIdentity Extension (bool)
- Vm
Type string (string)
- Vnet
Name string (string)
- Vnet
Resource stringGroup (string)
- Aad
Client stringId (string)
- Aad
Client stringSecret (string)
- Subscription
Id string Subscription credentials which uniquely identify Microsoft Azure subscription (string)
- Tenant
Id string Azure tenant ID to use (string)
- Aad
Client stringCert Password (string)
- Aad
Client stringCert Path (string)
- Cloud string
(string)
- Cloud
Provider boolBackoff (bool)
- Cloud
Provider intBackoff Duration (int)
- Cloud
Provider intBackoff Exponent (int)
- Cloud
Provider intBackoff Jitter (int)
- Cloud
Provider intBackoff Retries (int)
- Cloud
Provider boolRate Limit (bool)
- Cloud
Provider intRate Limit Bucket (int)
- Cloud
Provider intRate Limit Qps (int)
- Load
Balancer stringSku Allowed values:
basic
(default)standard
(string)- Location string
Azure Kubernetes cluster location. Default
eastus
(string)- Maximum
Load intBalancer Rule Count (int)
- Primary
Availability stringSet Name (string)
- Primary
Scale stringSet Name (string)
- Resource
Group string The name of the Cluster resource group (string)
- Route
Table stringName (string)
- Security
Group stringName (string)
- Subnet
Name string (string)
- Use
Instance boolMetadata (bool)
- Use
Managed boolIdentity Extension (bool)
- Vm
Type string (string)
- Vnet
Name string (string)
- Vnet
Resource stringGroup (string)
- aad
Client stringId (string)
- aad
Client stringSecret (string)
- subscription
Id string Subscription credentials which uniquely identify Microsoft Azure subscription (string)
- tenant
Id string Azure tenant ID to use (string)
- aad
Client stringCert Password (string)
- aad
Client stringCert Path (string)
- cloud string
(string)
- cloud
Provider booleanBackoff (bool)
- cloud
Provider numberBackoff Duration (int)
- cloud
Provider numberBackoff Exponent (int)
- cloud
Provider numberBackoff Jitter (int)
- cloud
Provider numberBackoff Retries (int)
- cloud
Provider booleanRate Limit (bool)
- cloud
Provider numberRate Limit Bucket (int)
- cloud
Provider numberRate Limit Qps (int)
- load
Balancer stringSku Allowed values:
basic
(default)standard
(string)- location string
Azure Kubernetes cluster location. Default
eastus
(string)- maximum
Load numberBalancer Rule Count (int)
- primary
Availability stringSet Name (string)
- primary
Scale stringSet Name (string)
- resource
Group string The name of the Cluster resource group (string)
- route
Table stringName (string)
- security
Group stringName (string)
- subnet
Name string (string)
- use
Instance booleanMetadata (bool)
- use
Managed booleanIdentity Extension (bool)
- vm
Type string (string)
- vnet
Name string (string)
- vnet
Resource stringGroup (string)
- aad_
client_ strid (string)
- aad_
client_ strsecret (string)
- subscription_
id str Subscription credentials which uniquely identify Microsoft Azure subscription (string)
- tenant_
id str Azure tenant ID to use (string)
- aad_
client_ strcert_ password (string)
- aad_
client_ strcert_ path (string)
- cloud str
(string)
- cloud_
provider_ boolbackoff (bool)
- cloud_
provider_ intbackoff_ duration (int)
- cloud_
provider_ intbackoff_ exponent (int)
- cloud_
provider_ intbackoff_ jitter (int)
- cloud_
provider_ intbackoff_ retries (int)
- cloud_
provider_ boolrate_ limit (bool)
- cloud_
provider_ intrate_ limit_ bucket (int)
- cloud_
provider_ intrate_ limit_ qps (int)
- load_
balancer_ strsku Allowed values:
basic
(default)standard
(string)- location str
Azure Kubernetes cluster location. Default
eastus
(string)- maximum_
load_ intbalancer_ rule_ count (int)
- primary_
availability_ strset_ name (string)
- primary_
scale_ strset_ name (string)
- resource_
group str The name of the Cluster resource group (string)
- route_
table_ strname (string)
- security_
group_ strname (string)
- subnet_
name str (string)
- use_
instance_ boolmetadata (bool)
- use_
managed_ boolidentity_ extension (bool)
- vm_
type str (string)
- vnet_
name str (string)
- vnet_
resource_ strgroup (string)
ClusterRkeConfigCloudProviderOpenstackCloudProvider
- Global
Cluster
Rke Config Cloud Provider Openstack Cloud Provider Global Args (list maxitems:1)
- Block
Storage ClusterRke Config Cloud Provider Openstack Cloud Provider Block Storage Args (list maxitems:1)
- Load
Balancer ClusterRke Config Cloud Provider Openstack Cloud Provider Load Balancer Args (list maxitems:1)
- Metadata
Cluster
Rke Config Cloud Provider Openstack Cloud Provider Metadata Args (list maxitems:1)
- Route
Cluster
Rke Config Cloud Provider Openstack Cloud Provider Route Args (list maxitems:1)
- Global
Cluster
Rke Config Cloud Provider Openstack Cloud Provider Global (list maxitems:1)
- Block
Storage ClusterRke Config Cloud Provider Openstack Cloud Provider Block Storage (list maxitems:1)
- Load
Balancer ClusterRke Config Cloud Provider Openstack Cloud Provider Load Balancer (list maxitems:1)
- Metadata
Cluster
Rke Config Cloud Provider Openstack Cloud Provider Metadata (list maxitems:1)
- Route
Cluster
Rke Config Cloud Provider Openstack Cloud Provider Route (list maxitems:1)
- global
Cluster
Rke Config Cloud Provider Openstack Cloud Provider Global (list maxitems:1)
- block
Storage ClusterRke Config Cloud Provider Openstack Cloud Provider Block Storage (list maxitems:1)
- load
Balancer ClusterRke Config Cloud Provider Openstack Cloud Provider Load Balancer (list maxitems:1)
- metadata
Cluster
Rke Config Cloud Provider Openstack Cloud Provider Metadata (list maxitems:1)
- route
Cluster
Rke Config Cloud Provider Openstack Cloud Provider Route (list maxitems:1)
- global_
Cluster
Rke Config Cloud Provider Openstack Cloud Provider Global Args (list maxitems:1)
- block_
storage ClusterRke Config Cloud Provider Openstack Cloud Provider Block Storage Args (list maxitems:1)
- load_
balancer ClusterRke Config Cloud Provider Openstack Cloud Provider Load Balancer Args (list maxitems:1)
- metadata
Cluster
Rke Config Cloud Provider Openstack Cloud Provider Metadata Args (list maxitems:1)
- route
Cluster
Rke Config Cloud Provider Openstack Cloud Provider Route Args (list maxitems:1)
ClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorage
- Bs
Version string (string)
- Ignore
Volume boolAz (string)
- Trust
Device boolPath (string)
- Bs
Version string (string)
- Ignore
Volume boolAz (string)
- Trust
Device boolPath (string)
- bs
Version string (string)
- ignore
Volume booleanAz (string)
- trust
Device booleanPath (string)
- bs_
version str (string)
- ignore_
volume_ boolaz (string)
- trust_
device_ boolpath (string)
ClusterRkeConfigCloudProviderOpenstackCloudProviderGlobal
- Auth
Url string (string)
- Password string
Registry password (string)
- Username string
(string)
- Ca
File string (string)
- Domain
Id string Required if
domain_name
not provided. (string)- Domain
Name string Required if
domain_id
not provided. (string)- Region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- Tenant
Id string Azure tenant ID to use (string)
- Tenant
Name string Required if
tenant_id
not provided. (string)- Trust
Id string (string)
- Auth
Url string (string)
- Password string
Registry password (string)
- Username string
(string)
- Ca
File string (string)
- Domain
Id string Required if
domain_name
not provided. (string)- Domain
Name string Required if
domain_id
not provided. (string)- Region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- Tenant
Id string Azure tenant ID to use (string)
- Tenant
Name string Required if
tenant_id
not provided. (string)- Trust
Id string (string)
- auth
Url string (string)
- password string
Registry password (string)
- username string
(string)
- ca
File string (string)
- domain
Id string Required if
domain_name
not provided. (string)- domain
Name string Required if
domain_id
not provided. (string)- region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- tenant
Id string Azure tenant ID to use (string)
- tenant
Name string Required if
tenant_id
not provided. (string)- trust
Id string (string)
- auth_
url str (string)
- password str
Registry password (string)
- username str
(string)
- ca_
file str (string)
- domain_
id str Required if
domain_name
not provided. (string)- domain_
name str Required if
domain_id
not provided. (string)- region str
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- tenant_
id str Azure tenant ID to use (string)
- tenant_
name str Required if
tenant_id
not provided. (string)- trust_
id str (string)
ClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer
- Create
Monitor bool (bool)
- Floating
Network stringId (string)
- Lb
Method string (string)
- Lb
Provider string (string)
- Lb
Version string (string)
- Manage
Security boolGroups (bool)
- Monitor
Delay string Default
60s
(string)- Monitor
Max intRetries Default 5 (int)
- Monitor
Timeout string Default
30s
(string)- Subnet
Id string (string)
- Use
Octavia bool (bool)
- Create
Monitor bool (bool)
- Floating
Network stringId (string)
- Lb
Method string (string)
- Lb
Provider string (string)
- Lb
Version string (string)
- Manage
Security boolGroups (bool)
- Monitor
Delay string Default
60s
(string)- Monitor
Max intRetries Default 5 (int)
- Monitor
Timeout string Default
30s
(string)- Subnet
Id string (string)
- Use
Octavia bool (bool)
- create
Monitor boolean (bool)
- floating
Network stringId (string)
- lb
Method string (string)
- lb
Provider string (string)
- lb
Version string (string)
- manage
Security booleanGroups (bool)
- monitor
Delay string Default
60s
(string)- monitor
Max numberRetries Default 5 (int)
- monitor
Timeout string Default
30s
(string)- subnet
Id string (string)
- use
Octavia boolean (bool)
- create_
monitor bool (bool)
- floating_
network_ strid (string)
- lb_
method str (string)
- lb_
provider str (string)
- lb_
version str (string)
- manage_
security_ boolgroups (bool)
- monitor_
delay str Default
60s
(string)- monitor_
max_ intretries Default 5 (int)
- monitor_
timeout str Default
30s
(string)- subnet_
id str (string)
- use_
octavia bool (bool)
ClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata
- Request
Timeout int (int)
- Search
Order string (string)
- Request
Timeout int (int)
- Search
Order string (string)
- request
Timeout number (int)
- search
Order string (string)
- request_
timeout int (int)
- search_
order str (string)
ClusterRkeConfigCloudProviderOpenstackCloudProviderRoute
- Router
Id string (string)
- Router
Id string (string)
- router
Id string (string)
- router_
id str (string)
ClusterRkeConfigCloudProviderVsphereCloudProvider
- Virtual
Centers List<ClusterRke Config Cloud Provider Vsphere Cloud Provider Virtual Center Args> (List)
- Workspace
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Workspace Args (list maxitems:1)
- Disk
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Disk Args (list maxitems:1)
- Global
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Global Args (list maxitems:1)
- Network
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Network Args Network for GKE cluster (string)
- Virtual
Centers []ClusterRke Config Cloud Provider Vsphere Cloud Provider Virtual Center (List)
- Workspace
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Workspace (list maxitems:1)
- Disk
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Disk (list maxitems:1)
- Global
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Global (list maxitems:1)
- Network
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Network Network for GKE cluster (string)
- virtual
Centers ClusterRke Config Cloud Provider Vsphere Cloud Provider Virtual Center[] (List)
- workspace
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Workspace (list maxitems:1)
- disk
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Disk (list maxitems:1)
- global
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Global (list maxitems:1)
- network
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Network Network for GKE cluster (string)
- virtual_
centers Sequence[ClusterRke Config Cloud Provider Vsphere Cloud Provider Virtual Center Args] (List)
- workspace
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Workspace Args (list maxitems:1)
- disk
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Disk Args (list maxitems:1)
- global_
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Global Args (list maxitems:1)
- network
Cluster
Rke Config Cloud Provider Vsphere Cloud Provider Network Args Network for GKE cluster (string)
ClusterRkeConfigCloudProviderVsphereCloudProviderDisk
- Scsi
Controller stringType (string)
- Scsi
Controller stringType (string)
- scsi
Controller stringType (string)
- scsi_
controller_ strtype (string)
ClusterRkeConfigCloudProviderVsphereCloudProviderGlobal
- Datacenters string
(string)
- Insecure
Flag bool (bool)
- Password string
Registry password (string)
- Port string
Port for node. Default
22
(string)- Soap
Roundtrip intCount (int)
- User string
Registry user (string)
- Datacenters string
(string)
- Insecure
Flag bool (bool)
- Password string
Registry password (string)
- Port string
Port for node. Default
22
(string)- Soap
Roundtrip intCount (int)
- User string
Registry user (string)
- datacenters string
(string)
- insecure
Flag boolean (bool)
- password string
Registry password (string)
- port string
Port for node. Default
22
(string)- soap
Roundtrip numberCount (int)
- user string
Registry user (string)
- datacenters str
(string)
- insecure_
flag bool (bool)
- password str
Registry password (string)
- port str
Port for node. Default
22
(string)- soap_
roundtrip_ intcount (int)
- user str
Registry user (string)
ClusterRkeConfigCloudProviderVsphereCloudProviderNetwork
- Public
Network string (string)
- Public
Network string (string)
- public
Network string (string)
- public_
network str (string)
ClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenter
- Datacenters string
(string)
- Name string
Name of cluster registration token (string)
- Password string
Registry password (string)
- User string
Registry user (string)
- Port string
Port for node. Default
22
(string)- Soap
Roundtrip intCount (int)
- Datacenters string
(string)
- Name string
Name of cluster registration token (string)
- Password string
Registry password (string)
- User string
Registry user (string)
- Port string
Port for node. Default
22
(string)- Soap
Roundtrip intCount (int)
- datacenters string
(string)
- name string
Name of cluster registration token (string)
- password string
Registry password (string)
- user string
Registry user (string)
- port string
Port for node. Default
22
(string)- soap
Roundtrip numberCount (int)
- datacenters str
(string)
- name str
Name of cluster registration token (string)
- password str
Registry password (string)
- user str
Registry user (string)
- port str
Port for node. Default
22
(string)- soap_
roundtrip_ intcount (int)
ClusterRkeConfigCloudProviderVsphereCloudProviderWorkspace
- Datacenter string
(string)
- Folder string
Folder for S3 service. Available from Rancher v2.2.7 (string)
- Server string
(string)
- Default
Datastore string (string)
- Resourcepool
Path string (string)
- Datacenter string
(string)
- Folder string
Folder for S3 service. Available from Rancher v2.2.7 (string)
- Server string
(string)
- Default
Datastore string (string)
- Resourcepool
Path string (string)
- datacenter string
(string)
- folder string
Folder for S3 service. Available from Rancher v2.2.7 (string)
- server string
(string)
- default
Datastore string (string)
- resourcepool
Path string (string)
- datacenter str
(string)
- folder str
Folder for S3 service. Available from Rancher v2.2.7 (string)
- server str
(string)
- default_
datastore str (string)
- resourcepool_
path str (string)
ClusterRkeConfigDns
- Linear
Autoscaler ClusterParams Rke Config Dns Linear Autoscaler Params Args LinearAutoScalerParams dns config (list Maxitem: 1)
- Node
Selector Dictionary<string, object> RKE monitoring node selector (map)
- Nodelocal
Cluster
Rke Config Dns Nodelocal Args Nodelocal dns config (list Maxitem: 1)
- Provider string
RKE monitoring provider (string)
- Reverse
Cidrs List<string> DNS add-on reverse cidr (list)
- Update
Strategy ClusterRke Config Dns Update Strategy Args RKE monitoring update strategy (list Maxitems: 1)
- Upstream
Nameservers List<string> DNS add-on upstream nameservers (list)
- Linear
Autoscaler ClusterParams Rke Config Dns Linear Autoscaler Params LinearAutoScalerParams dns config (list Maxitem: 1)
- Node
Selector map[string]interface{} RKE monitoring node selector (map)
- Nodelocal
Cluster
Rke Config Dns Nodelocal Nodelocal dns config (list Maxitem: 1)
- Provider string
RKE monitoring provider (string)
- Reverse
Cidrs []string DNS add-on reverse cidr (list)
- Update
Strategy ClusterRke Config Dns Update Strategy RKE monitoring update strategy (list Maxitems: 1)
- Upstream
Nameservers []string DNS add-on upstream nameservers (list)
- linear
Autoscaler ClusterParams Rke Config Dns Linear Autoscaler Params LinearAutoScalerParams dns config (list Maxitem: 1)
- node
Selector {[key: string]: any} RKE monitoring node selector (map)
- nodelocal
Cluster
Rke Config Dns Nodelocal Nodelocal dns config (list Maxitem: 1)
- provider string
RKE monitoring provider (string)
- reverse
Cidrs string[] DNS add-on reverse cidr (list)
- update
Strategy ClusterRke Config Dns Update Strategy RKE monitoring update strategy (list Maxitems: 1)
- upstream
Nameservers string[] DNS add-on upstream nameservers (list)
- linear_
autoscaler_ Clusterparams Rke Config Dns Linear Autoscaler Params Args LinearAutoScalerParams dns config (list Maxitem: 1)
- node_
selector Mapping[str, Any] RKE monitoring node selector (map)
- nodelocal
Cluster
Rke Config Dns Nodelocal Args Nodelocal dns config (list Maxitem: 1)
- provider str
RKE monitoring provider (string)
- reverse_
cidrs Sequence[str] DNS add-on reverse cidr (list)
- update_
strategy ClusterRke Config Dns Update Strategy Args RKE monitoring update strategy (list Maxitems: 1)
- upstream_
nameservers Sequence[str] DNS add-on upstream nameservers (list)
ClusterRkeConfigDnsLinearAutoscalerParams
- Cores
Per doubleReplica number of replicas per cluster cores (float64)
- Max int
maximum number of replicas (int64)
- Min int
minimum number of replicas (int64)
- Nodes
Per doubleReplica number of replica per cluster nodes (float64)
- Prevent
Single boolPoint Failure prevent single point of failure
- Cores
Per float64Replica number of replicas per cluster cores (float64)
- Max int
maximum number of replicas (int64)
- Min int
minimum number of replicas (int64)
- Nodes
Per float64Replica number of replica per cluster nodes (float64)
- Prevent
Single boolPoint Failure prevent single point of failure
- cores
Per numberReplica number of replicas per cluster cores (float64)
- max number
maximum number of replicas (int64)
- min number
minimum number of replicas (int64)
- nodes
Per numberReplica number of replica per cluster nodes (float64)
- prevent
Single booleanPoint Failure prevent single point of failure
- cores_
per_ floatreplica number of replicas per cluster cores (float64)
- max int
maximum number of replicas (int64)
- min int
minimum number of replicas (int64)
- nodes_
per_ floatreplica number of replica per cluster nodes (float64)
- prevent_
single_ boolpoint_ failure prevent single point of failure
ClusterRkeConfigDnsNodelocal
- Ip
Address string Nodelocal dns ip address (string)
- Node
Selector Dictionary<string, object> RKE monitoring node selector (map)
- Ip
Address string Nodelocal dns ip address (string)
- Node
Selector map[string]interface{} RKE monitoring node selector (map)
- ip
Address string Nodelocal dns ip address (string)
- node
Selector {[key: string]: any} RKE monitoring node selector (map)
- ip_
address str Nodelocal dns ip address (string)
- node_
selector Mapping[str, Any] RKE monitoring node selector (map)
ClusterRkeConfigDnsUpdateStrategy
- Rolling
Update ClusterRke Config Dns Update Strategy Rolling Update Args Monitoring deployment rolling update (list Maxitems: 1)
- Strategy string
Monitoring deployment update strategy (string)
- Rolling
Update ClusterRke Config Dns Update Strategy Rolling Update Monitoring deployment rolling update (list Maxitems: 1)
- Strategy string
Monitoring deployment update strategy (string)
- rolling
Update ClusterRke Config Dns Update Strategy Rolling Update Monitoring deployment rolling update (list Maxitems: 1)
- strategy string
Monitoring deployment update strategy (string)
- rolling_
update ClusterRke Config Dns Update Strategy Rolling Update Args Monitoring deployment rolling update (list Maxitems: 1)
- strategy str
Monitoring deployment update strategy (string)
ClusterRkeConfigDnsUpdateStrategyRollingUpdate
- Max
Surge int Monitoring deployment rolling update max surge. Default:
1
(int)- int
Monitoring deployment rolling update max unavailable. Default:
1
(int)
- Max
Surge int Monitoring deployment rolling update max surge. Default:
1
(int)- int
Monitoring deployment rolling update max unavailable. Default:
1
(int)
- max
Surge number Monitoring deployment rolling update max surge. Default:
1
(int)- number
Monitoring deployment rolling update max unavailable. Default:
1
(int)
- max_
surge int Monitoring deployment rolling update max surge. Default:
1
(int)- int
Monitoring deployment rolling update max unavailable. Default:
1
(int)
ClusterRkeConfigIngress
- Dns
Policy string Ingress controller DNS policy.
ClusterFirstWithHostNet
,ClusterFirst
,Default
, andNone
are supported. K8S dns Policy (string)- Extra
Args Dictionary<string, object> Extra arguments for scheduler service (map)
- Node
Selector Dictionary<string, object> RKE monitoring node selector (map)
- Options Dictionary<string, object>
RKE options for network (map)
- Provider string
RKE monitoring provider (string)
- Dns
Policy string Ingress controller DNS policy.
ClusterFirstWithHostNet
,ClusterFirst
,Default
, andNone
are supported. K8S dns Policy (string)- Extra
Args map[string]interface{} Extra arguments for scheduler service (map)
- Node
Selector map[string]interface{} RKE monitoring node selector (map)
- Options map[string]interface{}
RKE options for network (map)
- Provider string
RKE monitoring provider (string)
- dns
Policy string Ingress controller DNS policy.
ClusterFirstWithHostNet
,ClusterFirst
,Default
, andNone
are supported. K8S dns Policy (string)- extra
Args {[key: string]: any} Extra arguments for scheduler service (map)
- node
Selector {[key: string]: any} RKE monitoring node selector (map)
- options {[key: string]: any}
RKE options for network (map)
- provider string
RKE monitoring provider (string)
- dns_
policy str Ingress controller DNS policy.
ClusterFirstWithHostNet
,ClusterFirst
,Default
, andNone
are supported. K8S dns Policy (string)- extra_
args Mapping[str, Any] Extra arguments for scheduler service (map)
- node_
selector Mapping[str, Any] RKE monitoring node selector (map)
- options Mapping[str, Any]
RKE options for network (map)
- provider str
RKE monitoring provider (string)
ClusterRkeConfigMonitoring
- Node
Selector Dictionary<string, object> RKE monitoring node selector (map)
- Options Dictionary<string, object>
RKE options for network (map)
- Provider string
RKE monitoring provider (string)
- Replicas int
RKE monitoring replicas (int)
- Update
Strategy ClusterRke Config Monitoring Update Strategy Args RKE monitoring update strategy (list Maxitems: 1)
- Node
Selector map[string]interface{} RKE monitoring node selector (map)
- Options map[string]interface{}
RKE options for network (map)
- Provider string
RKE monitoring provider (string)
- Replicas int
RKE monitoring replicas (int)
- Update
Strategy ClusterRke Config Monitoring Update Strategy RKE monitoring update strategy (list Maxitems: 1)
- node
Selector {[key: string]: any} RKE monitoring node selector (map)
- options {[key: string]: any}
RKE options for network (map)
- provider string
RKE monitoring provider (string)
- replicas number
RKE monitoring replicas (int)
- update
Strategy ClusterRke Config Monitoring Update Strategy RKE monitoring update strategy (list Maxitems: 1)
- node_
selector Mapping[str, Any] RKE monitoring node selector (map)
- options Mapping[str, Any]
RKE options for network (map)
- provider str
RKE monitoring provider (string)
- replicas int
RKE monitoring replicas (int)
- update_
strategy ClusterRke Config Monitoring Update Strategy Args RKE monitoring update strategy (list Maxitems: 1)
ClusterRkeConfigMonitoringUpdateStrategy
- Rolling
Update ClusterRke Config Monitoring Update Strategy Rolling Update Args Monitoring deployment rolling update (list Maxitems: 1)
- Strategy string
Monitoring deployment update strategy (string)
- Rolling
Update ClusterRke Config Monitoring Update Strategy Rolling Update Monitoring deployment rolling update (list Maxitems: 1)
- Strategy string
Monitoring deployment update strategy (string)
- rolling
Update ClusterRke Config Monitoring Update Strategy Rolling Update Monitoring deployment rolling update (list Maxitems: 1)
- strategy string
Monitoring deployment update strategy (string)
- rolling_
update ClusterRke Config Monitoring Update Strategy Rolling Update Args Monitoring deployment rolling update (list Maxitems: 1)
- strategy str
Monitoring deployment update strategy (string)
ClusterRkeConfigMonitoringUpdateStrategyRollingUpdate
- Max
Surge int Monitoring deployment rolling update max surge. Default:
1
(int)- int
Monitoring deployment rolling update max unavailable. Default:
1
(int)
- Max
Surge int Monitoring deployment rolling update max surge. Default:
1
(int)- int
Monitoring deployment rolling update max unavailable. Default:
1
(int)
- max
Surge number Monitoring deployment rolling update max surge. Default:
1
(int)- number
Monitoring deployment rolling update max unavailable. Default:
1
(int)
- max_
surge int Monitoring deployment rolling update max surge. Default:
1
(int)- int
Monitoring deployment rolling update max unavailable. Default:
1
(int)
ClusterRkeConfigNetwork
- Calico
Network ClusterProvider Rke Config Network Calico Network Provider Args Calico provider config for RKE network (list maxitems:1)
- Canal
Network ClusterProvider Rke Config Network Canal Network Provider Args Canal provider config for RKE network (list maxitems:1)
- Flannel
Network ClusterProvider Rke Config Network Flannel Network Provider Args Flannel provider config for RKE network (list maxitems:1)
- Mtu int
Network provider MTU. Default
0
(int)- Options Dictionary<string, object>
RKE options for network (map)
- Plugin string
Plugin for RKE network.
canal
(default),flannel
,calico
,none
andweave
are supported. (string)- Weave
Network ClusterProvider Rke Config Network Weave Network Provider Args Weave provider config for RKE network (list maxitems:1)
- Calico
Network ClusterProvider Rke Config Network Calico Network Provider Calico provider config for RKE network (list maxitems:1)
- Canal
Network ClusterProvider Rke Config Network Canal Network Provider Canal provider config for RKE network (list maxitems:1)
- Flannel
Network ClusterProvider Rke Config Network Flannel Network Provider Flannel provider config for RKE network (list maxitems:1)
- Mtu int
Network provider MTU. Default
0
(int)- Options map[string]interface{}
RKE options for network (map)
- Plugin string
Plugin for RKE network.
canal
(default),flannel
,calico
,none
andweave
are supported. (string)- Weave
Network ClusterProvider Rke Config Network Weave Network Provider Weave provider config for RKE network (list maxitems:1)
- calico
Network ClusterProvider Rke Config Network Calico Network Provider Calico provider config for RKE network (list maxitems:1)
- canal
Network ClusterProvider Rke Config Network Canal Network Provider Canal provider config for RKE network (list maxitems:1)
- flannel
Network ClusterProvider Rke Config Network Flannel Network Provider Flannel provider config for RKE network (list maxitems:1)
- mtu number
Network provider MTU. Default
0
(int)- options {[key: string]: any}
RKE options for network (map)
- plugin string
Plugin for RKE network.
canal
(default),flannel
,calico
,none
andweave
are supported. (string)- weave
Network ClusterProvider Rke Config Network Weave Network Provider Weave provider config for RKE network (list maxitems:1)
- calico_
network_ Clusterprovider Rke Config Network Calico Network Provider Args Calico provider config for RKE network (list maxitems:1)
- canal_
network_ Clusterprovider Rke Config Network Canal Network Provider Args Canal provider config for RKE network (list maxitems:1)
- flannel_
network_ Clusterprovider Rke Config Network Flannel Network Provider Args Flannel provider config for RKE network (list maxitems:1)
- mtu int
Network provider MTU. Default
0
(int)- options Mapping[str, Any]
RKE options for network (map)
- plugin str
Plugin for RKE network.
canal
(default),flannel
,calico
,none
andweave
are supported. (string)- weave_
network_ Clusterprovider Rke Config Network Weave Network Provider Args Weave provider config for RKE network (list maxitems:1)
ClusterRkeConfigNetworkCalicoNetworkProvider
- Cloud
Provider string RKE options for Calico network provider (string)
- Cloud
Provider string RKE options for Calico network provider (string)
- cloud
Provider string RKE options for Calico network provider (string)
- cloud_
provider str RKE options for Calico network provider (string)
ClusterRkeConfigNetworkCanalNetworkProvider
- Iface string
Iface config Flannel network provider (string)
- Iface string
Iface config Flannel network provider (string)
- iface string
Iface config Flannel network provider (string)
- iface str
Iface config Flannel network provider (string)
ClusterRkeConfigNetworkFlannelNetworkProvider
- Iface string
Iface config Flannel network provider (string)
- Iface string
Iface config Flannel network provider (string)
- iface string
Iface config Flannel network provider (string)
- iface str
Iface config Flannel network provider (string)
ClusterRkeConfigNetworkWeaveNetworkProvider
- Password string
Registry password (string)
- Password string
Registry password (string)
- password string
Registry password (string)
- password str
Registry password (string)
ClusterRkeConfigNode
- Address string
Address ip for node (string)
- Roles List<string>
Roles for the node.
controlplane
,etcd
andworker
are supported. (list)- User string
Registry user (string)
- Docker
Socket string Docker socket for node (string)
- Hostname
Override string Hostname override for node (string)
- Internal
Address string Internal ip for node (string)
- Labels Dictionary<string, object>
Labels for cluster registration token object (map)
- Node
Id string Id for the node (string)
- Port string
Port for node. Default
22
(string)- Ssh
Agent boolAuth Use ssh agent auth. Default
false
(bool)- Ssh
Key string Node SSH private key (string)
- Ssh
Key stringPath Node SSH private key path (string)
- Address string
Address ip for node (string)
- Roles []string
Roles for the node.
controlplane
,etcd
andworker
are supported. (list)- User string
Registry user (string)
- Docker
Socket string Docker socket for node (string)
- Hostname
Override string Hostname override for node (string)
- Internal
Address string Internal ip for node (string)
- Labels map[string]interface{}
Labels for cluster registration token object (map)
- Node
Id string Id for the node (string)
- Port string
Port for node. Default
22
(string)- Ssh
Agent boolAuth Use ssh agent auth. Default
false
(bool)- Ssh
Key string Node SSH private key (string)
- Ssh
Key stringPath Node SSH private key path (string)
- address string
Address ip for node (string)
- roles string[]
Roles for the node.
controlplane
,etcd
andworker
are supported. (list)- user string
Registry user (string)
- docker
Socket string Docker socket for node (string)
- hostname
Override string Hostname override for node (string)
- internal
Address string Internal ip for node (string)
- labels {[key: string]: any}
Labels for cluster registration token object (map)
- node
Id string Id for the node (string)
- port string
Port for node. Default
22
(string)- ssh
Agent booleanAuth Use ssh agent auth. Default
false
(bool)- ssh
Key string Node SSH private key (string)
- ssh
Key stringPath Node SSH private key path (string)
- address str
Address ip for node (string)
- roles Sequence[str]
Roles for the node.
controlplane
,etcd
andworker
are supported. (list)- user str
Registry user (string)
- docker_
socket str Docker socket for node (string)
- hostname_
override str Hostname override for node (string)
- internal_
address str Internal ip for node (string)
- labels Mapping[str, Any]
Labels for cluster registration token object (map)
- node_
id str Id for the node (string)
- port str
Port for node. Default
22
(string)- ssh_
agent_ boolauth Use ssh agent auth. Default
false
(bool)- ssh_
key str Node SSH private key (string)
- ssh_
key_ strpath Node SSH private key path (string)
ClusterRkeConfigPrivateRegistry
- url str
Registry URL (string)
- is_
default bool Set as default registry. Default
false
(bool)- password str
Registry password (string)
- user str
Registry user (string)
ClusterRkeConfigServices
- Etcd
Cluster
Rke Config Services Etcd Args Etcd options for RKE services (list maxitems:1)
- Kube
Api ClusterRke Config Services Kube Api Args Kube API options for RKE services (list maxitems:1)
- Kube
Controller ClusterRke Config Services Kube Controller Args Kube Controller options for RKE services (list maxitems:1)
- Kubelet
Cluster
Rke Config Services Kubelet Args Kubelet options for RKE services (list maxitems:1)
- Kubeproxy
Cluster
Rke Config Services Kubeproxy Args Kubeproxy options for RKE services (list maxitems:1)
- Scheduler
Cluster
Rke Config Services Scheduler Args Scheduler options for RKE services (list maxitems:1)
- Etcd
Cluster
Rke Config Services Etcd Etcd options for RKE services (list maxitems:1)
- Kube
Api ClusterRke Config Services Kube Api Kube API options for RKE services (list maxitems:1)
- Kube
Controller ClusterRke Config Services Kube Controller Kube Controller options for RKE services (list maxitems:1)
- Kubelet
Cluster
Rke Config Services Kubelet Kubelet options for RKE services (list maxitems:1)
- Kubeproxy
Cluster
Rke Config Services Kubeproxy Kubeproxy options for RKE services (list maxitems:1)
- Scheduler
Cluster
Rke Config Services Scheduler Scheduler options for RKE services (list maxitems:1)
- etcd
Cluster
Rke Config Services Etcd Etcd options for RKE services (list maxitems:1)
- kube
Api ClusterRke Config Services Kube Api Kube API options for RKE services (list maxitems:1)
- kube
Controller ClusterRke Config Services Kube Controller Kube Controller options for RKE services (list maxitems:1)
- kubelet
Cluster
Rke Config Services Kubelet Kubelet options for RKE services (list maxitems:1)
- kubeproxy
Cluster
Rke Config Services Kubeproxy Kubeproxy options for RKE services (list maxitems:1)
- scheduler
Cluster
Rke Config Services Scheduler Scheduler options for RKE services (list maxitems:1)
- etcd
Cluster
Rke Config Services Etcd Args Etcd options for RKE services (list maxitems:1)
- kube_
api ClusterRke Config Services Kube Api Args Kube API options for RKE services (list maxitems:1)
- kube_
controller ClusterRke Config Services Kube Controller Args Kube Controller options for RKE services (list maxitems:1)
- kubelet
Cluster
Rke Config Services Kubelet Args Kubelet options for RKE services (list maxitems:1)
- kubeproxy
Cluster
Rke Config Services Kubeproxy Args Kubeproxy options for RKE services (list maxitems:1)
- scheduler
Cluster
Rke Config Services Scheduler Args Scheduler options for RKE services (list maxitems:1)
ClusterRkeConfigServicesEtcd
- Backup
Config ClusterRke Config Services Etcd Backup Config Args Backup options for etcd service. Just for Rancher v2.2.x (list maxitems:1)
- Ca
Cert string TLS CA certificate for etcd service (string)
- Cert string
TLS certificate for etcd service (string)
- Creation string
Creation option for etcd service (string)
- External
Urls List<string> External urls for etcd service (list)
- Extra
Args Dictionary<string, object> Extra arguments for scheduler service (map)
- Extra
Binds List<string> Extra binds for scheduler service (list)
- Extra
Envs List<string> Extra environment for scheduler service (list)
- Gid int
Etcd service GID. Default:
0
. For Rancher v2.3.x or above (int)- Image string
Docker image for scheduler service (string)
- Key string
TLS key for etcd service (string)
- Path string
(Optional) Audit log path. Default:
/var/log/kube-audit/audit-log.json
(string)- Retention string
Retention for etcd backup. Default
6
(int)- Snapshot bool
Snapshot option for etcd service (bool)
- Uid int
Etcd service UID. Default:
0
. For Rancher v2.3.x or above (int)
- Backup
Config ClusterRke Config Services Etcd Backup Config Backup options for etcd service. Just for Rancher v2.2.x (list maxitems:1)
- Ca
Cert string TLS CA certificate for etcd service (string)
- Cert string
TLS certificate for etcd service (string)
- Creation string
Creation option for etcd service (string)
- External
Urls []string External urls for etcd service (list)
- Extra
Args map[string]interface{} Extra arguments for scheduler service (map)
- Extra
Binds []string Extra binds for scheduler service (list)
- Extra
Envs []string Extra environment for scheduler service (list)
- Gid int
Etcd service GID. Default:
0
. For Rancher v2.3.x or above (int)- Image string
Docker image for scheduler service (string)
- Key string
TLS key for etcd service (string)
- Path string
(Optional) Audit log path. Default:
/var/log/kube-audit/audit-log.json
(string)- Retention string
Retention for etcd backup. Default
6
(int)- Snapshot bool
Snapshot option for etcd service (bool)
- Uid int
Etcd service UID. Default:
0
. For Rancher v2.3.x or above (int)
- backup
Config ClusterRke Config Services Etcd Backup Config Backup options for etcd service. Just for Rancher v2.2.x (list maxitems:1)
- ca
Cert string TLS CA certificate for etcd service (string)
- cert string
TLS certificate for etcd service (string)
- creation string
Creation option for etcd service (string)
- external
Urls string[] External urls for etcd service (list)
- extra
Args {[key: string]: any} Extra arguments for scheduler service (map)
- extra
Binds string[] Extra binds for scheduler service (list)
- extra
Envs string[] Extra environment for scheduler service (list)
- gid number
Etcd service GID. Default:
0
. For Rancher v2.3.x or above (int)- image string
Docker image for scheduler service (string)
- key string
TLS key for etcd service (string)
- path string
(Optional) Audit log path. Default:
/var/log/kube-audit/audit-log.json
(string)- retention string
Retention for etcd backup. Default
6
(int)- snapshot boolean
Snapshot option for etcd service (bool)
- uid number
Etcd service UID. Default:
0
. For Rancher v2.3.x or above (int)
- backup_
config ClusterRke Config Services Etcd Backup Config Args Backup options for etcd service. Just for Rancher v2.2.x (list maxitems:1)
- ca_
cert str TLS CA certificate for etcd service (string)
- cert str
TLS certificate for etcd service (string)
- creation str
Creation option for etcd service (string)
- external_
urls Sequence[str] External urls for etcd service (list)
- extra_
args Mapping[str, Any] Extra arguments for scheduler service (map)
- extra_
binds Sequence[str] Extra binds for scheduler service (list)
- extra_
envs Sequence[str] Extra environment for scheduler service (list)
- gid int
Etcd service GID. Default:
0
. For Rancher v2.3.x or above (int)- image str
Docker image for scheduler service (string)
- key str
TLS key for etcd service (string)
- path str
(Optional) Audit log path. Default:
/var/log/kube-audit/audit-log.json
(string)- retention str
Retention for etcd backup. Default
6
(int)- snapshot bool
Snapshot option for etcd service (bool)
- uid int
Etcd service UID. Default:
0
. For Rancher v2.3.x or above (int)
ClusterRkeConfigServicesEtcdBackupConfig
- Enabled bool
Enable scheduled cluster scan. Default:
false
(bool)- Interval
Hours int Interval hours for etcd backup. Default
12
(int)- Retention int
Retention for etcd backup. Default
6
(int)- S3Backup
Config ClusterRke Config Services Etcd Backup Config S3Backup Config Args S3 config options for etcd backup (list maxitems:1)
- Safe
Timestamp bool Safe timestamp for etcd backup. Default:
false
(bool)
- Enabled bool
Enable scheduled cluster scan. Default:
false
(bool)- Interval
Hours int Interval hours for etcd backup. Default
12
(int)- Retention int
Retention for etcd backup. Default
6
(int)- S3Backup
Config ClusterRke Config Services Etcd Backup Config S3Backup Config S3 config options for etcd backup (list maxitems:1)
- Safe
Timestamp bool Safe timestamp for etcd backup. Default:
false
(bool)
- enabled boolean
Enable scheduled cluster scan. Default:
false
(bool)- interval
Hours number Interval hours for etcd backup. Default
12
(int)- retention number
Retention for etcd backup. Default
6
(int)- s3Backup
Config ClusterRke Config Services Etcd Backup Config S3Backup Config S3 config options for etcd backup (list maxitems:1)
- safe
Timestamp boolean Safe timestamp for etcd backup. Default:
false
(bool)
- enabled bool
Enable scheduled cluster scan. Default:
false
(bool)- interval_
hours int Interval hours for etcd backup. Default
12
(int)- retention int
Retention for etcd backup. Default
6
(int)- s3_
backup_ Clusterconfig Rke Config Services Etcd Backup Config S3Backup Config Args S3 config options for etcd backup (list maxitems:1)
- safe_
timestamp bool Safe timestamp for etcd backup. Default:
false
(bool)
ClusterRkeConfigServicesEtcdBackupConfigS3BackupConfig
- Bucket
Name string Bucket name for S3 service (string)
- Endpoint string
Endpoint for S3 service (string)
- Access
Key string The AWS Client ID to use (string)
- Custom
Ca string Base64 encoded custom CA for S3 service. Use filebase64(
) for encoding file. Available from Rancher v2.2.5 (string) - Folder string
Folder for S3 service. Available from Rancher v2.2.7 (string)
- Region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- Secret
Key string The AWS Client Secret associated with the Client ID (string)
- Bucket
Name string Bucket name for S3 service (string)
- Endpoint string
Endpoint for S3 service (string)
- Access
Key string The AWS Client ID to use (string)
- Custom
Ca string Base64 encoded custom CA for S3 service. Use filebase64(
) for encoding file. Available from Rancher v2.2.5 (string) - Folder string
Folder for S3 service. Available from Rancher v2.2.7 (string)
- Region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- Secret
Key string The AWS Client Secret associated with the Client ID (string)
- bucket
Name string Bucket name for S3 service (string)
- endpoint string
Endpoint for S3 service (string)
- access
Key string The AWS Client ID to use (string)
- custom
Ca string Base64 encoded custom CA for S3 service. Use filebase64(
) for encoding file. Available from Rancher v2.2.5 (string) - folder string
Folder for S3 service. Available from Rancher v2.2.7 (string)
- region string
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- secret
Key string The AWS Client Secret associated with the Client ID (string)
- bucket_
name str Bucket name for S3 service (string)
- endpoint str
Endpoint for S3 service (string)
- access_
key str The AWS Client ID to use (string)
- custom_
ca str Base64 encoded custom CA for S3 service. Use filebase64(
) for encoding file. Available from Rancher v2.2.5 (string) - folder str
Folder for S3 service. Available from Rancher v2.2.7 (string)
- region str
The availability domain within the region to host the cluster. See here for a list of region names. (string)
- secret_
key str The AWS Client Secret associated with the Client ID (string)
ClusterRkeConfigServicesKubeApi
- Admission
Configuration Dictionary<string, object> Admission configuration (map)
- Always
Pull boolImages Enable AlwaysPullImages Admission controller plugin. Rancher docs Default:
false
(bool)- Audit
Log ClusterRke Config Services Kube Api Audit Log Args K8s audit log configuration. (list maxitems: 1)
- Event
Rate ClusterLimit Rke Config Services Kube Api Event Rate Limit Args K8s event rate limit configuration. (list maxitems: 1)
- Extra
Args Dictionary<string, object> Extra arguments for scheduler service (map)
- Extra
Binds List<string> Extra binds for scheduler service (list)
- Extra
Envs List<string> Extra environment for scheduler service (list)
- Image string
Docker image for scheduler service (string)
- Pod
Security boolPolicy Pod Security Policy option for kube API service. Default
false
(bool)- Secrets
Encryption ClusterConfig Rke Config Services Kube Api Secrets Encryption Config Args Encrypt k8s secret data configration. (list maxitem: 1)
- Service
Cluster stringIp Range Service Cluster ip Range option for kube controller service (string)
- Service
Node stringPort Range Service Node Port Range option for kube API service (string)
- Admission
Configuration map[string]interface{} Admission configuration (map)
- Always
Pull boolImages Enable AlwaysPullImages Admission controller plugin. Rancher docs Default:
false
(bool)- Audit
Log ClusterRke Config Services Kube Api Audit Log K8s audit log configuration. (list maxitems: 1)
- Event
Rate ClusterLimit Rke Config Services Kube Api Event Rate Limit K8s event rate limit configuration. (list maxitems: 1)
- Extra
Args map[string]interface{} Extra arguments for scheduler service (map)
- Extra
Binds []string Extra binds for scheduler service (list)
- Extra
Envs []string Extra environment for scheduler service (list)
- Image string
Docker image for scheduler service (string)
- Pod
Security boolPolicy Pod Security Policy option for kube API service. Default
false
(bool)- Secrets
Encryption ClusterConfig Rke Config Services Kube Api Secrets Encryption Config Encrypt k8s secret data configration. (list maxitem: 1)
- Service
Cluster stringIp Range Service Cluster ip Range option for kube controller service (string)
- Service
Node stringPort Range Service Node Port Range option for kube API service (string)
- admission
Configuration {[key: string]: any} Admission configuration (map)
- always
Pull booleanImages Enable AlwaysPullImages Admission controller plugin. Rancher docs Default:
false
(bool)- audit
Log ClusterRke Config Services Kube Api Audit Log K8s audit log configuration. (list maxitems: 1)
- event
Rate ClusterLimit Rke Config Services Kube Api Event Rate Limit K8s event rate limit configuration. (list maxitems: 1)
- extra
Args {[key: string]: any} Extra arguments for scheduler service (map)
- extra
Binds string[] Extra binds for scheduler service (list)
- extra
Envs string[] Extra environment for scheduler service (list)
- image string
Docker image for scheduler service (string)
- pod
Security booleanPolicy Pod Security Policy option for kube API service. Default
false
(bool)- secrets
Encryption ClusterConfig Rke Config Services Kube Api Secrets Encryption Config Encrypt k8s secret data configration. (list maxitem: 1)
- service
Cluster stringIp Range Service Cluster ip Range option for kube controller service (string)
- service
Node stringPort Range Service Node Port Range option for kube API service (string)
- admission_
configuration Mapping[str, Any] Admission configuration (map)
- always_
pull_ boolimages Enable AlwaysPullImages Admission controller plugin. Rancher docs Default:
false
(bool)- audit_
log ClusterRke Config Services Kube Api Audit Log Args K8s audit log configuration. (list maxitems: 1)
- event_
rate_ Clusterlimit Rke Config Services Kube Api Event Rate Limit Args K8s event rate limit configuration. (list maxitems: 1)
- extra_
args Mapping[str, Any] Extra arguments for scheduler service (map)
- extra_
binds Sequence[str] Extra binds for scheduler service (list)
- extra_
envs Sequence[str] Extra environment for scheduler service (list)
- image str
Docker image for scheduler service (string)
- pod_
security_ boolpolicy Pod Security Policy option for kube API service. Default
false
(bool)- secrets_
encryption_ Clusterconfig Rke Config Services Kube Api Secrets Encryption Config Args Encrypt k8s secret data configration. (list maxitem: 1)
- service_
cluster_ strip_ range Service Cluster ip Range option for kube controller service (string)
- service_
node_ strport_ range Service Node Port Range option for kube API service (string)
ClusterRkeConfigServicesKubeApiAuditLog
- Configuration
Cluster
Rke Config Services Kube Api Audit Log Configuration Args Event rate limit configuration yaml encoded definition.
apiVersion
andkind: Configuration"
fields are required in the yaml. Ex."apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n"
More info (string)- Enabled bool
Enable scheduled cluster scan. Default:
false
(bool)
- Configuration
Cluster
Rke Config Services Kube Api Audit Log Configuration Event rate limit configuration yaml encoded definition.
apiVersion
andkind: Configuration"
fields are required in the yaml. Ex."apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n"
More info (string)- Enabled bool
Enable scheduled cluster scan. Default:
false
(bool)
- configuration
Cluster
Rke Config Services Kube Api Audit Log Configuration Event rate limit configuration yaml encoded definition.
apiVersion
andkind: Configuration"
fields are required in the yaml. Ex."apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n"
More info (string)- enabled boolean
Enable scheduled cluster scan. Default:
false
(bool)
- configuration
Cluster
Rke Config Services Kube Api Audit Log Configuration Args Event rate limit configuration yaml encoded definition.
apiVersion
andkind: Configuration"
fields are required in the yaml. Ex."apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n"
More info (string)- enabled bool
Enable scheduled cluster scan. Default:
false
(bool)
ClusterRkeConfigServicesKubeApiAuditLogConfiguration
- Format string
Audit log format. Default: ‘json’ (string)
- Max
Age int Audit log max age. Default:
30
(int)- Max
Backup int Audit log max backup. Default:
10
(int)- Max
Size int The EKS node group maximum size. Default
2
(int)- Path string
(Optional) Audit log path. Default:
/var/log/kube-audit/audit-log.json
(string)- Policy string
Audit policy yaml encoded definition.
apiVersion
andkind: Policy\nrules:"
fields are required in the yaml. Ex."apiVersion: audit.k8s.io/v1\nkind: Policy\nrules:\n- level: RequestResponse\n resources:\n - resources:\n - pods\n"
More info (string)
- Format string
Audit log format. Default: ‘json’ (string)
- Max
Age int Audit log max age. Default:
30
(int)- Max
Backup int Audit log max backup. Default:
10
(int)- Max
Size int The EKS node group maximum size. Default
2
(int)- Path string
(Optional) Audit log path. Default:
/var/log/kube-audit/audit-log.json
(string)- Policy string
Audit policy yaml encoded definition.
apiVersion
andkind: Policy\nrules:"
fields are required in the yaml. Ex."apiVersion: audit.k8s.io/v1\nkind: Policy\nrules:\n- level: RequestResponse\n resources:\n - resources:\n - pods\n"
More info (string)
- format string
Audit log format. Default: ‘json’ (string)
- max
Age number Audit log max age. Default:
30
(int)- max
Backup number Audit log max backup. Default:
10
(int)- max
Size number The EKS node group maximum size. Default
2
(int)- path string
(Optional) Audit log path. Default:
/var/log/kube-audit/audit-log.json
(string)- policy string
Audit policy yaml encoded definition.
apiVersion
andkind: Policy\nrules:"
fields are required in the yaml. Ex."apiVersion: audit.k8s.io/v1\nkind: Policy\nrules:\n- level: RequestResponse\n resources:\n - resources:\n - pods\n"
More info (string)
- format str
Audit log format. Default: ‘json’ (string)
- max_
age int Audit log max age. Default:
30
(int)- max_
backup int Audit log max backup. Default:
10
(int)- max_
size int The EKS node group maximum size. Default
2
(int)- path str
(Optional) Audit log path. Default:
/var/log/kube-audit/audit-log.json
(string)- policy str
Audit policy yaml encoded definition.
apiVersion
andkind: Policy\nrules:"
fields are required in the yaml. Ex."apiVersion: audit.k8s.io/v1\nkind: Policy\nrules:\n- level: RequestResponse\n resources:\n - resources:\n - pods\n"
More info (string)
ClusterRkeConfigServicesKubeApiEventRateLimit
- Configuration string
Event rate limit configuration yaml encoded definition.
apiVersion
andkind: Configuration"
fields are required in the yaml. Ex."apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n"
More info (string)- Enabled bool
Enable scheduled cluster scan. Default:
false
(bool)
- Configuration string
Event rate limit configuration yaml encoded definition.
apiVersion
andkind: Configuration"
fields are required in the yaml. Ex."apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n"
More info (string)- Enabled bool
Enable scheduled cluster scan. Default:
false
(bool)
- configuration string
Event rate limit configuration yaml encoded definition.
apiVersion
andkind: Configuration"
fields are required in the yaml. Ex."apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n"
More info (string)- enabled boolean
Enable scheduled cluster scan. Default:
false
(bool)
- configuration str
Event rate limit configuration yaml encoded definition.
apiVersion
andkind: Configuration"
fields are required in the yaml. Ex."apiVersion: eventratelimit.admission.k8s.io/v1alpha1\nkind: Configuration\nlimits:\n- type: Server\n burst: 35000\n qps: 6000\n"
More info (string)- enabled bool
Enable scheduled cluster scan. Default:
false
(bool)
ClusterRkeConfigServicesKubeApiSecretsEncryptionConfig
- Custom
Config string Secrets encryption yaml encoded custom configuration.
"apiVersion"
and"kind":"EncryptionConfiguration"
fields are required in the yaml. Ex.apiVersion: apiserver.config.k8s.io/v1\nkind: EncryptionConfiguration\nresources:\n- resources:\n - secrets\n providers:\n - aescbc:\n keys:\n - name: k-fw5hn\n secret: RTczRjFDODMwQzAyMDVBREU4NDJBMUZFNDhCNzM5N0I=\n identity: {}\n
More info (string)- Enabled bool
Enable scheduled cluster scan. Default:
false
(bool)
- Custom
Config string Secrets encryption yaml encoded custom configuration.
"apiVersion"
and"kind":"EncryptionConfiguration"
fields are required in the yaml. Ex.apiVersion: apiserver.config.k8s.io/v1\nkind: EncryptionConfiguration\nresources:\n- resources:\n - secrets\n providers:\n - aescbc:\n keys:\n - name: k-fw5hn\n secret: RTczRjFDODMwQzAyMDVBREU4NDJBMUZFNDhCNzM5N0I=\n identity: {}\n
More info (string)- Enabled bool
Enable scheduled cluster scan. Default:
false
(bool)
- custom
Config string Secrets encryption yaml encoded custom configuration.
"apiVersion"
and"kind":"EncryptionConfiguration"
fields are required in the yaml. Ex.apiVersion: apiserver.config.k8s.io/v1\nkind: EncryptionConfiguration\nresources:\n- resources:\n - secrets\n providers:\n - aescbc:\n keys:\n - name: k-fw5hn\n secret: RTczRjFDODMwQzAyMDVBREU4NDJBMUZFNDhCNzM5N0I=\n identity: {}\n
More info (string)- enabled boolean
Enable scheduled cluster scan. Default:
false
(bool)
- custom_
config str Secrets encryption yaml encoded custom configuration.
"apiVersion"
and"kind":"EncryptionConfiguration"
fields are required in the yaml. Ex.apiVersion: apiserver.config.k8s.io/v1\nkind: EncryptionConfiguration\nresources:\n- resources:\n - secrets\n providers:\n - aescbc:\n keys:\n - name: k-fw5hn\n secret: RTczRjFDODMwQzAyMDVBREU4NDJBMUZFNDhCNzM5N0I=\n identity: {}\n
More info (string)- enabled bool
Enable scheduled cluster scan. Default:
false
(bool)
ClusterRkeConfigServicesKubeController
- Cluster
Cidr string Cluster CIDR option for kube controller service (string)
- Extra
Args Dictionary<string, object> Extra arguments for scheduler service (map)
- Extra
Binds List<string> Extra binds for scheduler service (list)
- Extra
Envs List<string> Extra environment for scheduler service (list)
- Image string
Docker image for scheduler service (string)
- Service
Cluster stringIp Range Service Cluster ip Range option for kube controller service (string)
- Cluster
Cidr string Cluster CIDR option for kube controller service (string)
- Extra
Args map[string]interface{} Extra arguments for scheduler service (map)
- Extra
Binds []string Extra binds for scheduler service (list)
- Extra
Envs []string Extra environment for scheduler service (list)
- Image string
Docker image for scheduler service (string)
- Service
Cluster stringIp Range Service Cluster ip Range option for kube controller service (string)
- cluster
Cidr string Cluster CIDR option for kube controller service (string)
- extra
Args {[key: string]: any} Extra arguments for scheduler service (map)
- extra
Binds string[] Extra binds for scheduler service (list)
- extra
Envs string[] Extra environment for scheduler service (list)
- image string
Docker image for scheduler service (string)
- service
Cluster stringIp Range Service Cluster ip Range option for kube controller service (string)
- cluster_
cidr str Cluster CIDR option for kube controller service (string)
- extra_
args Mapping[str, Any] Extra arguments for scheduler service (map)
- extra_
binds Sequence[str] Extra binds for scheduler service (list)
- extra_
envs Sequence[str] Extra environment for scheduler service (list)
- image str
Docker image for scheduler service (string)
- service_
cluster_ strip_ range Service Cluster ip Range option for kube controller service (string)
ClusterRkeConfigServicesKubelet
- Cluster
Dns stringServer Cluster DNS Server option for kubelet service (string)
- Cluster
Domain string Cluster Domain option for kubelet service (string)
- Extra
Args Dictionary<string, object> Extra arguments for scheduler service (map)
- Extra
Binds List<string> Extra binds for scheduler service (list)
- Extra
Envs List<string> Extra environment for scheduler service (list)
- Fail
Swap boolOn Enable or disable failing when swap on is not supported (bool)
- Generate
Serving boolCertificate Generate a certificate signed by the kube-ca. Default
false
(bool)- Image string
Docker image for scheduler service (string)
- Infra
Container stringImage Infra container image for kubelet service (string)
- Cluster
Dns stringServer Cluster DNS Server option for kubelet service (string)
- Cluster
Domain string Cluster Domain option for kubelet service (string)
- Extra
Args map[string]interface{} Extra arguments for scheduler service (map)
- Extra
Binds []string Extra binds for scheduler service (list)
- Extra
Envs []string Extra environment for scheduler service (list)
- Fail
Swap boolOn Enable or disable failing when swap on is not supported (bool)
- Generate
Serving boolCertificate Generate a certificate signed by the kube-ca. Default
false
(bool)- Image string
Docker image for scheduler service (string)
- Infra
Container stringImage Infra container image for kubelet service (string)
- cluster
Dns stringServer Cluster DNS Server option for kubelet service (string)
- cluster
Domain string Cluster Domain option for kubelet service (string)
- extra
Args {[key: string]: any} Extra arguments for scheduler service (map)
- extra
Binds string[] Extra binds for scheduler service (list)
- extra
Envs string[] Extra environment for scheduler service (list)
- fail
Swap booleanOn Enable or disable failing when swap on is not supported (bool)
- generate
Serving booleanCertificate Generate a certificate signed by the kube-ca. Default
false
(bool)- image string
Docker image for scheduler service (string)
- infra
Container stringImage Infra container image for kubelet service (string)
- cluster_
dns_ strserver Cluster DNS Server option for kubelet service (string)
- cluster_
domain str Cluster Domain option for kubelet service (string)
- extra_
args Mapping[str, Any] Extra arguments for scheduler service (map)
- extra_
binds Sequence[str] Extra binds for scheduler service (list)
- extra_
envs Sequence[str] Extra environment for scheduler service (list)
- fail_
swap_ boolon Enable or disable failing when swap on is not supported (bool)
- generate_
serving_ boolcertificate Generate a certificate signed by the kube-ca. Default
false
(bool)- image str
Docker image for scheduler service (string)
- infra_
container_ strimage Infra container image for kubelet service (string)
ClusterRkeConfigServicesKubeproxy
- Extra
Args Dictionary<string, object> Extra arguments for scheduler service (map)
- Extra
Binds List<string> Extra binds for scheduler service (list)
- Extra
Envs List<string> Extra environment for scheduler service (list)
- Image string
Docker image for scheduler service (string)
- Extra
Args map[string]interface{} Extra arguments for scheduler service (map)
- Extra
Binds []string Extra binds for scheduler service (list)
- Extra
Envs []string Extra environment for scheduler service (list)
- Image string
Docker image for scheduler service (string)
- extra
Args {[key: string]: any} Extra arguments for scheduler service (map)
- extra
Binds string[] Extra binds for scheduler service (list)
- extra
Envs string[] Extra environment for scheduler service (list)
- image string
Docker image for scheduler service (string)
- extra_
args Mapping[str, Any] Extra arguments for scheduler service (map)
- extra_
binds Sequence[str] Extra binds for scheduler service (list)
- extra_
envs Sequence[str]