Class Cluster

Manages a V1 Magnum cluster resource within OpenStack.

Example Usage

Create a Cluster

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
public MyStack()
{
    var cluster1 = new OpenStack.ContainerInfra.Cluster("cluster1", new OpenStack.ContainerInfra.ClusterArgs
    {
        ClusterTemplateId = "b9a45c5c-cd03-4958-82aa-b80bf93cb922",
        Keypair = "ssh_keypair",
        MasterCount = 3,
        NodeCount = 5,
    });
}

}

Argument reference

The following arguments are supported:

  • region - (Optional) 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.

  • name - (Required) The name of the cluster. Changing this updates the name of the existing cluster template.

  • project_id - (Optional) The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.

  • user_id - (Optional) The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.

  • cluster_template_id - (Required) The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.

  • create_timeout - (Optional) The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.

  • discovery_url - (Optional) The URL used for cluster node discovery. Changing this creates a new cluster.

  • docker_volume_size - (Optional) The size (in GB) of the Docker volume. Changing this creates a new cluster.

  • flavor - (Optional) The flavor for the nodes of the cluster. Can be set via the OS_MAGNUM_FLAVOR environment variable. Changing this creates a new cluster.

  • master_flavor - (Optional) The flavor for the master nodes. Can be set via the OS_MAGNUM_MASTER_FLAVOR environment variable. Changing this creates a new cluster.

  • keypair - (Optional) The name of the Compute service SSH keypair. Changing this creates a new cluster.

  • labels - (Optional) The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.

  • master_count - (Optional) The number of master nodes for the cluster. Changing this creates a new cluster.

  • node_count - (Optional) The number of nodes for the cluster. Changing this creates a new cluster.

  • fixed_network - (Optional) The fixed network that will be attached to the cluster. Changing this creates a new cluster.

  • fixed_subnet - (Optional) The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.

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.
  • master_count - See Argument Reference above.
  • node_count - See Argument Reference above.
  • fixed_network - See Argument Reference above.
  • fixed_subnet - 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
Inheritance
System.Object
Resource
CustomResource
Cluster
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.OpenStack.ContainerInfra
Assembly: Pulumi.OpenStack.dll
Syntax
public class Cluster : CustomResource

Constructors

View Source

Cluster(String, ClusterArgs, CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

Declaration
public Cluster(string name, ClusterArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
ClusterArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

ApiAddress

Declaration
public Output<string> ApiAddress { get; }
Property Value
Type Description
Output<System.String>
View Source

ClusterTemplateId

Declaration
public Output<string> ClusterTemplateId { get; }
Property Value
Type Description
Output<System.String>
View Source

CoeVersion

Declaration
public Output<string> CoeVersion { get; }
Property Value
Type Description
Output<System.String>
View Source

ContainerVersion

Declaration
public Output<string> ContainerVersion { get; }
Property Value
Type Description
Output<System.String>
View Source

CreatedAt

Declaration
public Output<string> CreatedAt { get; }
Property Value
Type Description
Output<System.String>
View Source

CreateTimeout

Declaration
public Output<int> CreateTimeout { get; }
Property Value
Type Description
Output<System.Int32>
View Source

DiscoveryUrl

Declaration
public Output<string> DiscoveryUrl { get; }
Property Value
Type Description
Output<System.String>
View Source

DockerVolumeSize

Declaration
public Output<int> DockerVolumeSize { get; }
Property Value
Type Description
Output<System.Int32>
View Source

FixedNetwork

Declaration
public Output<string> FixedNetwork { get; }
Property Value
Type Description
Output<System.String>
View Source

FixedSubnet

Declaration
public Output<string> FixedSubnet { get; }
Property Value
Type Description
Output<System.String>
View Source

Flavor

Declaration
public Output<string> Flavor { get; }
Property Value
Type Description
Output<System.String>
View Source

Keypair

Declaration
public Output<string> Keypair { get; }
Property Value
Type Description
Output<System.String>
View Source

Kubeconfig

Declaration
public Output<ClusterKubeconfig> Kubeconfig { get; }
Property Value
Type Description
Output<ClusterKubeconfig>
View Source

Labels

Declaration
public Output<ImmutableDictionary<string, object>> Labels { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

MasterAddresses

Declaration
public Output<ImmutableArray<string>> MasterAddresses { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

MasterCount

Declaration
public Output<int> MasterCount { get; }
Property Value
Type Description
Output<System.Int32>
View Source

MasterFlavor

Declaration
public Output<string> MasterFlavor { get; }
Property Value
Type Description
Output<System.String>
View Source

Name

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

NodeAddresses

Declaration
public Output<ImmutableArray<string>> NodeAddresses { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

NodeCount

Declaration
public Output<int> NodeCount { get; }
Property Value
Type Description
Output<System.Int32>
View Source

ProjectId

Declaration
public Output<string> ProjectId { get; }
Property Value
Type Description
Output<System.String>
View Source

Region

Declaration
public Output<string> Region { get; }
Property Value
Type Description
Output<System.String>
View Source

StackId

Declaration
public Output<string> StackId { get; }
Property Value
Type Description
Output<System.String>
View Source

UpdatedAt

Declaration
public Output<string> UpdatedAt { get; }
Property Value
Type Description
Output<System.String>
View Source

UserId

Declaration
public Output<string> UserId { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, ClusterState, CustomResourceOptions)

Get an existing Cluster resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static Cluster Get(string name, Input<string> id, ClusterState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
ClusterState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
Cluster