Skip to content

defenseunicorns/uds-package-confluence

Repository files navigation

🚚 UDS Confluence Zarf Package

Latest Release Build Status OpenSSF Scorecard

This package is designed to be deployed on UDS Core, and is based on the upstream Confluence chart.

Pre-requisites

The Confluence Package expects to be deployed on top of UDS Core with the dependencies listed below being configured prior to deployment.

Confluence is configured by default to assume the internal dependencies that are used for testing (see postgres in the bundle).

Database

  • A Postgres database is running on port 5432 and accessible to the cluster via the CONFLUENCE_DB_ENDPOINT Zarf var.
  • This database can be logged into via the username configured with the Zarf var CONFLUENCE_DB_USERNAME. Default is confluence.confluence
  • This database instance has a psql database created matching what is defined in the Zarf var CONFLUENCE_DB_NAME. Default is confluencedb
  • The user has read/write access to the above mentioned database
  • Create confluence-postgres service in confluence namespace that points to the psql database
  • Create confluence-postgres secret in confluence namespace with the key password that contains the password to the user for the psql database

Flavors

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

Important

NOTE: To create the registry1 flavor you will need to be logged into Iron Bank - you can find instructions on how to do this in the Big Bang Zarf Tutorial.

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

Tip

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

Contributing

Please see the CONTRIBUTING.md