Rancher 2 v4.0.0, Apr 20 23

rancher2.getClusterV2

Explore with Pulumi AI

Use this data source to retrieve information about a Rancher v2 cluster.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    var foo = Rancher2.GetClusterV2.Invoke(new()
    {
        FleetNamespace = "fleet-ns",
        Name = "foo",
    });

});

package main

import (
	"github.com/pulumi/pulumi-rancher2/sdk/v4/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.LookupClusterV2(ctx, &rancher2.LookupClusterV2Args{
			FleetNamespace: pulumi.StringRef("fleet-ns"),
			Name:           "foo",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.Rancher2Functions;
import com.pulumi.rancher2.inputs.GetClusterV2Args;
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 foo = Rancher2Functions.getClusterV2(GetClusterV2Args.builder()
            .fleetNamespace("fleet-ns")
            .name("foo")
            .build());

    }
}

import pulumi
import pulumi_rancher2 as rancher2

foo = rancher2.get_cluster_v2(fleet_namespace="fleet-ns",
    name="foo")

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

const foo = rancher2.getClusterV2({
    fleetNamespace: "fleet-ns",
    name: "foo",
});

variables:
  foo:
    fn::invoke:
      Function: rancher2:getClusterV2
      Arguments:
        fleetNamespace: fleet-ns
        name: foo

Using getClusterV2

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 getClusterV2(args: GetClusterV2Args, opts?: InvokeOptions): Promise<GetClusterV2Result>
function getClusterV2Output(args: GetClusterV2OutputArgs, opts?: InvokeOptions): Output<GetClusterV2Result>

