Regen docs [email protected]

pulumi · Dec 1, 2023 · d72f3b3 · d72f3b3
1 parent a3c21d3
commit d72f3b3
Show file tree

Hide file tree

Showing 100 changed files with 1,153 additions and 931 deletions.
diff --git a/content/docs/cli/commands/pulumi.md b/content/docs/cli/commands/pulumi.md
@@ -67,11 +67,11 @@ For more information, please visit the project page: https://www.pulumi.com/docs
 * [pulumi preview](/docs/cli/commands/pulumi_preview/)	 - Show a preview of updates to a stack's resources
 * [pulumi refresh](/docs/cli/commands/pulumi_refresh/)	 - Refresh the resources in a stack
 * [pulumi schema](/docs/cli/commands/pulumi_schema/)	 - Analyze package schemas
-* [pulumi stack](/docs/cli/commands/pulumi_stack/)	 - Manage stacks
+* [pulumi stack](/docs/cli/commands/pulumi_stack/)	 - Manage stacks and view stack state
 * [pulumi state](/docs/cli/commands/pulumi_state/)	 - Edit the current stack's state
 * [pulumi up](/docs/cli/commands/pulumi_up/)	 - Create or update the resources in a stack
 * [pulumi version](/docs/cli/commands/pulumi_version/)	 - Print Pulumi's version number
 * [pulumi watch](/docs/cli/commands/pulumi_watch/)	 - Continuously update the resources in a stack
 * [pulumi whoami](/docs/cli/commands/pulumi_whoami/)	 - Display the current logged-in user
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_about.md b/content/docs/cli/commands/pulumi_about.md
@@ -54,4 +54,4 @@ pulumi about [flags]
 
 * [pulumi](/docs/cli/commands/pulumi/)	 - Pulumi command line
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_cancel.md b/content/docs/cli/commands/pulumi_cancel.md
@@ -51,4 +51,4 @@ pulumi cancel [<stack-name>] [flags]
 
 * [pulumi](/docs/cli/commands/pulumi/)	 - Pulumi command line
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_config.md b/content/docs/cli/commands/pulumi_config.md
@@ -11,7 +11,7 @@ Manage configuration
 ## Synopsis
 
 Lists all configuration values for a specific stack. To add a new configuration value, run
