diff --git a/README.md b/README.md index 6021178..55f8a3f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ :construction: **This project is still early in its development.** +This is a bundle created using [uds-cli](https://github.com/defenseunicorns/uds-cli). uds-cli is a tool to declaratively orchestrate zarf packages by combining them into bundles. + This is the early stages of a UDS Bundle we call the UDS Software Factory. This UDS Bundle brings together a collection of necessary Zarf packages as well as UDS Capabilities and the development version of their dependency packages. The development dependency packages are only meant to satisfy the UDS Capability's dependencies for demonstration purposes. **This UDS Bundle is not intended for a production environment**. ## Known Issues @@ -20,6 +22,10 @@ This is the early stages of a UDS Bundle we call the UDS Software Factory. This ## Prerequisites +### UDS-CLI + +- Install the release of [uds-cli](https://github.com/defenseunicorns/uds-cli/releases) that matches the version in the [makefile](https://github.com/defenseunicorns/uds-package-software-factory/blob/main/Makefile#L4). + ### Kubernetes Cluster - 1.26 @@ -28,3 +34,9 @@ This is the early stages of a UDS Bundle we call the UDS Software Factory. This ## Documentation [Identity and Access Management Configuration](doc/idam.md) + +## Quick Start Guide + +- Ensure the machine you are using has a valid kubecontext and has access to a sufficiently large cluster +- Ensure uds-cli is present on your machine by running `uds version` and verify it matches the version in the [makefile](https://github.com/defenseunicorns/uds-package-software-factory/blob/main/Makefile#L4) +- Run `uds bundle deploy oci://ghcr.io/defenseunicorns/uds-package/software-factory-demo: --confirm` and replace `` with the [version of SWF](https://github.com/defenseunicorns/uds-package-software-factory/pkgs/container/uds-package%2Fsoftware-factory-demo) you need