Skip to content

Commit

Permalink
Revert docs/2-the-zarf-cli/100-cli-commands/ to the state of commit 5…
Browse files Browse the repository at this point in the history
  • Loading branch information
waveywaves committed Jul 2, 2024
1 parent 2510d25 commit 5a57bd4
Show file tree
Hide file tree
Showing 67 changed files with 20 additions and 134 deletions.
1 change: 0 additions & 1 deletion docs/2-the-zarf-cli/100-cli-commands/zarf.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ zarf COMMAND [flags]

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
-h, --help help for zarf
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
Expand Down
1 change: 0 additions & 1 deletion docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ See each sub-command's help for details on how to use the generated script.

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ zarf completion bash

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ zarf completion fish [flags]

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ zarf completion powershell [flags]

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ zarf completion zsh [flags]

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
1 change: 0 additions & 1 deletion docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ zarf connect { REGISTRY | LOGGING | GIT | connect-name } [flags]

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
1 change: 0 additions & 1 deletion docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ zarf connect list [flags]

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
1 change: 0 additions & 1 deletion docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ zarf destroy --confirm [flags]

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
2 changes: 0 additions & 2 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ Commands useful for developing packages

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand All @@ -28,7 +27,6 @@ Commands useful for developing packages
* [zarf](zarf.md) - DevSecOps for Airgap
* [zarf dev deploy](zarf_dev_deploy.md) - [beta] Creates and deploys a Zarf package from a given directory
* [zarf dev find-images](zarf_dev_find-images.md) - Evaluates components in a Zarf file to identify images specified in their helm charts and manifests
* [zarf dev generate](zarf_dev_generate.md) - [alpha] Creates a zarf.yaml automatically from a given remote (git) Helm chart
* [zarf dev generate-config](zarf_dev_generate-config.md) - Generates a config file for Zarf
* [zarf dev lint](zarf_dev_lint.md) - Lints the given package for valid schema and recommended practices
* [zarf dev patch-git](zarf_dev_patch-git.md) - Converts all .git URLs to the specified Zarf HOST and with the Zarf URL pattern in a given FILE. NOTE:
Expand Down
5 changes: 0 additions & 5 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_dev_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,19 @@ zarf dev deploy [flags]
## Options

```
--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.
--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.
--create-set stringToString Specify package variables to set on the command line (KEY=value) (default [])
--deploy-set stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
-h, --help help for deploy
--no-yolo Disable the YOLO mode default override and create / deploy the package as-defined
--registry-override stringToString Specify a map of domains to override on package create when pulling images (e.g. --registry-override docker.io=dockerio-reg.enterprise.intranet) (default [])
--retries int Number of retries to perform for Zarf deploy operations like git/image pushes or Helm installs (default 3)
--skip-webhooks [alpha] Skip waiting for external webhooks to execute as each package component is deployed
--timeout duration Timeout for Helm operations such as installs and rollbacks (default 15m0s)
```

## Options inherited from parent commands

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
13 changes: 4 additions & 9 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_dev_find-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,16 @@ zarf dev find-images [ PACKAGE ] [flags]
## Options

```
--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 [])
--deploy-set stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
-h, --help help for find-images
--kube-version string Override the default helm template KubeVersion when performing a package chart template
--registry-url string Override the ###ZARF_REGISTRY### value (default "127.0.0.1:31999")
-p, --repo-chart-path string If git repos hold helm charts, often found with gitops tools, specify the chart path, e.g. "/" or "/chart"
--why string Prints the source manifest for the specified image
-h, --help help for find-images
--kube-version string Override the default helm template KubeVersion when performing a package chart template
-p, --repo-chart-path string If git repos hold helm charts, often found with gitops tools, specify the chart path, e.g. "/" or "/chart"
--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 [])
```

## Options inherited from parent commands

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ zarf dev generate-config [ FILENAME ] [flags]

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
1 change: 0 additions & 1 deletion docs/2-the-zarf-cli/100-cli-commands/zarf_dev_lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ zarf dev lint [ DIRECTORY ] [flags]

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
1 change: 0 additions & 1 deletion docs/2-the-zarf-cli/100-cli-commands/zarf_dev_patch-git.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ zarf dev patch-git HOST FILE [flags]

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
1 change: 0 additions & 1 deletion docs/2-the-zarf-cli/100-cli-commands/zarf_dev_sha256sum.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ zarf dev sha256sum { FILE | URL } [flags]

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
2 changes: 0 additions & 2 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ $ zarf init --artifact-push-password={PASSWORD} --artifact-push-username={USERNA
--registry-push-username string Username to access to the registry Zarf is configured to use (default "zarf-push")
--registry-secret string Registry secret value
--registry-url string External registry url address to use for this Zarf cluster
--retries int Number of retries to perform for Zarf deploy operations like git/image pushes or Helm installs (default 3)
--set stringToString Specify deployment variables to set on the command line (KEY=value) (default [])
--skip-webhooks [alpha] Skip waiting for external webhooks to execute as each package component is deployed
--storage-class string Specify the storage class to use for the registry and git server. E.g. --storage-class=standard
Expand All @@ -81,7 +80,6 @@ $ zarf init --artifact-push-password={PASSWORD} --artifact-push-username={USERNA

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
1 change: 0 additions & 1 deletion docs/2-the-zarf-cli/100-cli-commands/zarf_package.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Zarf package commands for creating, deploying, and inspecting packages

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
2 changes: 0 additions & 2 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ zarf package create [ DIRECTORY ] [flags]
-m, --max-package-size int Specify the maximum size of the package in megabytes, packages larger than this will be split into multiple parts to be loaded onto smaller media (i.e. DVDs). Use 0 to disable splitting.
-o, --output string Specify the output (either a directory or an oci:// URL) for the created Zarf package
--registry-override stringToString Specify a map of domains to override on package create when pulling images (e.g. --registry-override docker.io=dockerio-reg.enterprise.intranet) (default [])
--retries int Number of retries to perform for Zarf deploy operations like git/image pushes or Helm installs (default 3)
-s, --sbom View SBOM contents after creating the package
--sbom-out string Specify an output directory for the SBOMs from the created Zarf package
--set stringToString Specify package variables to set on the command line (KEY=value) (default [])
Expand All @@ -36,7 +35,6 @@ zarf package create [ DIRECTORY ] [flags]

```
-a, --architecture string Architecture for OCI images and Zarf packages
--config-path string Specify the path of the configuration file to use
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
Expand Down
Loading

0 comments on commit 5a57bd4

Please sign in to comment.