-`pulumi config set`. To remove and existing value run `pulumi config rm`. To get the value of
+`pulumi config set`. To remove an existing value run `pulumi config rm`. To get the value of
 for a specific configuration key, use `pulumi config get <key-name>`.
 
 ```
@@ -48,11 +48,12 @@ pulumi config [flags]
 
 * [pulumi](/docs/cli/commands/pulumi/)	 - Pulumi command line
 * [pulumi config cp](/docs/cli/commands/pulumi_config_cp/)	 - Copy config to another stack
+* [pulumi config env](/docs/cli/commands/pulumi_config_env/)	 - Manage ESC environments for a stack
 * [pulumi config get](/docs/cli/commands/pulumi_config_get/)	 - Get a single configuration value
 * [pulumi config refresh](/docs/cli/commands/pulumi_config_refresh/)	 - Update the local configuration based on the most recent deployment of the stack
 * [pulumi config rm](/docs/cli/commands/pulumi_config_rm/)	 - Remove configuration value
 * [pulumi config rm-all](/docs/cli/commands/pulumi_config_rm-all/)	 - Remove multiple configuration values
 * [pulumi config set](/docs/cli/commands/pulumi_config_set/)	 - Set configuration value
 * [pulumi config set-all](/docs/cli/commands/pulumi_config_set-all/)	 - Set multiple configuration values
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_config_cp.md b/content/docs/cli/commands/pulumi_config_cp.md
@@ -47,4 +47,4 @@ pulumi config cp [key] [flags]
 
 * [pulumi config](/docs/cli/commands/pulumi_config/)	 - Manage configuration
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_config_env.md b/content/docs/cli/commands/pulumi_config_env.md
@@ -0,0 +1,47 @@
+---
+title: "pulumi config env"
+aliases:
+  - /docs/reference/cli/pulumi_config_env/
+---
+
+
+
+Manage ESC environments for a stack
+
+## Synopsis
+
+Manages the ESC environment associated with a specific stack. To create a new environment
+from a stack's configuration, use `pulumi config env init`.
+
+## Options
+
+```
+  -h, --help   help for env
+```
+
+## Options inherited from parent commands
+
+```
+      --color string                 Colorize output. Choices are: always, never, raw, auto (default "auto")
+      --config-file string           Use the configuration values in the specified file rather than detecting the file name
+  -C, --cwd string                   Run pulumi as if it had been started in another directory
+      --disable-integrity-checking   Disable integrity checking of checkpoint files
+  -e, --emoji                        Enable emojis in the output
+      --logflow                      Flow log settings to child processes (like plugins)
+      --logtostderr                  Log to stderr instead of to files
+      --memprofilerate int           Enable more precise (and expensive) memory allocation profiles by setting runtime.MemProfileRate
+      --non-interactive              Disable interactive mode for all commands
+      --profiling string             Emit CPU and memory profiles and an execution trace to '[filename].[pid].{cpu,mem,trace}', respectively
+  -s, --stack string                 The name of the stack to operate on. Defaults to the current stack
+      --tracing file:                Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file
+  -v, --verbose int                  Enable verbose logging (e.g., v=3); anything >3 is very verbose
+```
+
+## SEE ALSO
+
+* [pulumi config](/docs/cli/commands/pulumi_config/)	 - Manage configuration
+* [pulumi config env add](/docs/cli/commands/pulumi_config_env_add/)	 - Add environments to a stack
+* [pulumi config env init](/docs/cli/commands/pulumi_config_env_init/)	 - Creates an environment for a stack
+* [pulumi config env rm](/docs/cli/commands/pulumi_config_env_rm/)	 - Remove environments from a stack
+
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_config_env_add.md b/content/docs/cli/commands/pulumi_config_env_add.md
@@ -0,0 +1,51 @@
+---
+title: "pulumi config env add"
+aliases:
+  - /docs/reference/cli/pulumi_config_env_add/
+---
+
+
+
+Add environments to a stack
+
+## Synopsis
+
+Adds environments to the end of a stack's import list. Imported environments are merged in order
+per the ESC merge rules. The list of stacks behaves as if it were the import list in an anonymous
+environment.
+
+```
+pulumi config env add [flags]
+```
+
+## Options
+
+```
+  -h, --help           help for add
+      --show-secrets   Show secret values in plaintext instead of ciphertext
+  -y, --yes            True to save changes without prompting
+```
+
+## Options inherited from parent commands
+
+```
+      --color string                 Colorize output. Choices are: always, never, raw, auto (default "auto")
+      --config-file string           Use the configuration values in the specified file rather than detecting the file name
+  -C, --cwd string                   Run pulumi as if it had been started in another directory
+      --disable-integrity-checking   Disable integrity checking of checkpoint files
+  -e, --emoji                        Enable emojis in the output
+      --logflow                      Flow log settings to child processes (like plugins)
+      --logtostderr                  Log to stderr instead of to files
+      --memprofilerate int           Enable more precise (and expensive) memory allocation profiles by setting runtime.MemProfileRate
+      --non-interactive              Disable interactive mode for all commands
+      --profiling string             Emit CPU and memory profiles and an execution trace to '[filename].[pid].{cpu,mem,trace}', respectively
+  -s, --stack string                 The name of the stack to operate on. Defaults to the current stack
+      --tracing file:                Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file
+  -v, --verbose int                  Enable verbose logging (e.g., v=3); anything >3 is very verbose
+```
+
+## SEE ALSO
+
+* [pulumi config env](/docs/cli/commands/pulumi_config_env/)	 - Manage ESC environments for a stack
+
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_config_env_init.md b/content/docs/cli/commands/pulumi_config_env_init.md
@@ -0,0 +1,53 @@
+---
+title: "pulumi config env init"
+aliases:
+  - /docs/reference/cli/pulumi_config_env_init/
+---
+
+
+
+Creates an environment for a stack
+
+## Synopsis
+
+Creates an environment for a specific stack based on the stack's configuration values,
+then replaces the stack's configuration values with a reference to that environment.
+The environment will be created in the same organization as the stack.
+
+```
+pulumi config env init [flags]
+```
+
+## Options
+
+```
+      --env string     The name of the environment to create. Defaults to "<project name>-<stack name>"
+  -h, --help           help for init
+      --keep-config    Do not remove configuration values from the stack after creating the environment
+      --show-secrets   Show secret values in plaintext instead of ciphertext
+  -y, --yes            True to save the created environment without prompting
+```
+
+## Options inherited from parent commands
+
+```
+      --color string                 Colorize output. Choices are: always, never, raw, auto (default "auto")
+      --config-file string           Use the configuration values in the specified file rather than detecting the file name
+  -C, --cwd string                   Run pulumi as if it had been started in another directory
+      --disable-integrity-checking   Disable integrity checking of checkpoint files
+  -e, --emoji                        Enable emojis in the output
+      --logflow                      Flow log settings to child processes (like plugins)
+      --logtostderr                  Log to stderr instead of to files
+      --memprofilerate int           Enable more precise (and expensive) memory allocation profiles by setting runtime.MemProfileRate
+      --non-interactive              Disable interactive mode for all commands
+      --profiling string             Emit CPU and memory profiles and an execution trace to '[filename].[pid].{cpu,mem,trace}', respectively
+  -s, --stack string                 The name of the stack to operate on. Defaults to the current stack
+      --tracing file:                Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file
+  -v, --verbose int                  Enable verbose logging (e.g., v=3); anything >3 is very verbose
+```
+
+## SEE ALSO
+
+* [pulumi config env](/docs/cli/commands/pulumi_config_env/)	 - Manage ESC environments for a stack
+
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_config_env_rm.md b/content/docs/cli/commands/pulumi_config_env_rm.md
@@ -0,0 +1,49 @@
+---
+title: "pulumi config env rm"
+aliases:
+  - /docs/reference/cli/pulumi_config_env_rm/
+---
+
+
+
+Remove environments from a stack
+
+## Synopsis
+
+Removes an environment from a stack's import list.
+
+```
+pulumi config env rm [flags]
+```
+
+## Options
+
+```
+  -h, --help           help for rm
+      --show-secrets   Show secret values in plaintext instead of ciphertext
+  -y, --yes            True to save changes without prompting
+```
+
+## Options inherited from parent commands
+
+```
+      --color string                 Colorize output. Choices are: always, never, raw, auto (default "auto")
+      --config-file string           Use the configuration values in the specified file rather than detecting the file name
+  -C, --cwd string                   Run pulumi as if it had been started in another directory
+      --disable-integrity-checking   Disable integrity checking of checkpoint files
+  -e, --emoji                        Enable emojis in the output
+      --logflow                      Flow log settings to child processes (like plugins)
+      --logtostderr                  Log to stderr instead of to files
+      --memprofilerate int           Enable more precise (and expensive) memory allocation profiles by setting runtime.MemProfileRate
+      --non-interactive              Disable interactive mode for all commands
+      --profiling string             Emit CPU and memory profiles and an execution trace to '[filename].[pid].{cpu,mem,trace}', respectively
+  -s, --stack string                 The name of the stack to operate on. Defaults to the current stack
+      --tracing file:                Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file
+  -v, --verbose int                  Enable verbose logging (e.g., v=3); anything >3 is very verbose
+```
+
+## SEE ALSO
+
+* [pulumi config env](/docs/cli/commands/pulumi_config_env/)	 - Manage ESC environments for a stack
+
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_config_get.md b/content/docs/cli/commands/pulumi_config_get.md
@@ -51,4 +51,4 @@ pulumi config get <key> [flags]
 
 * [pulumi config](/docs/cli/commands/pulumi_config/)	 - Manage configuration
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_config_refresh.md b/content/docs/cli/commands/pulumi_config_refresh.md
@@ -41,4 +41,4 @@ pulumi config refresh [flags]
 
 * [pulumi config](/docs/cli/commands/pulumi_config/)	 - Manage configuration
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_config_rm-all.md b/content/docs/cli/commands/pulumi_config_rm-all.md
@@ -51,4 +51,4 @@ pulumi config rm-all <key1> <key2> <key3> ... [flags]
 
 * [pulumi config](/docs/cli/commands/pulumi_config/)	 - Manage configuration
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_config_rm.md b/content/docs/cli/commands/pulumi_config_rm.md
@@ -50,4 +50,4 @@ pulumi config rm <key> [flags]
 
 * [pulumi config](/docs/cli/commands/pulumi_config/)	 - Manage configuration
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_config_set-all.md b/content/docs/cli/commands/pulumi_config_set-all.md
@@ -61,4 +61,4 @@ pulumi config set-all --plaintext key1=value1 --plaintext key2=value2 --secret k
 
 * [pulumi config](/docs/cli/commands/pulumi_config/)	 - Manage configuration
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_config_set.md b/content/docs/cli/commands/pulumi_config_set.md
@@ -56,4 +56,4 @@ pulumi config set <key> [value] [flags]
 
 * [pulumi config](/docs/cli/commands/pulumi_config/)	 - Manage configuration
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_console.md b/content/docs/cli/commands/pulumi_console.md
@@ -39,4 +39,4 @@ pulumi console [flags]
 
 * [pulumi](/docs/cli/commands/pulumi/)	 - Pulumi command line
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_convert.md b/content/docs/cli/commands/pulumi_convert.md
@@ -57,4 +57,4 @@ pulumi convert [flags]
 
 * [pulumi](/docs/cli/commands/pulumi/)	 - Pulumi command line
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_destroy.md b/content/docs/cli/commands/pulumi_destroy.md
@@ -70,4 +70,4 @@ pulumi destroy [flags]
 
 * [pulumi](/docs/cli/commands/pulumi/)	 - Pulumi command line
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_env.md b/content/docs/cli/commands/pulumi_env.md
@@ -59,4 +59,4 @@ For more information, please visit the project page: https://www.pulumi.com/docs
 * [pulumi env run](/docs/cli/commands/pulumi_env_run/)	 - Open the environment with the given name and run a command.
 * [pulumi env set](/docs/cli/commands/pulumi_env_set/)	 - Set a value within an environment.
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_env_edit.md b/content/docs/cli/commands/pulumi_env_edit.md
@@ -53,4 +53,4 @@ pulumi env edit [<org-name>/]<environment-name> [flags]
 
 * [pulumi env](/docs/cli/commands/pulumi_env/)	 - Manage environments
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_env_get.md b/content/docs/cli/commands/pulumi_env_get.md
@@ -50,4 +50,4 @@ pulumi env get [<org-name>/]<environment-name> <path> [flags]
 
 * [pulumi env](/docs/cli/commands/pulumi_env/)	 - Manage environments
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_env_init.md b/content/docs/cli/commands/pulumi_env_init.md
@@ -51,4 +51,4 @@ pulumi env init [<org-name>/]<environment-name> [flags]
 
 * [pulumi env](/docs/cli/commands/pulumi_env/)	 - Manage environments
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_env_ls.md b/content/docs/cli/commands/pulumi_env_ls.md
@@ -47,4 +47,4 @@ pulumi env ls [flags]
 
 * [pulumi env](/docs/cli/commands/pulumi_env/)	 - Manage environments
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_env_open.md b/content/docs/cli/commands/pulumi_env_open.md
@@ -49,4 +49,4 @@ pulumi env open [<org-name>/]<environment-name> [property path] [flags]
 
 * [pulumi env](/docs/cli/commands/pulumi_env/)	 - Manage environments
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_env_rm.md b/content/docs/cli/commands/pulumi_env_rm.md
@@ -48,4 +48,4 @@ pulumi env rm [<org-name>/]<environment-name> [path] [flags]
 
 * [pulumi env](/docs/cli/commands/pulumi_env/)	 - Manage environments
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_env_run.md b/content/docs/cli/commands/pulumi_env_run.md
@@ -64,4 +64,4 @@ pulumi env run [<org-name>/]<environment-name> [flags] -- [command]
 
 * [pulumi env](/docs/cli/commands/pulumi_env/)	 - Manage environments
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_env_set.md b/content/docs/cli/commands/pulumi_env_set.md
@@ -50,4 +50,4 @@ pulumi env set [<org-name>/]<environment-name> <path> <value> [flags]
 
 * [pulumi env](/docs/cli/commands/pulumi_env/)	 - Manage environments
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_gen-completion.md b/content/docs/cli/commands/pulumi_gen-completion.md
@@ -38,4 +38,4 @@ pulumi gen-completion <SHELL> [flags]
 
 * [pulumi](/docs/cli/commands/pulumi/)	 - Pulumi command line
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_import.md b/content/docs/cli/commands/pulumi_import.md
@@ -129,4 +129,4 @@ pulumi import [type] [name] [id] [flags]
 
 * [pulumi](/docs/cli/commands/pulumi/)	 - Pulumi command line
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_install.md b/content/docs/cli/commands/pulumi_install.md
@@ -45,4 +45,4 @@ pulumi install [flags]
 
 * [pulumi](/docs/cli/commands/pulumi/)	 - Pulumi command line
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_login.md b/content/docs/cli/commands/pulumi_login.md
@@ -90,4 +90,4 @@ pulumi login [<url>] [flags]
 
 * [pulumi](/docs/cli/commands/pulumi/)	 - Pulumi command line
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023
diff --git a/content/docs/cli/commands/pulumi_logout.md b/content/docs/cli/commands/pulumi_logout.md
@@ -55,4 +55,4 @@ pulumi logout <url> [flags]
 
 * [pulumi](/docs/cli/commands/pulumi/)	 - Pulumi command line
 
-###### Auto generated by spf13/cobra on 17-Nov-2023
+###### Auto generated by spf13/cobra on 1-Dec-2023