rancher2 logo
Rancher 2 v4.0.0, Apr 20 23

rancher2.ClusterSync

Explore with Pulumi AI

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    // Create a new rancher2 rke Cluster 
    var foo_customCluster = new Rancher2.Cluster("foo-customCluster", new()
    {
        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()
    {
        Description = "foo test",
        Amazonec2Config = new Rancher2.Inputs.NodeTemplateAmazonec2ConfigArgs
        {
            AccessKey = "<AWS_ACCESS_KEY>",
            SecretKey = "<AWS_SECRET_KEY>",
            Ami = "<AMI_ID>",
            Region = "<REGION>",
            SecurityGroups = new[]
            {
                "<AWS_SECURITY_GROUP>",
            },
            SubnetId = "<SUBNET_ID>",
            VpcId = "<VPC_ID>",
            Zone = "<ZONE>",
        },
    });

    // Create a new rancher2 Node Pool
    var fooNodePool = new Rancher2.NodePool("fooNodePool", new()
    {
        ClusterId = foo_customCluster.Id,
        HostnamePrefix = "foo-cluster-0",
        NodeTemplateId = fooNodeTemplate.Id,
        Quantity = 3,
        ControlPlane = true,
        Etcd = true,
        Worker = true,
    });

    // Create a new rancher2 Cluster Sync
    var foo_customClusterSync = new Rancher2.ClusterSync("foo-customClusterSync", new()
    {
        ClusterId = foo_customCluster.Id,
        NodePoolIds = new[]
        {
            fooNodePool.Id,
        },
    });

    // Create a new rancher2 Project
    var fooProject = new Rancher2.Project("fooProject", new()
    {
        ClusterId = foo_customClusterSync.Id,
        Description = "Terraform namespace acceptance test",
        ResourceQuota = new Rancher2.Inputs.ProjectResourceQuotaArgs
        {
            ProjectLimit = new Rancher2.Inputs.ProjectResourceQuotaProjectLimitArgs
            {
                LimitsCpu = "2000m",
                LimitsMemory = "2000Mi",
                RequestsStorage = "2Gi",
            },
            NamespaceDefaultLimit = new Rancher2.Inputs.ProjectResourceQuotaNamespaceDefaultLimitArgs
            {
                LimitsCpu = "500m",
                LimitsMemory = "500Mi",
                RequestsStorage = "1Gi",
            },
        },
        ContainerResourceLimit = new Rancher2.Inputs.ProjectContainerResourceLimitArgs
        {
            LimitsCpu = "20m",
            LimitsMemory = "20Mi",
            RequestsCpu = "1m",
            RequestsMemory = "1Mi",
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.NewCluster(ctx, "foo-customCluster", &rancher2.ClusterArgs{
			Description: pulumi.String("Foo rancher2 custom cluster"),
			RkeConfig: &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
		}
		fooNodePool, err := rancher2.NewNodePool(ctx, "fooNodePool", &rancher2.NodePoolArgs{
			ClusterId:      foo_customCluster.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
		}
		_, err = rancher2.NewClusterSync(ctx, "foo-customClusterSync", &rancher2.ClusterSyncArgs{
			ClusterId: foo_customCluster.ID(),
			NodePoolIds: pulumi.StringArray{
				fooNodePool.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = rancher2.NewProject(ctx, "fooProject", &rancher2.ProjectArgs{
			ClusterId:   foo_customClusterSync.ID(),
			Description: pulumi.String("Terraform namespace acceptance test"),
			ResourceQuota: &rancher2.ProjectResourceQuotaArgs{
				ProjectLimit: &rancher2.ProjectResourceQuotaProjectLimitArgs{
					LimitsCpu:       pulumi.String("2000m"),
					LimitsMemory:    pulumi.String("2000Mi"),
					RequestsStorage: pulumi.String("2Gi"),
				},
				NamespaceDefaultLimit: &rancher2.ProjectResourceQuotaNamespaceDefaultLimitArgs{
					LimitsCpu:       pulumi.String("500m"),
					LimitsMemory:    pulumi.String("500Mi"),
					RequestsStorage: pulumi.String("1Gi"),
				},
			},
			ContainerResourceLimit: &rancher2.ProjectContainerResourceLimitArgs{
				LimitsCpu:      pulumi.String("20m"),
				LimitsMemory:   pulumi.String("20Mi"),
				RequestsCpu:    pulumi.String("1m"),
				RequestsMemory: pulumi.String("1Mi"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.Cluster;
import com.pulumi.rancher2.ClusterArgs;
import com.pulumi.rancher2.inputs.ClusterRkeConfigArgs;
import com.pulumi.rancher2.inputs.ClusterRkeConfigNetworkArgs;
import com.pulumi.rancher2.NodeTemplate;
import com.pulumi.rancher2.NodeTemplateArgs;
import com.pulumi.rancher2.inputs.NodeTemplateAmazonec2ConfigArgs;
import com.pulumi.rancher2.NodePool;
import com.pulumi.rancher2.NodePoolArgs;
import com.pulumi.rancher2.ClusterSync;
import com.pulumi.rancher2.ClusterSyncArgs;
import com.pulumi.rancher2.Project;
import com.pulumi.rancher2.ProjectArgs;
import com.pulumi.rancher2.inputs.ProjectResourceQuotaArgs;
import com.pulumi.rancher2.inputs.ProjectResourceQuotaProjectLimitArgs;
import com.pulumi.rancher2.inputs.ProjectResourceQuotaNamespaceDefaultLimitArgs;
import com.pulumi.rancher2.inputs.ProjectContainerResourceLimitArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foo_customCluster = new Cluster("foo-customCluster", ClusterArgs.builder()        
            .description("Foo rancher2 custom cluster")
            .rkeConfig(ClusterRkeConfigArgs.builder()
                .network(ClusterRkeConfigNetworkArgs.builder()
                    .plugin("canal")
                    .build())
                .build())
            .build());

        var fooNodeTemplate = new NodeTemplate("fooNodeTemplate", NodeTemplateArgs.builder()        
            .description("foo test")
            .amazonec2Config(NodeTemplateAmazonec2ConfigArgs.builder()
                .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>")
                .build())
            .build());

        var fooNodePool = new NodePool("fooNodePool", NodePoolArgs.builder()        
            .clusterId(foo_customCluster.id())
            .hostnamePrefix("foo-cluster-0")
            .nodeTemplateId(fooNodeTemplate.id())
            .quantity(3)
            .controlPlane(true)
            .etcd(true)
            .worker(true)
            .build());

        var foo_customClusterSync = new ClusterSync("foo-customClusterSync", ClusterSyncArgs.builder()        
            .clusterId(foo_customCluster.id())
            .nodePoolIds(fooNodePool.id())
            .build());

        var fooProject = new Project("fooProject", ProjectArgs.builder()        
            .clusterId(foo_customClusterSync.id())
            .description("Terraform namespace acceptance test")
            .resourceQuota(ProjectResourceQuotaArgs.builder()
                .projectLimit(ProjectResourceQuotaProjectLimitArgs.builder()
                    .limitsCpu("2000m")
                    .limitsMemory("2000Mi")
                    .requestsStorage("2Gi")
                    .build())
                .namespaceDefaultLimit(ProjectResourceQuotaNamespaceDefaultLimitArgs.builder()
                    .limitsCpu("500m")
                    .limitsMemory("500Mi")
                    .requestsStorage("1Gi")
                    .build())
                .build())
            .containerResourceLimit(ProjectContainerResourceLimitArgs.builder()
                .limitsCpu("20m")
                .limitsMemory("20Mi")
                .requestsCpu("1m")
                .requestsMemory("1Mi")
                .build())
            .build());

    }
}
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",
        ),
    ))
# 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_cluster.id,
    hostname_prefix="foo-cluster-0",
    node_template_id=foo_node_template.id,
    quantity=3,
    control_plane=True,
    etcd=True,
    worker=True)
# Create a new rancher2 Cluster Sync
foo_custom_cluster_sync = rancher2.ClusterSync("foo-customClusterSync",
    cluster_id=foo_custom_cluster.id,
    node_pool_ids=[foo_node_pool.id])
# Create a new rancher2 Project
foo_project = rancher2.Project("fooProject",
    cluster_id=foo_custom_cluster_sync.id,
    description="Terraform namespace acceptance test",
    resource_quota=rancher2.ProjectResourceQuotaArgs(
        project_limit=rancher2.ProjectResourceQuotaProjectLimitArgs(
            limits_cpu="2000m",
            limits_memory="2000Mi",
            requests_storage="2Gi",
        ),
        namespace_default_limit=rancher2.ProjectResourceQuotaNamespaceDefaultLimitArgs(
            limits_cpu="500m",
            limits_memory="500Mi",
            requests_storage="1Gi",
        ),
    ),
    container_resource_limit=rancher2.ProjectContainerResourceLimitArgs(
        limits_cpu="20m",
        limits_memory="20Mi",
        requests_cpu="1m",
        requests_memory="1Mi",
    ))
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",
        },
    },
});
// 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_customCluster.id,
    hostnamePrefix: "foo-cluster-0",
    nodeTemplateId: fooNodeTemplate.id,
    quantity: 3,
    controlPlane: true,
    etcd: true,
    worker: true,
});
// Create a new rancher2 Cluster Sync
const foo_customClusterSync = new rancher2.ClusterSync("foo-customClusterSync", {
    clusterId: foo_customCluster.id,
    nodePoolIds: [fooNodePool.id],
});
// Create a new rancher2 Project
const fooProject = new rancher2.Project("fooProject", {
    clusterId: foo_customClusterSync.id,
    description: "Terraform namespace acceptance test",
    resourceQuota: {
        projectLimit: {
            limitsCpu: "2000m",
            limitsMemory: "2000Mi",
            requestsStorage: "2Gi",
        },
        namespaceDefaultLimit: {
            limitsCpu: "500m",
            limitsMemory: "500Mi",
            requestsStorage: "1Gi",
        },
    },
    containerResourceLimit: {
        limitsCpu: "20m",
        limitsMemory: "20Mi",
        requestsCpu: "1m",
        requestsMemory: "1Mi",
    },
});
resources:
  # Create a new rancher2 rke Cluster
  foo-customCluster:
    type: rancher2:Cluster
    properties:
      description: Foo rancher2 custom cluster
      rkeConfig:
        network:
          plugin: canal
  # Create a new rancher2 Node Template
  fooNodeTemplate:
    type: rancher2:NodeTemplate
    properties:
      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
  fooNodePool:
    type: rancher2:NodePool
    properties:
      clusterId: ${["foo-customCluster"].id}
      hostnamePrefix: foo-cluster-0
      nodeTemplateId: ${fooNodeTemplate.id}
      quantity: 3
      controlPlane: true
      etcd: true
      worker: true
  # Create a new rancher2 Cluster Sync
  foo-customClusterSync:
    type: rancher2:ClusterSync
    properties:
      clusterId: ${["foo-customCluster"].id}
      nodePoolIds:
        - ${fooNodePool.id}
  # Create a new rancher2 Project
  fooProject:
    type: rancher2:Project
    properties:
      clusterId: ${["foo-customClusterSync"].id}
      description: Terraform namespace acceptance test
      resourceQuota:
        projectLimit:
          limitsCpu: 2000m
          limitsMemory: 2000Mi
          requestsStorage: 2Gi
        namespaceDefaultLimit:
          limitsCpu: 500m
          limitsMemory: 500Mi
          requestsStorage: 1Gi
      containerResourceLimit:
        limitsCpu: 20m
        limitsMemory: 20Mi
        requestsCpu: 1m
        requestsMemory: 1Mi

Create ClusterSync Resource

new ClusterSync(name: string, args: ClusterSyncArgs, opts?: CustomResourceOptions);
@overload
def ClusterSync(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                cluster_id: Optional[str] = None,
                node_pool_ids: Optional[Sequence[str]] = None,
                state_confirm: Optional[int] = None,
                synced: Optional[bool] = None,
                wait_alerting: Optional[bool] = None,
                wait_catalogs: Optional[bool] = None,
                wait_monitoring: Optional[bool] = None)
@overload
def ClusterSync(resource_name: str,
                args: ClusterSyncArgs,
                opts: Optional[ResourceOptions] = None)
func NewClusterSync(ctx *Context, name string, args ClusterSyncArgs, opts ...ResourceOption) (*ClusterSync, error)
public ClusterSync(string name, ClusterSyncArgs args, CustomResourceOptions? opts = null)
public ClusterSync(String name, ClusterSyncArgs args)
public ClusterSync(String name, ClusterSyncArgs args, CustomResourceOptions options)
type: rancher2:ClusterSync
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ClusterSyncArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ClusterSyncArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ClusterSyncArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterSyncArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClusterSyncArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ClusterSync Resource Properties

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

Inputs

The ClusterSync resource accepts the following input properties:

ClusterId string

The cluster ID that is syncing (string)

NodePoolIds List<string>

The node pool IDs used by the cluster id (list)

StateConfirm int

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

Synced bool
WaitAlerting bool

Wait until alerting is up and running. Default: false (bool)

WaitCatalogs bool

Wait until all catalogs are downloaded and active. Default: false (bool)

WaitMonitoring bool

Wait until monitoring is up and running. Default: false (bool)

ClusterId string

The cluster ID that is syncing (string)

NodePoolIds []string

The node pool IDs used by the cluster id (list)

StateConfirm int

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

Synced bool
WaitAlerting bool

Wait until alerting is up and running. Default: false (bool)

WaitCatalogs bool

Wait until all catalogs are downloaded and active. Default: false (bool)

WaitMonitoring bool

Wait until monitoring is up and running. Default: false (bool)

clusterId String

The cluster ID that is syncing (string)

nodePoolIds List<String>

The node pool IDs used by the cluster id (list)

stateConfirm Integer

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

synced Boolean
waitAlerting Boolean

Wait until alerting is up and running. Default: false (bool)

waitCatalogs Boolean

Wait until all catalogs are downloaded and active. Default: false (bool)

waitMonitoring Boolean

Wait until monitoring is up and running. Default: false (bool)

clusterId string

The cluster ID that is syncing (string)

nodePoolIds string[]

The node pool IDs used by the cluster id (list)

stateConfirm number

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

synced boolean
waitAlerting boolean

Wait until alerting is up and running. Default: false (bool)

waitCatalogs boolean

Wait until all catalogs are downloaded and active. Default: false (bool)

waitMonitoring boolean

Wait until monitoring is up and running. Default: false (bool)

cluster_id str

The cluster ID that is syncing (string)

node_pool_ids Sequence[str]

The node pool IDs used by the cluster id (list)

state_confirm int

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

synced bool
wait_alerting bool

Wait until alerting is up and running. Default: false (bool)

wait_catalogs bool

Wait until all catalogs are downloaded and active. Default: false (bool)

wait_monitoring bool

Wait until monitoring is up and running. Default: false (bool)

clusterId String

The cluster ID that is syncing (string)

nodePoolIds List<String>

The node pool IDs used by the cluster id (list)

stateConfirm Number

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

synced Boolean
waitAlerting Boolean

Wait until alerting is up and running. Default: false (bool)

waitCatalogs Boolean

Wait until all catalogs are downloaded and active. Default: false (bool)

waitMonitoring Boolean

Wait until monitoring is up and running. Default: false (bool)

Outputs

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

DefaultProjectId string

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

Id string

The provider-assigned unique ID for this managed resource.

KubeConfig string

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

Nodes List<ClusterSyncNode>

(Computed) The cluster nodes (list).

SystemProjectId string

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

DefaultProjectId string

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

Id string

The provider-assigned unique ID for this managed resource.

KubeConfig string

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

Nodes []ClusterSyncNode

(Computed) The cluster nodes (list).

SystemProjectId string

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

defaultProjectId String

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

id String

The provider-assigned unique ID for this managed resource.

kubeConfig String

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

nodes List<ClusterSyncNode>

(Computed) The cluster nodes (list).

systemProjectId String

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

defaultProjectId string

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

id string

The provider-assigned unique ID for this managed resource.

kubeConfig string

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

nodes ClusterSyncNode[]

(Computed) The cluster nodes (list).

systemProjectId string

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

default_project_id str

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

id str

The provider-assigned unique ID for this managed resource.

kube_config str

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

nodes Sequence[ClusterSyncNode]

(Computed) The cluster nodes (list).

system_project_id str

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

defaultProjectId String

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

id String

The provider-assigned unique ID for this managed resource.

kubeConfig String

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

nodes List<Property Map>

(Computed) The cluster nodes (list).

systemProjectId String

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

Look up Existing ClusterSync Resource

Get an existing ClusterSync 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?: ClusterSyncState, opts?: CustomResourceOptions): ClusterSync
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        default_project_id: Optional[str] = None,
        kube_config: Optional[str] = None,
        node_pool_ids: Optional[Sequence[str]] = None,
        nodes: Optional[Sequence[ClusterSyncNodeArgs]] = None,
        state_confirm: Optional[int] = None,
        synced: Optional[bool] = None,
        system_project_id: Optional[str] = None,
        wait_alerting: Optional[bool] = None,
        wait_catalogs: Optional[bool] = None,
        wait_monitoring: Optional[bool] = None) -> ClusterSync
