Skip to content
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: add uds ui cmd #917

Merged
merged 20 commits into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ repos:
rev: v4.0.1
hooks:
- id: check-added-large-files
args: ["--maxkb=1024"]
args: ["--maxkb=102400"]
- id: check-merge-conflict
- id: detect-aws-credentials
args:
Expand Down
24 changes: 24 additions & 0 deletions design-docs/0002-uds-ui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# 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 from uds-cli
decleaver marked this conversation as resolved.
Show resolved Hide resolved

### Implementation Details

In order to be able to execute UDS Runtime from uds-cli, the UDS Runtime binaries have been added to the uds-cli repository under src/cmd/bin. Renovate has been set up to automatically create a PR to update the UDS Runtime binaries in the uds-cli repository whenever the latest UDS Runtime release is published. The renovate configuration is defined in `renovate.json` and the script checks and updates the UDS Runtime binaries is `hack/update-uds-runtime-binaries.sh`

A downside to this implementation is that we are now including 4 additional binaries as a part of uds-cli which are each about 80MB in size.
48 changes: 48 additions & 0 deletions design-docs/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Design Doc Title
decleaver marked this conversation as resolved.
Show resolved Hide resolved

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
1 change: 1 addition & 0 deletions docs/command-reference/uds.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,6 @@ uds COMMAND [flags]
* [uds pull](/cli/command-reference/uds_pull/) - Pull a bundle from a remote registry and save to the local file system
* [uds remove](/cli/command-reference/uds_remove/) - Remove a bundle that has been deployed already
* [uds run](/cli/command-reference/uds_run/) - Run a task using maru-runner
* [uds ui](/cli/command-reference/uds_ui/) - [beta] Deploy UDS Runtime and view UI
* [uds version](/cli/command-reference/uds_version/) - Shows the version of the running UDS-CLI binary

37 changes: 37 additions & 0 deletions docs/command-reference/uds_ui.md
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] Deploy UDS Runtime and view UI
decleaver marked this conversation as resolved.
Show resolved Hide resolved

```
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

4 changes: 4 additions & 0 deletions docs/quickstart-and-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -509,3 +509,7 @@ uds scan --org <organization> --package-name <package-name> --tag <tag> [options
```sh
uds scan -o defenseunicorns -n packages/uds/gitlab-runner -g 16.10.0-uds.0-upstream -u docker-username -p docker-password -f gitlab-runner.csv
```

## UDS Runtime

The `uds ui` command launches UDS Runtime, which gives you a user interface to view what is running in your cluster. More information regarding UDS Runtime can be found [here](https://github.com/defenseunicorns/uds-runtime).
decleaver marked this conversation as resolved.
Show resolved Hide resolved
Loading
Loading