1. Packages
  2. Talos Linux
  3. API Docs
  4. machine
  5. Bootstrap
talos v0.2.0 published on Thursday, Dec 21, 2023 by Pulumiverse

talos.machine.Bootstrap

Explore with Pulumi AI

talos logo
talos v0.2.0 published on Thursday, Dec 21, 2023 by Pulumiverse

    The machine bootstrap resource allows you to bootstrap a Talos node.

    Create Bootstrap Resource

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

    Constructor syntax

    new Bootstrap(name: string, args: BootstrapArgs, opts?: CustomResourceOptions);
    @overload
    def Bootstrap(resource_name: str,
                  args: BootstrapArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Bootstrap(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  client_configuration: Optional[BootstrapClientConfigurationArgs] = None,
                  node: Optional[str] = None,
                  endpoint: Optional[str] = None,
                  timeouts: Optional[BootstrapTimeoutsArgs] = None)
    func NewBootstrap(ctx *Context, name string, args BootstrapArgs, opts ...ResourceOption) (*Bootstrap, error)
    public Bootstrap(string name, BootstrapArgs args, CustomResourceOptions? opts = null)
    public Bootstrap(String name, BootstrapArgs args)
    public Bootstrap(String name, BootstrapArgs args, CustomResourceOptions options)
    
    type: talos:machine:Bootstrap
    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 BootstrapArgs
    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 BootstrapArgs
    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 BootstrapArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BootstrapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BootstrapArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var bootstrapResource = new Talos.Machine.Bootstrap("bootstrapResource", new()
    {
        ClientConfiguration = new Talos.Machine.Inputs.BootstrapClientConfigurationArgs
        {
            CaCertificate = "string",
            ClientCertificate = "string",
            ClientKey = "string",
        },
        Node = "string",
        Endpoint = "string",
        Timeouts = new Talos.Machine.Inputs.BootstrapTimeoutsArgs
        {
            Create = "string",
        },
    });
    
    example, err := machine.NewBootstrap(ctx, "bootstrapResource", &machine.BootstrapArgs{
    	ClientConfiguration: &machine.BootstrapClientConfigurationArgs{
    		CaCertificate:     pulumi.String("string"),
    		ClientCertificate: pulumi.String("string"),
    		ClientKey:         pulumi.String("string"),
    	},
    	Node:     pulumi.String("string"),
    	Endpoint: pulumi.String("string"),
    	Timeouts: &machine.BootstrapTimeoutsArgs{
    		Create: pulumi.String("string"),
    	},
    })
    
    var bootstrapResource = new Bootstrap("bootstrapResource", BootstrapArgs.builder()        
        .clientConfiguration(BootstrapClientConfigurationArgs.builder()
            .caCertificate("string")
            .clientCertificate("string")
            .clientKey("string")
            .build())
        .node("string")
        .endpoint("string")
        .timeouts(BootstrapTimeoutsArgs.builder()
            .create("string")
            .build())
        .build());
    
    bootstrap_resource = talos.machine.Bootstrap("bootstrapResource",
        client_configuration=talos.machine.BootstrapClientConfigurationArgs(
            ca_certificate="string",
            client_certificate="string",
            client_key="string",
        ),
        node="string",
        endpoint="string",
        timeouts=talos.machine.BootstrapTimeoutsArgs(
            create="string",
        ))
    
    const bootstrapResource = new talos.machine.Bootstrap("bootstrapResource", {
        clientConfiguration: {
            caCertificate: "string",
            clientCertificate: "string",
            clientKey: "string",
        },
        node: "string",
        endpoint: "string",
        timeouts: {
            create: "string",
        },
    });
    
    type: talos:machine:Bootstrap
    properties:
        clientConfiguration:
            caCertificate: string
            clientCertificate: string
            clientKey: string
        endpoint: string
        node: string
        timeouts:
            create: string
    

    Bootstrap Resource Properties

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

    Inputs

    The Bootstrap resource accepts the following input properties:

    ClientConfiguration Pulumiverse.Talos.Machine.Inputs.BootstrapClientConfiguration
    The client configuration data
    Node string
    The name of the node to bootstrap
    Endpoint string
    The endpoint of the machine to bootstrap
    Timeouts Pulumiverse.Talos.Machine.Inputs.BootstrapTimeouts
    ClientConfiguration BootstrapClientConfigurationArgs
    The client configuration data
    Node string
    The name of the node to bootstrap
    Endpoint string
    The endpoint of the machine to bootstrap
    Timeouts BootstrapTimeoutsArgs
    clientConfiguration BootstrapClientConfiguration
    The client configuration data
    node String
    The name of the node to bootstrap
    endpoint String
    The endpoint of the machine to bootstrap
    timeouts BootstrapTimeouts
    clientConfiguration BootstrapClientConfiguration
    The client configuration data
    node string
    The name of the node to bootstrap
    endpoint string
    The endpoint of the machine to bootstrap
    timeouts BootstrapTimeouts
    client_configuration BootstrapClientConfigurationArgs
    The client configuration data
    node str
    The name of the node to bootstrap
    endpoint str
    The endpoint of the machine to bootstrap
    timeouts BootstrapTimeoutsArgs
    clientConfiguration Property Map
    The client configuration data
    node String
    The name of the node to bootstrap
    endpoint String
    The endpoint of the machine to bootstrap
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Bootstrap Resource

    Get an existing Bootstrap 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?: BootstrapState, opts?: CustomResourceOptions): Bootstrap
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            client_configuration: Optional[BootstrapClientConfigurationArgs] = None,
            endpoint: Optional[str] = None,
            node: Optional[str] = None,
            timeouts: Optional[BootstrapTimeoutsArgs] = None) -> Bootstrap
    func GetBootstrap(ctx *Context, name string, id IDInput, state *BootstrapState, opts ...ResourceOption) (*Bootstrap, error)
    public static Bootstrap Get(string name, Input<string> id, BootstrapState? state, CustomResourceOptions? opts = null)
    public static Bootstrap get(String name, Output<String> id, BootstrapState 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:
    ClientConfiguration Pulumiverse.Talos.Machine.Inputs.BootstrapClientConfiguration
    The client configuration data
    Endpoint string
    The endpoint of the machine to bootstrap
    Node string
    The name of the node to bootstrap
    Timeouts Pulumiverse.Talos.Machine.Inputs.BootstrapTimeouts
    ClientConfiguration BootstrapClientConfigurationArgs
    The client configuration data
    Endpoint string
    The endpoint of the machine to bootstrap
    Node string
    The name of the node to bootstrap
    Timeouts BootstrapTimeoutsArgs
    clientConfiguration BootstrapClientConfiguration
    The client configuration data
    endpoint String
    The endpoint of the machine to bootstrap
    node String
    The name of the node to bootstrap
    timeouts BootstrapTimeouts
    clientConfiguration BootstrapClientConfiguration
    The client configuration data
    endpoint string
    The endpoint of the machine to bootstrap
    node string
    The name of the node to bootstrap
    timeouts BootstrapTimeouts
    client_configuration BootstrapClientConfigurationArgs
    The client configuration data
    endpoint str
    The endpoint of the machine to bootstrap
    node str
    The name of the node to bootstrap
    timeouts BootstrapTimeoutsArgs
    clientConfiguration Property Map
    The client configuration data
    endpoint String
    The endpoint of the machine to bootstrap
    node String
    The name of the node to bootstrap
    timeouts Property Map

    Supporting Types

    BootstrapClientConfiguration, BootstrapClientConfigurationArgs

    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

    BootstrapTimeouts, BootstrapTimeoutsArgs

    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).
    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).
    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).
    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).
    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).
    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).

    Import

    terraform machine bootstrap can be imported to let terraform know that the machine is already bootstrapped

     $ pulumi import talos:machine/bootstrap:Bootstrap this <any id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.2.0 published on Thursday, Dec 21, 2023 by Pulumiverse