Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Openstack Provider
  3. API Docs
  4. containerinfra
  5. getCluster
OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-openstack

openstack.containerinfra.getCluster

Explore with Pulumi AI

openstack logo
OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-openstack

    Use this data source to get the ID of an available OpenStack Magnum cluster.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const cluster1 = openstack.containerinfra.getCluster({
    name: "cluster_1",
});

    import pulumi
import pulumi_openstack as openstack

cluster1 = openstack.containerinfra.get_cluster(name="cluster_1")

    package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v5/go/openstack/containerinfra"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := containerinfra.LookupCluster(ctx, &containerinfra.LookupClusterArgs{
			Name: "cluster_1",
		}, nil)
		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 = OpenStack.ContainerInfra.GetCluster.Invoke(new()
    {
        Name = "cluster_1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.containerinfra.ContainerinfraFunctions;
import com.pulumi.openstack.containerinfra.inputs.GetClusterArgs;
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) {
        final var cluster1 = ContainerinfraFunctions.getCluster(GetClusterArgs.builder()
            .name("cluster_1")
            .build());

    }
}

    variables:
  cluster1:
    fn::invoke:
      function: openstack:containerinfra:getCluster
      arguments:
        name: cluster_1

    Using getCluster

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
    def get_cluster(name: Optional[str] = None,
                region: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(name: Optional[pulumi.Input[str]] = None,
                region: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

    > Note: This function is named LookupCluster in the Go SDK.

    public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: openstack:containerinfra/getCluster:getCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the cluster.
    Region string
    The region in which to obtain the V1 Container Infra client. If omitted, the region argument of the provider is used.
    Name string
    The name of the cluster.
    Region string
    The region in which to obtain the V1 Container Infra client. If omitted, the region argument of the provider is used.
    name String
    The name of the cluster.
    region String
    The region in which to obtain the V1 Container Infra client. If omitted, the region argument of the provider is used.
    name string
    The name of the cluster.
    region string
    The region in which to obtain the V1 Container Infra client. If omitted, the region argument of the provider is used.
    name str
    The name of the cluster.
    region str
    The region in which to obtain the V1 Container Infra client. If omitted, the region argument of the provider is used.
    name String
    The name of the cluster.
    region String
    The region in which to obtain the V1 Container Infra client. If omitted, the region argument of the provider is used.

    getCluster Result

    The following output properties are available:

    ApiAddress string
    COE API address.
    ClusterTemplateId string
    The UUID of the V1 Container Infra cluster template.
    CoeVersion string
    COE software version.
    ContainerVersion string
    CreateTimeout int
    The timeout (in minutes) for creating the cluster.
    CreatedAt string
    The time at which cluster was created.
    DiscoveryUrl string
    The URL used for cluster node discovery.
    DockerVolumeSize int
    The size (in GB) of the Docker volume.
    FixedNetwork string
    The fixed network that is attached to the cluster.
    FixedSubnet string
    The fixed subnet that is attached to the cluster.
    Flavor string
    The flavor for the nodes of the cluster.
    FloatingIpEnabled bool
    Id string
    The provider-assigned unique ID for this managed resource.
    Keypair string
    The name of the Compute service SSH keypair.
    Kubeconfig Dictionary<string, string>
    The Kubernetes cluster's credentials
    Labels Dictionary<string, string>
    The list of key value pairs representing additional properties of the cluster.
    MasterAddresses List<string>
    IP addresses of the master node of the cluster.
    MasterCount int
    The number of master nodes for the cluster.
    MasterFlavor string
    The flavor for the master nodes.
    MasterLbEnabled bool
    Whether a load balancer is created for the master cluster nodes.
    Name string
    See Argument Reference above.
    NodeAddresses List<string>
    IP addresses of the node of the cluster.
    NodeCount int
    The number of nodes for the cluster.
    ProjectId string
    The project of the cluster.
    Region string
    See Argument Reference above.
    StackId string
    UUID of the Orchestration service stack.
    UpdatedAt string
    The time at which cluster was updated.
    UserId string
    The user of the cluster.
    ApiAddress string
    COE API address.
    ClusterTemplateId string
    The UUID of the V1 Container Infra cluster template.
    CoeVersion string
    COE software version.
    ContainerVersion string
    CreateTimeout int
    The timeout (in minutes) for creating the cluster.
    CreatedAt string
    The time at which cluster was created.
    DiscoveryUrl string
    The URL used for cluster node discovery.
    DockerVolumeSize int
    The size (in GB) of the Docker volume.
    FixedNetwork string
    The fixed network that is attached to the cluster.
    FixedSubnet string
    The fixed subnet that is attached to the cluster.
    Flavor string
    The flavor for the nodes of the cluster.
    FloatingIpEnabled bool
    Id string
    The provider-assigned unique ID for this managed resource.
    Keypair string
    The name of the Compute service SSH keypair.
    Kubeconfig map[string]string
    The Kubernetes cluster's credentials
    Labels map[string]string
    The list of key value pairs representing additional properties of the cluster.
    MasterAddresses []string
    IP addresses of the master node of the cluster.
    MasterCount int
    The number of master nodes for the cluster.
    MasterFlavor string
    The flavor for the master nodes.
    MasterLbEnabled bool
    Whether a load balancer is created for the master cluster nodes.
    Name string
    See Argument Reference above.
    NodeAddresses []string
    IP addresses of the node of the cluster.
    NodeCount int
    The number of nodes for the cluster.
    ProjectId string
    The project of the cluster.
    Region string
    See Argument Reference above.
    StackId string
    UUID of the Orchestration service stack.
    UpdatedAt string
    The time at which cluster was updated.
    UserId string
    The user of the cluster.
    apiAddress String
    COE API address.
    clusterTemplateId String
    The UUID of the V1 Container Infra cluster template.
    coeVersion String
    COE software version.
    containerVersion String
    createTimeout Integer
    The timeout (in minutes) for creating the cluster.
    createdAt String
    The time at which cluster was created.
    discoveryUrl String
    The URL used for cluster node discovery.
    dockerVolumeSize Integer
    The size (in GB) of the Docker volume.
    fixedNetwork String
    The fixed network that is attached to the cluster.
    fixedSubnet String
    The fixed subnet that is attached to the cluster.
    flavor String
    The flavor for the nodes of the cluster.
    floatingIpEnabled Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    keypair String
    The name of the Compute service SSH keypair.
    kubeconfig Map<String,String>
    The Kubernetes cluster's credentials
    labels Map<String,String>
    The list of key value pairs representing additional properties of the cluster.
    masterAddresses List<String>
    IP addresses of the master node of the cluster.
    masterCount Integer
    The number of master nodes for the cluster.
    masterFlavor String
    The flavor for the master nodes.
    masterLbEnabled Boolean
    Whether a load balancer is created for the master cluster nodes.
    name String
    See Argument Reference above.
    nodeAddresses List<String>
    IP addresses of the node of the cluster.
    nodeCount Integer
    The number of nodes for the cluster.
    projectId String
    The project of the cluster.
    region String
    See Argument Reference above.
    stackId String
    UUID of the Orchestration service stack.
    updatedAt String
    The time at which cluster was updated.
    userId String
    The user of the cluster.
    apiAddress string
    COE API address.
    clusterTemplateId string
    The UUID of the V1 Container Infra cluster template.
    coeVersion string
    COE software version.
    containerVersion string
    createTimeout number
    The timeout (in minutes) for creating the cluster.
    createdAt string
    The time at which cluster was created.
    discoveryUrl string
    The URL used for cluster node discovery.
    dockerVolumeSize number
    The size (in GB) of the Docker volume.
    fixedNetwork string
    The fixed network that is attached to the cluster.
    fixedSubnet string
    The fixed subnet that is attached to the cluster.
    flavor string
    The flavor for the nodes of the cluster.
    floatingIpEnabled boolean
    id string
    The provider-assigned unique ID for this managed resource.
    keypair string
    The name of the Compute service SSH keypair.
    kubeconfig {[key: string]: string}
    The Kubernetes cluster's credentials
    labels {[key: string]: string}
    The list of key value pairs representing additional properties of the cluster.
    masterAddresses string[]
    IP addresses of the master node of the cluster.
    masterCount number
    The number of master nodes for the cluster.
    masterFlavor string
    The flavor for the master nodes.
    masterLbEnabled boolean
    Whether a load balancer is created for the master cluster nodes.
    name string
    See Argument Reference above.
    nodeAddresses string[]
    IP addresses of the node of the cluster.
    nodeCount number
    The number of nodes for the cluster.
    projectId string
    The project of the cluster.
    region string
    See Argument Reference above.
    stackId string
    UUID of the Orchestration service stack.
    updatedAt string
    The time at which cluster was updated.
    userId string
    The user of the cluster.
    api_address str
    COE API address.
    cluster_template_id str
    The UUID of the V1 Container Infra cluster template.
    coe_version str
    COE software version.
    container_version str
    create_timeout int
    The timeout (in minutes) for creating the cluster.
    created_at str
    The time at which cluster was created.
    discovery_url str
    The URL used for cluster node discovery.
    docker_volume_size int
    The size (in GB) of the Docker volume.
    fixed_network str
    The fixed network that is attached to the cluster.
    fixed_subnet str
    The fixed subnet that is attached to the cluster.
    flavor str
    The flavor for the nodes of the cluster.
    floating_ip_enabled bool
    id str
    The provider-assigned unique ID for this managed resource.
    keypair str
    The name of the Compute service SSH keypair.
    kubeconfig Mapping[str, str]
    The Kubernetes cluster's credentials
    labels Mapping[str, str]
    The list of key value pairs representing additional properties of the cluster.
    master_addresses Sequence[str]
    IP addresses of the master node of the cluster.
    master_count int
    The number of master nodes for the cluster.
    master_flavor str
    The flavor for the master nodes.
    master_lb_enabled bool
    Whether a load balancer is created for the master cluster nodes.
    name str
    See Argument Reference above.
    node_addresses Sequence[str]
    IP addresses of the node of the cluster.
    node_count int
    The number of nodes for the cluster.
    project_id str
    The project of the cluster.
    region str
    See Argument Reference above.
    stack_id str
    UUID of the Orchestration service stack.
    updated_at str
    The time at which cluster was updated.
    user_id str
    The user of the cluster.
    apiAddress String
    COE API address.
    clusterTemplateId String
    The UUID of the V1 Container Infra cluster template.
    coeVersion String
    COE software version.
    containerVersion String
    createTimeout Number
    The timeout (in minutes) for creating the cluster.
    createdAt String
    The time at which cluster was created.
    discoveryUrl String
    The URL used for cluster node discovery.
    dockerVolumeSize Number
    The size (in GB) of the Docker volume.
    fixedNetwork String
    The fixed network that is attached to the cluster.
    fixedSubnet String
    The fixed subnet that is attached to the cluster.
    flavor String
    The flavor for the nodes of the cluster.
    floatingIpEnabled Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    keypair String
    The name of the Compute service SSH keypair.
    kubeconfig Map<String>
    The Kubernetes cluster's credentials
    labels Map<String>
    The list of key value pairs representing additional properties of the cluster.
    masterAddresses List<String>
    IP addresses of the master node of the cluster.
    masterCount Number
    The number of master nodes for the cluster.
    masterFlavor String
    The flavor for the master nodes.
    masterLbEnabled Boolean
    Whether a load balancer is created for the master cluster nodes.
    name String
    See Argument Reference above.
    nodeAddresses List<String>
    IP addresses of the node of the cluster.
    nodeCount Number
    The number of nodes for the cluster.
    projectId String
    The project of the cluster.
    region String
    See Argument Reference above.
    stackId String
    UUID of the Orchestration service stack.
    updatedAt String
    The time at which cluster was updated.
    userId String
    The user of the cluster.

    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 v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi
    pulumi/pulumi-openstack