Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Talos Linux
  3. API Docs
  4. cluster
  5. getKubeconfig
talos v0.5.2 published on Thursday, Jan 23, 2025 by Pulumiverse
pulumiverse/pulumi-talos

talos.cluster.getKubeconfig

Explore with Pulumi AI

talos logo
talos v0.5.2 published on Thursday, Jan 23, 2025 by Pulumiverse
pulumiverse/pulumi-talos

    Retrieves the kubeconfig for a Talos cluster

    Using getKubeconfig

    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 getKubeconfig(args: GetKubeconfigArgs, opts?: InvokeOptions): Promise<GetKubeconfigResult>
function getKubeconfigOutput(args: GetKubeconfigOutputArgs, opts?: InvokeOptions): Output<GetKubeconfigResult>
    def get_kubeconfig(client_configuration: Optional[GetKubeconfigClientConfiguration] = None,
                   endpoint: Optional[str] = None,
                   node: Optional[str] = None,
                   timeouts: Optional[GetKubeconfigTimeouts] = None,
                   wait: Optional[bool] = None,
                   opts: Optional[InvokeOptions] = None) -> GetKubeconfigResult
def get_kubeconfig_output(client_configuration: Optional[pulumi.Input[GetKubeconfigClientConfigurationArgs]] = None,
                   endpoint: Optional[pulumi.Input[str]] = None,
                   node: Optional[pulumi.Input[str]] = None,
                   timeouts: Optional[pulumi.Input[GetKubeconfigTimeoutsArgs]] = None,
                   wait: Optional[pulumi.Input[bool]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetKubeconfigResult]
    func LookupKubeconfig(ctx *Context, args *LookupKubeconfigArgs, opts ...InvokeOption) (*LookupKubeconfigResult, error)
func LookupKubeconfigOutput(ctx *Context, args *LookupKubeconfigOutputArgs, opts ...InvokeOption) LookupKubeconfigResultOutput

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

    public static class GetKubeconfig 
{
    public static Task<GetKubeconfigResult> InvokeAsync(GetKubeconfigArgs args, InvokeOptions? opts = null)
    public static Output<GetKubeconfigResult> Invoke(GetKubeconfigInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKubeconfigResult> getKubeconfig(GetKubeconfigArgs args, InvokeOptions options)
public static Output<GetKubeconfigResult> getKubeconfig(GetKubeconfigArgs args, InvokeOptions options)

    fn::invoke:
  function: talos:cluster/getKubeconfig:getKubeconfig
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClientConfiguration Pulumiverse.Talos.Cluster.Inputs.GetKubeconfigClientConfiguration
    The client configuration data
    Node string
    controlplane node to retrieve the kubeconfig from
    Endpoint string
    endpoint to use for the talosclient. If not set, the node value will be used
    Timeouts Pulumiverse.Talos.Cluster.Inputs.GetKubeconfigTimeouts
    Wait bool
    Wait for the kubernetes api to be available

    Deprecated: This attribute is deprecated and no-op. Will be removed in a future version. Use talos.cluster.getHealth instead.

    ClientConfiguration GetKubeconfigClientConfiguration
    The client configuration data
    Node string
    controlplane node to retrieve the kubeconfig from
    Endpoint string
    endpoint to use for the talosclient. If not set, the node value will be used
    Timeouts GetKubeconfigTimeouts
    Wait bool
    Wait for the kubernetes api to be available

    Deprecated: This attribute is deprecated and no-op. Will be removed in a future version. Use talos.cluster.getHealth instead.

    clientConfiguration GetKubeconfigClientConfiguration
    The client configuration data
    node String
    controlplane node to retrieve the kubeconfig from
    endpoint String
    endpoint to use for the talosclient. If not set, the node value will be used
    timeouts GetKubeconfigTimeouts
    wait_ Boolean
    Wait for the kubernetes api to be available

    Deprecated: This attribute is deprecated and no-op. Will be removed in a future version. Use talos.cluster.getHealth instead.

    clientConfiguration GetKubeconfigClientConfiguration
    The client configuration data
    node string
    controlplane node to retrieve the kubeconfig from
    endpoint string
    endpoint to use for the talosclient. If not set, the node value will be used
    timeouts GetKubeconfigTimeouts
    wait boolean
    Wait for the kubernetes api to be available

    Deprecated: This attribute is deprecated and no-op. Will be removed in a future version. Use talos.cluster.getHealth instead.

    client_configuration GetKubeconfigClientConfiguration
    The client configuration data
    node str
    controlplane node to retrieve the kubeconfig from
    endpoint str
    endpoint to use for the talosclient. If not set, the node value will be used
    timeouts GetKubeconfigTimeouts
    wait bool
    Wait for the kubernetes api to be available

    Deprecated: This attribute is deprecated and no-op. Will be removed in a future version. Use talos.cluster.getHealth instead.

    clientConfiguration Property Map
    The client configuration data
    node String
    controlplane node to retrieve the kubeconfig from
    endpoint String
    endpoint to use for the talosclient. If not set, the node value will be used
    timeouts Property Map
    wait Boolean
    Wait for the kubernetes api to be available

    Deprecated: This attribute is deprecated and no-op. Will be removed in a future version. Use talos.cluster.getHealth instead.

    getKubeconfig Result

    The following output properties are available:

    ClientConfiguration Pulumiverse.Talos.Cluster.Outputs.GetKubeconfigClientConfiguration
    The client configuration data
    Endpoint string
    endpoint to use for the talosclient. If not set, the node value will be used
    Id string
    The ID of this resource.
    KubeconfigRaw string
    The raw kubeconfig
    KubernetesClientConfiguration Pulumiverse.Talos.Cluster.Outputs.GetKubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    Node string
    controlplane node to retrieve the kubeconfig from
    Timeouts Pulumiverse.Talos.Cluster.Outputs.GetKubeconfigTimeouts
    Wait bool
    Wait for the kubernetes api to be available

    Deprecated: This attribute is deprecated and no-op. Will be removed in a future version. Use talos.cluster.getHealth instead.

    ClientConfiguration GetKubeconfigClientConfiguration
    The client configuration data
    Endpoint string
    endpoint to use for the talosclient. If not set, the node value will be used
    Id string
    The ID of this resource.
    KubeconfigRaw string
    The raw kubeconfig
    KubernetesClientConfiguration GetKubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    Node string
    controlplane node to retrieve the kubeconfig from
    Timeouts GetKubeconfigTimeouts
    Wait bool
    Wait for the kubernetes api to be available

    Deprecated: This attribute is deprecated and no-op. Will be removed in a future version. Use talos.cluster.getHealth instead.

    clientConfiguration GetKubeconfigClientConfiguration
    The client configuration data
    endpoint String
    endpoint to use for the talosclient. If not set, the node value will be used
    id String
    The ID of this resource.
    kubeconfigRaw String
    The raw kubeconfig
    kubernetesClientConfiguration GetKubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    node String
    controlplane node to retrieve the kubeconfig from
    timeouts GetKubeconfigTimeouts
    wait_ Boolean
    Wait for the kubernetes api to be available

    Deprecated: This attribute is deprecated and no-op. Will be removed in a future version. Use talos.cluster.getHealth instead.

    clientConfiguration GetKubeconfigClientConfiguration
    The client configuration data
    endpoint string
    endpoint to use for the talosclient. If not set, the node value will be used
    id string
    The ID of this resource.
    kubeconfigRaw string
    The raw kubeconfig
    kubernetesClientConfiguration GetKubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    node string
    controlplane node to retrieve the kubeconfig from
    timeouts GetKubeconfigTimeouts
    wait boolean
    Wait for the kubernetes api to be available

    Deprecated: This attribute is deprecated and no-op. Will be removed in a future version. Use talos.cluster.getHealth instead.

    client_configuration GetKubeconfigClientConfiguration
    The client configuration data
    endpoint str
    endpoint to use for the talosclient. If not set, the node value will be used
    id str
    The ID of this resource.
    kubeconfig_raw str
    The raw kubeconfig
    kubernetes_client_configuration GetKubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    node str
    controlplane node to retrieve the kubeconfig from
    timeouts GetKubeconfigTimeouts
    wait bool
    Wait for the kubernetes api to be available

    Deprecated: This attribute is deprecated and no-op. Will be removed in a future version. Use talos.cluster.getHealth instead.

    clientConfiguration Property Map
    The client configuration data
    endpoint String
    endpoint to use for the talosclient. If not set, the node value will be used
    id String
    The ID of this resource.
    kubeconfigRaw String
    The raw kubeconfig
    kubernetesClientConfiguration Property Map
    The kubernetes client configuration
    node String
    controlplane node to retrieve the kubeconfig from
    timeouts Property Map
    wait Boolean
    Wait for the kubernetes api to be available

    Deprecated: This attribute is deprecated and no-op. Will be removed in a future version. Use talos.cluster.getHealth instead.

    Supporting Types

    GetKubeconfigClientConfiguration

    CaCertificate string
    The client CA certificate
    ClientCertificate string
    The client certificate
    ClientKey string
    The client key
    CaCertificate string
    The client CA certificate
    ClientCertificate string
    The client certificate
    ClientKey string
    The client key
    caCertificate String
    The client CA certificate
    clientCertificate String
    The client certificate
    clientKey String
    The client key
    caCertificate string
    The client CA certificate
    clientCertificate string
    The client certificate
    clientKey string
    The client key
    ca_certificate str
    The client CA certificate
    client_certificate str
    The client certificate
    client_key str
    The client key
    caCertificate String
    The client CA certificate
    clientCertificate String
    The client certificate
    clientKey String
    The client key

    GetKubeconfigKubernetesClientConfiguration

    CaCertificate string
    The kubernetes CA certificate
    ClientCertificate string
    The kubernetes client certificate
    ClientKey string
    The kubernetes client key
    Host string
    The kubernetes host
    CaCertificate string
    The kubernetes CA certificate
    ClientCertificate string
    The kubernetes client certificate
    ClientKey string
    The kubernetes client key
    Host string
    The kubernetes host
    caCertificate String
    The kubernetes CA certificate
    clientCertificate String
    The kubernetes client certificate
    clientKey String
    The kubernetes client key
    host String
    The kubernetes host
    caCertificate string
    The kubernetes CA certificate
    clientCertificate string
    The kubernetes client certificate
    clientKey string
    The kubernetes client key
    host string
    The kubernetes host
    ca_certificate str
    The kubernetes CA certificate
    client_certificate str
    The kubernetes client certificate
    client_key str
    The kubernetes client key
    host str
    The kubernetes host
    caCertificate String
    The kubernetes CA certificate
    clientCertificate String
    The kubernetes client certificate
    clientKey String
    The kubernetes client key
    host String
    The kubernetes host

    GetKubeconfigTimeouts

    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

    Package Details

    Repository
    talos pulumiverse/pulumi-talos
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the talos Terraform Provider.
    talos logo
    talos v0.5.2 published on Thursday, Jan 23, 2025 by Pulumiverse
    pulumiverse/pulumi-talos