Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Talos Linux
  3. API Docs
  4. cluster
  5. Kubeconfig
talos v0.4.1 published on Tuesday, Nov 5, 2024 by Pulumiverse
pulumiverse/pulumi-talos

talos.cluster.Kubeconfig

Explore with Pulumi AI

talos logo
talos v0.4.1 published on Tuesday, Nov 5, 2024 by Pulumiverse
pulumiverse/pulumi-talos

    Retrieves the kubeconfig for a Talos cluster

    Create Kubeconfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Kubeconfig(name: string, args: KubeconfigArgs, opts?: CustomResourceOptions);
    @overload
def Kubeconfig(resource_name: str,
               args: KubeconfigArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Kubeconfig(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               client_configuration: Optional[KubeconfigClientConfigurationArgs] = None,
               node: Optional[str] = None,
               certificate_renewal_duration: Optional[str] = None,
               endpoint: Optional[str] = None,
               timeouts: Optional[KubeconfigTimeoutsArgs] = None)
    func NewKubeconfig(ctx *Context, name string, args KubeconfigArgs, opts ...ResourceOption) (*Kubeconfig, error)
    public Kubeconfig(string name, KubeconfigArgs args, CustomResourceOptions? opts = null)
    public Kubeconfig(String name, KubeconfigArgs args)
public Kubeconfig(String name, KubeconfigArgs args, CustomResourceOptions options)

    type: talos:cluster:Kubeconfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args KubeconfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args KubeconfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args KubeconfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KubeconfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KubeconfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var kubeconfigResource = new Talos.Cluster.Kubeconfig("kubeconfigResource", new()
{
    ClientConfiguration = new Talos.Cluster.Inputs.KubeconfigClientConfigurationArgs
    {
        CaCertificate = "string",
        ClientCertificate = "string",
        ClientKey = "string",
    },
    Node = "string",
    CertificateRenewalDuration = "string",
    Endpoint = "string",
    Timeouts = new Talos.Cluster.Inputs.KubeconfigTimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
});

    example, err := cluster.NewKubeconfig(ctx, "kubeconfigResource", &cluster.KubeconfigArgs{
	ClientConfiguration: &cluster.KubeconfigClientConfigurationArgs{
		CaCertificate:     pulumi.String("string"),
		ClientCertificate: pulumi.String("string"),
		ClientKey:         pulumi.String("string"),
	},
	Node:                       pulumi.String("string"),
	CertificateRenewalDuration: pulumi.String("string"),
	Endpoint:                   pulumi.String("string"),
	Timeouts: &cluster.KubeconfigTimeoutsArgs{
		Create: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var kubeconfigResource = new Kubeconfig("kubeconfigResource", KubeconfigArgs.builder()
    .clientConfiguration(KubeconfigClientConfigurationArgs.builder()
        .caCertificate("string")
        .clientCertificate("string")
        .clientKey("string")
        .build())
    .node("string")
    .certificateRenewalDuration("string")
    .endpoint("string")
    .timeouts(KubeconfigTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .build());

    kubeconfig_resource = talos.cluster.Kubeconfig("kubeconfigResource",
    client_configuration={
        "ca_certificate": "string",
        "client_certificate": "string",
        "client_key": "string",
    },
    node="string",
    certificate_renewal_duration="string",
    endpoint="string",
    timeouts={
        "create": "string",
        "update": "string",
    })

    const kubeconfigResource = new talos.cluster.Kubeconfig("kubeconfigResource", {
    clientConfiguration: {
        caCertificate: "string",
        clientCertificate: "string",
        clientKey: "string",
    },
    node: "string",
    certificateRenewalDuration: "string",
    endpoint: "string",
    timeouts: {
        create: "string",
        update: "string",
    },
});

    type: talos:cluster:Kubeconfig
properties:
    certificateRenewalDuration: string
    clientConfiguration:
        caCertificate: string
        clientCertificate: string
        clientKey: string
    endpoint: string
    node: string
    timeouts:
        create: string
        update: string

    Kubeconfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Kubeconfig resource accepts the following input properties:

    ClientConfiguration Pulumiverse.Talos.Cluster.Inputs.KubeconfigClientConfiguration
    The client configuration data
    Node string
    controlplane node to retrieve the kubeconfig from
    CertificateRenewalDuration string
    The duration in hours before the certificate is renewed, defaults to 720h. Must be a valid duration string
    Endpoint string
    endpoint to use for the talosclient. If not set, the node value will be used
    Timeouts Pulumiverse.Talos.Cluster.Inputs.KubeconfigTimeouts
    ClientConfiguration KubeconfigClientConfigurationArgs
    The client configuration data
    Node string
    controlplane node to retrieve the kubeconfig from
    CertificateRenewalDuration string
    The duration in hours before the certificate is renewed, defaults to 720h. Must be a valid duration string
    Endpoint string
    endpoint to use for the talosclient. If not set, the node value will be used
    Timeouts KubeconfigTimeoutsArgs
    clientConfiguration KubeconfigClientConfiguration
    The client configuration data
    node String
    controlplane node to retrieve the kubeconfig from
    certificateRenewalDuration String
    The duration in hours before the certificate is renewed, defaults to 720h. Must be a valid duration string
    endpoint String
    endpoint to use for the talosclient. If not set, the node value will be used
    timeouts KubeconfigTimeouts
    clientConfiguration KubeconfigClientConfiguration
    The client configuration data
    node string
    controlplane node to retrieve the kubeconfig from
    certificateRenewalDuration string
    The duration in hours before the certificate is renewed, defaults to 720h. Must be a valid duration string
    endpoint string
    endpoint to use for the talosclient. If not set, the node value will be used
    timeouts KubeconfigTimeouts
    client_configuration KubeconfigClientConfigurationArgs
    The client configuration data
    node str
    controlplane node to retrieve the kubeconfig from
    certificate_renewal_duration str
    The duration in hours before the certificate is renewed, defaults to 720h. Must be a valid duration string
    endpoint str
    endpoint to use for the talosclient. If not set, the node value will be used
    timeouts KubeconfigTimeoutsArgs
    clientConfiguration Property Map
    The client configuration data
    node String
    controlplane node to retrieve the kubeconfig from
    certificateRenewalDuration String
    The duration in hours before the certificate is renewed, defaults to 720h. Must be a valid duration string
    endpoint String
    endpoint to use for the talosclient. If not set, the node value will be used
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Kubeconfig resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    KubeconfigRaw string
    The raw kubeconfig
    KubernetesClientConfiguration Pulumiverse.Talos.Cluster.Outputs.KubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    Id string
    The provider-assigned unique ID for this managed resource.
    KubeconfigRaw string
    The raw kubeconfig
    KubernetesClientConfiguration KubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    id String
    The provider-assigned unique ID for this managed resource.
    kubeconfigRaw String
    The raw kubeconfig
    kubernetesClientConfiguration KubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    id string
    The provider-assigned unique ID for this managed resource.
    kubeconfigRaw string
    The raw kubeconfig
    kubernetesClientConfiguration KubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    id str
    The provider-assigned unique ID for this managed resource.
    kubeconfig_raw str
    The raw kubeconfig
    kubernetes_client_configuration KubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    id String
    The provider-assigned unique ID for this managed resource.
    kubeconfigRaw String
    The raw kubeconfig
    kubernetesClientConfiguration Property Map
    The kubernetes client configuration

    Look up Existing Kubeconfig Resource

    Get an existing Kubeconfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: KubeconfigState, opts?: CustomResourceOptions): Kubeconfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_renewal_duration: Optional[str] = None,
        client_configuration: Optional[KubeconfigClientConfigurationArgs] = None,
        endpoint: Optional[str] = None,
        kubeconfig_raw: Optional[str] = None,
        kubernetes_client_configuration: Optional[KubeconfigKubernetesClientConfigurationArgs] = None,
        node: Optional[str] = None,
        timeouts: Optional[KubeconfigTimeoutsArgs] = None) -> Kubeconfig
    func GetKubeconfig(ctx *Context, name string, id IDInput, state *KubeconfigState, opts ...ResourceOption) (*Kubeconfig, error)
    public static Kubeconfig Get(string name, Input<string> id, KubeconfigState? state, CustomResourceOptions? opts = null)
    public static Kubeconfig get(String name, Output<String> id, KubeconfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CertificateRenewalDuration string
    The duration in hours before the certificate is renewed, defaults to 720h. Must be a valid duration string
    ClientConfiguration Pulumiverse.Talos.Cluster.Inputs.KubeconfigClientConfiguration
    The client configuration data
    Endpoint string
    endpoint to use for the talosclient. If not set, the node value will be used
    KubeconfigRaw string
    The raw kubeconfig
    KubernetesClientConfiguration Pulumiverse.Talos.Cluster.Inputs.KubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    Node string
    controlplane node to retrieve the kubeconfig from
    Timeouts Pulumiverse.Talos.Cluster.Inputs.KubeconfigTimeouts
    CertificateRenewalDuration string
    The duration in hours before the certificate is renewed, defaults to 720h. Must be a valid duration string
    ClientConfiguration KubeconfigClientConfigurationArgs
    The client configuration data
    Endpoint string
    endpoint to use for the talosclient. If not set, the node value will be used
    KubeconfigRaw string
    The raw kubeconfig
    KubernetesClientConfiguration KubeconfigKubernetesClientConfigurationArgs
    The kubernetes client configuration
    Node string
    controlplane node to retrieve the kubeconfig from
    Timeouts KubeconfigTimeoutsArgs
    certificateRenewalDuration String
    The duration in hours before the certificate is renewed, defaults to 720h. Must be a valid duration string
    clientConfiguration KubeconfigClientConfiguration
    The client configuration data
    endpoint String
    endpoint to use for the talosclient. If not set, the node value will be used
    kubeconfigRaw String
    The raw kubeconfig
    kubernetesClientConfiguration KubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    node String
    controlplane node to retrieve the kubeconfig from
    timeouts KubeconfigTimeouts
    certificateRenewalDuration string
    The duration in hours before the certificate is renewed, defaults to 720h. Must be a valid duration string
    clientConfiguration KubeconfigClientConfiguration
    The client configuration data
    endpoint string
    endpoint to use for the talosclient. If not set, the node value will be used
    kubeconfigRaw string
    The raw kubeconfig
    kubernetesClientConfiguration KubeconfigKubernetesClientConfiguration
    The kubernetes client configuration
    node string
    controlplane node to retrieve the kubeconfig from
    timeouts KubeconfigTimeouts
    certificate_renewal_duration str
    The duration in hours before the certificate is renewed, defaults to 720h. Must be a valid duration string
    client_configuration KubeconfigClientConfigurationArgs
    The client configuration data
    endpoint str
    endpoint to use for the talosclient. If not set, the node value will be used
    kubeconfig_raw str
    The raw kubeconfig
    kubernetes_client_configuration KubeconfigKubernetesClientConfigurationArgs
    The kubernetes client configuration
    node str
    controlplane node to retrieve the kubeconfig from
    timeouts KubeconfigTimeoutsArgs
    certificateRenewalDuration String
    The duration in hours before the certificate is renewed, defaults to 720h. Must be a valid duration string
    clientConfiguration Property Map
    The client configuration data
    endpoint String
    endpoint to use for the talosclient. If not set, the node value will be used
    kubeconfigRaw String
    The raw kubeconfig
    kubernetesClientConfiguration Property Map
    The kubernetes client configuration
    node String
    controlplane node to retrieve the kubeconfig from
    timeouts Property Map

    Supporting Types

    KubeconfigClientConfiguration, KubeconfigClientConfigurationArgs

    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

    KubeconfigKubernetesClientConfiguration, KubeconfigKubernetesClientConfigurationArgs

    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

    KubeconfigTimeouts, KubeconfigTimeoutsArgs

    Create 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).
    Update 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).
    Create 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).
    Update 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).
    create 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).
    update 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).
    create 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).
    update 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).
    create 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).
    update 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).
    create 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).
    update 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).

    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.4.1 published on Tuesday, Nov 5, 2024 by Pulumiverse
    pulumiverse/pulumi-talos