-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into renovate/github.com-defenseunicorns-uds-secu…
…rity-hub-0.x
- Loading branch information
Showing
28 changed files
with
646 additions
and
215 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -35,3 +35,4 @@ tmp/ | |
out.txt | ||
*.gif | ||
*.mp4 | ||
src/cmd/bin |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# UDS UI | ||
|
||
Author(s): @decleaver | ||
Date Created: Sept 9, 2024 | ||
Status: IMPLEMENTED | ||
Ticket: https://github.com/defenseunicorns/uds-cli/issues/870 | ||
|
||
### Problem Statement | ||
|
||
The goal of the `uds ui` command is to allow uds-cli users to launch the UDS Runtime application from the command line. | ||
|
||
### Proposal | ||
|
||
Bundle the UDS Runtime binaries as a part of uds-cli allowing users to launch UDS Runtime from the command line. | ||
|
||
### Scope and Requirements | ||
|
||
Allow users to launch UDS Runtime locally from uds-cli. When running UDS Runtime locally, API token authentication is required. This is implemented programmatically and is transparent to the user. | ||
|
||
### Implementation Details | ||
|
||
To execute UDS Runtime from uds-cli, the appropriate runtime binary is pulled into the `src/cmd/bin` directory during the uds-cli build process. This is based on the specific build task being run (e.g., `build-cli-linux-arm`). The runtime binary is then packaged with the uds-cli binary. | ||
|
||
To ensure the `uds ui` command works correctly, the uds-cli must be built using the build tasks specified in `tasks.yaml`. If not, the runtime binary might be missing, causing the `uds ui` command to fail. | ||
|
||
### Alternatives Considered | ||
|
||
1. Save runtime binaries directly in the uds-cli repo to avoid having to pull at build time. This approach was discarded because it adds extra size and complexity to the uds-cli repo | ||
2. Vendor UDS Runtime in uds-cli. This approach was discarded because although the Runtime backend can be vendored, it required static assets from the frontend which would need to be embedded in the uds-cli binary, thus negating the benefits of vendoring. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Design Doc Title | ||
|
||
Author(s): <@Your Name Here> | ||
Date Created: Mar 13, 2024 | ||
Status: DRAFT | REVIEW | APPROVED | IMPLEMENTED | ||
Ticket: <link to ticket> | ||
Reviews Requested By: Mm DD, YYYY | ||
|
||
### Problem Statement | ||
|
||
Give background to the reader about the problem being solved and why a change is necessary. There should be adequate information here for a person with minimal context to understand the author's motivation for creating the document. | ||
|
||
### Proposal | ||
|
||
Briefly outline the proposed solution and explain how it will solve the problem mentioned in the background section. | ||
|
||
### Scope and Requirements | ||
|
||
Explicitly outline any project requirements that must be solved by the solution. | ||
|
||
### Implementation Details | ||
|
||
Expand upon the implementation details here. Draw the reader's attention to: | ||
|
||
* Changes to existing systems. | ||
* Creation of new systems. | ||
* Impacts to the customer. | ||
* Include code samples where possible. | ||
|
||
### Metrics & Alerts | ||
|
||
List any Metrics / Alerts that you plan to include in the system design | ||
|
||
### Alternatives Considered | ||
|
||
List any alternative solutions considered and how the proposed solution is a better fit. | ||
|
||
### Non-Goals | ||
|
||
List out anything that may be related to the solution, but won't be covered by this solution. | ||
|
||
### Future Improvements: | ||
|
||
List out anything that won't be included in this version of the feature/solution, but could be revisited or iterated upon in the future. | ||
|
||
### Other Considerations: | ||
|
||
List anything else that won't be solved by the solution |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
title: uds ui | ||
description: UDS CLI command reference for <code>uds ui</code>. | ||
type: docs | ||
--- | ||
## uds ui | ||
|
||
[beta] Launch UDS Runtime and view UI | ||
|
||
``` | ||
uds ui [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for ui | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-a, --architecture string Architecture for UDS bundles and Zarf packages | ||
--insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. | ||
-l, --log-level string Log level when running UDS-CLI. Valid options are: warn, info, debug, trace (default "info") | ||
--no-color Disable color output | ||
--no-log-file Disable log file creation | ||
--no-progress Disable fancy UI progress bars, spinners, logos, etc | ||
--oci-concurrency int Number of concurrent layer operations to perform when interacting with a remote bundle. (default 3) | ||
--tmpdir string Specify the temporary directory to use for intermediate files | ||
--uds-cache string Specify the location of the UDS cache directory (default "~/.uds-cache") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [uds](/cli/command-reference/uds/) - CLI for UDS Bundles | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.