Skip to content

Commit 345765d

Browse files
authored
feat: add --set-values flags and migrate --set to alias new --set-variables (#4466)
Signed-off-by: Kit Patella <kit@defenseunicorns.com>
1 parent 89e7db4 commit 345765d

22 files changed

+192
-132
lines changed

site/src/content/docs/commands/zarf_dev_deploy.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,17 @@ zarf dev deploy [flags]
2121
### Options
2222

2323
```
24-
--adopt-existing-resources Adopts any pre-existing K8s resources into the Helm charts managed by Zarf. ONLY use when you have existing deployments you want Zarf to takeover.
25-
--components string Comma-separated list of components to deploy. Adding this flag will skip the prompts for selected components. Globbing component names with '*' and deselecting 'default' components with a leading '-' are also supported.
26-
--create-set stringToString Specify package variables to set on the command line (KEY=value) (default [])
27-
--deploy-set stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
28-
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
29-
-h, --help help for deploy
30-
--no-yolo Disable the YOLO mode default override and create / deploy the package as-defined
31-
--oci-concurrency int Number of concurrent layer operations when pulling or pushing images or packages to/from OCI registries. (default 6)
32-
--registry-override stringArray Specify a mapping of domains to override on package create when pulling images (e.g. --registry-override docker.io=dockerio-reg.enterprise.intranet)
33-
--retries int Number of retries to perform for Zarf operations like git/image pushes (default 3)
34-
--timeout duration Timeout for health checks and Helm operations such as installs and rollbacks (default 15m0s)
24+
--adopt-existing-resources Adopts any pre-existing K8s resources into the Helm charts managed by Zarf. ONLY use when you have existing deployments you want Zarf to takeover.
25+
--components string Comma-separated list of components to deploy. Adding this flag will skip the prompts for selected components. Globbing component names with '*' and deselecting 'default' components with a leading '-' are also supported.
26+
--create-set stringToString Specify package templates to set on the command line (KEY=value) (default [])
27+
--deploy-set-variables stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
28+
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
29+
-h, --help help for deploy
30+
--no-yolo Disable the YOLO mode default override and create / deploy the package as-defined
31+
--oci-concurrency int Number of concurrent layer operations when pulling or pushing images or packages to/from OCI registries. (default 6)
32+
--registry-override stringArray Specify a mapping of domains to override on package create when pulling images (e.g. --registry-override docker.io=dockerio-reg.enterprise.intranet)
33+
--retries int Number of retries to perform for Zarf operations like git/image pushes (default 3)
34+
--timeout duration Timeout for health checks and Helm operations such as installs and rollbacks (default 15m0s)
3535
```
3636

3737
### Options inherited from parent commands

site/src/content/docs/commands/zarf_dev_find-images.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ zarf dev find-images [ DIRECTORY ] [flags]
2323
### Options
2424

2525
```
26-
--create-set stringToString Specify package variables to set on the command line (KEY=value). Note, if using a config file, this will be set by [package.create.set]. (default [])
27-
--deploy-set stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
28-
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
29-
-h, --help help for find-images
30-
--kube-version string Override the default helm template KubeVersion when performing a package chart template
31-
--registry-url string Override the ###ZARF_REGISTRY### value (default "127.0.0.1:31999")
32-
-p, --repo-chart-path string If git repos hold helm charts, often found with gitops tools, specify the chart path, e.g. "/" or "/chart"
33-
--skip-cosign Skip searching for cosign artifacts related to discovered images
34-
-u, --update Update the images in the zarf.yaml file if needed. Formatting such as comments and newlines may change.
35-
--why string Prints the source manifest for the specified image
26+
--create-set stringToString Specify package templates to set on the command line (KEY=value). Note, if using a config file, this will be set by [package.create.set]. (default [])
27+
--deploy-set-variables stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
28+
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
29+
-h, --help help for find-images
30+
--kube-version string Override the default helm template KubeVersion when performing a package chart template
31+
--registry-url string Override the ###ZARF_REGISTRY### value (default "127.0.0.1:31999")
32+
-p, --repo-chart-path string If git repos hold helm charts, often found with gitops tools, specify the chart path, e.g. "/" or "/chart"
33+
--skip-cosign Skip searching for cosign artifacts related to discovered images
34+
-u, --update Update the images in the zarf.yaml file if needed. Formatting such as comments and newlines may change.
35+
--why string Prints the source manifest for the specified image
3636
```
3737

3838
### Options inherited from parent commands

site/src/content/docs/commands/zarf_dev_inspect_definition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ zarf dev inspect definition [ DIRECTORY ] [flags]
2323
```
2424
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
2525
-h, --help help for definition
26-
--set stringToString Specify package variables to set on the command line (KEY=value) (default [])
26+
--set stringToString Specify package templates to set on the command line (KEY=value) (default [])
2727
```
2828

2929
### Options inherited from parent commands

site/src/content/docs/commands/zarf_dev_inspect_manifests.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ zarf dev inspect manifests [ DIRECTORY ] [flags]
1717
### Options
1818

1919
```
20-
--create-set stringToString Specify package variables to set on the command line (KEY=value) (default [])
21-
--deploy-set stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
22-
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
23-
-h, --help help for manifests
24-
--kube-version string Override the default helm template KubeVersion when performing a package chart template
25-
--set-values stringToString Set specific values via command line (format: key.path=value) (default [])
26-
--values strings Path to values file(s) for templating
20+
--create-set stringToString Specify package templates to set on the command line (KEY=value) (default [])
21+
--deploy-set-variables stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
22+
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
23+
-h, --help help for manifests
24+
--kube-version string Override the default helm template KubeVersion when performing a package chart template
25+
--set-values stringToString Specify deployment package values to set on the command line (key.path=value). (default [])
26+
--values strings [alpha] Values files to use for templating and Helm overrides. Multiple files can be passed in as a comma separated list, and the flag can be provided multiple times.
2727
```
2828

2929
### Options inherited from parent commands

site/src/content/docs/commands/zarf_dev_inspect_values-files.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ zarf dev inspect values-files [ DIRECTORY ] [flags]
2121
### Options
2222

2323
```
24-
--create-set stringToString Specify package variables to set on the command line (KEY=value) (default [])
25-
--deploy-set stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
26-
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
27-
-h, --help help for values-files
28-
--kube-version string Override the default helm template KubeVersion when performing a package chart template
29-
--set-values stringToString Set specific values via command line (format: key.path=value) (default [])
30-
--values strings Path to values file(s) for templating
24+
--create-set stringToString Specify package templates to set on the command line (KEY=value) (default [])
25+
--deploy-set-variables stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
26+
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
27+
-h, --help help for values-files
28+
--kube-version string Override the default helm template KubeVersion when performing a package chart template
29+
--set-values stringToString Specify deployment package values to set on the command line (key.path=value). (default [])
30+
--values strings [alpha] Values files to use for templating and Helm overrides. Multiple files can be passed in as a comma separated list, and the flag can be provided multiple times.
3131
```
3232

3333
### Options inherited from parent commands

site/src/content/docs/commands/zarf_dev_lint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ zarf dev lint [ DIRECTORY ] [flags]
2323
```
2424
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
2525
-h, --help help for lint
26-
--set stringToString Specify package variables to set on the command line (KEY=value) (default [])
26+
--set stringToString Specify package templates to set on the command line (KEY=value) (default [])
2727
```
2828

2929
### Options inherited from parent commands

site/src/content/docs/commands/zarf_init.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ $ zarf init --artifact-push-password={PASSWORD} --artifact-push-username={USERNA
7777
--registry-secret string Registry secret value
7878
--registry-url string External registry url address to use for this Zarf cluster
7979
--retries int Number of retries to perform for Zarf operations like git/image pushes (default 3)
80-
--set stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
80+
--set-variables stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
8181
--storage-class string Specify the storage class to use for the registry and git server. E.g. --storage-class=standard
8282
--timeout duration Timeout for health checks and Helm operations such as installs and rollbacks (default 15m0s)
8383
--verify Verify the Zarf package signature

site/src/content/docs/commands/zarf_package_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ zarf package create [ DIRECTORY ] [flags]
3333
--registry-override strings Specify a mapping of domains to override on package create when pulling images (e.g. --registry-override docker.io=dockerio-reg.enterprise.intranet)
3434
-s, --sbom View SBOM contents after creating the package
3535
--sbom-out string Specify an output directory for the SBOMs from the created Zarf package
36-
--set stringToString Specify package variables to set on the command line (KEY=value) (default [])
36+
--set stringToString Specify package templates to set on the command line (KEY=value) (default [])
3737
--signing-key string Private key for signing packages. Accepts either a local file path or a Cosign-supported key provider
3838
--signing-key-pass string Password to the private key used for signing packages
3939
--skip-sbom Skip generating SBOM for this package

site/src/content/docs/commands/zarf_package_deploy.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,20 @@ zarf package deploy [ PACKAGE_SOURCE ] [flags]
2222
### Options
2323

2424
```
25-
--adopt-existing-resources Adopts any pre-existing K8s resources into the Helm charts managed by Zarf. ONLY use when you have existing deployments you want Zarf to takeover.
26-
--components string Comma-separated list of components to deploy. Adding this flag will skip the prompts for selected components. Globbing component names with '*' and deselecting 'default' components with a leading '-' are also supported.
27-
-c, --confirm Confirms package deployment without prompting. ONLY use with packages you trust. Skips prompts to review SBOM, configure variables, select optional components and review potential breaking changes.
28-
-h, --help help for deploy
29-
-k, --key string Path to public key file for validating signed packages
30-
-n, --namespace string [Alpha] Override the namespace for package deployment. Requires the package to have only one distinct namespace defined.
31-
--oci-concurrency int Number of concurrent layer operations when pulling or pushing images or packages to/from OCI registries. (default 6)
32-
--retries int Number of retries to perform for Zarf operations like git/image pushes (default 3)
33-
--set stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
34-
--shasum string Shasum of the package to deploy. Required if deploying a remote https package.
35-
--timeout duration Timeout for health checks and Helm operations such as installs and rollbacks (default 15m0s)
36-
-v, --values strings [alpha] Values files to use for templating and Helm overrides. Multiple files can be passed in as a comma separated list, and the flag can be provided multiple times.
37-
--verify Verify the Zarf package signature
25+
--adopt-existing-resources Adopts any pre-existing K8s resources into the Helm charts managed by Zarf. ONLY use when you have existing deployments you want Zarf to takeover.
26+
--components string Comma-separated list of components to deploy. Adding this flag will skip the prompts for selected components. Globbing component names with '*' and deselecting 'default' components with a leading '-' are also supported.
27+
-c, --confirm Confirms package deployment without prompting. ONLY use with packages you trust. Skips prompts to review SBOM, configure variables, select optional components and review potential breaking changes.
28+
-h, --help help for deploy
29+
-k, --key string Path to public key file for validating signed packages
30+
-n, --namespace string [Alpha] Override the namespace for package deployment. Requires the package to have only one distinct namespace defined.
31+
--oci-concurrency int Number of concurrent layer operations when pulling or pushing images or packages to/from OCI registries. (default 6)
32+
--retries int Number of retries to perform for Zarf operations like git/image pushes (default 3)
33+
--set-values stringToString Specify deployment package values to set on the command line (key.path=value). (default [])
34+
--set-variables stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
35+
--shasum string Shasum of the package to deploy. Required if deploying a remote https package.
36+
--timeout duration Timeout for health checks and Helm operations such as installs and rollbacks (default 15m0s)
37+
-v, --values strings [alpha] Values files to use for templating and Helm overrides. Multiple files can be passed in as a comma separated list, and the flag can be provided multiple times.
38+
--verify Verify the Zarf package signature
3839
```
3940

4041
### Options inherited from parent commands

site/src/content/docs/commands/zarf_package_inspect_manifests.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ zarf package inspect manifests [ PACKAGE ] [flags]
1717
### Options
1818

1919
```
20-
--components string comma separated list of components to show manifests for
21-
-h, --help help for manifests
22-
-k, --key string Path to public key file for validating signed packages
23-
--kube-version string Override the default helm template KubeVersion when performing a package chart template
24-
--oci-concurrency int Number of concurrent layer operations when pulling or pushing images or packages to/from OCI registries. (default 6)
25-
--set stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
26-
--verify Verify the Zarf package signature
20+
--components string comma separated list of components to show manifests for
21+
-h, --help help for manifests
22+
-k, --key string Path to public key file for validating signed packages
23+
--kube-version string Override the default helm template KubeVersion when performing a package chart template
24+
--oci-concurrency int Number of concurrent layer operations when pulling or pushing images or packages to/from OCI registries. (default 6)
25+
--set-variables stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
26+
--verify Verify the Zarf package signature
2727
```
2828

2929
### Options inherited from parent commands

0 commit comments

Comments
 (0)