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

talos.machine.ConfigurationApply

Explore with Pulumi AI

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

    The machine configuration apply resource allows to apply machine configuration to a node

    Create ConfigurationApply Resource

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

    Constructor syntax

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

@overload
def ConfigurationApply(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       client_configuration: Optional[ClientConfigurationArgs] = None,
                       machine_configuration_input: Optional[str] = None,
                       node: Optional[str] = None,
                       apply_mode: Optional[str] = None,
                       config_patches: Optional[Sequence[str]] = None,
                       endpoint: Optional[str] = None,
                       on_destroy: Optional[ConfigurationApplyOnDestroyArgs] = None,
                       timeouts: Optional[TimeoutArgs] = None)
    func NewConfigurationApply(ctx *Context, name string, args ConfigurationApplyArgs, opts ...ResourceOption) (*ConfigurationApply, error)
    public ConfigurationApply(string name, ConfigurationApplyArgs args, CustomResourceOptions? opts = null)
    public ConfigurationApply(String name, ConfigurationApplyArgs args)
public ConfigurationApply(String name, ConfigurationApplyArgs args, CustomResourceOptions options)

    type: talos:machine:ConfigurationApply
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 ConfigurationApplyArgs
    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 ConfigurationApplyArgs
    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 ConfigurationApplyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigurationApplyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigurationApplyArgs
    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 configurationApplyResource = new Talos.Machine.ConfigurationApply("configurationApplyResource", new()
{
    ClientConfiguration = new Talos.Machine.Inputs.ClientConfigurationArgs
    {
        CaCertificate = "string",
        ClientCertificate = "string",
        ClientKey = "string",
    },
    MachineConfigurationInput = "string",
    Node = "string",
    ApplyMode = "string",
    ConfigPatches = new[]
    {
        "string",
    },
    Endpoint = "string",
    OnDestroy = new Talos.Machine.Inputs.ConfigurationApplyOnDestroyArgs
    {
        Graceful = false,
        Reboot = false,
        Reset = false,
    },
    Timeouts = new Talos.Machine.Inputs.TimeoutArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := machine.NewConfigurationApply(ctx, "configurationApplyResource", &machine.ConfigurationApplyArgs{
	ClientConfiguration: &machine.ClientConfigurationArgs{
		CaCertificate:     pulumi.String("string"),
		ClientCertificate: pulumi.String("string"),
		ClientKey:         pulumi.String("string"),
	},
	MachineConfigurationInput: pulumi.String("string"),
	Node:                      pulumi.String("string"),
	ApplyMode:                 pulumi.String("string"),
	ConfigPatches: pulumi.StringArray{
		pulumi.String("string"),
	},
	Endpoint: pulumi.String("string"),
	OnDestroy: &machine.ConfigurationApplyOnDestroyArgs{
		Graceful: pulumi.Bool(false),
		Reboot:   pulumi.Bool(false),
		Reset:    pulumi.Bool(false),
	},
	Timeouts: &machine.TimeoutArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var configurationApplyResource = new ConfigurationApply("configurationApplyResource", ConfigurationApplyArgs.builder()
    .clientConfiguration(ClientConfigurationArgs.builder()
        .caCertificate("string")
        .clientCertificate("string")
        .clientKey("string")
        .build())
    .machineConfigurationInput("string")
    .node("string")
    .applyMode("string")
    .configPatches("string")
    .endpoint("string")
    .onDestroy(ConfigurationApplyOnDestroyArgs.builder()
        .graceful(false)
        .reboot(false)
        .reset(false)
        .build())
    .timeouts(TimeoutArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    configuration_apply_resource = talos.machine.ConfigurationApply("configurationApplyResource",
    client_configuration={
        "ca_certificate": "string",
        "client_certificate": "string",
        "client_key": "string",
    },
    machine_configuration_input="string",
    node="string",
    apply_mode="string",
    config_patches=["string"],
    endpoint="string",
    on_destroy={
        "graceful": False,
        "reboot": False,
        "reset": False,
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const configurationApplyResource = new talos.machine.ConfigurationApply("configurationApplyResource", {
    clientConfiguration: {
        caCertificate: "string",
        clientCertificate: "string",
        clientKey: "string",
    },
    machineConfigurationInput: "string",
    node: "string",
    applyMode: "string",
    configPatches: ["string"],
    endpoint: "string",
    onDestroy: {
        graceful: false,
        reboot: false,
        reset: false,
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: talos:machine:ConfigurationApply
properties:
    applyMode: string
    clientConfiguration:
        caCertificate: string
        clientCertificate: string
        clientKey: string
    configPatches:
        - string
    endpoint: string
    machineConfigurationInput: string
    node: string
    onDestroy:
        graceful: false
        reboot: false
        reset: false
    timeouts:
        create: string
        delete: string
        update: string

    ConfigurationApply 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 ConfigurationApply resource accepts the following input properties:

    ClientConfiguration Pulumiverse.Talos.Machine.Inputs.ClientConfiguration
    The client configuration data
    MachineConfigurationInput string
    The machine configuration to apply
    Node string
    The name of the node to bootstrap
    ApplyMode string
    The mode of the apply operation
    ConfigPatches List<string>
    The list of config patches to apply
    Endpoint string
    The endpoint of the machine to bootstrap
    OnDestroy Pulumiverse.Talos.Machine.Inputs.ConfigurationApplyOnDestroy
    Actions to be taken on destroy, if reset is not set this is a no-op.
    Timeouts Pulumiverse.Talos.Machine.Inputs.Timeout
    ClientConfiguration ClientConfigurationArgs
    The client configuration data
    MachineConfigurationInput string
    The machine configuration to apply
    Node string
    The name of the node to bootstrap
    ApplyMode string
    The mode of the apply operation
    ConfigPatches []string
    The list of config patches to apply
    Endpoint string
    The endpoint of the machine to bootstrap
    OnDestroy ConfigurationApplyOnDestroyArgs
    Actions to be taken on destroy, if reset is not set this is a no-op.
    Timeouts TimeoutArgs
    clientConfiguration ClientConfiguration
    The client configuration data
    machineConfigurationInput String
    The machine configuration to apply
    node String
    The name of the node to bootstrap
    applyMode String
    The mode of the apply operation
    configPatches List<String>
    The list of config patches to apply
    endpoint String
    The endpoint of the machine to bootstrap
    onDestroy ConfigurationApplyOnDestroy
    Actions to be taken on destroy, if reset is not set this is a no-op.
    timeouts Timeout
    clientConfiguration ClientConfiguration
    The client configuration data
    machineConfigurationInput string
    The machine configuration to apply
    node string
    The name of the node to bootstrap
    applyMode string
    The mode of the apply operation
    configPatches string[]
    The list of config patches to apply
    endpoint string
    The endpoint of the machine to bootstrap
    onDestroy ConfigurationApplyOnDestroy
    Actions to be taken on destroy, if reset is not set this is a no-op.
    timeouts Timeout
    client_configuration ClientConfigurationArgs
    The client configuration data
    machine_configuration_input str
    The machine configuration to apply
    node str
    The name of the node to bootstrap
    apply_mode str
    The mode of the apply operation
    config_patches Sequence[str]
    The list of config patches to apply
    endpoint str
    The endpoint of the machine to bootstrap
    on_destroy ConfigurationApplyOnDestroyArgs
    Actions to be taken on destroy, if reset is not set this is a no-op.
    timeouts TimeoutArgs
    clientConfiguration Property Map
    The client configuration data
    machineConfigurationInput String
    The machine configuration to apply
    node String
    The name of the node to bootstrap
    applyMode String
    The mode of the apply operation
    configPatches List<String>
    The list of config patches to apply
    endpoint String
    The endpoint of the machine to bootstrap
    onDestroy Property Map
    Actions to be taken on destroy, if reset is not set this is a no-op.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    MachineConfiguration string
    The generated machine configuration after applying patches
    Id string
    The provider-assigned unique ID for this managed resource.
    MachineConfiguration string
    The generated machine configuration after applying patches
    id String
    The provider-assigned unique ID for this managed resource.
    machineConfiguration String
    The generated machine configuration after applying patches
    id string
    The provider-assigned unique ID for this managed resource.
    machineConfiguration string
    The generated machine configuration after applying patches
    id str
    The provider-assigned unique ID for this managed resource.
    machine_configuration str
    The generated machine configuration after applying patches
    id String
    The provider-assigned unique ID for this managed resource.
    machineConfiguration String
    The generated machine configuration after applying patches

    Look up Existing ConfigurationApply Resource

    Get an existing ConfigurationApply 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?: ConfigurationApplyState, opts?: CustomResourceOptions): ConfigurationApply
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apply_mode: Optional[str] = None,
        client_configuration: Optional[ClientConfigurationArgs] = None,
        config_patches: Optional[Sequence[str]] = None,
        endpoint: Optional[str] = None,
        machine_configuration: Optional[str] = None,
        machine_configuration_input: Optional[str] = None,
        node: Optional[str] = None,
        on_destroy: Optional[ConfigurationApplyOnDestroyArgs] = None,
        timeouts: Optional[TimeoutArgs] = None) -> ConfigurationApply
    func GetConfigurationApply(ctx *Context, name string, id IDInput, state *ConfigurationApplyState, opts ...ResourceOption) (*ConfigurationApply, error)
    public static ConfigurationApply Get(string name, Input<string> id, ConfigurationApplyState? state, CustomResourceOptions? opts = null)
    public static ConfigurationApply get(String name, Output<String> id, ConfigurationApplyState 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:
    ApplyMode string
    The mode of the apply operation
    ClientConfiguration Pulumiverse.Talos.Machine.Inputs.ClientConfiguration
    The client configuration data
    ConfigPatches List<string>
    The list of config patches to apply
    Endpoint string
    The endpoint of the machine to bootstrap
    MachineConfiguration string
    The generated machine configuration after applying patches
    MachineConfigurationInput string
    The machine configuration to apply
    Node string
    The name of the node to bootstrap
    OnDestroy Pulumiverse.Talos.Machine.Inputs.ConfigurationApplyOnDestroy
    Actions to be taken on destroy, if reset is not set this is a no-op.
    Timeouts Pulumiverse.Talos.Machine.Inputs.Timeout
    ApplyMode string
    The mode of the apply operation
    ClientConfiguration ClientConfigurationArgs
    The client configuration data
    ConfigPatches []string
    The list of config patches to apply
    Endpoint string
    The endpoint of the machine to bootstrap
    MachineConfiguration string
    The generated machine configuration after applying patches
    MachineConfigurationInput string
    The machine configuration to apply
    Node string
    The name of the node to bootstrap
    OnDestroy ConfigurationApplyOnDestroyArgs
    Actions to be taken on destroy, if reset is not set this is a no-op.
    Timeouts TimeoutArgs
    applyMode String
    The mode of the apply operation
    clientConfiguration ClientConfiguration
    The client configuration data
    configPatches List<String>
    The list of config patches to apply
    endpoint String
    The endpoint of the machine to bootstrap
    machineConfiguration String
    The generated machine configuration after applying patches
    machineConfigurationInput String
    The machine configuration to apply
    node String
    The name of the node to bootstrap
    onDestroy ConfigurationApplyOnDestroy
    Actions to be taken on destroy, if reset is not set this is a no-op.
    timeouts Timeout
    applyMode string
    The mode of the apply operation
    clientConfiguration ClientConfiguration
    The client configuration data
    configPatches string[]
    The list of config patches to apply
    endpoint string
    The endpoint of the machine to bootstrap
    machineConfiguration string
    The generated machine configuration after applying patches
    machineConfigurationInput string
    The machine configuration to apply
    node string
    The name of the node to bootstrap
    onDestroy ConfigurationApplyOnDestroy
    Actions to be taken on destroy, if reset is not set this is a no-op.
    timeouts Timeout
    apply_mode str
    The mode of the apply operation
    client_configuration ClientConfigurationArgs
    The client configuration data
    config_patches Sequence[str]
    The list of config patches to apply
    endpoint str
    The endpoint of the machine to bootstrap
    machine_configuration str
    The generated machine configuration after applying patches
    machine_configuration_input str
    The machine configuration to apply
    node str
    The name of the node to bootstrap
    on_destroy ConfigurationApplyOnDestroyArgs
    Actions to be taken on destroy, if reset is not set this is a no-op.
    timeouts TimeoutArgs
    applyMode String
    The mode of the apply operation
    clientConfiguration Property Map
    The client configuration data
    configPatches List<String>
    The list of config patches to apply
    endpoint String
    The endpoint of the machine to bootstrap
    machineConfiguration String
    The generated machine configuration after applying patches
    machineConfigurationInput String
    The machine configuration to apply
    node String
    The name of the node to bootstrap
    onDestroy Property Map
    Actions to be taken on destroy, if reset is not set this is a no-op.
    timeouts Property Map

    Supporting Types

    ClientConfiguration, ClientConfigurationArgs

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

    ConfigurationApplyOnDestroy, ConfigurationApplyOnDestroyArgs

    Graceful bool
    Graceful indicates whether node should leave etcd before the upgrade, it also enforces etcd checks before leaving. Default true
    Reboot bool
    Reboot indicates whether node should reboot or halt after resetting. Default false
    Reset bool
    Reset the machine to the initial state (STATE and EPHEMERAL will be wiped). Default false
    Graceful bool
    Graceful indicates whether node should leave etcd before the upgrade, it also enforces etcd checks before leaving. Default true
    Reboot bool
    Reboot indicates whether node should reboot or halt after resetting. Default false
    Reset bool
    Reset the machine to the initial state (STATE and EPHEMERAL will be wiped). Default false
    graceful Boolean
    Graceful indicates whether node should leave etcd before the upgrade, it also enforces etcd checks before leaving. Default true
    reboot Boolean
    Reboot indicates whether node should reboot or halt after resetting. Default false
    reset Boolean
    Reset the machine to the initial state (STATE and EPHEMERAL will be wiped). Default false
    graceful boolean
    Graceful indicates whether node should leave etcd before the upgrade, it also enforces etcd checks before leaving. Default true
    reboot boolean
    Reboot indicates whether node should reboot or halt after resetting. Default false
    reset boolean
    Reset the machine to the initial state (STATE and EPHEMERAL will be wiped). Default false
    graceful bool
    Graceful indicates whether node should leave etcd before the upgrade, it also enforces etcd checks before leaving. Default true
    reboot bool
    Reboot indicates whether node should reboot or halt after resetting. Default false
    reset bool
    Reset the machine to the initial state (STATE and EPHEMERAL will be wiped). Default false
    graceful Boolean
    Graceful indicates whether node should leave etcd before the upgrade, it also enforces etcd checks before leaving. Default true
    reboot Boolean
    Reboot indicates whether node should reboot or halt after resetting. Default false
    reset Boolean
    Reset the machine to the initial state (STATE and EPHEMERAL will be wiped). Default false

    Timeout, TimeoutArgs

    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).
    Delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    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).
    Delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    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).
    delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    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).
    delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    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).
    delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    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).
    delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    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