1. Packages
  2. OpenStack
  3. API Docs
  4. containerinfra
  5. Cluster
OpenStack v4.0.0 published on Tuesday, May 21, 2024 by Pulumi

openstack.containerinfra.Cluster

Explore with Pulumi AI

openstack logo
OpenStack v4.0.0 published on Tuesday, May 21, 2024 by Pulumi

    Manages a V1 Magnum cluster resource within OpenStack.

    Note: All arguments including the kubeconfig computed attribute will be stored in the raw state as plain-text. Read more about sensitive data in state.

    Example Usage

    Create a Cluster

    import * as pulumi from "@pulumi/pulumi";
    import * as openstack from "@pulumi/openstack";
    
    const cluster1 = new openstack.containerinfra.Cluster("cluster_1", {
        name: "cluster_1",
        clusterTemplateId: "b9a45c5c-cd03-4958-82aa-b80bf93cb922",
        masterCount: 3,
        nodeCount: 5,
        keypair: "ssh_keypair",
    });
    
    import pulumi
    import pulumi_openstack as openstack
    
    cluster1 = openstack.containerinfra.Cluster("cluster_1",
        name="cluster_1",
        cluster_template_id="b9a45c5c-cd03-4958-82aa-b80bf93cb922",
        master_count=3,
        node_count=5,
        keypair="ssh_keypair")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-openstack/sdk/v4/go/openstack/containerinfra"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := containerinfra.NewCluster(ctx, "cluster_1", &containerinfra.ClusterArgs{
    			Name:              pulumi.String("cluster_1"),
    			ClusterTemplateId: pulumi.String("b9a45c5c-cd03-4958-82aa-b80bf93cb922"),
    			MasterCount:       pulumi.Int(3),
    			NodeCount:         pulumi.Int(5),
    			Keypair:           pulumi.String("ssh_keypair"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using OpenStack = Pulumi.OpenStack;
    
    return await Deployment.RunAsync(() => 
    {
        var cluster1 = new OpenStack.ContainerInfra.Cluster("cluster_1", new()
        {
            Name = "cluster_1",
            ClusterTemplateId = "b9a45c5c-cd03-4958-82aa-b80bf93cb922",
            MasterCount = 3,
            NodeCount = 5,
            Keypair = "ssh_keypair",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.openstack.containerinfra.Cluster;
    import com.pulumi.openstack.containerinfra.ClusterArgs;
    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 cluster1 = new Cluster("cluster1", ClusterArgs.builder()        
                .name("cluster_1")
                .clusterTemplateId("b9a45c5c-cd03-4958-82aa-b80bf93cb922")
                .masterCount(3)
                .nodeCount(5)
                .keypair("ssh_keypair")
                .build());
    
        }
    }
    
    resources:
      cluster1:
        type: openstack:containerinfra:Cluster
        name: cluster_1
        properties:
          name: cluster_1
          clusterTemplateId: b9a45c5c-cd03-4958-82aa-b80bf93cb922
          masterCount: 3
          nodeCount: 5
          keypair: ssh_keypair
    

    Attributes reference

    The following attributes are exported:

    • region - See Argument Reference above.
    • name - See Argument Reference above.
    • project_id - See Argument Reference above.
    • created_at - The time at which cluster was created.
    • updated_at - The time at which cluster was created.
    • api_address - COE API address.
    • coe_version - COE software version.
    • cluster_template_id - See Argument Reference above.
    • container_version - Container software version.
    • create_timeout - See Argument Reference above.
    • discovery_url - See Argument Reference above.
    • docker_volume_size - See Argument Reference above.
    • flavor - See Argument Reference above.
    • master_flavor - See Argument Reference above.
    • keypair - See Argument Reference above.
    • labels - See Argument Reference above.
    • merge_labels - See Argument Reference above.
    • master_count - See Argument Reference above.
    • node_count - See Argument Reference above.
    • fixed_network - See Argument Reference above.
    • fixed_subnet - See Argument Reference above.
    • floating_ip_enabled - See Argument Reference above.
    • master_addresses - IP addresses of the master node of the cluster.
    • node_addresses - IP addresses of the node of the cluster.
    • stack_id - UUID of the Orchestration service stack.
    • kubeconfig - The Kubernetes cluster’s credentials
      • raw_config - The raw kubeconfig file
      • host - The cluster’s API server URL
      • cluster_ca_certificate - The cluster’s CA certificate
      • client_key - The client’s RSA key
      • client_certificate - The client’s certificate

    Create Cluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                args: ClusterArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                cluster_template_id: Optional[str] = None,
                create_timeout: Optional[int] = None,
                discovery_url: Optional[str] = None,
                docker_volume_size: Optional[int] = None,
                fixed_network: Optional[str] = None,
                fixed_subnet: Optional[str] = None,
                flavor: Optional[str] = None,
                floating_ip_enabled: Optional[bool] = None,
                keypair: Optional[str] = None,
                labels: Optional[Mapping[str, Any]] = None,
                master_count: Optional[int] = None,
                master_flavor: Optional[str] = None,
                merge_labels: Optional[bool] = None,
                name: Optional[str] = None,
                node_count: Optional[int] = None,
                region: Optional[str] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
    public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
    
    type: openstack:containerinfra:Cluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

    The following reference example uses placeholder values for all input properties.

    var clusterResource = new OpenStack.ContainerInfra.Cluster("clusterResource", new()
    {
        ClusterTemplateId = "string",
        CreateTimeout = 0,
        DiscoveryUrl = "string",
        DockerVolumeSize = 0,
        FixedNetwork = "string",
        FixedSubnet = "string",
        Flavor = "string",
        FloatingIpEnabled = false,
        Keypair = "string",
        Labels = 
        {
            { "string", "any" },
        },
        MasterCount = 0,
        MasterFlavor = "string",
        MergeLabels = false,
        Name = "string",
        NodeCount = 0,
        Region = "string",
    });
    
    example, err := containerinfra.NewCluster(ctx, "clusterResource", &containerinfra.ClusterArgs{
    	ClusterTemplateId: pulumi.String("string"),
    	CreateTimeout:     pulumi.Int(0),
    	DiscoveryUrl:      pulumi.String("string"),
    	DockerVolumeSize:  pulumi.Int(0),
    	FixedNetwork:      pulumi.String("string"),
    	FixedSubnet:       pulumi.String("string"),
    	Flavor:            pulumi.String("string"),
    	FloatingIpEnabled: pulumi.Bool(false),
    	Keypair:           pulumi.String("string"),
    	Labels: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	MasterCount:  pulumi.Int(0),
    	MasterFlavor: pulumi.String("string"),
    	MergeLabels:  pulumi.Bool(false),
    	Name:         pulumi.String("string"),
    	NodeCount:    pulumi.Int(0),
    	Region:       pulumi.String("string"),
    })
    
    var clusterResource = new Cluster("clusterResource", ClusterArgs.builder()
        .clusterTemplateId("string")
        .createTimeout(0)
        .discoveryUrl("string")
        .dockerVolumeSize(0)
        .fixedNetwork("string")
        .fixedSubnet("string")
        .flavor("string")
        .floatingIpEnabled(false)
        .keypair("string")
        .labels(Map.of("string", "any"))
        .masterCount(0)
        .masterFlavor("string")
        .mergeLabels(false)
        .name("string")
        .nodeCount(0)
        .region("string")
        .build());
    
    cluster_resource = openstack.containerinfra.Cluster("clusterResource",
        cluster_template_id="string",
        create_timeout=0,
        discovery_url="string",
        docker_volume_size=0,
        fixed_network="string",
        fixed_subnet="string",
        flavor="string",
        floating_ip_enabled=False,
        keypair="string",
        labels={
            "string": "any",
        },
        master_count=0,
        master_flavor="string",
        merge_labels=False,
        name="string",
        node_count=0,
        region="string")
    
    const clusterResource = new openstack.containerinfra.Cluster("clusterResource", {
        clusterTemplateId: "string",
        createTimeout: 0,
        discoveryUrl: "string",
        dockerVolumeSize: 0,
        fixedNetwork: "string",
        fixedSubnet: "string",
        flavor: "string",
        floatingIpEnabled: false,
        keypair: "string",
        labels: {
            string: "any",
        },
        masterCount: 0,
        masterFlavor: "string",
        mergeLabels: false,
        name: "string",
        nodeCount: 0,
        region: "string",
    });
    
    type: openstack:containerinfra:Cluster
    properties:
        clusterTemplateId: string
        createTimeout: 0
        discoveryUrl: string
        dockerVolumeSize: 0
        fixedNetwork: string
        fixedSubnet: string
        flavor: string
        floatingIpEnabled: false
        keypair: string
        labels:
            string: any
        masterCount: 0
        masterFlavor: string
        mergeLabels: false
        name: string
        nodeCount: 0
        region: string
    

    Cluster Resource Properties

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

    Inputs

    The Cluster resource accepts the following input properties:

    ClusterTemplateId string
    The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.
    CreateTimeout int
    The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.
    DiscoveryUrl string
    The URL used for cluster node discovery. Changing this creates a new cluster.
    DockerVolumeSize int
    The size (in GB) of the Docker volume. Changing this creates a new cluster.
    FixedNetwork string
    The fixed network that will be attached to the cluster. Changing this creates a new cluster.
    FixedSubnet string
    The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.
    Flavor string
    The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.
    FloatingIpEnabled bool
    Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.
    Keypair string
    The name of the Compute service SSH keypair. Changing this creates a new cluster.
    Labels Dictionary<string, object>
    The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.
    MasterCount int
    The number of master nodes for the cluster. Changing this creates a new cluster.
    MasterFlavor string
    The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.
    MergeLabels bool
    Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.
    Name string
    The name of the cluster. Changing this creates a new cluster.
    NodeCount int
    The number of nodes for the cluster.
    Region string
    The region in which to obtain the V1 Container Infra client. A Container Infra client is needed to create a cluster. If omitted, the region argument of the provider is used. Changing this creates a new cluster.
    ClusterTemplateId string
    The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.
    CreateTimeout int
    The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.
    DiscoveryUrl string
    The URL used for cluster node discovery. Changing this creates a new cluster.
    DockerVolumeSize int
    The size (in GB) of the Docker volume. Changing this creates a new cluster.
    FixedNetwork string
    The fixed network that will be attached to the cluster. Changing this creates a new cluster.
    FixedSubnet string
    The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.
    Flavor string
    The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.
    FloatingIpEnabled bool
    Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.
    Keypair string
    The name of the Compute service SSH keypair. Changing this creates a new cluster.
    Labels map[string]interface{}
    The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.
    MasterCount int
    The number of master nodes for the cluster. Changing this creates a new cluster.
    MasterFlavor string
    The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.
    MergeLabels bool
    Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.
    Name string
    The name of the cluster. Changing this creates a new cluster.
    NodeCount int
    The number of nodes for the cluster.
    Region string
    The region in which to obtain the V1 Container Infra client. A Container Infra client is needed to create a cluster. If omitted, the region argument of the provider is used. Changing this creates a new cluster.
    clusterTemplateId String
    The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.
    createTimeout Integer
    The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.
    discoveryUrl String
    The URL used for cluster node discovery. Changing this creates a new cluster.
    dockerVolumeSize Integer
    The size (in GB) of the Docker volume. Changing this creates a new cluster.
    fixedNetwork String
    The fixed network that will be attached to the cluster. Changing this creates a new cluster.
    fixedSubnet String
    The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.
    flavor String
    The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.
    floatingIpEnabled Boolean
    Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.
    keypair String
    The name of the Compute service SSH keypair. Changing this creates a new cluster.
    labels Map<String,Object>
    The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.
    masterCount Integer
    The number of master nodes for the cluster. Changing this creates a new cluster.
    masterFlavor String
    The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.
    mergeLabels Boolean
    Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.
    name String
    The name of the cluster. Changing this creates a new cluster.
    nodeCount Integer
    The number of nodes for the cluster.
    region String
    The region in which to obtain the V1 Container Infra client. A Container Infra client is needed to create a cluster. If omitted, the region argument of the provider is used. Changing this creates a new cluster.
    clusterTemplateId string
    The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.
    createTimeout number
    The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.
    discoveryUrl string
    The URL used for cluster node discovery. Changing this creates a new cluster.
    dockerVolumeSize number
    The size (in GB) of the Docker volume. Changing this creates a new cluster.
    fixedNetwork string
    The fixed network that will be attached to the cluster. Changing this creates a new cluster.
    fixedSubnet string
    The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.
    flavor string
    The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.
    floatingIpEnabled boolean
    Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.
    keypair string
    The name of the Compute service SSH keypair. Changing this creates a new cluster.
    labels {[key: string]: any}
    The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.
    masterCount number
    The number of master nodes for the cluster. Changing this creates a new cluster.
    masterFlavor string
    The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.
    mergeLabels boolean
    Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.
    name string
    The name of the cluster. Changing this creates a new cluster.
    nodeCount number
    The number of nodes for the cluster.
    region string
    The region in which to obtain the V1 Container Infra client. A Container Infra client is needed to create a cluster. If omitted, the region argument of the provider is used. Changing this creates a new cluster.
    cluster_template_id str
    The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.
    create_timeout int
    The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.
    discovery_url str
    The URL used for cluster node discovery. Changing this creates a new cluster.
    docker_volume_size int
    The size (in GB) of the Docker volume. Changing this creates a new cluster.
    fixed_network str
    The fixed network that will be attached to the cluster. Changing this creates a new cluster.
    fixed_subnet str
    The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.
    flavor str
    The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.
    floating_ip_enabled bool
    Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.
    keypair str
    The name of the Compute service SSH keypair. Changing this creates a new cluster.
    labels Mapping[str, Any]
    The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.
    master_count int
    The number of master nodes for the cluster. Changing this creates a new cluster.
    master_flavor str
    The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.
    merge_labels bool
    Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.
    name str
    The name of the cluster. Changing this creates a new cluster.
    node_count int
    The number of nodes for the cluster.
    region str
    The region in which to obtain the V1 Container Infra client. A Container Infra client is needed to create a cluster. If omitted, the region argument of the provider is used. Changing this creates a new cluster.
    clusterTemplateId String
    The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.
    createTimeout Number
    The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.
    discoveryUrl String
    The URL used for cluster node discovery. Changing this creates a new cluster.
    dockerVolumeSize Number
    The size (in GB) of the Docker volume. Changing this creates a new cluster.
    fixedNetwork String
    The fixed network that will be attached to the cluster. Changing this creates a new cluster.
    fixedSubnet String
    The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.
    flavor String
    The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.
    floatingIpEnabled Boolean
    Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.
    keypair String
    The name of the Compute service SSH keypair. Changing this creates a new cluster.
    labels Map<Any>
    The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.
    masterCount Number
    The number of master nodes for the cluster. Changing this creates a new cluster.
    masterFlavor String
    The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.
    mergeLabels Boolean
    Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.
    name String
    The name of the cluster. Changing this creates a new cluster.
    nodeCount Number
    The number of nodes for the cluster.
    region String
    The region in which to obtain the V1 Container Infra client. A Container Infra client is needed to create a cluster. If omitted, the region argument of the provider is used. Changing this creates a new cluster.

    Outputs

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

    ApiAddress string
    CoeVersion string
    ContainerVersion string
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    Kubeconfig Dictionary<string, string>
    MasterAddresses List<string>
    NodeAddresses List<string>
    ProjectId string
    The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.
    StackId string
    UpdatedAt string
    UserId string
    The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.
    ApiAddress string
    CoeVersion string
    ContainerVersion string
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    Kubeconfig map[string]string
    MasterAddresses []string
    NodeAddresses []string
    ProjectId string
    The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.
    StackId string
    UpdatedAt string
    UserId string
    The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.
    apiAddress String
    coeVersion String
    containerVersion String
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    kubeconfig Map<String,String>
    masterAddresses List<String>
    nodeAddresses List<String>
    projectId String
    The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.
    stackId String
    updatedAt String
    userId String
    The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.
    apiAddress string
    coeVersion string
    containerVersion string
    createdAt string
    id string
    The provider-assigned unique ID for this managed resource.
    kubeconfig {[key: string]: string}
    masterAddresses string[]
    nodeAddresses string[]
    projectId string
    The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.
    stackId string
    updatedAt string
    userId string
    The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.
    api_address str
    coe_version str
    container_version str
    created_at str
    id str
    The provider-assigned unique ID for this managed resource.
    kubeconfig Mapping[str, str]
    master_addresses Sequence[str]
    node_addresses Sequence[str]
    project_id str
    The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.
    stack_id str
    updated_at str
    user_id str
    The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.
    apiAddress String
    coeVersion String
    containerVersion String
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    kubeconfig Map<String>
    masterAddresses List<String>
    nodeAddresses List<String>
    projectId String
    The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.
    stackId String
    updatedAt String
    userId String
    The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.

    Look up 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,
            api_address: Optional[str] = None,
            cluster_template_id: Optional[str] = None,
            coe_version: Optional[str] = None,
            container_version: Optional[str] = None,
            create_timeout: Optional[int] = None,
            created_at: Optional[str] = None,
            discovery_url: Optional[str] = None,
            docker_volume_size: Optional[int] = None,
            fixed_network: Optional[str] = None,
            fixed_subnet: Optional[str] = None,
            flavor: Optional[str] = None,
            floating_ip_enabled: Optional[bool] = None,
            keypair: Optional[str] = None,
            kubeconfig: Optional[Mapping[str, str]] = None,
            labels: Optional[Mapping[str, Any]] = None,
            master_addresses: Optional[Sequence[str]] = None,
            master_count: Optional[int] = None,
            master_flavor: Optional[str] = None,
            merge_labels: Optional[bool] = None,
            name: Optional[str] = None,
            node_addresses: Optional[Sequence[str]] = None,
            node_count: Optional[int] = None,
            project_id: Optional[str] = None,
            region: Optional[str] = None,
            stack_id: Optional[str] = None,
            updated_at: Optional[str] = None,
            user_id: Optional[str] = None) -> Cluster
    func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
    public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
    public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiAddress string
    ClusterTemplateId string
    The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.
    CoeVersion string
    ContainerVersion string
    CreateTimeout int
    The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.
    CreatedAt string
    DiscoveryUrl string
    The URL used for cluster node discovery. Changing this creates a new cluster.
    DockerVolumeSize int
    The size (in GB) of the Docker volume. Changing this creates a new cluster.
    FixedNetwork string
    The fixed network that will be attached to the cluster. Changing this creates a new cluster.
    FixedSubnet string
    The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.
    Flavor string
    The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.
    FloatingIpEnabled bool
    Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.
    Keypair string
    The name of the Compute service SSH keypair. Changing this creates a new cluster.
    Kubeconfig Dictionary<string, string>
    Labels Dictionary<string, object>
    The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.
    MasterAddresses List<string>
    MasterCount int
    The number of master nodes for the cluster. Changing this creates a new cluster.
    MasterFlavor string
    The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.
    MergeLabels bool
    Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.
    Name string
    The name of the cluster. Changing this creates a new cluster.
    NodeAddresses List<string>
    NodeCount int
    The number of nodes for the cluster.
    ProjectId string
    The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.
    Region string
    The region in which to obtain the V1 Container Infra client. A Container Infra client is needed to create a cluster. If omitted, the region argument of the provider is used. Changing this creates a new cluster.
    StackId string
    UpdatedAt string
    UserId string
    The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.
    ApiAddress string
    ClusterTemplateId string
    The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.
    CoeVersion string
    ContainerVersion string
    CreateTimeout int
    The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.
    CreatedAt string
    DiscoveryUrl string
    The URL used for cluster node discovery. Changing this creates a new cluster.
    DockerVolumeSize int
    The size (in GB) of the Docker volume. Changing this creates a new cluster.
    FixedNetwork string
    The fixed network that will be attached to the cluster. Changing this creates a new cluster.
    FixedSubnet string
    The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.
    Flavor string
    The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.
    FloatingIpEnabled bool
    Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.
    Keypair string
    The name of the Compute service SSH keypair. Changing this creates a new cluster.
    Kubeconfig map[string]string
    Labels map[string]interface{}
    The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.
    MasterAddresses []string
    MasterCount int
    The number of master nodes for the cluster. Changing this creates a new cluster.
    MasterFlavor string
    The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.
    MergeLabels bool
    Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.
    Name string
    The name of the cluster. Changing this creates a new cluster.
    NodeAddresses []string
    NodeCount int
    The number of nodes for the cluster.
    ProjectId string
    The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.
    Region string
    The region in which to obtain the V1 Container Infra client. A Container Infra client is needed to create a cluster. If omitted, the region argument of the provider is used. Changing this creates a new cluster.
    StackId string
    UpdatedAt string
    UserId string
    The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.
    apiAddress String
    clusterTemplateId String
    The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.
    coeVersion String
    containerVersion String
    createTimeout Integer
    The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.
    createdAt String
    discoveryUrl String
    The URL used for cluster node discovery. Changing this creates a new cluster.
    dockerVolumeSize Integer
    The size (in GB) of the Docker volume. Changing this creates a new cluster.
    fixedNetwork String
    The fixed network that will be attached to the cluster. Changing this creates a new cluster.
    fixedSubnet String
    The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.
    flavor String
    The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.
    floatingIpEnabled Boolean
    Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.
    keypair String
    The name of the Compute service SSH keypair. Changing this creates a new cluster.
    kubeconfig Map<String,String>
    labels Map<String,Object>
    The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.
    masterAddresses List<String>
    masterCount Integer
    The number of master nodes for the cluster. Changing this creates a new cluster.
    masterFlavor String
    The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.
    mergeLabels Boolean
    Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.
    name String
    The name of the cluster. Changing this creates a new cluster.
    nodeAddresses List<String>
    nodeCount Integer
    The number of nodes for the cluster.
    projectId String
    The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.
    region String
    The region in which to obtain the V1 Container Infra client. A Container Infra client is needed to create a cluster. If omitted, the region argument of the provider is used. Changing this creates a new cluster.
    stackId String
    updatedAt String
    userId String
    The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.
    apiAddress string
    clusterTemplateId string
    The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.
    coeVersion string
    containerVersion string
    createTimeout number
    The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.
    createdAt string
    discoveryUrl string
    The URL used for cluster node discovery. Changing this creates a new cluster.
    dockerVolumeSize number
    The size (in GB) of the Docker volume. Changing this creates a new cluster.
    fixedNetwork string
    The fixed network that will be attached to the cluster. Changing this creates a new cluster.
    fixedSubnet string
    The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.
    flavor string
    The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.
    floatingIpEnabled boolean
    Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.
    keypair string
    The name of the Compute service SSH keypair. Changing this creates a new cluster.
    kubeconfig {[key: string]: string}
    labels {[key: string]: any}
    The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.
    masterAddresses string[]
    masterCount number
    The number of master nodes for the cluster. Changing this creates a new cluster.
    masterFlavor string
    The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.
    mergeLabels boolean
    Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.
    name string
    The name of the cluster. Changing this creates a new cluster.
    nodeAddresses string[]
    nodeCount number
    The number of nodes for the cluster.
    projectId string
    The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.
    region string
    The region in which to obtain the V1 Container Infra client. A Container Infra client is needed to create a cluster. If omitted, the region argument of the provider is used. Changing this creates a new cluster.
    stackId string
    updatedAt string
    userId string
    The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.
    api_address str
    cluster_template_id str
    The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.
    coe_version str
    container_version str
    create_timeout int
    The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.
    created_at str
    discovery_url str
    The URL used for cluster node discovery. Changing this creates a new cluster.
    docker_volume_size int
    The size (in GB) of the Docker volume. Changing this creates a new cluster.
    fixed_network str
    The fixed network that will be attached to the cluster. Changing this creates a new cluster.
    fixed_subnet str
    The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.
    flavor str
    The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.
    floating_ip_enabled bool
    Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.
    keypair str
    The name of the Compute service SSH keypair. Changing this creates a new cluster.
    kubeconfig Mapping[str, str]
    labels Mapping[str, Any]
    The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.
    master_addresses Sequence[str]
    master_count int
    The number of master nodes for the cluster. Changing this creates a new cluster.
    master_flavor str
    The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.
    merge_labels bool
    Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.
    name str
    The name of the cluster. Changing this creates a new cluster.
    node_addresses Sequence[str]
    node_count int
    The number of nodes for the cluster.
    project_id str
    The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.
    region str
    The region in which to obtain the V1 Container Infra client. A Container Infra client is needed to create a cluster. If omitted, the region argument of the provider is used. Changing this creates a new cluster.
    stack_id str
    updated_at str
    user_id str
    The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.
    apiAddress String
    clusterTemplateId String
    The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.
    coeVersion String
    containerVersion String
    createTimeout Number
    The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.
    createdAt String
    discoveryUrl String
    The URL used for cluster node discovery. Changing this creates a new cluster.
    dockerVolumeSize Number
    The size (in GB) of the Docker volume. Changing this creates a new cluster.
    fixedNetwork String
    The fixed network that will be attached to the cluster. Changing this creates a new cluster.
    fixedSubnet String
    The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.
    flavor String
    The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.
    floatingIpEnabled Boolean
    Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.
    keypair String
    The name of the Compute service SSH keypair. Changing this creates a new cluster.
    kubeconfig Map<String>
    labels Map<Any>
    The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.
    masterAddresses List<String>
    masterCount Number
    The number of master nodes for the cluster. Changing this creates a new cluster.
    masterFlavor String
    The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.
    mergeLabels Boolean
    Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.
    name String
    The name of the cluster. Changing this creates a new cluster.
    nodeAddresses List<String>
    nodeCount Number
    The number of nodes for the cluster.
    projectId String
    The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.
    region String
    The region in which to obtain the V1 Container Infra client. A Container Infra client is needed to create a cluster. If omitted, the region argument of the provider is used. Changing this creates a new cluster.
    stackId String
    updatedAt String
    userId String
    The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.

    Import

    Clusters can be imported using the id, e.g.

    $ pulumi import openstack:containerinfra/cluster:Cluster cluster_1 ce0f9463-dd25-474b-9fe8-94de63e5e42b
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v4.0.0 published on Tuesday, May 21, 2024 by Pulumi