-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: uds dev deploy
beta note, packages flag, skip sbom
#557
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# 3. Terminal User Interface (TUI) | ||
# 4. Terminal User Interface (TUI) | ||
|
||
Date: 22 March 2024 | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# 5. Dev Mode | ||
|
||
Date: 05 April 2024 | ||
|
||
## Status | ||
In Progress | ||
|
||
## Context | ||
|
||
Zarf currently has a dev command that helps speed up the zarf package development cycle, we want to provide similar capabilities to help speed up the UDS bundle development cycle. | ||
|
||
The current bundle development lifecycle is: | ||
|
||
1. Create a local zarf package or reference a remote zarf package | ||
2. Create a `bundle.yaml` and add packages | ||
3. Create a bundle with `uds create <dir>` | ||
4. Start up a cluster if one does not already exist | ||
5. Run `uds zarf init` to initialize th cluster | ||
6. Deploy the bundle with `uds deploy BUNDLE_TARBALL|OCI_REF]` | ||
|
||
## Decision | ||
Introduce `uds dev deploy` which allows you to deploy a UDS bundle in dev mode. If a local zarf package is missing, this command will create that zarf package for you assuming that your `zarf.yaml` file and zarf package are expected in the same directory. It will then create your bundle and deploy your zarf packages in [YOLO](https://docs.zarf.dev/docs/faq#what-is-yolo-mode-and-why-would-i-use-it) mode, eliminating the need to do a `uds zarf init` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's add a note about being in-memory vs creating local artifacts (both bundle and Zarf artifacts) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also, are there any limitations for local vs remote packages? |
||
|
||
## Consequences | ||
Commands under `dev` are meant to be used in **development** environments, and are **not** meant to be used in **production** environments. There is still the possibility that a user will use `uds dev deploy` in a production environment, but the command name and documentation will make it clear that this is not the intended use case. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.