From 05a8a872090b92c5a3e121307d98966ebacee3d3 Mon Sep 17 00:00:00 2001 From: TristanHoladay <40547442+TristanHoladay@users.noreply.github.com> Date: Fri, 19 Jan 2024 14:02:03 -0700 Subject: [PATCH 1/5] chore: updating readme --- README.md | 23 +++++++++++++++++++++++ chart/README.md | 8 ++++++++ 2 files changed, 31 insertions(+) create mode 100644 chart/README.md diff --git a/README.md b/README.md index 2393a96f..c419e8b3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ # uds-package-sonarqube UDS Sonarqube Zarf Package + +## Flavors +| Flavor | example creation | +| ------ | ---------------- | +| upstream-ce | `zarf package create . -f upstream-ce` | +| registry1 | `zarf package create . -f registry1` | + +## Tasks +| Task | Description | Example | +| ---- | ----------- | ------- | +| setup-cluster | Uses the `k3d-core-istio` bundle to create a cluster for testing against | `uds run setup-cluster` | +| create-package | Creates just the sonarqube package | `uds run create-package --set FLAVOR=` | +| create-test-bundle | Creates sonarqube and sonarqube dependency packages and then bundles them | `uds run create-test-bundle` | +| deploy-package | Deploy Sonarqube package only | `uds run deploy-package` | +| deploy-test-bundle | Deploy Sonarqube and Sonarqube dependency bundle | `uds run deploy-test-bundle` | +| test-package | Run checks against a deployed package or bundle | `uds run test-package` | +| cleanup | Teardown the cluster | `uds run cleanup` | + +## Values + +See: +1. [/values/sonarqube-values.yaml](/values/sonarqube-values.yaml) +2. [/values/upstream.yaml](/values/upstream.yaml) \ No newline at end of file diff --git a/chart/README.md b/chart/README.md new file mode 100644 index 00000000..5674a994 --- /dev/null +++ b/chart/README.md @@ -0,0 +1,8 @@ +# chart + +![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) + +uds-sonarqube-config + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0) From f4a717b68450fb8e469dfd3033131c45a5b19327 Mon Sep 17 00:00:00 2001 From: TristanHoladay <40547442+TristanHoladay@users.noreply.github.com> Date: Wed, 24 Jan 2024 06:49:05 -0700 Subject: [PATCH 2/5] wip: updates; removed ce.yaml --- README.md | 13 +++++++++++-- values/ce.yaml | 0 zarf.yaml | 1 - 3 files changed, 11 insertions(+), 3 deletions(-) delete mode 100644 values/ce.yaml diff --git a/README.md b/README.md index c419e8b3..7729c28c 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,22 @@ # uds-package-sonarqube UDS Sonarqube Zarf Package +This package is purposed for use as part of the software factory bundle deployed on UDS-CORE (https://github.com/defenseunicorns/uds-core). + +## Pre-requisites + +Sonarqube needs connection to a postgres instance either in cluster or external. It finds this connection via the `sonarqube_db_endpoint` variable declared in the zarf package and configured (as an example) at deploy time by the [uds bundle config](./bundle/uds-config.yaml). + ## Flavors -| Flavor | example creation | + +| Flavor | Example Creation | | ------ | ---------------- | | upstream-ce | `zarf package create . -f upstream-ce` | | registry1 | `zarf package create . -f registry1` | -## Tasks +## UDS Tasks (for local dev and CI) +*For local dev, this requires you install [uds-cli](https://github.com/defenseunicorns/uds-cli?tab=readme-ov-file#install) + | Task | Description | Example | | ---- | ----------- | ------- | | setup-cluster | Uses the `k3d-core-istio` bundle to create a cluster for testing against | `uds run setup-cluster` | diff --git a/values/ce.yaml b/values/ce.yaml deleted file mode 100644 index e69de29b..00000000 diff --git a/zarf.yaml b/zarf.yaml index 046c4509..4e14d8be 100644 --- a/zarf.yaml +++ b/zarf.yaml @@ -80,7 +80,6 @@ components: valuesFiles: - values/sonarqube-values.yaml - values/upstream.yaml - - values/ce.yaml - name: uds-sonarqube-config namespace: sonarqube version: 0.1.0 From 09d931d18a32d60395f96ed037870d373bdeba3a Mon Sep 17 00:00:00 2001 From: TristanHoladay <40547442+TristanHoladay@users.noreply.github.com> Date: Wed, 24 Jan 2024 07:05:58 -0700 Subject: [PATCH 3/5] wip: more updates --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7729c28c..929e10dc 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ This package is purposed for use as part of the software factory bundle deployed Sonarqube needs connection to a postgres instance either in cluster or external. It finds this connection via the `sonarqube_db_endpoint` variable declared in the zarf package and configured (as an example) at deploy time by the [uds bundle config](./bundle/uds-config.yaml). +For local testing and CI, Sonarqube is bundled with the [dev-postgres package](ghcr.io/defenseunicorns/packages/uds/dev-postgres) + ## Flavors | Flavor | Example Creation | @@ -14,6 +16,11 @@ Sonarqube needs connection to a postgres instance either in cluster or external. | upstream-ce | `zarf package create . -f upstream-ce` | | registry1 | `zarf package create . -f registry1` | +## Package + +The deployment package can be found in [ghcr](https://github.com/defenseunicorns/uds-package-sonarqube/pkgs/container/packages%2Fuds%2Fsonarqube). + + ## UDS Tasks (for local dev and CI) *For local dev, this requires you install [uds-cli](https://github.com/defenseunicorns/uds-cli?tab=readme-ov-file#install) @@ -31,4 +38,7 @@ Sonarqube needs connection to a postgres instance either in cluster or external. See: 1. [/values/sonarqube-values.yaml](/values/sonarqube-values.yaml) -2. [/values/upstream.yaml](/values/upstream.yaml) \ No newline at end of file +2. [/values/upstream.yaml](/values/upstream.yaml) + +## Contributing +Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) \ No newline at end of file From d4401e5525646e2a4e74331c47031cddd9f24633 Mon Sep 17 00:00:00 2001 From: TristanHoladay <40547442+TristanHoladay@users.noreply.github.com> Date: Wed, 24 Jan 2024 07:07:10 -0700 Subject: [PATCH 4/5] wip: more updates --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 929e10dc..f22ade10 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This package is purposed for use as part of the software factory bundle deployed Sonarqube needs connection to a postgres instance either in cluster or external. It finds this connection via the `sonarqube_db_endpoint` variable declared in the zarf package and configured (as an example) at deploy time by the [uds bundle config](./bundle/uds-config.yaml). -For local testing and CI, Sonarqube is bundled with the [dev-postgres package](ghcr.io/defenseunicorns/packages/uds/dev-postgres) +For local testing and CI, Sonarqube is bundled with the [dev-postgres package](ghcr.io/defenseunicorns/packages/uds/dev-postgres). ## Flavors From 4a28a5628eb8a3d284281c4597c32d0713e4a1ea Mon Sep 17 00:00:00 2001 From: TristanHoladay <40547442+TristanHoladay@users.noreply.github.com> Date: Wed, 24 Jan 2024 07:13:09 -0700 Subject: [PATCH 5/5] wip: remove local chart readme --- chart/README.md | 8 -------- 1 file changed, 8 deletions(-) delete mode 100644 chart/README.md diff --git a/chart/README.md b/chart/README.md deleted file mode 100644 index 5674a994..00000000 --- a/chart/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# chart - -![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) - -uds-sonarqube-config - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)