Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

ClusterTemplate

Provides a Rancher v2 Cluster Template resource. This can be used to create Cluster Templates for Rancher v2 RKE clusters and retrieve their information.

Cluster Templates are available from Rancher v2.3.x and above.

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new rancher2 Cluster Template
        var foo = new Rancher2.ClusterTemplate("foo", new Rancher2.ClusterTemplateArgs
        {
            Description = "Terraform cluster template foo",
            Members = 
            {
                new Rancher2.Inputs.ClusterTemplateMemberArgs
                {
                    AccessType = "owner",
                    UserPrincipalId = "local://user-XXXXX",
                },
            },
            TemplateRevisions = 
            {
                new Rancher2.Inputs.ClusterTemplateTemplateRevisionArgs
                {
                    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,
                    Name = "V1",
                },
            },
        });
    }

}
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.NewClusterTemplate(ctx, "foo", &rancher2.ClusterTemplateArgs{
            Description: pulumi.String("Terraform cluster template foo"),
            Members: rancher2.ClusterTemplateMemberArray{
                &rancher2.ClusterTemplateMemberArgs{
                    AccessType:      pulumi.String("owner"),
                    UserPrincipalId: pulumi.String("local://user-XXXXX"),
                },
            },
            TemplateRevisions: rancher2.ClusterTemplateTemplateRevisionArray{
                &rancher2.ClusterTemplateTemplateRevisionArgs{
                    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),
                    Name:    pulumi.String("V1"),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

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

// Create a new rancher2 Cluster Template
const foo = new rancher2.ClusterTemplate("foo", {
    description: "Terraform cluster template foo",
    members: [{
        accessType: "owner",
        userPrincipalId: "local://user-XXXXX",
    }],
    templateRevisions: [{
        clusterConfig: {
            rkeConfig: {
                network: {
                    plugin: "canal",
                },
                services: {
                    etcd: {
                        creation: "6h",
                        retention: "24h",
                    },
                },
            },
        },
        default: true,
        name: "V1",
    }],
});

Create a ClusterTemplate Resource

new ClusterTemplate(name: string, args?: ClusterTemplateArgs, opts?: CustomResourceOptions);
def ClusterTemplate(resource_name: str, opts: Optional[ResourceOptions] = None, annotations: Optional[Mapping[str, Any]] = None, description: Optional[str] = None, labels: Optional[Mapping[str, Any]] = None, members: Optional[Sequence[ClusterTemplateMemberArgs]] = None, name: Optional[str] = None, template_revisions: Optional[Sequence[ClusterTemplateTemplateRevisionArgs]] = None)
func NewClusterTemplate(ctx *Context, name string, args *ClusterTemplateArgs, opts ...ResourceOption) (*ClusterTemplate, error)
public ClusterTemplate(string name, ClusterTemplateArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ClusterTemplateArgs
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 ClusterTemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ClusterTemplate Resource Properties

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

Inputs

The ClusterTemplate resource accepts the following input properties:

Annotations Dictionary<string, object>

Annotations for the cluster template revision (map)

Description string

Cluster template description

Labels Dictionary<string, object>

Labels for the cluster template revision (map)

Members List<ClusterTemplateMemberArgs>

Cluster template members (list)

Name string

The cluster template revision name (string)

TemplateRevisions List<ClusterTemplateTemplateRevisionArgs>

Cluster template revisions (list)

Annotations map[string]interface{}

Annotations for the cluster template revision (map)

Description string

Cluster template description

Labels map[string]interface{}

Labels for the cluster template revision (map)

Members []ClusterTemplateMember

Cluster template members (list)

Name string

The cluster template revision name (string)

TemplateRevisions []ClusterTemplateTemplateRevision

Cluster template revisions (list)

annotations {[key: string]: any}

Annotations for the cluster template revision (map)

description string

Cluster template description

labels {[key: string]: any}

Labels for the cluster template revision (map)

members ClusterTemplateMember[]

Cluster template members (list)

name string

The cluster template revision name (string)

templateRevisions ClusterTemplateTemplateRevision[]

Cluster template revisions (list)

annotations Mapping[str, Any]

Annotations for the cluster template revision (map)

description str

Cluster template description

labels Mapping[str, Any]

Labels for the cluster template revision (map)

members Sequence[ClusterTemplateMemberArgs]

Cluster template members (list)

name str

The cluster template revision name (string)

template_revisions Sequence[ClusterTemplateTemplateRevisionArgs]

Cluster template revisions (list)

Outputs

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

DefaultRevisionId string

(Computed) Default cluster template revision ID (string)

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

(Computed) Default cluster template revision ID (string)

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

(Computed) Default cluster template revision ID (string)

id string
The provider-assigned unique ID for this managed resource.
default_revision_id str

(Computed) Default cluster template revision ID (string)

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

Look up an Existing ClusterTemplate Resource

Get an existing ClusterTemplate 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?: ClusterTemplateState, opts?: CustomResourceOptions): ClusterTemplate
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, annotations: Optional[Mapping[str, Any]] = None, default_revision_id: Optional[str] = None, description: Optional[str] = None, labels: Optional[Mapping[str, Any]] = None, members: Optional[Sequence[ClusterTemplateMemberArgs]] = None, name: Optional[str] = None, template_revisions: Optional[Sequence[ClusterTemplateTemplateRevisionArgs]] = None) -> ClusterTemplate
func GetClusterTemplate(ctx *Context, name string, id IDInput, state *ClusterTemplateState, opts ...ResourceOption) (*ClusterTemplate, error)
public static ClusterTemplate Get(string name, Input<string> id, ClusterTemplateState? 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:

Annotations Dictionary<string, object>

Annotations for the cluster template revision (map)

DefaultRevisionId string

(Computed) Default cluster template revision ID (string)

Description string

Cluster template description

Labels Dictionary<string, object>

Labels for the cluster template revision (map)

Members List<ClusterTemplateMemberArgs>

Cluster template members (list)

Name string

The cluster template revision name (string)

TemplateRevisions List<ClusterTemplateTemplateRevisionArgs>

Cluster template revisions (list)

Annotations map[string]interface{}

Annotations for the cluster template revision (map)

DefaultRevisionId string

(Computed) Default cluster template revision ID (string)

Description string

Cluster template description

Labels map[string]interface{}

Labels for the cluster template revision (map)

Members []ClusterTemplateMember

Cluster template members (list)

Name string

The cluster template revision name (string)

TemplateRevisions []ClusterTemplateTemplateRevision

Cluster template revisions (list)

annotations {[key: string]: any}

Annotations for the cluster template revision (map)

defaultRevisionId string

(Computed) Default cluster template revision ID (string)

description string

Cluster template description

labels {[key: string]: any}

Labels for the cluster template revision (map)

members ClusterTemplateMember[]

Cluster template members (list)

name string

The cluster template revision name (string)

templateRevisions ClusterTemplateTemplateRevision[]

Cluster template revisions (list)

annotations Mapping[str, Any]

Annotations for the cluster template revision (map)

default_revision_id str

(Computed) Default cluster template revision ID (string)

description str

Cluster template description

labels Mapping[str, Any]

Labels for the cluster template revision (map)

members Sequence[ClusterTemplateMemberArgs]

Cluster template members (list)

name str

The cluster template revision name (string)

template_revisions Sequence[ClusterTemplateTemplateRevisionArgs]

Cluster template revisions (list)

Supporting Types

ClusterTemplateMember

AccessType string

Member access type. Valid values: ["read-only" | "owner"] (string)

GroupPrincipalId string

Member group principal id (string)

UserPrincipalId string

Member user principal id (string)

AccessType string

Member access type. Valid values: ["read-only" | "owner"] (string)

GroupPrincipalId string

Member group principal id (string)

UserPrincipalId string

Member user principal id (string)

accessType string

Member access type. Valid values: ["read-only" | "owner"] (string)

groupPrincipalId string

Member group principal id (string)

userPrincipalId string

Member user principal id (string)

access_type str

Member access type. Valid values: ["read-only" | "owner"] (string)

group_principal_id str

Member group principal id (string)

user_principal_id str

Member user principal id (string)

ClusterTemplateTemplateRevision

ClusterConfig ClusterTemplateTemplateRevisionClusterConfigArgs

Cluster configuration (list maxitem: 1)

Name string

The cluster template revision name (string)

Annotations Dictionary<string, object>

Annotations for the cluster template revision (map)

ClusterTemplateId string

Cluster template ID (string)

Default bool

Default variable value (string)

Enabled bool

Enable cluster template revision. Default true (bool)

Id string

The cluster template revision ID (string)

Labels Dictionary<string, object>

Labels for the cluster template revision (map)

Questions List<ClusterTemplateTemplateRevisionQuestionArgs>

Cluster template questions (list)

ClusterConfig ClusterTemplateTemplateRevisionClusterConfig

Cluster configuration (list maxitem: 1)

Name string

The cluster template revision name (string)

Annotations map[string]interface{}

Annotations for the cluster template revision (map)

ClusterTemplateId string

Cluster template ID (string)

Default bool

Default variable value (string)

Enabled bool

Enable cluster template revision. Default true (bool)

Id string

The cluster template revision ID (string)

Labels map[string]interface{}

Labels for the cluster template revision (map)

Questions []ClusterTemplateTemplateRevisionQuestion

Cluster template questions (list)

clusterConfig ClusterTemplateTemplateRevisionClusterConfig

Cluster configuration (list maxitem: 1)

name string

The cluster template revision name (string)

annotations {[key: string]: any}

Annotations for the cluster template revision (map)

clusterTemplateId string

Cluster template ID (string)

default boolean

Default variable value (string)

enabled boolean

Enable cluster template revision. Default true (bool)

id string

The cluster template revision ID (string)

labels {[key: string]: any}

Labels for the cluster template revision (map)

questions ClusterTemplateTemplateRevisionQuestion[]

Cluster template questions (list)

cluster_config ClusterTemplateTemplateRevisionClusterConfigArgs

Cluster configuration (list maxitem: 1)

name str

The cluster template revision name (string)

annotations Mapping[str, Any]

Annotations for the cluster template revision (map)

cluster_template_id str

Cluster template ID (string)

default bool

Default variable value (string)

enabled bool

Enable cluster template revision. Default true (bool)

id str

The cluster template revision ID (string)

labels Mapping[str, Any]

Labels for the cluster template revision (map)

questions Sequence[ClusterTemplateTemplateRevisionQuestionArgs]

Cluster template questions (list)

ClusterTemplateTemplateRevisionClusterConfig

RkeConfig ClusterTemplateTemplateRevisionClusterConfigRkeConfigArgs

Rancher Kubernetes Engine Config (list maxitems: 1)

ClusterAuthEndpoint ClusterTemplateTemplateRevisionClusterConfigClusterAuthEndpointArgs

Local cluster auth endpoint (list maxitems: 1)

DefaultClusterRoleForProjectMembers string

Default cluster role for project members (string)

DefaultPodSecurityPolicyTemplateId string

Default pod security policy template ID (string)

DesiredAgentImage string

Desired agent image (string)

DesiredAuthImage string

Desired auth image (string)

DockerRootDir string

Desired auth image (string)

EnableClusterAlerting bool

Enable built-in cluster alerting. Default: false (bool)

EnableClusterMonitoring bool

Enable built-in cluster monitoring. Default: false (bool)

EnableNetworkPolicy bool

Enable project network isolation. Default: false (bool)

ScheduledClusterScan ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanArgs

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

WindowsPreferedCluster bool

Windows prefered cluster. Default: false (bool)

RkeConfig ClusterTemplateTemplateRevisionClusterConfigRkeConfig

Rancher Kubernetes Engine Config (list maxitems: 1)

ClusterAuthEndpoint ClusterTemplateTemplateRevisionClusterConfigClusterAuthEndpoint

Local cluster auth endpoint (list maxitems: 1)

DefaultClusterRoleForProjectMembers string

Default cluster role for project members (string)

DefaultPodSecurityPolicyTemplateId string

Default pod security policy template ID (string)

DesiredAgentImage string

Desired agent image (string)

DesiredAuthImage string

Desired auth image (string)

DockerRootDir string

Desired auth image (string)

EnableClusterAlerting bool

Enable built-in cluster alerting. Default: false (bool)

EnableClusterMonitoring bool

Enable built-in cluster monitoring. Default: false (bool)

EnableNetworkPolicy bool

Enable project network isolation. Default: false (bool)

ScheduledClusterScan ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScan

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

WindowsPreferedCluster bool

Windows prefered cluster. Default: false (bool)

rkeConfig ClusterTemplateTemplateRevisionClusterConfigRkeConfig

Rancher Kubernetes Engine Config (list maxitems: 1)

clusterAuthEndpoint ClusterTemplateTemplateRevisionClusterConfigClusterAuthEndpoint

Local cluster auth endpoint (list maxitems: 1)

defaultClusterRoleForProjectMembers string

Default cluster role for project members (string)

defaultPodSecurityPolicyTemplateId string

Default pod security policy template ID (string)

desiredAgentImage string

Desired agent image (string)

desiredAuthImage string

Desired auth image (string)

dockerRootDir string

Desired auth image (string)

enableClusterAlerting boolean

Enable built-in cluster alerting. Default: false (bool)

enableClusterMonitoring boolean

Enable built-in cluster monitoring. Default: false (bool)

enableNetworkPolicy boolean

Enable project network isolation. Default: false (bool)

scheduledClusterScan ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScan

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

windowsPreferedCluster boolean

Windows prefered cluster. Default: false (bool)

rke_config ClusterTemplateTemplateRevisionClusterConfigRkeConfigArgs

Rancher Kubernetes Engine Config (list maxitems: 1)

cluster_auth_endpoint ClusterTemplateTemplateRevisionClusterConfigClusterAuthEndpointArgs

Local cluster auth endpoint (list maxitems: 1)

default_cluster_role_for_project_members str

Default cluster role for project members (string)

default_pod_security_policy_template_id str

Default pod security policy template ID (string)

desired_agent_image str

Desired agent image (string)

desired_auth_image str

Desired auth image (string)

docker_root_dir str

Desired auth image (string)

enable_cluster_alerting bool

Enable built-in cluster alerting. Default: false (bool)

enable_cluster_monitoring bool

Enable built-in cluster monitoring. Default: false (bool)

enable_network_policy bool

Enable project network isolation. Default: false (bool)

scheduled_cluster_scan ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanArgs

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

windows_prefered_cluster bool

Windows prefered cluster. Default: false (bool)

ClusterTemplateTemplateRevisionClusterConfigClusterAuthEndpoint

CaCerts string
Enabled bool

Enable cluster template revision. Default true (bool)

Fqdn string
CaCerts string
Enabled bool

Enable cluster template revision. Default true (bool)

Fqdn string
caCerts string
enabled boolean

Enable cluster template revision. Default true (bool)

fqdn string
ca_certs str
enabled bool

Enable cluster template revision. Default true (bool)

fqdn str

ClusterTemplateTemplateRevisionClusterConfigRkeConfig

AddonJobTimeout int
Addons string
AddonsIncludes List<string>
Authentication ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthenticationArgs
Authorization ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthorizationArgs
BastionHost ClusterTemplateTemplateRevisionClusterConfigRkeConfigBastionHostArgs
CloudProvider ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderArgs
Dns ClusterTemplateTemplateRevisionClusterConfigRkeConfigDnsArgs
IgnoreDockerVersion bool
Ingress ClusterTemplateTemplateRevisionClusterConfigRkeConfigIngressArgs
KubernetesVersion string
Monitoring ClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoringArgs
Network ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkArgs
Nodes List<ClusterTemplateTemplateRevisionClusterConfigRkeConfigNodeArgs>
PrefixPath string
PrivateRegistries List<ClusterTemplateTemplateRevisionClusterConfigRkeConfigPrivateRegistryArgs>
Services ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesArgs
SshAgentAuth bool
SshCertPath string
SshKeyPath string
UpgradeStrategy ClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategyArgs
AddonJobTimeout int
Addons string
AddonsIncludes []string
Authentication ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthentication
Authorization ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthorization
BastionHost ClusterTemplateTemplateRevisionClusterConfigRkeConfigBastionHost
CloudProvider ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProvider
Dns ClusterTemplateTemplateRevisionClusterConfigRkeConfigDns
IgnoreDockerVersion bool
Ingress ClusterTemplateTemplateRevisionClusterConfigRkeConfigIngress
KubernetesVersion string
Monitoring ClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoring
Network ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetwork
Nodes []ClusterTemplateTemplateRevisionClusterConfigRkeConfigNode
PrefixPath string
PrivateRegistries []ClusterTemplateTemplateRevisionClusterConfigRkeConfigPrivateRegistry
Services ClusterTemplateTemplateRevisionClusterConfigRkeConfigServices
SshAgentAuth bool
SshCertPath string
SshKeyPath string
UpgradeStrategy ClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategy
addonJobTimeout number
addons string
addonsIncludes string[]
authentication ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthentication
authorization ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthorization
bastionHost ClusterTemplateTemplateRevisionClusterConfigRkeConfigBastionHost
cloudProvider ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProvider
dns ClusterTemplateTemplateRevisionClusterConfigRkeConfigDns
ignoreDockerVersion boolean
ingress ClusterTemplateTemplateRevisionClusterConfigRkeConfigIngress
kubernetesVersion string
monitoring ClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoring
network ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetwork
nodes ClusterTemplateTemplateRevisionClusterConfigRkeConfigNode[]
prefixPath string
privateRegistries ClusterTemplateTemplateRevisionClusterConfigRkeConfigPrivateRegistry[]
services ClusterTemplateTemplateRevisionClusterConfigRkeConfigServices
sshAgentAuth boolean
sshCertPath string
sshKeyPath string
upgradeStrategy ClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategy
addon_job_timeout int
addons str
addons_includes Sequence[str]
authentication ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthenticationArgs
authorization ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthorizationArgs
bastion_host ClusterTemplateTemplateRevisionClusterConfigRkeConfigBastionHostArgs
cloud_provider ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderArgs
dns ClusterTemplateTemplateRevisionClusterConfigRkeConfigDnsArgs
ignore_docker_version bool
ingress ClusterTemplateTemplateRevisionClusterConfigRkeConfigIngressArgs
kubernetes_version str
monitoring ClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoringArgs
network ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkArgs
nodes Sequence[ClusterTemplateTemplateRevisionClusterConfigRkeConfigNodeArgs]
prefix_path str
private_registries Sequence[ClusterTemplateTemplateRevisionClusterConfigRkeConfigPrivateRegistryArgs]
services ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesArgs
ssh_agent_auth bool
ssh_cert_path str
ssh_key_path str
upgrade_strategy ClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategyArgs

ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthentication

Sans List<string>
Strategy string
Sans []string
Strategy string
sans string[]
strategy string
sans Sequence[str]
strategy str

ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthorization

Mode string
Options Dictionary<string, object>
Mode string
Options map[string]interface{}
mode string
options {[key: string]: any}
mode str
options Mapping[str, Any]

ClusterTemplateTemplateRevisionClusterConfigRkeConfigBastionHost

Address string
User string
Port string
SshAgentAuth bool
SshKey string
SshKeyPath string
Address string
User string
Port string
SshAgentAuth bool
SshKey string
SshKeyPath string
address string
user string
port string
sshAgentAuth boolean
sshKey string
sshKeyPath string

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProvider

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProvider

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderGlobal

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderServiceOverride

Service string
Region string
SigningMethod string
SigningName string
SigningRegion string
Url string
Service string
Region string
SigningMethod string
SigningName string
SigningRegion string
Url string
service string
region string
signingMethod string
signingName string
signingRegion string
url string

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAzureCloudProvider

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProvider

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderBlockStorage

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderGlobal

AuthUrl string
Password string
Username string
CaFile string
DomainId string
DomainName string
Region string
TenantId string
TenantName string
TrustId string
AuthUrl string
Password string
Username string
CaFile string
DomainId string
DomainName string
Region string
TenantId string
TenantName string
TrustId string
authUrl string
password string
username string
caFile string
domainId string
domainName string
region string
tenantId string
tenantName string
trustId string

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderMetadata

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderRoute

RouterId string
RouterId string
routerId string

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProvider

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderDisk

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderGlobal

datacenters string
insecureFlag boolean
password string
port string
soapRoundtripCount number
user string

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderNetwork

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderVirtualCenter

Datacenters string
Name string

The cluster template revision name (string)

Password string
User string
Port string
SoapRoundtripCount int
Datacenters string
Name string

The cluster template revision name (string)

Password string
User string
Port string
SoapRoundtripCount int
datacenters string
name string

The cluster template revision name (string)

password string
user string
port string
soapRoundtripCount number
datacenters str
name str

The cluster template revision name (string)

password str
user str
port str
soap_roundtrip_count int

ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderWorkspace

ClusterTemplateTemplateRevisionClusterConfigRkeConfigDns

ClusterTemplateTemplateRevisionClusterConfigRkeConfigDnsLinearAutoscalerParams

ClusterTemplateTemplateRevisionClusterConfigRkeConfigDnsNodelocal

IpAddress string
NodeSelector Dictionary<string, object>
IpAddress string
NodeSelector map[string]interface{}
ipAddress string
nodeSelector {[key: string]: any}
ip_address str
node_selector Mapping[str, Any]

ClusterTemplateTemplateRevisionClusterConfigRkeConfigDnsUpdateStrategy

ClusterTemplateTemplateRevisionClusterConfigRkeConfigDnsUpdateStrategyRollingUpdate

ClusterTemplateTemplateRevisionClusterConfigRkeConfigIngress

DnsPolicy string
ExtraArgs Dictionary<string, object>
NodeSelector Dictionary<string, object>
Options Dictionary<string, object>
Provider string
DnsPolicy string
ExtraArgs map[string]interface{}
NodeSelector map[string]interface{}
Options map[string]interface{}
Provider string
dnsPolicy string
extraArgs {[key: string]: any}
nodeSelector {[key: string]: any}
options {[key: string]: any}
provider string
dns_policy str
extra_args Mapping[str, Any]
node_selector Mapping[str, Any]
options Mapping[str, Any]
provider str

ClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoring

ClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoringUpdateStrategy

ClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoringUpdateStrategyRollingUpdate

ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetwork

ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCalicoNetworkProvider

ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCanalNetworkProvider

Iface string
Iface string
iface string
iface str

ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkFlannelNetworkProvider

Iface string
Iface string
iface string
iface str

ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkWeaveNetworkProvider

Password string
Password string
password string

ClusterTemplateTemplateRevisionClusterConfigRkeConfigNode

Address string
Roles List<string>
User string
DockerSocket string
HostnameOverride string
InternalAddress string
Labels Dictionary<string, object>

Labels for the cluster template revision (map)

NodeId string
Port string
SshAgentAuth bool
SshKey string
SshKeyPath string
Address string
Roles []string
User string
DockerSocket string
HostnameOverride string
InternalAddress string
Labels map[string]interface{}

Labels for the cluster template revision (map)

NodeId string
Port string
SshAgentAuth bool
SshKey string
SshKeyPath string
address string
roles string[]
user string
dockerSocket string
hostnameOverride string
internalAddress string
labels {[key: string]: any}

Labels for the cluster template revision (map)

nodeId string
port string
sshAgentAuth boolean
sshKey string
sshKeyPath string
address str
roles Sequence[str]
user str
docker_socket str
hostname_override str
internal_address str
labels Mapping[str, Any]

Labels for the cluster template revision (map)

node_id str
port str
ssh_agent_auth bool
ssh_key str
ssh_key_path str

ClusterTemplateTemplateRevisionClusterConfigRkeConfigPrivateRegistry

Url string
IsDefault bool
Password string
User string
Url string
IsDefault bool
Password string
User string
url string
isDefault boolean
password string
user string
url str
is_default bool
password str
user str

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServices

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcd

BackupConfig ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfigArgs
CaCert string
Cert string
Creation string
ExternalUrls List<string>
ExtraArgs Dictionary<string, object>
ExtraBinds List<string>
ExtraEnvs List<string>
Gid int
Image string
Key string
Path string
Retention string
Snapshot bool
Uid int

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfig

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfigS3BackupConfig

BucketName string
Endpoint string
AccessKey string
CustomCa string
Folder string
Region string
SecretKey string
BucketName string
Endpoint string
AccessKey string
CustomCa string
Folder string
Region string
SecretKey string
bucketName string
endpoint string
accessKey string
customCa string
folder string
region string
secretKey string

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApi

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLog

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLogConfiguration

Format string
MaxAge int
MaxBackup int
MaxSize int
Path string
Policy string
Format string
MaxAge int
MaxBackup int
MaxSize int
Path string
Policy string
format string
maxAge number
maxBackup number
maxSize number
path string
policy string

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiEventRateLimit

Configuration string
Enabled bool

Enable cluster template revision. Default true (bool)

Configuration string
Enabled bool

Enable cluster template revision. Default true (bool)

configuration string
enabled boolean

Enable cluster template revision. Default true (bool)

configuration str
enabled bool

Enable cluster template revision. Default true (bool)

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiSecretsEncryptionConfig

CustomConfig string
Enabled bool

Enable cluster template revision. Default true (bool)

CustomConfig string
Enabled bool

Enable cluster template revision. Default true (bool)

customConfig string
enabled boolean

Enable cluster template revision. Default true (bool)

custom_config str
enabled bool

Enable cluster template revision. Default true (bool)

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeController

ClusterCidr string
ExtraArgs Dictionary<string, object>
ExtraBinds List<string>
ExtraEnvs List<string>
Image string
ServiceClusterIpRange string
ClusterCidr string
ExtraArgs map[string]interface{}
ExtraBinds []string
ExtraEnvs []string
Image string
ServiceClusterIpRange string
clusterCidr string
extraArgs {[key: string]: any}
extraBinds string[]
extraEnvs string[]
image string
serviceClusterIpRange string
cluster_cidr str
extra_args Mapping[str, Any]
extra_binds Sequence[str]
extra_envs Sequence[str]
image str
service_cluster_ip_range str

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubelet

ClusterDnsServer string
ClusterDomain string
ExtraArgs Dictionary<string, object>
ExtraBinds List<string>
ExtraEnvs List<string>
FailSwapOn bool
GenerateServingCertificate bool
Image string
InfraContainerImage string
ClusterDnsServer string
ClusterDomain string
ExtraArgs map[string]interface{}
ExtraBinds []string
ExtraEnvs []string
FailSwapOn bool
GenerateServingCertificate bool
Image string
InfraContainerImage string
clusterDnsServer string
clusterDomain string
extraArgs {[key: string]: any}
extraBinds string[]
extraEnvs string[]
failSwapOn boolean
generateServingCertificate boolean
image string
infraContainerImage string

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeproxy

ExtraArgs Dictionary<string, object>
ExtraBinds List<string>
ExtraEnvs List<string>
Image string
ExtraArgs map[string]interface{}
ExtraBinds []string
ExtraEnvs []string
Image string
extraArgs {[key: string]: any}
extraBinds string[]
extraEnvs string[]
image string
extra_args Mapping[str, Any]
extra_binds Sequence[str]
extra_envs Sequence[str]
image str

ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesScheduler

ExtraArgs Dictionary<string, object>
ExtraBinds List<string>
ExtraEnvs List<string>
Image string
ExtraArgs map[string]interface{}
ExtraBinds []string
ExtraEnvs []string
Image string
extraArgs {[key: string]: any}
extraBinds string[]
extraEnvs string[]
image string
extra_args Mapping[str, Any]
extra_binds Sequence[str]
extra_envs Sequence[str]
image str

ClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategy

ClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategyDrainInput

deleteLocalData boolean
force boolean
gracePeriod number
ignoreDaemonSets boolean
timeout number

ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScan

ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfig

ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfigCisScanConfig

ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScheduleConfig

cronSchedule string
retention number

ClusterTemplateTemplateRevisionQuestion

Default string

Default variable value (string)

Variable string

Variable name (string)

Required bool

Required variable. Default false (bool)

Type string

Variable type. boolean, int and string are allowed. Default string (string)

Default string

Default variable value (string)

Variable string

Variable name (string)

Required bool

Required variable. Default false (bool)

Type string

Variable type. boolean, int and string are allowed. Default string (string)

default string

Default variable value (string)

variable string

Variable name (string)

required boolean

Required variable. Default false (bool)

type string

Variable type. boolean, int and string are allowed. Default string (string)

default str

Default variable value (string)

variable str

Variable name (string)

required bool

Required variable. Default false (bool)

type str

Variable type. boolean, int and string are allowed. Default string (string)

Import

Cluster Template can be imported using the rancher Cluster Template ID

 $ pulumi import rancher2:index/clusterTemplate:ClusterTemplate foo &lt;CLUSTER_TEMPLATE_ID&gt;

Package Details

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