From 64e9fcbc0026b415ffb3e2d90026d7de84c470d3 Mon Sep 17 00:00:00 2001 From: Wayne Starr Date: Fri, 26 Jul 2024 08:59:38 -0600 Subject: [PATCH] chore: improve the formatting on the README (#87) ## Description This improves the formatting of the deployment sections of the README. ## Related Issue Fixes #N/A ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [X] Other (security config, docs update, etc) ## Checklist before merging - [X] Test, docs, adr added or updated as needed - [X] [Contributor Guide Steps](https://github.com/defenseunicorns/uds-software-factory/blob/main/CONTRIBUTING.md#developer-workflow) followed --- README.md | 43 +++++++++++++++++++++++++------------------ 1 file changed, 25 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index d9ae36d..24b9ff1 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ Also note that the Software Factory team helps to manage the following shared UD ## Bundles -> [!NOTE] -> These UDS Bundles are intended for dev and test environments and should not be used for production. They can however serve as examples to create custom bundles. +> [!CAUTION] +> These UDS Bundles are intended for dev, test and demo environments and should _not_ be used for production. They can however serve as examples to create custom bundles. This repository publishes multiple bundles for dev, test and demo purposes. They are located in sub-directories under `bundles`. @@ -47,7 +47,8 @@ If you have the resources for it locally (see above), you can deploy the full So - [Docker Compatible Runtime](https://docs.docker.com/engine/) necessary for running `k3d`. - [UDS CLI](https://github.com/defenseunicorns/uds-cli?tab=readme-ov-file#install) v0.10.4 or later -> [!NOTE]: Apple users follow these [instructions](./docs/development.md) to properly set up your environment to deploy this bundle. +> [!NOTE] +> Apple users follow these [instructions](./docs/development.md) to properly set up your environment to deploy this bundle. #### Deployment @@ -70,35 +71,41 @@ Alternatively, you can deploy the [uds-k3d-swf-dev bundle](./bundles/dev/README. - [K3D](https://k3d.io/) for dev & test environments or any [CNCF Certified Kubernetes Cluster](https://www.cncf.io/training/certification/software-conformance/#logos) for production environments. - [UDS CLI](https://github.com/defenseunicorns/uds-cli?tab=readme-ov-file#install) v0.10.4 or later -> [!NOTE]: Apple users follow these [instructions](./docs/development.md) to properly set up your environment to deploy this bundle. +> [!NOTE] +> Apple users follow these [instructions](./docs/development.md) to properly set up your environment to deploy this bundle. #### Deployment -For `swf-dev` you have two options, build and deploy from source or deploy the artifacts from where they are hosted in the ghcr OCI registry. +For `swf-dev` you have two options, build and deploy from source or deploy the artifacts from where they are hosted in the `ghcr.io` OCI registry. + +##### 1. Deploy from Source To build and deploy from source you can utilize the UDS tasks in this repo by running: ```bash - uds run +uds run ``` -Alternatively, you can deploy from OCI by running the following two commands: +##### 2. Deploy from Artifacts -1. Run the below command to deploy the `k3d-core-slim-dev` bundle: +_Alternatively_, you can deploy from OCI by running the following two commands: -> [!NOTE]: You can append `--set INSECURE_ADMIN_PASSWORD_GENERATION=true` to the below command to enable a default keycloak admin. This is useful for development and testing of the SWF stack and enables the ability to run `uds run setup:create-doug-user` to create a user to test with using the username `doug` and the password `unicorn123!@#UN`. +Run the below command to deploy the `k3d-core-slim-dev` bundle: - ```bash - uds deploy k3d-core-slim-dev:0.24.1 - ``` +> [!TIP] +> You can append `--set INSECURE_ADMIN_PASSWORD_GENERATION=true` to the below command to enable a default keycloak admin. This is useful for development and testing of the SWF stack and enables the ability to run `uds run setup:create-doug-user` to create a user to test with using the username `doug` and the password `unicorn123!@#UN`. -1. Run the below command to deploy the `swf-dev` bundle on top of the dev cluster: +```bash +uds deploy k3d-core-slim-dev:0.24.1 +``` - - ```bash - uds deploy swf-dev:0.2.3 - ``` - +Run the below command to deploy the `swf-dev` bundle on top of the dev cluster: + + +```bash +uds deploy swf-dev:0.2.3 +``` + ## Development