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

openstack.containerinfra.getClusterTemplate

Explore with Pulumi AI

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

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as openstack from "@pulumi/openstack";
    
    const clustertemplate1 = openstack.containerinfra.getClusterTemplate({
        name: "clustertemplate_1",
    });
    
    import pulumi
    import pulumi_openstack as openstack
    
    clustertemplate1 = openstack.containerinfra.get_cluster_template(name="clustertemplate_1")
    
    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.LookupClusterTemplate(ctx, &containerinfra.LookupClusterTemplateArgs{
    			Name: "clustertemplate_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 clustertemplate1 = OpenStack.ContainerInfra.GetClusterTemplate.Invoke(new()
        {
            Name = "clustertemplate_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.GetClusterTemplateArgs;
    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 clustertemplate1 = ContainerinfraFunctions.getClusterTemplate(GetClusterTemplateArgs.builder()
                .name("clustertemplate_1")
                .build());
    
        }
    }
    
    variables:
      clustertemplate1:
        fn::invoke:
          Function: openstack:containerinfra:getClusterTemplate
          Arguments:
            name: clustertemplate_1
    

    Using getClusterTemplate

    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 getClusterTemplate(args: GetClusterTemplateArgs, opts?: InvokeOptions): Promise<GetClusterTemplateResult>
    function getClusterTemplateOutput(args: GetClusterTemplateOutputArgs, opts?: InvokeOptions): Output<GetClusterTemplateResult>
    def get_cluster_template(name: Optional[str] = None,
                             region: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetClusterTemplateResult
    def get_cluster_template_output(name: Optional[pulumi.Input[str]] = None,
                             region: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetClusterTemplateResult]
    func LookupClusterTemplate(ctx *Context, args *LookupClusterTemplateArgs, opts ...InvokeOption) (*LookupClusterTemplateResult, error)
    func LookupClusterTemplateOutput(ctx *Context, args *LookupClusterTemplateOutputArgs, opts ...InvokeOption) LookupClusterTemplateResultOutput

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

    public static class GetClusterTemplate 
    {
        public static Task<GetClusterTemplateResult> InvokeAsync(GetClusterTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterTemplateResult> Invoke(GetClusterTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClusterTemplateResult> getClusterTemplate(GetClusterTemplateArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: openstack:containerinfra/getClusterTemplate:getClusterTemplate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the cluster template.
    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 template.
    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 template.
    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 template.
    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 template.
    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 template.
    region String
    The region in which to obtain the V1 Container Infra client. If omitted, the region argument of the provider is used.

    getClusterTemplate Result

    The following output properties are available:

    ApiserverPort int
    The API server port for the Container Orchestration Engine for this cluster template.
    ClusterDistro string
    The distro for the cluster (fedora-atomic, coreos, etc.).
    Coe string
    The Container Orchestration Engine for this cluster template.
    CreatedAt string
    The time at which cluster template was created.
    DnsNameserver string
    Address of the DNS nameserver that is used in nodes of the cluster.
    DockerStorageDriver string
    Docker storage driver. Changing this updates the Docker storage driver of the existing cluster template.
    DockerVolumeSize int
    The size (in GB) of the Docker volume.
    ExternalNetworkId string
    The ID of the external network that will be used for the cluster.
    FixedNetwork string
    The fixed network that will be attached to the cluster.
    FixedSubnet string
    =The fixed subnet that will be attached to the cluster.
    Flavor string
    The flavor for the nodes of the cluster.
    FloatingIpEnabled bool
    Indicates whether created cluster should create IP floating IP for every node or not.
    Hidden bool
    Indicates whether the ClusterTemplate is hidden or not.
    HttpProxy string
    The address of a proxy for receiving all HTTP requests and relay them.
    HttpsProxy string
    The address of a proxy for receiving all HTTPS requests and relay them.
    Id string
    The provider-assigned unique ID for this managed resource.
    Image string
    The reference to an image that is used for nodes of the cluster.
    InsecureRegistry string
    The insecure registry URL for the cluster template.
    KeypairId string
    The name of the Compute service SSH keypair.
    Labels Dictionary<string, object>
    The list of key value pairs representing additional properties of the cluster template.
    MasterFlavor string
    The flavor for the master nodes.
    MasterLbEnabled bool
    Indicates whether created cluster should has a loadbalancer for master nodes or not.
    Name string
    See Argument Reference above.
    NetworkDriver string
    The name of the driver for the container network.
    NoProxy string
    A comma-separated list of IP addresses that shouldn't be used in the cluster.
    ProjectId string
    The project of the cluster template.
    Public bool
    Indicates whether cluster template should be public.
    Region string
    See Argument Reference above.
    RegistryEnabled bool
    Indicates whether Docker registry is enabled in the cluster.
    ServerType string
    The server type for the cluster template.
    TlsDisabled bool
    Indicates whether the TLS should be disabled in the cluster.
    UpdatedAt string
    The time at which cluster template was updated.
    UserId string
    The user of the cluster template.
    VolumeDriver string
    The name of the driver that is used for the volumes of the cluster nodes.
    ApiserverPort int
    The API server port for the Container Orchestration Engine for this cluster template.
    ClusterDistro string
    The distro for the cluster (fedora-atomic, coreos, etc.).
    Coe string
    The Container Orchestration Engine for this cluster template.
    CreatedAt string
    The time at which cluster template was created.
    DnsNameserver string
    Address of the DNS nameserver that is used in nodes of the cluster.
    DockerStorageDriver string
    Docker storage driver. Changing this updates the Docker storage driver of the existing cluster template.
    DockerVolumeSize int
    The size (in GB) of the Docker volume.
    ExternalNetworkId string
    The ID of the external network that will be used for the cluster.
    FixedNetwork string
    The fixed network that will be attached to the cluster.
    FixedSubnet string
    =The fixed subnet that will be attached to the cluster.
    Flavor string
    The flavor for the nodes of the cluster.
    FloatingIpEnabled bool
    Indicates whether created cluster should create IP floating IP for every node or not.
    Hidden bool
    Indicates whether the ClusterTemplate is hidden or not.
    HttpProxy string
    The address of a proxy for receiving all HTTP requests and relay them.
    HttpsProxy string
    The address of a proxy for receiving all HTTPS requests and relay them.
    Id string
    The provider-assigned unique ID for this managed resource.
    Image string
    The reference to an image that is used for nodes of the cluster.
    InsecureRegistry string
    The insecure registry URL for the cluster template.
    KeypairId string
    The name of the Compute service SSH keypair.
    Labels map[string]interface{}
    The list of key value pairs representing additional properties of the cluster template.
    MasterFlavor string
    The flavor for the master nodes.
    MasterLbEnabled bool
    Indicates whether created cluster should has a loadbalancer for master nodes or not.
    Name string
    See Argument Reference above.
    NetworkDriver string
    The name of the driver for the container network.
    NoProxy string
    A comma-separated list of IP addresses that shouldn't be used in the cluster.
    ProjectId string
    The project of the cluster template.
    Public bool
    Indicates whether cluster template should be public.
    Region string
    See Argument Reference above.
    RegistryEnabled bool
    Indicates whether Docker registry is enabled in the cluster.
    ServerType string
    The server type for the cluster template.
    TlsDisabled bool
    Indicates whether the TLS should be disabled in the cluster.
    UpdatedAt string
    The time at which cluster template was updated.
    UserId string
    The user of the cluster template.
    VolumeDriver string
    The name of the driver that is used for the volumes of the cluster nodes.
    apiserverPort Integer
    The API server port for the Container Orchestration Engine for this cluster template.
    clusterDistro String
    The distro for the cluster (fedora-atomic, coreos, etc.).
    coe String
    The Container Orchestration Engine for this cluster template.
    createdAt String
    The time at which cluster template was created.
    dnsNameserver String
    Address of the DNS nameserver that is used in nodes of the cluster.
    dockerStorageDriver String
    Docker storage driver. Changing this updates the Docker storage driver of the existing cluster template.
    dockerVolumeSize Integer
    The size (in GB) of the Docker volume.
    externalNetworkId String
    The ID of the external network that will be used for the cluster.
    fixedNetwork String
    The fixed network that will be attached to the cluster.
    fixedSubnet String
    =The fixed subnet that will be attached to the cluster.
    flavor String
    The flavor for the nodes of the cluster.
    floatingIpEnabled Boolean
    Indicates whether created cluster should create IP floating IP for every node or not.
    hidden Boolean
    Indicates whether the ClusterTemplate is hidden or not.
    httpProxy String
    The address of a proxy for receiving all HTTP requests and relay them.
    httpsProxy String
    The address of a proxy for receiving all HTTPS requests and relay them.
    id String
    The provider-assigned unique ID for this managed resource.
    image String
    The reference to an image that is used for nodes of the cluster.
    insecureRegistry String
    The insecure registry URL for the cluster template.
    keypairId String
    The name of the Compute service SSH keypair.
    labels Map<String,Object>
    The list of key value pairs representing additional properties of the cluster template.
    masterFlavor String
    The flavor for the master nodes.
    masterLbEnabled Boolean
    Indicates whether created cluster should has a loadbalancer for master nodes or not.
    name String
    See Argument Reference above.
    networkDriver String
    The name of the driver for the container network.
    noProxy String
    A comma-separated list of IP addresses that shouldn't be used in the cluster.
    projectId String
    The project of the cluster template.
    public_ Boolean
    Indicates whether cluster template should be public.
    region String
    See Argument Reference above.
    registryEnabled Boolean
    Indicates whether Docker registry is enabled in the cluster.
    serverType String
    The server type for the cluster template.
    tlsDisabled Boolean
    Indicates whether the TLS should be disabled in the cluster.
    updatedAt String
    The time at which cluster template was updated.
    userId String
    The user of the cluster template.
    volumeDriver String
    The name of the driver that is used for the volumes of the cluster nodes.
    apiserverPort number
    The API server port for the Container Orchestration Engine for this cluster template.
    clusterDistro string
    The distro for the cluster (fedora-atomic, coreos, etc.).
    coe string
    The Container Orchestration Engine for this cluster template.
    createdAt string
    The time at which cluster template was created.
    dnsNameserver string
    Address of the DNS nameserver that is used in nodes of the cluster.
    dockerStorageDriver string
    Docker storage driver. Changing this updates the Docker storage driver of the existing cluster template.
    dockerVolumeSize number
    The size (in GB) of the Docker volume.
    externalNetworkId string
    The ID of the external network that will be used for the cluster.
    fixedNetwork string
    The fixed network that will be attached to the cluster.
    fixedSubnet string
    =The fixed subnet that will be attached to the cluster.
    flavor string
    The flavor for the nodes of the cluster.
    floatingIpEnabled boolean
    Indicates whether created cluster should create IP floating IP for every node or not.
    hidden boolean
    Indicates whether the ClusterTemplate is hidden or not.
    httpProxy string
    The address of a proxy for receiving all HTTP requests and relay them.
    httpsProxy string
    The address of a proxy for receiving all HTTPS requests and relay them.
    id string
    The provider-assigned unique ID for this managed resource.
    image string
    The reference to an image that is used for nodes of the cluster.
    insecureRegistry string
    The insecure registry URL for the cluster template.
    keypairId string
    The name of the Compute service SSH keypair.
    labels {[key: string]: any}
    The list of key value pairs representing additional properties of the cluster template.
    masterFlavor string
    The flavor for the master nodes.
    masterLbEnabled boolean
    Indicates whether created cluster should has a loadbalancer for master nodes or not.
    name string
    See Argument Reference above.
    networkDriver string
    The name of the driver for the container network.
    noProxy string
    A comma-separated list of IP addresses that shouldn't be used in the cluster.
    projectId string
    The project of the cluster template.
    public boolean
    Indicates whether cluster template should be public.
    region string
    See Argument Reference above.
    registryEnabled boolean
    Indicates whether Docker registry is enabled in the cluster.
    serverType string
    The server type for the cluster template.
    tlsDisabled boolean
    Indicates whether the TLS should be disabled in the cluster.
    updatedAt string
    The time at which cluster template was updated.
    userId string
    The user of the cluster template.
    volumeDriver string
    The name of the driver that is used for the volumes of the cluster nodes.
    apiserver_port int
    The API server port for the Container Orchestration Engine for this cluster template.
    cluster_distro str
    The distro for the cluster (fedora-atomic, coreos, etc.).
    coe str
    The Container Orchestration Engine for this cluster template.
    created_at str
    The time at which cluster template was created.
    dns_nameserver str
    Address of the DNS nameserver that is used in nodes of the cluster.
    docker_storage_driver str
    Docker storage driver. Changing this updates the Docker storage driver of the existing cluster template.
    docker_volume_size int
    The size (in GB) of the Docker volume.
    external_network_id str
    The ID of the external network that will be used for the cluster.
    fixed_network str
    The fixed network that will be attached to the cluster.
    fixed_subnet str
    =The fixed subnet that will be attached to the cluster.
    flavor str
    The flavor for the nodes of the cluster.
    floating_ip_enabled bool
    Indicates whether created cluster should create IP floating IP for every node or not.
    hidden bool
    Indicates whether the ClusterTemplate is hidden or not.
    http_proxy str
    The address of a proxy for receiving all HTTP requests and relay them.
    https_proxy str
    The address of a proxy for receiving all HTTPS requests and relay them.
    id str
    The provider-assigned unique ID for this managed resource.
    image str
    The reference to an image that is used for nodes of the cluster.
    insecure_registry str
    The insecure registry URL for the cluster template.
    keypair_id str
    The name of the Compute service SSH keypair.
    labels Mapping[str, Any]
    The list of key value pairs representing additional properties of the cluster template.
    master_flavor str
    The flavor for the master nodes.
    master_lb_enabled bool
    Indicates whether created cluster should has a loadbalancer for master nodes or not.
    name str
    See Argument Reference above.
    network_driver str
    The name of the driver for the container network.
    no_proxy str
    A comma-separated list of IP addresses that shouldn't be used in the cluster.
    project_id str
    The project of the cluster template.
    public bool
    Indicates whether cluster template should be public.
    region str
    See Argument Reference above.
    registry_enabled bool
    Indicates whether Docker registry is enabled in the cluster.
    server_type str
    The server type for the cluster template.
    tls_disabled bool
    Indicates whether the TLS should be disabled in the cluster.
    updated_at str
    The time at which cluster template was updated.
    user_id str
    The user of the cluster template.
    volume_driver str
    The name of the driver that is used for the volumes of the cluster nodes.
    apiserverPort Number
    The API server port for the Container Orchestration Engine for this cluster template.
    clusterDistro String
    The distro for the cluster (fedora-atomic, coreos, etc.).
    coe String
    The Container Orchestration Engine for this cluster template.
    createdAt String
    The time at which cluster template was created.
    dnsNameserver String
    Address of the DNS nameserver that is used in nodes of the cluster.
    dockerStorageDriver String
    Docker storage driver. Changing this updates the Docker storage driver of the existing cluster template.
    dockerVolumeSize Number
    The size (in GB) of the Docker volume.
    externalNetworkId String
    The ID of the external network that will be used for the cluster.
    fixedNetwork String
    The fixed network that will be attached to the cluster.
    fixedSubnet String
    =The fixed subnet that will be attached to the cluster.
    flavor String
    The flavor for the nodes of the cluster.
    floatingIpEnabled Boolean
    Indicates whether created cluster should create IP floating IP for every node or not.
    hidden Boolean
    Indicates whether the ClusterTemplate is hidden or not.
    httpProxy String
    The address of a proxy for receiving all HTTP requests and relay them.
    httpsProxy String
    The address of a proxy for receiving all HTTPS requests and relay them.
    id String
    The provider-assigned unique ID for this managed resource.
    image String
    The reference to an image that is used for nodes of the cluster.
    insecureRegistry String
    The insecure registry URL for the cluster template.
    keypairId String
    The name of the Compute service SSH keypair.
    labels Map<Any>
    The list of key value pairs representing additional properties of the cluster template.
    masterFlavor String
    The flavor for the master nodes.
    masterLbEnabled Boolean
    Indicates whether created cluster should has a loadbalancer for master nodes or not.
    name String
    See Argument Reference above.
    networkDriver String
    The name of the driver for the container network.
    noProxy String
    A comma-separated list of IP addresses that shouldn't be used in the cluster.
    projectId String
    The project of the cluster template.
    public Boolean
    Indicates whether cluster template should be public.
    region String
    See Argument Reference above.
    registryEnabled Boolean
    Indicates whether Docker registry is enabled in the cluster.
    serverType String
    The server type for the cluster template.
    tlsDisabled Boolean
    Indicates whether the TLS should be disabled in the cluster.
    updatedAt String
    The time at which cluster template was updated.
    userId String
    The user of the cluster template.
    volumeDriver String
    The name of the driver that is used for the volumes of the cluster nodes.

    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