Skip to content

Commit

Permalink
Update docs structure for new site
Browse files Browse the repository at this point in the history
  • Loading branch information
pauldipietro committed Oct 11, 2024
1 parent 2b67085 commit 5baa73e
Show file tree
Hide file tree
Showing 26 changed files with 31 additions and 107 deletions.
5 changes: 0 additions & 5 deletions docs/command-reference/_index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds
description: UDS CLI command reference for <code>uds</code>.
type: docs
---
## uds

Expand Down Expand Up @@ -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

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds completion
description: UDS CLI command reference for <code>uds completion</code>.
type: docs
---
## uds completion

Expand Down Expand Up @@ -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

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds completion bash
description: UDS CLI command reference for <code>uds completion bash</code>.
type: docs
---
## uds completion bash

Expand Down Expand Up @@ -59,4 +57,3 @@ uds completion bash
### SEE ALSO

* [uds completion](/cli/command-reference/uds_completion/) - Generate the autocompletion script for the specified shell

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds completion fish
description: UDS CLI command reference for <code>uds completion fish</code>.
type: docs
---
## uds completion fish

Expand Down Expand Up @@ -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

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds completion zsh
description: UDS CLI command reference for <code>uds completion zsh</code>.
type: docs
---
## uds completion zsh

Expand Down Expand Up @@ -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

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds create
description: UDS CLI command reference for <code>uds create</code>.
type: docs
---
## uds create

Expand Down Expand Up @@ -40,4 +38,3 @@ uds create [DIRECTORY] [flags]
### SEE ALSO

* [uds](/cli/command-reference/uds/) - CLI for UDS Bundles

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds deploy
description: UDS CLI command reference for <code>uds deploy</code>.
type: docs
---
## uds deploy

Expand Down Expand Up @@ -39,4 +37,3 @@ uds deploy [BUNDLE_TARBALL|OCI_REF] [flags]
### SEE ALSO

* [uds](/cli/command-reference/uds/) - CLI for UDS Bundles

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds dev
description: UDS CLI command reference for <code>uds dev</code>.
type: docs
---
## uds dev

Expand Down Expand Up @@ -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

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds dev deploy
description: UDS CLI command reference for <code>uds dev deploy</code>.
type: docs
---
## uds dev deploy

Expand Down Expand Up @@ -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

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds inspect
description: UDS CLI command reference for <code>uds inspect</code>.
type: docs
---
## uds inspect

Expand Down Expand Up @@ -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

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds logs
description: UDS CLI command reference for <code>uds logs</code>.
type: docs
---
## uds logs

Expand Down Expand Up @@ -34,4 +32,3 @@ uds logs [flags]
### SEE ALSO

* [uds](/cli/command-reference/uds/) - CLI for UDS Bundles

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds monitor
description: UDS CLI command reference for <code>uds monitor</code>.
type: docs
---
## uds monitor

Expand Down Expand Up @@ -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

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds monitor pepr
description: UDS CLI command reference for <code>uds monitor pepr</code>.
type: docs
---
## uds monitor pepr

Expand Down Expand Up @@ -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

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds publish
description: UDS CLI command reference for <code>uds publish</code>.
type: docs
---
## uds publish

Expand Down Expand Up @@ -35,4 +33,3 @@ uds publish [BUNDLE_TARBALL] [OCI_REF] [flags]
### SEE ALSO

* [uds](/cli/command-reference/uds/) - CLI for UDS Bundles

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds pull
description: UDS CLI command reference for <code>uds pull</code>.
type: docs
---
## uds pull

Expand Down Expand Up @@ -36,4 +34,3 @@ uds pull [OCI_REF] [flags]
### SEE ALSO

* [uds](/cli/command-reference/uds/) - CLI for UDS Bundles

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds remove
description: UDS CLI command reference for <code>uds remove</code>.
type: docs
---
## uds remove

Expand Down Expand Up @@ -36,4 +34,3 @@ uds remove [BUNDLE_TARBALL|OCI_REF] [flags]
### SEE ALSO

* [uds](/cli/command-reference/uds/) - CLI for UDS Bundles

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds run
description: UDS CLI command reference for <code>uds run</code>.
type: docs
---
## uds run

Expand Down Expand Up @@ -34,4 +32,3 @@ uds run [flags]
### SEE ALSO

* [uds](/cli/command-reference/uds/) - CLI for UDS Bundles

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds ui
description: UDS CLI command reference for <code>uds ui</code>.
type: docs
---
## uds ui

Expand Down Expand Up @@ -34,4 +32,3 @@ uds ui [flags]
### SEE ALSO

* [uds](/cli/command-reference/uds/) - CLI for UDS Bundles

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: uds version
description: UDS CLI command reference for <code>uds version</code>.
type: docs
---
## uds version

Expand Down Expand Up @@ -38,4 +36,3 @@ uds version [flags]
### SEE ALSO

* [uds](/cli/command-reference/uds/) - CLI for UDS Bundles

5 changes: 0 additions & 5 deletions docs/_index.md → docs/reference/CLI/overview.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Quickstart and Usage
type: docs
weight: 1
---

## Install
Expand Down Expand Up @@ -72,9 +70,9 @@ There are 2 ways to create Bundles:
1. Inside an OCI registry: `uds create <dir> -o ghcr.io/defenseunicorns/dev`
1. Locally on your filesystem: `uds create <dir>`

{{% 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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -199,9 +197,9 @@ As an example: `uds remove uds-bundle-<name>.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.

Expand All @@ -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.

Expand Down Expand Up @@ -366,19 +364,19 @@ 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

UDS CLI includes a vendored version of Zarf inside of its binary. To use Zarf, simply run `uds zarf <command>`. For example, to create a Zarf package, run `uds zarf create <dir>`, or to use the [airgap tooling](https://docs.zarf.dev/docs/the-zarf-cli/cli-commands/zarf_tools) that Zarf provides, run `uds zarf tools <cmd>`.

## Dev Mode

{{% alert-note %}}
:::note
Dev mode is a BETA feature
{{% /alert-note %}}
:::

Dev mode facilitates faster dev cycles when developing and testing bundles

Expand Down Expand Up @@ -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
Expand All @@ -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.

Expand Down Expand Up @@ -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 %}}
:::
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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"
},
```

Expand Down
Loading

0 comments on commit 5baa73e

Please sign in to comment.