Skip to content

Commit

Permalink
make docs-and-schema
Browse files Browse the repository at this point in the history
  • Loading branch information
caesarshift committed Jul 7, 2023
1 parent 6062585 commit 1f7e6ec
Show file tree
Hide file tree
Showing 49 changed files with 123 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ zarf COMMAND [flags]
-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")
--no-color Disable colors in output
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
Expand All @@ -35,3 +36,4 @@ zarf COMMAND [flags]
* [zarf prepare](zarf_prepare.md) - Tools to help prepare assets for packaging
* [zarf tools](zarf_tools.md) - Collection of additional tools to make airgap easier
* [zarf version](zarf_version.md) - Shows the version of the running Zarf binary

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ 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
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
Expand All @@ -34,3 +35,4 @@ See each sub-command's help for details on how to use the generated script.
* [zarf completion fish](zarf_completion_fish.md) - Generate the autocompletion script for fish
* [zarf completion powershell](zarf_completion_powershell.md) - Generate the autocompletion script for powershell
* [zarf completion zsh](zarf_completion_zsh.md) - Generate the autocompletion script for zsh

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ zarf completion bash
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
Expand All @@ -53,3 +54,4 @@ zarf completion bash
## SEE ALSO

* [zarf completion](zarf_completion.md) - Generate the autocompletion script for the specified shell

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ zarf completion fish [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
Expand All @@ -44,3 +45,4 @@ zarf completion fish [flags]
## SEE ALSO

* [zarf completion](zarf_completion.md) - Generate the autocompletion script for the specified shell

Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ zarf completion powershell [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
Expand All @@ -41,3 +42,4 @@ zarf completion powershell [flags]
## SEE ALSO

* [zarf completion](zarf_completion.md) - Generate the autocompletion script for the specified shell

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ zarf completion zsh [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
Expand All @@ -55,3 +56,4 @@ zarf completion zsh [flags]
## SEE ALSO

* [zarf completion](zarf_completion.md) - Generate the autocompletion script for the specified shell

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ zarf connect { REGISTRY | LOGGING | GIT | connect-name } [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
Expand All @@ -45,3 +46,4 @@ zarf connect { REGISTRY | LOGGING | GIT | connect-name } [flags]

* [zarf](zarf.md) - DevSecOps for Airgap
* [zarf connect list](zarf_connect_list.md) - Lists all available connection shortcuts

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ zarf connect list [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
Expand All @@ -28,3 +29,4 @@ zarf connect list [flags]
## SEE ALSO

* [zarf connect](zarf_connect.md) - Accesses services or pods deployed in the cluster

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ zarf destroy --confirm [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
Expand All @@ -40,3 +41,4 @@ zarf destroy --confirm [flags]
## SEE ALSO

* [zarf](zarf.md) - DevSecOps for Airgap

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ zarf init [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
Expand All @@ -82,3 +83,4 @@ zarf init [flags]
## SEE ALSO

* [zarf](zarf.md) - DevSecOps for Airgap

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_package.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Zarf package commands for creating, deploying, and inspecting packages
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
Expand All @@ -32,3 +33,4 @@ Zarf package commands for creating, deploying, and inspecting packages
* [zarf package publish](zarf_package_publish.md) - Publishes a Zarf package to a remote registry
* [zarf package pull](zarf_package_pull.md) - Pulls a Zarf package from a remote registry and save to the local file system
* [zarf package remove](zarf_package_remove.md) - Removes a Zarf package that has been deployed already (runs offline)

2 changes: 2 additions & 0 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 @@ -36,6 +36,7 @@ zarf package create [ DIRECTORY ] [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--oci-concurrency int Number of concurrent layer operations to perform when interacting with a remote package. (default 3)
Expand All @@ -46,3 +47,4 @@ zarf package create [ DIRECTORY ] [flags]
## SEE ALSO

* [zarf package](zarf_package.md) - Zarf package commands for creating, deploying, and inspecting packages

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ zarf package deploy [ PACKAGE ] [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--oci-concurrency int Number of concurrent layer operations to perform when interacting with a remote package. (default 3)
Expand All @@ -41,3 +42,4 @@ zarf package deploy [ PACKAGE ] [flags]
## SEE ALSO

* [zarf package](zarf_package.md) - Zarf package commands for creating, deploying, and inspecting packages

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ zarf package inspect [ PACKAGE ] [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--oci-concurrency int Number of concurrent layer operations to perform when interacting with a remote package. (default 3)
Expand All @@ -36,3 +37,4 @@ zarf package inspect [ PACKAGE ] [flags]
## SEE ALSO

* [zarf package](zarf_package.md) - Zarf package commands for creating, deploying, and inspecting packages

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ zarf package list [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--oci-concurrency int Number of concurrent layer operations to perform when interacting with a remote package. (default 3)
Expand All @@ -29,3 +30,4 @@ zarf package list [flags]
## SEE ALSO

* [zarf package](zarf_package.md) - Zarf package commands for creating, deploying, and inspecting packages

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ zarf package publish { PACKAGE | SKELETON DIRECTORY } REPOSITORY [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--oci-concurrency int Number of concurrent layer operations to perform when interacting with a remote package. (default 3)
Expand All @@ -43,3 +44,4 @@ zarf package publish { PACKAGE | SKELETON DIRECTORY } REPOSITORY [flags]
## SEE ALSO

* [zarf package](zarf_package.md) - Zarf package commands for creating, deploying, and inspecting packages

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ zarf package pull REFERENCE [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--oci-concurrency int Number of concurrent layer operations to perform when interacting with a remote package. (default 3)
Expand All @@ -37,3 +38,4 @@ zarf package pull REFERENCE [flags]
## SEE ALSO

* [zarf package](zarf_package.md) - Zarf package commands for creating, deploying, and inspecting packages

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ zarf package remove { PACKAGE_NAME | PACKAGE_FILE } --confirm [flags]
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--oci-concurrency int Number of concurrent layer operations to perform when interacting with a remote package. (default 3)
Expand All @@ -31,3 +32,4 @@ zarf package remove { PACKAGE_NAME | PACKAGE_FILE } --confirm [flags]
## SEE ALSO

* [zarf package](zarf_package.md) - Zarf package commands for creating, deploying, and inspecting packages

2 changes: 2 additions & 0 deletions docs/2-the-zarf-cli/100-cli-commands/zarf_prepare.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Tools to help prepare assets for packaging
-a, --architecture string Architecture for OCI images and Zarf packages
--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
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
Expand All @@ -29,3 +30,4 @@ Tools to help prepare assets for packaging
* [zarf prepare patch-git](zarf_prepare_patch-git.md) - Converts all .git URLs to the specified Zarf HOST and with the Zarf URL pattern in a given FILE. NOTE:
This should only be used for manifests that are not mutated by the Zarf Agent Mutating Webhook.
* [zarf prepare sha256sum](zarf_prepare_sha256sum.md) - Generates a SHA256SUM for the given file

Loading

0 comments on commit 1f7e6ec

Please sign in to comment.