func GetClusterSync(ctx *Context, name string, id IDInput, state *ClusterSyncState, opts ...ResourceOption) (*ClusterSync, error)
public static ClusterSync Get(string name, Input<string> id, ClusterSyncState? state, CustomResourceOptions? opts = null)
public static ClusterSync get(String name, Output<String> id, ClusterSyncState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ClusterId string

The cluster ID that is syncing (string)

DefaultProjectId string

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

KubeConfig string

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

NodePoolIds List<string>

The node pool IDs used by the cluster id (list)

Nodes List<ClusterSyncNodeArgs>

(Computed) The cluster nodes (list).

StateConfirm int

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

Synced bool
SystemProjectId string

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

WaitAlerting bool

Wait until alerting is up and running. Default: false (bool)

WaitCatalogs bool

Wait until all catalogs are downloaded and active. Default: false (bool)

WaitMonitoring bool

Wait until monitoring is up and running. Default: false (bool)

ClusterId string

The cluster ID that is syncing (string)

DefaultProjectId string

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

KubeConfig string

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

NodePoolIds []string

The node pool IDs used by the cluster id (list)

Nodes []ClusterSyncNodeArgs

(Computed) The cluster nodes (list).

StateConfirm int

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

Synced bool
SystemProjectId string

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

WaitAlerting bool

Wait until alerting is up and running. Default: false (bool)

WaitCatalogs bool

Wait until all catalogs are downloaded and active. Default: false (bool)

WaitMonitoring bool

Wait until monitoring is up and running. Default: false (bool)

clusterId String

The cluster ID that is syncing (string)

defaultProjectId String

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

kubeConfig String

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

nodePoolIds List<String>

The node pool IDs used by the cluster id (list)

nodes List<ClusterSyncNodeArgs>

(Computed) The cluster nodes (list).

stateConfirm Integer

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

synced Boolean
systemProjectId String

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

waitAlerting Boolean

Wait until alerting is up and running. Default: false (bool)

waitCatalogs Boolean

Wait until all catalogs are downloaded and active. Default: false (bool)

waitMonitoring Boolean

Wait until monitoring is up and running. Default: false (bool)

clusterId string

The cluster ID that is syncing (string)

defaultProjectId string

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

kubeConfig string

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

nodePoolIds string[]

The node pool IDs used by the cluster id (list)

nodes ClusterSyncNodeArgs[]

(Computed) The cluster nodes (list).

stateConfirm number

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

synced boolean
systemProjectId string

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

waitAlerting boolean

Wait until alerting is up and running. Default: false (bool)

waitCatalogs boolean

Wait until all catalogs are downloaded and active. Default: false (bool)

waitMonitoring boolean

Wait until monitoring is up and running. Default: false (bool)

cluster_id str

The cluster ID that is syncing (string)

default_project_id str

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

kube_config str

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

node_pool_ids Sequence[str]

The node pool IDs used by the cluster id (list)

nodes Sequence[ClusterSyncNodeArgs]

(Computed) The cluster nodes (list).

state_confirm int

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

synced bool
system_project_id str

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

wait_alerting bool

Wait until alerting is up and running. Default: false (bool)

wait_catalogs bool

Wait until all catalogs are downloaded and active. Default: false (bool)

wait_monitoring bool

Wait until monitoring is up and running. Default: false (bool)

clusterId String

The cluster ID that is syncing (string)

defaultProjectId String

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

kubeConfig String

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

nodePoolIds List<String>

The node pool IDs used by the cluster id (list)

nodes List<Property Map>

(Computed) The cluster nodes (list).

stateConfirm Number

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

synced Boolean
systemProjectId String

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

waitAlerting Boolean

Wait until alerting is up and running. Default: false (bool)

waitCatalogs Boolean

Wait until all catalogs are downloaded and active. Default: false (bool)

waitMonitoring Boolean

Wait until monitoring is up and running. Default: false (bool)

Supporting Types

ClusterSyncNode

Annotations Dictionary<string, object>

Annotations of the node (map).

Capacity Dictionary<string, object>

The total resources of a node (map).

ClusterId string

The cluster ID that is syncing (string)

ExternalIpAddress string

The external IP address of the node (string).

Hostname string

The hostname of the node (string).

Id string

The ID of the node (string)

IpAddress string

The private IP address of the node (string).

Labels Dictionary<string, object>

Labels of the node (map).

Name string

The name of the node (string).

NodePoolId string

The Node Pool ID of the node (string).

NodeTemplateId string

The Node Template ID of the node (string).

ProviderId string

The Provider ID of the node (string).

RequestedHostname string

The requested hostname (string).

Roles List<string>

Roles of the node. controlplane, etcd and worker. (list)

SshUser string

The user to connect to the node (string).

SystemInfo Dictionary<string, object>

General information about the node, such as kernel version, kubelet and kube-proxy version, Docker version (if used), and OS name.

Annotations map[string]interface{}

Annotations of the node (map).

Capacity map[string]interface{}

The total resources of a node (map).

ClusterId string

The cluster ID that is syncing (string)

ExternalIpAddress string

The external IP address of the node (string).

Hostname string

The hostname of the node (string).

Id string

The ID of the node (string)

IpAddress string

The private IP address of the node (string).

Labels map[string]interface{}

Labels of the node (map).

Name string

The name of the node (string).

NodePoolId string

The Node Pool ID of the node (string).

NodeTemplateId string

The Node Template ID of the node (string).

ProviderId string

The Provider ID of the node (string).

RequestedHostname string

The requested hostname (string).

Roles []string

Roles of the node. controlplane, etcd and worker. (list)

SshUser string

The user to connect to the node (string).

SystemInfo map[string]interface{}

General information about the node, such as kernel version, kubelet and kube-proxy version, Docker version (if used), and OS name.

annotations Map<String,Object>

Annotations of the node (map).

capacity Map<String,Object>

The total resources of a node (map).

clusterId String

The cluster ID that is syncing (string)

externalIpAddress String

The external IP address of the node (string).

hostname String

The hostname of the node (string).

id String

The ID of the node (string)

ipAddress String

The private IP address of the node (string).

labels Map<String,Object>

Labels of the node (map).

name String

The name of the node (string).

nodePoolId String

The Node Pool ID of the node (string).

nodeTemplateId String

The Node Template ID of the node (string).

providerId String

The Provider ID of the node (string).

requestedHostname String

The requested hostname (string).

roles List<String>

Roles of the node. controlplane, etcd and worker. (list)

sshUser String

The user to connect to the node (string).

systemInfo Map<String,Object>

General information about the node, such as kernel version, kubelet and kube-proxy version, Docker version (if used), and OS name.

annotations {[key: string]: any}

Annotations of the node (map).

capacity {[key: string]: any}

The total resources of a node (map).

clusterId string

The cluster ID that is syncing (string)

externalIpAddress string

The external IP address of the node (string).

hostname string

The hostname of the node (string).

id string

The ID of the node (string)

ipAddress string

The private IP address of the node (string).

labels {[key: string]: any}

Labels of the node (map).

name string

The name of the node (string).

nodePoolId string

The Node Pool ID of the node (string).

nodeTemplateId string

The Node Template ID of the node (string).

providerId string

The Provider ID of the node (string).

requestedHostname string

The requested hostname (string).

roles string[]

Roles of the node. controlplane, etcd and worker. (list)

sshUser string

The user to connect to the node (string).

systemInfo {[key: string]: any}

General information about the node, such as kernel version, kubelet and kube-proxy version, Docker version (if used), and OS name.

annotations Mapping[str, Any]

Annotations of the node (map).

capacity Mapping[str, Any]

The total resources of a node (map).

cluster_id str

The cluster ID that is syncing (string)

external_ip_address str

The external IP address of the node (string).

hostname str

The hostname of the node (string).

id str

The ID of the node (string)

ip_address str

The private IP address of the node (string).

labels Mapping[str, Any]

Labels of the node (map).

name str

The name of the node (string).

node_pool_id str

The Node Pool ID of the node (string).

node_template_id str

The Node Template ID of the node (string).

provider_id str

The Provider ID of the node (string).

requested_hostname str

The requested hostname (string).

roles Sequence[str]

Roles of the node. controlplane, etcd and worker. (list)

ssh_user str

The user to connect to the node (string).

system_info Mapping[str, Any]

General information about the node, such as kernel version, kubelet and kube-proxy version, Docker version (if used), and OS name.

annotations Map<Any>

Annotations of the node (map).

capacity Map<Any>

The total resources of a node (map).

clusterId String

The cluster ID that is syncing (string)

externalIpAddress String

The external IP address of the node (string).

hostname String

The hostname of the node (string).

id String

The ID of the node (string)

ipAddress String

The private IP address of the node (string).

labels Map<Any>

Labels of the node (map).

name String

The name of the node (string).

nodePoolId String

The Node Pool ID of the node (string).

nodeTemplateId String

The Node Template ID of the node (string).

providerId String

The Provider ID of the node (string).

requestedHostname String

The requested hostname (string).

roles List<String>

Roles of the node. controlplane, etcd and worker. (list)

sshUser String

The user to connect to the node (string).

systemInfo Map<Any>

General information about the node, such as kernel version, kubelet and kube-proxy version, Docker version (if used), and OS name.

Package Details

Repository
Rancher2 pulumi/pulumi-rancher2
License
Apache-2.0
Notes

This Pulumi package is based on the rancher2 Terraform Provider.