diff --git a/docs/command-reference/_index.md b/docs/command-reference/_index.md deleted file mode 100644 index 373d4fce..00000000 --- a/docs/command-reference/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Command Reference -type: docs -weight: 6 ---- \ No newline at end of file diff --git a/docs/command-reference/uds.md b/docs/reference/CLI/commands/uds.md similarity index 97% rename from docs/command-reference/uds.md rename to docs/reference/CLI/commands/uds.md index b62305ae..22021e66 100644 --- a/docs/command-reference/uds.md +++ b/docs/reference/CLI/commands/uds.md @@ -1,7 +1,5 @@ --- title: uds -description: UDS CLI command reference for uds. -type: docs --- ## uds @@ -41,4 +39,3 @@ uds COMMAND [flags] * [uds run](/cli/command-reference/uds_run/) - Run a task using maru-runner * [uds ui](/cli/command-reference/uds_ui/) - [beta] Launch UDS Runtime and view UI * [uds version](/cli/command-reference/uds_version/) - Shows the version of the running UDS-CLI binary - diff --git a/docs/command-reference/uds_completion.md b/docs/reference/CLI/commands/uds_completion.md similarity index 95% rename from docs/command-reference/uds_completion.md rename to docs/reference/CLI/commands/uds_completion.md index bcf5a109..2364798f 100644 --- a/docs/command-reference/uds_completion.md +++ b/docs/reference/CLI/commands/uds_completion.md @@ -1,7 +1,5 @@ --- title: uds completion -description: UDS CLI command reference for uds completion. -type: docs --- ## uds completion @@ -39,4 +37,3 @@ See each sub-command's help for details on how to use the generated script. * [uds completion bash](/cli/command-reference/uds_completion_bash/) - Generate the autocompletion script for bash * [uds completion fish](/cli/command-reference/uds_completion_fish/) - Generate the autocompletion script for fish * [uds completion zsh](/cli/command-reference/uds_completion_zsh/) - Generate the autocompletion script for zsh - diff --git a/docs/command-reference/uds_completion_bash.md b/docs/reference/CLI/commands/uds_completion_bash.md similarity index 95% rename from docs/command-reference/uds_completion_bash.md rename to docs/reference/CLI/commands/uds_completion_bash.md index 68cee5db..48ed3957 100644 --- a/docs/command-reference/uds_completion_bash.md +++ b/docs/reference/CLI/commands/uds_completion_bash.md @@ -1,7 +1,5 @@ --- title: uds completion bash -description: UDS CLI command reference for uds completion bash. -type: docs --- ## uds completion bash @@ -59,4 +57,3 @@ uds completion bash ### SEE ALSO * [uds completion](/cli/command-reference/uds_completion/) - Generate the autocompletion script for the specified shell - diff --git a/docs/command-reference/uds_completion_fish.md b/docs/reference/CLI/commands/uds_completion_fish.md similarity index 95% rename from docs/command-reference/uds_completion_fish.md rename to docs/reference/CLI/commands/uds_completion_fish.md index 2ae287be..ffd9ec03 100644 --- a/docs/command-reference/uds_completion_fish.md +++ b/docs/reference/CLI/commands/uds_completion_fish.md @@ -1,7 +1,5 @@ --- title: uds completion fish -description: UDS CLI command reference for uds completion fish. -type: docs --- ## uds completion fish @@ -50,4 +48,3 @@ uds completion fish [flags] ### SEE ALSO * [uds completion](/cli/command-reference/uds_completion/) - Generate the autocompletion script for the specified shell - diff --git a/docs/command-reference/uds_completion_zsh.md b/docs/reference/CLI/commands/uds_completion_zsh.md similarity index 95% rename from docs/command-reference/uds_completion_zsh.md rename to docs/reference/CLI/commands/uds_completion_zsh.md index 8ba431f6..879365f3 100644 --- a/docs/command-reference/uds_completion_zsh.md +++ b/docs/reference/CLI/commands/uds_completion_zsh.md @@ -1,7 +1,5 @@ --- title: uds completion zsh -description: UDS CLI command reference for uds completion zsh. -type: docs --- ## uds completion zsh @@ -61,4 +59,3 @@ uds completion zsh [flags] ### SEE ALSO * [uds completion](/cli/command-reference/uds_completion/) - Generate the autocompletion script for the specified shell - diff --git a/docs/command-reference/uds_create.md b/docs/reference/CLI/commands/uds_create.md similarity index 95% rename from docs/command-reference/uds_create.md rename to docs/reference/CLI/commands/uds_create.md index aeb9511d..fc9e4676 100644 --- a/docs/command-reference/uds_create.md +++ b/docs/reference/CLI/commands/uds_create.md @@ -1,7 +1,5 @@ --- title: uds create -description: UDS CLI command reference for uds create. -type: docs --- ## uds create @@ -40,4 +38,3 @@ uds create [DIRECTORY] [flags] ### SEE ALSO * [uds](/cli/command-reference/uds/) - CLI for UDS Bundles - diff --git a/docs/command-reference/uds_deploy.md b/docs/reference/CLI/commands/uds_deploy.md similarity index 96% rename from docs/command-reference/uds_deploy.md rename to docs/reference/CLI/commands/uds_deploy.md index 1c786231..4a8cbe68 100644 --- a/docs/command-reference/uds_deploy.md +++ b/docs/reference/CLI/commands/uds_deploy.md @@ -1,7 +1,5 @@ --- title: uds deploy -description: UDS CLI command reference for uds deploy. -type: docs --- ## uds deploy @@ -39,4 +37,3 @@ uds deploy [BUNDLE_TARBALL|OCI_REF] [flags] ### SEE ALSO * [uds](/cli/command-reference/uds/) - CLI for UDS Bundles - diff --git a/docs/command-reference/uds_dev.md b/docs/reference/CLI/commands/uds_dev.md similarity index 94% rename from docs/command-reference/uds_dev.md rename to docs/reference/CLI/commands/uds_dev.md index 57111327..8a7c5f12 100644 --- a/docs/command-reference/uds_dev.md +++ b/docs/reference/CLI/commands/uds_dev.md @@ -1,7 +1,5 @@ --- title: uds dev -description: UDS CLI command reference for uds dev. -type: docs --- ## uds dev @@ -31,4 +29,3 @@ type: docs * [uds](/cli/command-reference/uds/) - CLI for UDS Bundles * [uds dev deploy](/cli/command-reference/uds_dev_deploy/) - [beta] Creates and deploys a UDS bundle in dev mode - diff --git a/docs/command-reference/uds_dev_deploy.md b/docs/reference/CLI/commands/uds_dev_deploy.md similarity index 96% rename from docs/command-reference/uds_dev_deploy.md rename to docs/reference/CLI/commands/uds_dev_deploy.md index c5a7defe..b89b1e78 100644 --- a/docs/command-reference/uds_dev_deploy.md +++ b/docs/reference/CLI/commands/uds_dev_deploy.md @@ -1,7 +1,5 @@ --- title: uds dev deploy -description: UDS CLI command reference for uds dev deploy. -type: docs --- ## uds dev deploy @@ -43,4 +41,3 @@ uds dev deploy [BUNDLE_DIR|OCI_REF] [flags] ### SEE ALSO * [uds dev](/cli/command-reference/uds_dev/) - [beta] Commands useful for developing bundles - diff --git a/docs/command-reference/uds_inspect.md b/docs/reference/CLI/commands/uds_inspect.md similarity index 95% rename from docs/command-reference/uds_inspect.md rename to docs/reference/CLI/commands/uds_inspect.md index 0236c650..28c62ac1 100644 --- a/docs/command-reference/uds_inspect.md +++ b/docs/reference/CLI/commands/uds_inspect.md @@ -1,7 +1,5 @@ --- title: uds inspect -description: UDS CLI command reference for uds inspect. -type: docs --- ## uds inspect @@ -39,4 +37,3 @@ uds inspect [BUNDLE_TARBALL|OCI_REF|BUNDLE_YAML_FILE] [flags] ### SEE ALSO * [uds](/cli/command-reference/uds/) - CLI for UDS Bundles - diff --git a/docs/command-reference/uds_logs.md b/docs/reference/CLI/commands/uds_logs.md similarity index 94% rename from docs/command-reference/uds_logs.md rename to docs/reference/CLI/commands/uds_logs.md index 856b610e..ee816c91 100644 --- a/docs/command-reference/uds_logs.md +++ b/docs/reference/CLI/commands/uds_logs.md @@ -1,7 +1,5 @@ --- title: uds logs -description: UDS CLI command reference for uds logs. -type: docs --- ## uds logs @@ -34,4 +32,3 @@ uds logs [flags] ### SEE ALSO * [uds](/cli/command-reference/uds/) - CLI for UDS Bundles - diff --git a/docs/command-reference/uds_monitor.md b/docs/reference/CLI/commands/uds_monitor.md similarity index 94% rename from docs/command-reference/uds_monitor.md rename to docs/reference/CLI/commands/uds_monitor.md index 532b9382..c7e7804a 100644 --- a/docs/command-reference/uds_monitor.md +++ b/docs/reference/CLI/commands/uds_monitor.md @@ -1,7 +1,5 @@ --- title: uds monitor -description: UDS CLI command reference for uds monitor. -type: docs --- ## uds monitor @@ -36,4 +34,3 @@ Tools for monitoring a UDS Cluster and connecting to the UDS Engine for advanced * [uds](/cli/command-reference/uds/) - CLI for UDS Bundles * [uds monitor pepr](/cli/command-reference/uds_monitor_pepr/) - Observe Pepr operations in a UDS Cluster - diff --git a/docs/command-reference/uds_monitor_pepr.md b/docs/reference/CLI/commands/uds_monitor_pepr.md similarity index 96% rename from docs/command-reference/uds_monitor_pepr.md rename to docs/reference/CLI/commands/uds_monitor_pepr.md index b2fab08a..e7b356ac 100644 --- a/docs/command-reference/uds_monitor_pepr.md +++ b/docs/reference/CLI/commands/uds_monitor_pepr.md @@ -1,7 +1,5 @@ --- title: uds monitor pepr -description: UDS CLI command reference for uds monitor pepr. -type: docs --- ## uds monitor pepr @@ -69,4 +67,3 @@ uds monitor pepr [policies | operator | allowed | denied | failed | mutated] [fl ### SEE ALSO * [uds monitor](/cli/command-reference/uds_monitor/) - Monitor a UDS Cluster - diff --git a/docs/command-reference/uds_publish.md b/docs/reference/CLI/commands/uds_publish.md similarity index 94% rename from docs/command-reference/uds_publish.md rename to docs/reference/CLI/commands/uds_publish.md index 5cdb3944..903ed749 100644 --- a/docs/command-reference/uds_publish.md +++ b/docs/reference/CLI/commands/uds_publish.md @@ -1,7 +1,5 @@ --- title: uds publish -description: UDS CLI command reference for uds publish. -type: docs --- ## uds publish @@ -35,4 +33,3 @@ uds publish [BUNDLE_TARBALL] [OCI_REF] [flags] ### SEE ALSO * [uds](/cli/command-reference/uds/) - CLI for UDS Bundles - diff --git a/docs/command-reference/uds_pull.md b/docs/reference/CLI/commands/uds_pull.md similarity index 95% rename from docs/command-reference/uds_pull.md rename to docs/reference/CLI/commands/uds_pull.md index dec25b21..1a9c23a2 100644 --- a/docs/command-reference/uds_pull.md +++ b/docs/reference/CLI/commands/uds_pull.md @@ -1,7 +1,5 @@ --- title: uds pull -description: UDS CLI command reference for uds pull. -type: docs --- ## uds pull @@ -36,4 +34,3 @@ uds pull [OCI_REF] [flags] ### SEE ALSO * [uds](/cli/command-reference/uds/) - CLI for UDS Bundles - diff --git a/docs/command-reference/uds_remove.md b/docs/reference/CLI/commands/uds_remove.md similarity index 95% rename from docs/command-reference/uds_remove.md rename to docs/reference/CLI/commands/uds_remove.md index c804fe32..514f8bb5 100644 --- a/docs/command-reference/uds_remove.md +++ b/docs/reference/CLI/commands/uds_remove.md @@ -1,7 +1,5 @@ --- title: uds remove -description: UDS CLI command reference for uds remove. -type: docs --- ## uds remove @@ -36,4 +34,3 @@ uds remove [BUNDLE_TARBALL|OCI_REF] [flags] ### SEE ALSO * [uds](/cli/command-reference/uds/) - CLI for UDS Bundles - diff --git a/docs/command-reference/uds_run.md b/docs/reference/CLI/commands/uds_run.md similarity index 94% rename from docs/command-reference/uds_run.md rename to docs/reference/CLI/commands/uds_run.md index e587e65d..8585b40e 100644 --- a/docs/command-reference/uds_run.md +++ b/docs/reference/CLI/commands/uds_run.md @@ -1,7 +1,5 @@ --- title: uds run -description: UDS CLI command reference for uds run. -type: docs --- ## uds run @@ -34,4 +32,3 @@ uds run [flags] ### SEE ALSO * [uds](/cli/command-reference/uds/) - CLI for UDS Bundles - diff --git a/docs/command-reference/uds_ui.md b/docs/reference/CLI/commands/uds_ui.md similarity index 94% rename from docs/command-reference/uds_ui.md rename to docs/reference/CLI/commands/uds_ui.md index 6e1b8662..3168f8a2 100644 --- a/docs/command-reference/uds_ui.md +++ b/docs/reference/CLI/commands/uds_ui.md @@ -1,7 +1,5 @@ --- title: uds ui -description: UDS CLI command reference for uds ui. -type: docs --- ## uds ui @@ -34,4 +32,3 @@ uds ui [flags] ### SEE ALSO * [uds](/cli/command-reference/uds/) - CLI for UDS Bundles - diff --git a/docs/command-reference/uds_version.md b/docs/reference/CLI/commands/uds_version.md similarity index 94% rename from docs/command-reference/uds_version.md rename to docs/reference/CLI/commands/uds_version.md index 0fb67bd0..1d5a7817 100644 --- a/docs/command-reference/uds_version.md +++ b/docs/reference/CLI/commands/uds_version.md @@ -1,7 +1,5 @@ --- title: uds version -description: UDS CLI command reference for uds version. -type: docs --- ## uds version @@ -38,4 +36,3 @@ uds version [flags] ### SEE ALSO * [uds](/cli/command-reference/uds/) - CLI for UDS Bundles - diff --git a/docs/_index.md b/docs/reference/CLI/overview.md similarity index 93% rename from docs/_index.md rename to docs/reference/CLI/overview.md index 634261dc..762db28e 100644 --- a/docs/_index.md +++ b/docs/reference/CLI/overview.md @@ -1,10 +1,5 @@ --- title: Overview -linkTitle: UDS CLI -type: docs -menu: - main: - weight: 30 --- The [UDS CLI](https://github.com/defenseunicorns/uds-cli) is the primary interface for users to interact with various components within the UDS landscape. It streamlines the deployment process of mission applications and secure infrastructure, simplifying tasks involved in running mission applications while maintaining regulatory compliance in a unified and efficient manner. diff --git a/docs/quickstart-and-usage.md b/docs/reference/CLI/quickstart-and-usage.md similarity index 98% rename from docs/quickstart-and-usage.md rename to docs/reference/CLI/quickstart-and-usage.md index ef5b6b07..b21abaa6 100644 --- a/docs/quickstart-and-usage.md +++ b/docs/reference/CLI/quickstart-and-usage.md @@ -1,7 +1,5 @@ --- title: Quickstart and Usage -type: docs -weight: 1 --- ## Install @@ -72,9 +70,9 @@ There are 2 ways to create Bundles: 1. Inside an OCI registry: `uds create -o ghcr.io/defenseunicorns/dev` 1. Locally on your filesystem: `uds create ` -{{% alert-note %}} +:::note The `--insecure` flag is necessary when interacting with a local registry, but not from secure, remote registries such as GHCR. -{{% /alert-note %}} +::: ### Bundle Deploy @@ -105,9 +103,9 @@ In the process of upgrading bundles, it's common to swap or remove packages from When `uds deploy` is executed, the bundle's metadata, along with a list of its packages and each package's overrides and Zarf variables, will be outputted to the terminal. Unlike [`inspect --list-variables`](#viewing-variables), this output will show the value set for each override or Zarf variable. Overrides and variables that have not been set will not be shown in the output. -{{% alert-note %}} +:::note To view this output more easily or for troubleshooting, run `deploy` without the `--confirm` flag. -{{% /alert-note %}} +::: ### Bundle Inspect @@ -199,9 +197,9 @@ As an example: `uds remove uds-bundle-.tar.zst --packages init,nginx` ### Logs -{{% alert-note %}} +:::note Only works with `uds deploy` for now, may work for other operations but isn't guaranteed. -{{% /alert-note %}} +::: The `uds logs` command can be used to view the most recent logs of a bundle operation. Note that depending on your OS temporary directory and file settings, recent logs are purged after a certain amount of time, so this command may return an error if the logs are no longer available. @@ -222,9 +220,9 @@ UDS CLI supports multi-arch bundles. This means you can push bundles with differ When deploying a local bundle, the bundle's architecture will be used for comparison against the cluster architecture to ensure compatibility. If deploying a remote bundle, by default the bundle is pulled based on system architecture, which is then checked against the cluster. -{{% alert-note %}} +:::note It is possible to override the bundle architecture used at validation time by using the `--architecture` / `-a` flag. -{{% /alert-note %}} +::: If, for example, you have a multi-arch remote bundle that you want to deploy from an arm64 machine to an amd64 cluster, the validation with fail because the system arch does not match the cluster arch. However, you can pull the correct bundle version by specifying the arch with the command line architecture flag. @@ -366,9 +364,9 @@ The naming conventions for deploying duplicate packages are as follows: 1. The duplicate packages must be deployed in different namespaces 1. In order to deploy duplicates of local packages, the `path` field must point to a Zarf package tarball instead of to a folder. -{{% alert-note %}} +:::note Today the duplicate packages feature is only supported for packages with Helm charts. This is because Helm charts' [namespaces can be overridden](https://github.com/defenseunicorns/uds-cli/blob/main/docs/overrides.md) at deploy time. -{{% /alert-note %}} +::: ## Zarf Integration @@ -376,9 +374,9 @@ UDS CLI includes a vendored version of Zarf inside of its binary. To use Zarf, s ## Dev Mode -{{% alert-note %}} +:::note Dev mode is a BETA feature -{{% /alert-note %}} +::: Dev mode facilitates faster dev cycles when developing and testing bundles @@ -453,7 +451,7 @@ Stream UDS Policy mutation logs: uds monitor pepr mutated ``` -Stream UDS Policy deny logs and UDS Operator error logs: +Stream UDS Policy deny logs and UDS Operator error logs: `uds monitor pepr failed` #### Monitor Flags @@ -468,9 +466,9 @@ Stream UDS Policy deny logs and UDS Operator error logs: ## Scan -{{% alert-note %}} +:::note Trivy is a prerequisite for scanning container images and filesystem for vulnerabilities. You can find more information and installation instructions at [Trivy's official documentation](https://aquasecurity.github.io/trivy). -{{% /alert-note %}} +::: The `scan` command is used to scan a Zarf package for vulnerabilities and generate a report. This command is currently in ALPHA. @@ -506,6 +504,6 @@ The `uds ui` command launches UDS Runtime, which provides a web-based user inter To exit UDS Runtime, press `Ctrl+C`. -{{% alert-note %}} +:::note There is currently a known data loading [issue](https://github.com/defenseunicorns/uds-runtime/issues/365) with opening UDS Runtime via `uds ui` in multiple tabs or windows. If you encounter this issue, please ensure there is only one tab or window of UDS Runtime open at a time. -{{% /alert-note %}} +::: diff --git a/docs/schema-validation.md b/docs/reference/CLI/schema-validation.md similarity index 90% rename from docs/schema-validation.md rename to docs/reference/CLI/schema-validation.md index 6c24703a..13c19672 100644 --- a/docs/schema-validation.md +++ b/docs/reference/CLI/schema-validation.md @@ -1,10 +1,6 @@ --- -title: Schema -type: docs -weight: 5 +title: Schema Validation --- -## Schema Validation - When working with UDS configuration files, it can be useful to setup your IDE to know about the various schemas that UDS uses. The recommended method of validating schemas is by the use of `yaml-language-server` file headers: @@ -34,7 +30,7 @@ To do this in VS Code you can install the [YAML Extension](https://marketplace.v ```json "yaml.schemas": { - "https://raw.githubusercontent.com/defenseunicorns/uds-cli/main/uds.schema.json": "uds-bundle.yaml" + "https://raw.githubusercontent.com/defenseunicorns/cli-commands/main/uds.schema.json": "uds-bundle.yaml" }, ``` diff --git a/docs/runner.md b/docs/reference/CLI/uds-runner.md similarity index 97% rename from docs/runner.md rename to docs/reference/CLI/uds-runner.md index 22b864b4..0fd056d0 100644 --- a/docs/runner.md +++ b/docs/reference/CLI/uds-runner.md @@ -1,7 +1,5 @@ --- title: UDS Runner -type: docs -weight: 3 --- UDS CLI contains vendors and configures the [maru-runner](https://github.com/defenseunicorns/maru-runner) build tool to make compiling and building UDS bundles simple. @@ -51,9 +49,9 @@ tasks: - cmd: ./zarf tools kubectl get pods -A # uses vendored Zarf ``` -{{% alert-note %}} +:::note UDS CLI automatically removes progress bars from `./uds` commands and if `CI=true`then it will also remove progress bars from `uds run` commands. -{{% /alert-note %}} +::: ### Architecture Environment Variable diff --git a/docs/overrides.md b/docs/reference/bundles/overrides.md similarity index 98% rename from docs/overrides.md rename to docs/reference/bundles/overrides.md index 1b907c8f..91aa868b 100644 --- a/docs/overrides.md +++ b/docs/reference/bundles/overrides.md @@ -1,7 +1,5 @@ --- title: Bundle Overrides -type: docs -weight: 2 --- Bundle overrides provide a mechanism to customize Helm charts inside of Zarf packages. @@ -246,9 +244,9 @@ There are 3 ways to override the `UI_COLOR` variable: > **:warning: Warning**: Because Helm override variables and Zarf variables share the same --set syntax, be careful with variable names to avoid conflicts. -{{% alert-note %}} +:::note A variable that is not overridden by any of the methods above and has no default will be ignored. -{{% /alert-note %}} +::: #### Variable Precedence @@ -263,9 +261,9 @@ Variable precedence is as follows: Variables can be of either type `raw` or `file`. The type will default to raw if not set explicitly. -{{% alert-caution %}} +:::caution If a variable is set to accept a file as its value, but is missing the `file` type, then the file will not be processed. -{{% /alert-caution %}} +::: ```yaml kind: UDSBundle @@ -307,11 +305,11 @@ This means when `test.cert` is evaluated it will first be appended to the config If the file path is already set to the same relative path as the config, then no merging will take place. -{{% alert-note %}} +:::note UDS CLI does not encrypt or base64 encode any file contents before passing said data to Zarf or Helm. For example, if the file contains a key to be used in a Kubernetes secret, it must be base64 encoded before being ingested by UDS CLI. -{{% /alert-note %}} +::: ### Sensitive diff --git a/docs/bundle-anatomy.md b/docs/reference/bundles/overview.md similarity index 81% rename from docs/bundle-anatomy.md rename to docs/reference/bundles/overview.md index ae6b73c4..e4cfeff4 100644 --- a/docs/bundle-anatomy.md +++ b/docs/reference/bundles/overview.md @@ -1,7 +1,8 @@ --- -title: Bundle Anatomy -type: docs -weight: 4 +title: Overview + +sidebar: + order: 1 --- ## Bundle Anatomy