Skip to content

Commit

Permalink
update dev mode docs
Browse files Browse the repository at this point in the history
  • Loading branch information
UncleGedd committed Jun 7, 2024
1 parent 91cb9cd commit 72da0a9
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions docs/quickstart-and-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,31 +274,32 @@ UDS CLI includes a vendored version of Zarf inside of its binary. To use Zarf, s

## Dev Mode

{{% alert-caution %}}
Dev mode is a BETA feature
{{% /alert-caution %}}
<b>NOTE: Dev mode is a BETA feature</b>

Dev mode facilitates faster dev cycles when developing and testing bundles

```
uds dev deploy <path-to-bundle-yaml-dir> | <oci-ref>
```
The `dev deploy` command performs the following operations
The `dev deploy` command performs the following operations:
- If local bundle: Creates Zarf packages for all local packages in a bundle
- Creates the Zarf tarball in the same directory as the `zarf.yaml`
- Will only create the Zarf tarball if one does not already exist
- Ignores any `kind: ZarfInitConfig` packages in the bundle
- Creates a bundle from the newly created Zarf packages
- Deploys the bundle in [YOLO](https://docs.zarf.dev/faq/#what-is-yolo-mode-and-why-would-i-use-it) mode, eliminating the need to do a `zarf init`
- Any `kind: ZarfInitConfig` packages in the bundle will be ignored
- For local bundles:
- For local packages:
- Creates the Zarf tarball if one does not already exist or the `--force-create` flag can be used to force the creation of a new Zarf package
- The Zarf tarball is created in the same directory as the `zarf.yaml`
- The `--flavor` flag can be used to specify what flavor of a package you want to create (example: `--flavor podinfo=upstream` to specify the flavor for the `podinfo` package or `--flavor upstream` to specify the flavor for all the packages in the bundle)
- For remote packages:
- The `--ref` flag can be used to specify what package ref you want to deploy (example: `--ref podinfo=0.2.0`)
- Creates a bundle from the newly created Zarf packages
## Scan
{{% alert-caution %}}
Scan is an ALPHA feature.
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-caution %}}
> [!NOTE]
> Scan is an ALPHA feature.
> 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).
The `scan` command is used to scan a Zarf package for vulnerabilities and generate a report. This command is currently in ALPHA.
Expand Down

0 comments on commit 72da0a9

Please sign in to comment.