def get_cluster_v2(fleet_namespace: Optional[str] = None,
                   name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetClusterV2Result
def get_cluster_v2_output(fleet_namespace: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetClusterV2Result]

func LookupClusterV2(ctx *Context, args *LookupClusterV2Args, opts ...InvokeOption) (*LookupClusterV2Result, error)
func LookupClusterV2Output(ctx *Context, args *LookupClusterV2OutputArgs, opts ...InvokeOption) LookupClusterV2ResultOutput

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

public static class GetClusterV2 
{
    public static Task<GetClusterV2Result> InvokeAsync(GetClusterV2Args args, InvokeOptions? opts = null)
    public static Output<GetClusterV2Result> Invoke(GetClusterV2InvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClusterV2Result> getClusterV2(GetClusterV2Args args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: rancher2:index/getClusterV2:getClusterV2
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the Cluster v2 (string)
FleetNamespace string: The fleet namespace of the Cluster v2. Default: \"fleet-default\" (string)

Name string: The name of the Cluster v2 (string)
FleetNamespace string: The fleet namespace of the Cluster v2. Default: \"fleet-default\" (string)

name String: The name of the Cluster v2 (string)
fleetNamespace String: The fleet namespace of the Cluster v2. Default: \"fleet-default\" (string)

name string: The name of the Cluster v2 (string)
fleetNamespace string: The fleet namespace of the Cluster v2. Default: \"fleet-default\" (string)

name str: The name of the Cluster v2 (string)
fleet_namespace str: The fleet namespace of the Cluster v2. Default: \"fleet-default\" (string)

name String: The name of the Cluster v2 (string)
fleetNamespace String: The fleet namespace of the Cluster v2. Default: \"fleet-default\" (string)

getClusterV2 Result

The following output properties are available:

AgentEnvVars List<GetClusterV2AgentEnvVar>: (Computed) Optional Agent Env Vars for Rancher agent (list)
Annotations Dictionary<string, object>
CloudCredentialSecretName string: (Computed) Cluster V2 cloud credential secret name (string)
ClusterRegistrationToken GetClusterV2ClusterRegistrationToken: (Computed/Sensitive) Cluster Registration Token generated for the cluster v2 (list maxitems:1)
ClusterV1Id string: (Computed) Cluster v1 id for cluster v2 (string)
DefaultClusterRoleForProjectMembers string: (Computed) Cluster V2 default cluster role for project members (string)
DefaultPodSecurityPolicyTemplateName string: (Computed) Cluster V2 default pod security policy template name (string)
EnableNetworkPolicy bool: (Computed) Enable k8s network policy at Cluster V2 (bool)
Id string: The provider-assigned unique ID for this managed resource.
KubeConfig string: (Computed/Sensitive) Kube Config generated for the cluster v2 (string)
KubernetesVersion string: (Computed) The kubernetes version of the Cluster v2 (list maxitems:1)
Labels Dictionary<string, object>
Name string
ResourceVersion string: (Computed) Cluster v2 k8s resource version (string)
RkeConfig GetClusterV2RkeConfig: (Computed) The RKE configuration for k3s and rke2 Clusters v2. (list maxitems:1)
FleetNamespace string

AgentEnvVars []GetClusterV2AgentEnvVar: (Computed) Optional Agent Env Vars for Rancher agent (list)
Annotations map[string]interface{}
CloudCredentialSecretName string: (Computed) Cluster V2 cloud credential secret name (string)
ClusterRegistrationToken GetClusterV2ClusterRegistrationToken: (Computed/Sensitive) Cluster Registration Token generated for the cluster v2 (list maxitems:1)
ClusterV1Id string: (Computed) Cluster v1 id for cluster v2 (string)
DefaultClusterRoleForProjectMembers string: (Computed) Cluster V2 default cluster role for project members (string)
DefaultPodSecurityPolicyTemplateName string: (Computed) Cluster V2 default pod security policy template name (string)
EnableNetworkPolicy bool: (Computed) Enable k8s network policy at Cluster V2 (bool)
Id string: The provider-assigned unique ID for this managed resource.
KubeConfig string: (Computed/Sensitive) Kube Config generated for the cluster v2 (string)
KubernetesVersion string: (Computed) The kubernetes version of the Cluster v2 (list maxitems:1)
Labels map[string]interface{}
Name string
ResourceVersion string: (Computed) Cluster v2 k8s resource version (string)
RkeConfig GetClusterV2RkeConfig: (Computed) The RKE configuration for k3s and rke2 Clusters v2. (list maxitems:1)
FleetNamespace string

agentEnvVars List<GetClusterV2AgentEnvVar>: (Computed) Optional Agent Env Vars for Rancher agent (list)
annotations Map<String,Object>
cloudCredentialSecretName String: (Computed) Cluster V2 cloud credential secret name (string)
clusterRegistrationToken GetClusterV2ClusterRegistrationToken: (Computed/Sensitive) Cluster Registration Token generated for the cluster v2 (list maxitems:1)
clusterV1Id String: (Computed) Cluster v1 id for cluster v2 (string)
defaultClusterRoleForProjectMembers String: (Computed) Cluster V2 default cluster role for project members (string)
defaultPodSecurityPolicyTemplateName String: (Computed) Cluster V2 default pod security policy template name (string)
enableNetworkPolicy Boolean: (Computed) Enable k8s network policy at Cluster V2 (bool)
id String: The provider-assigned unique ID for this managed resource.
kubeConfig String: (Computed/Sensitive) Kube Config generated for the cluster v2 (string)
kubernetesVersion String: (Computed) The kubernetes version of the Cluster v2 (list maxitems:1)
labels Map<String,Object>
name String
resourceVersion String: (Computed) Cluster v2 k8s resource version (string)
rkeConfig GetClusterV2RkeConfig: (Computed) The RKE configuration for k3s and rke2 Clusters v2. (list maxitems:1)
fleetNamespace String

agentEnvVars GetClusterV2AgentEnvVar[]: (Computed) Optional Agent Env Vars for Rancher agent (list)
annotations {[key: string]: any}
cloudCredentialSecretName string: (Computed) Cluster V2 cloud credential secret name (string)
clusterRegistrationToken GetClusterV2ClusterRegistrationToken: (Computed/Sensitive) Cluster Registration Token generated for the cluster v2 (list maxitems:1)
clusterV1Id string: (Computed) Cluster v1 id for cluster v2 (string)
defaultClusterRoleForProjectMembers string: (Computed) Cluster V2 default cluster role for project members (string)
defaultPodSecurityPolicyTemplateName string: (Computed) Cluster V2 default pod security policy template name (string)
enableNetworkPolicy boolean: (Computed) Enable k8s network policy at Cluster V2 (bool)
id string: The provider-assigned unique ID for this managed resource.
kubeConfig string: (Computed/Sensitive) Kube Config generated for the cluster v2 (string)
kubernetesVersion string: (Computed) The kubernetes version of the Cluster v2 (list maxitems:1)
labels {[key: string]: any}
name string
resourceVersion string: (Computed) Cluster v2 k8s resource version (string)
rkeConfig GetClusterV2RkeConfig: (Computed) The RKE configuration for k3s and rke2 Clusters v2. (list maxitems:1)
fleetNamespace string

agent_env_vars Sequence[GetClusterV2AgentEnvVar]: (Computed) Optional Agent Env Vars for Rancher agent (list)
annotations Mapping[str, Any]
cloud_credential_secret_name str: (Computed) Cluster V2 cloud credential secret name (string)
cluster_registration_token GetClusterV2ClusterRegistrationToken: (Computed/Sensitive) Cluster Registration Token generated for the cluster v2 (list maxitems:1)
cluster_v1_id str: (Computed) Cluster v1 id for cluster v2 (string)
default_cluster_role_for_project_members str: (Computed) Cluster V2 default cluster role for project members (string)
default_pod_security_policy_template_name str: (Computed) Cluster V2 default pod security policy template name (string)
enable_network_policy bool: (Computed) Enable k8s network policy at Cluster V2 (bool)
id str: The provider-assigned unique ID for this managed resource.
kube_config str: (Computed/Sensitive) Kube Config generated for the cluster v2 (string)
kubernetes_version str: (Computed) The kubernetes version of the Cluster v2 (list maxitems:1)
labels Mapping[str, Any]
name str
resource_version str: (Computed) Cluster v2 k8s resource version (string)
rke_config GetClusterV2RkeConfig: (Computed) The RKE configuration for k3s and rke2 Clusters v2. (list maxitems:1)
fleet_namespace str

agentEnvVars List<Property Map>: (Computed) Optional Agent Env Vars for Rancher agent (list)
annotations Map<Any>
cloudCredentialSecretName String: (Computed) Cluster V2 cloud credential secret name (string)
clusterRegistrationToken Property Map: (Computed/Sensitive) Cluster Registration Token generated for the cluster v2 (list maxitems:1)
clusterV1Id String: (Computed) Cluster v1 id for cluster v2 (string)
defaultClusterRoleForProjectMembers String: (Computed) Cluster V2 default cluster role for project members (string)
defaultPodSecurityPolicyTemplateName String: (Computed) Cluster V2 default pod security policy template name (string)
enableNetworkPolicy Boolean: (Computed) Enable k8s network policy at Cluster V2 (bool)
id String: The provider-assigned unique ID for this managed resource.
kubeConfig String: (Computed/Sensitive) Kube Config generated for the cluster v2 (string)
kubernetesVersion String: (Computed) The kubernetes version of the Cluster v2 (list maxitems:1)
labels Map<Any>
name String
resourceVersion String: (Computed) Cluster v2 k8s resource version (string)
rkeConfig Property Map: (Computed) The RKE configuration for k3s and rke2 Clusters v2. (list maxitems:1)
fleetNamespace String