How to Manage Pulumi Stack Configuration with 'pulumi config' (with examples)

The pulumi config command is a powerful tool provided by Pulumi, an infrastructure as code (IaC) platform, designed to manage the configuration of a Pulumi stack. It allows users to view, set, and manage configuration values efficiently. The command is instrumental in both development and deployment processes, ensuring that settings are correctly applied to different environments. More information about this command can be found in the official documentation at https://www.pulumi.com/docs/iac/cli/commands/pulumi_config/ .

Use Case 1: View Current Configuration in JSON Format

Code:

pulumi config --json

Motivation:

Viewing the current configuration of a Pulumi stack in JSON format is essential for understanding the stack’s settings clearly and precisely. The JSON format is particularly useful for automation scripts or when integrating with other tools that can read JSON. It provides a structured, machine-readable output that is ideal for programmatic consumption.

Explanation:

• pulumi config: The base command to access Pulumi stack configuration settings.
• --json: An option to output the configuration in JSON format rather than the default human-readable form. This switches the output to a format that is structured and easier to parse programmatically.

Example output:

{
  "config-key-1": "value1",
  "config-key-2": "value2"
}

Use Case 2: Get the Value of a Configuration Key

Code:

pulumi config get key

Motivation:

Fetching the value of a particular configuration key is crucial when you need to verify or validate the specific setting currently in use without altering other configurations. It is especially useful in scripts and automation where conditional logic might depend on certain configuration values.

Explanation:

• pulumi config get: The command to retrieve the value of a specific configuration key.
• key: The actual configuration key whose value you want to retrieve. This is user-defined and corresponds to a particular setting in your stack.

Example output:

value1

Use Case 3: Remove a Configuration Value

Code:

pulumi config rm key

Motivation:

Removing a configuration value is essential when the setting is no longer needed, or you want to ensure that outdated or sensitive information is cleared from your current configuration. This helps in maintaining a clean, efficient configuration state and avoids potential security risks associated with leaving unused sensitive data in the configuration.

Explanation:

• pulumi config rm: The command to remove a specified configuration key and its associated value.
• key: The key representing the configuration setting you wish to remove from the current stack.

Example output:

Removed key 'key'

Use Case 4: Set a Value for a Configuration Key from a File

Code:

cat path/to/file | pulumi config set key

Motivation:

Setting a configuration value from a file is beneficial when dealing with large or complex data that is better managed in a separate file rather than directly in the command line. This method helps automate configuration processes by allowing file-based imports, particularly useful in CI/CD pipelines.

Explanation:

• cat path/to/file: A command that outputs the contents of a specified file.
• |: A pipe that passes the output of the cat command to the next command.
• pulumi config set: The command used to assign a new value to a configuration key.
• key: The configuration key to which you want to assign a new value. This key will be associated with the file’s content.

Example output:

Set key 'key'

Use Case 5: Set a Secret Value for a Configuration Key and Store/Display as Ciphertext

Code:

pulumi config set --secret key S3cr37_value

Motivation:

Storing sensitive information like API keys securely is paramount. Using the secret feature ensures that such data is encrypted and won’t be accidentally exposed in plain text. It enhances the security of your configurations by encrypting the values and safely storing them in the state backend.

Explanation:

• pulumi config set: This base command is used to assign a value to a configuration key.
• --secret: A flag indicating that the value should be treated as a secret, meaning it will be encrypted at rest.
• key: The configuration key for storing the secret value.
• S3cr37_value: The sensitive data you want to store securely, keeping it safe from prying eyes and unauthorized access.

Example output:

Set secret key 'key'

Use Case 6: Remove Multiple Configuration Values from a Specified Configuration File

Code:

pulumi config --config-file path/to/file rm-all key1 key2 ...

Motivation:

This use case is particularly advantageous when you need to clean up multiple configuration values at once from a specific file, especially when managing several auxiliary stacks or environments where configurations can vary significantly. It facilitates batch operations, improving efficiency and reducing human errors in manual operations.

Explanation:

• pulumi config: The main command used for configuration operations.
• --config-file path/to/file: Specifies the configuration file from which the keys should be removed, indicating the need to work with a separate config file rather than the default or current stack configuration.
• rm-all: A sub-command that allows the removal of multiple configuration keys.
• key1 key2 ...: A list of keys to be removed from the specified configuration file, allowing batch removal operations.

Example output:

Removed keys 'key1', 'key2', ...

Conclusion:

The pulumi config command is an essential tool in managing the configurations of Pulumi stacks. These examples illustrate the flexibility and utility provided by this command, allowing users to view, set, and manage their configurations efficiently and securely. Whether automating deployment pipelines or ensuring sensitive information is protected, pulumi config provides the necessary functionality to meet infrastructure as code configuration needs.