search

defenseunicorns / uds-package-sonarqube

🏭 UDS Sonarqube Zarf Package
Apache License 2.0
3 stars 2 forks source link

readme

🏭 UDS SonarQube Zarf Package

Latest Release Build Status OpenSSF Scorecard

This package is designed for use as part of a UDS Software Factory bundle deployed on UDS Core.

Prerequisites

SonarQube needs connection to a PostgreSQL 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.

For local testing and CI, SonarQube is bundled with the dev-postgres package.

Flavors

Flavor Description Example Creation
upstream Uses upstream images within the package zarf package create . -f upstream
registry1 Uses images from registry1.dso.mil within the package zarf package create . -f registry1

NOTE: registry1 flavor only supports the amd64 architecture

Releases

The released packages can be found in ghcr.

UDS Tasks (for local dev and CI)

*For local dev, this requires you install uds-cli

:white_check_mark: Tip: To get a list of tasks to run you can use uds run --list!

Contributing

Please see the CONTRIBUTING.md

Notes:

This package is currently using registry1 chart for both flavors. This is because the upstream chart depends on 'hostname' and 'wget' to be available in the images, and the registry1 images do not include these tools.

Development

When developing this package it is ideal to utilize the json schemas for UDS Bundles, Zarf Packages and Maru Tasks. This involves configuring your IDE to provide schema validation for the respective files used by each application. For guidance on how to set up this schema validation, please refer to the guide in uds-common.