Package com.pulumi.openstack.containerinfra

Class Cluster

  • public class Cluster
extends com.pulumi.resources.CustomResource
    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 ```java 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() .clusterTemplateId("b9a45c5c-cd03-4958-82aa-b80bf93cb922") .keypair("ssh_keypair") .masterCount(3) .nodeCount(5) .build()); } } ``` ## 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 ## Import Clusters can be imported using the `id`, e.g. ```sh $ pulumi import openstack:containerinfra/cluster:Cluster cluster_1 ce0f9463-dd25-474b-9fe8-94de63e5e42b ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Cluster​(java.lang.String name)  
      Cluster​(java.lang.String name, ClusterArgs args)  
      Cluster​(java.lang.String name, ClusterArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> apiAddress()  
      com.pulumi.core.Output<java.lang.String> clusterTemplateId()  
      com.pulumi.core.Output<java.lang.String> coeVersion()  
      com.pulumi.core.Output<java.lang.String> containerVersion()  
      com.pulumi.core.Output<java.lang.String> createdAt()  
      com.pulumi.core.Output<java.lang.Integer> createTimeout()  
      com.pulumi.core.Output<java.lang.String> discoveryUrl()  
      com.pulumi.core.Output<java.lang.Integer> dockerVolumeSize()  
      com.pulumi.core.Output<java.lang.String> fixedNetwork()  
      com.pulumi.core.Output<java.lang.String> fixedSubnet()  
      com.pulumi.core.Output<java.lang.String> flavor()  
      com.pulumi.core.Output<java.lang.Boolean> floatingIpEnabled()  
      static Cluster get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ClusterState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> keypair()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> kubeconfig()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Object>> labels()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> masterAddresses()  
      com.pulumi.core.Output<java.lang.Integer> masterCount()  
      com.pulumi.core.Output<java.lang.String> masterFlavor()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> mergeLabels()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> nodeAddresses()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> nodeCount()  
      com.pulumi.core.Output<java.lang.String> projectId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> stackId()  
      com.pulumi.core.Output<java.lang.String> updatedAt()  
      com.pulumi.core.Output<java.lang.String> userId()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Cluster

        public Cluster​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Cluster

        public Cluster​(java.lang.String name,
               ClusterArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Cluster

        public Cluster​(java.lang.String name,
               ClusterArgs args,
               @Nullable
               com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • apiAddress

        public com.pulumi.core.Output<java.lang.String> apiAddress()

      • clusterTemplateId

        public com.pulumi.core.Output<java.lang.String> clusterTemplateId()
        Returns:
        The UUID of the V1 Container Infra cluster template. Changing this creates a new cluster.

      • coeVersion

        public com.pulumi.core.Output<java.lang.String> coeVersion()

      • containerVersion

        public com.pulumi.core.Output<java.lang.String> containerVersion()

      • createTimeout

        public com.pulumi.core.Output<java.lang.Integer> createTimeout()
        Returns:
        The timeout (in minutes) for creating the cluster. Changing this creates a new cluster.

      • createdAt

        public com.pulumi.core.Output<java.lang.String> createdAt()

      • discoveryUrl

        public com.pulumi.core.Output<java.lang.String> discoveryUrl()
        Returns:
        The URL used for cluster node discovery. Changing this creates a new cluster.

      • dockerVolumeSize

        public com.pulumi.core.Output<java.lang.Integer> dockerVolumeSize()
        Returns:
        The size (in GB) of the Docker volume. Changing this creates a new cluster.

      • fixedNetwork

        public com.pulumi.core.Output<java.lang.String> fixedNetwork()
        Returns:
        The fixed network that will be attached to the cluster. Changing this creates a new cluster.

      • fixedSubnet

        public com.pulumi.core.Output<java.lang.String> fixedSubnet()
        Returns:
        The fixed subnet that will be attached to the cluster. Changing this creates a new cluster.

      • flavor

        public com.pulumi.core.Output<java.lang.String> flavor()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.Boolean> floatingIpEnabled()
        Returns:
        Indicates whether floating IP should be created for every cluster node. Changing this creates a new cluster.

      • keypair

        public com.pulumi.core.Output<java.lang.String> keypair()
        Returns:
        The name of the Compute service SSH keypair. Changing this creates a new cluster.

      • kubeconfig

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> kubeconfig()

      • labels

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Object>> labels()
        Returns:
        The list of key value pairs representing additional properties of the cluster. Changing this creates a new cluster.

      • masterAddresses

        public com.pulumi.core.Output<java.util.List<java.lang.String>> masterAddresses()

      • masterCount

        public com.pulumi.core.Output<java.lang.Integer> masterCount()
        Returns:
        The number of master nodes for the cluster. Changing this creates a new cluster.

      • masterFlavor

        public com.pulumi.core.Output<java.lang.String> masterFlavor()
        Returns:
        The flavor for the master nodes. Can be set via the `OS_MAGNUM_MASTER_FLAVOR` environment variable. Changing this creates a new cluster.

      • mergeLabels

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> mergeLabels()
        Returns:
        Indicates whether the provided labels should be merged with cluster template labels. Changing this creates a new cluster.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the cluster. Changing this creates a new cluster.

      • nodeAddresses

        public com.pulumi.core.Output<java.util.List<java.lang.String>> nodeAddresses()

      • nodeCount

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> nodeCount()
        Returns:
        The number of nodes for the cluster.

      • projectId

        public com.pulumi.core.Output<java.lang.String> projectId()
        Returns:
        The project of the cluster. Required if admin wants to create a cluster in another project. Changing this creates a new cluster.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> stackId()

      • updatedAt

        public com.pulumi.core.Output<java.lang.String> updatedAt()

      • userId

        public com.pulumi.core.Output<java.lang.String> userId()
        Returns:
        The user of the cluster. Required if admin wants to create a cluster template for another user. Changing this creates a new cluster.

      • get

        public static Cluster get​(java.lang.String name,
                          com.pulumi.core.Output<java.lang.String> id,
                          @Nullable
                          ClusterState state,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.