Skip to content

Commit

Permalink
Fix notes & rebase
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul DiPietro authored and Paul DiPietro committed Oct 10, 2024
1 parent e343855 commit 4563281
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions docs/reference/CLI/quickstart-and-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,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 @@ -103,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 @@ -197,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 @@ -220,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 @@ -364,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 @@ -466,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 @@ -504,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 %}}
:::

0 comments on commit 4563281

Please sign in to comment.