Helm charts for the BJJ Éire platform — a React 19 SPA, a Java 25 / Spring Boot API, and MongoDB, delivered to AKS by Flux.
This repository produces chart artifacts; it does not deploy them. Charts
are published to GHCR as OCI artifacts, and Flux pulls
them from bjjeire-gitops,
which owns the values each cluster actually runs.
| Architecture | Chart composition, delivery chain, which values files are actually used |
| CI/CD | CI, release-please, chart publishing, Renovate |
| Decisions (ADRs) | Why the umbrella uses file:// deps, why charts ship as OCI, why the seeder is a hook |
| Runbooks | Release a chart · MongoDB recovery · Local install |
| AGENTS.md | Conventions and hard rules — for coding agents and new contributors alike |
Note that directory names and chart names differ:
| Directory | Chart | Version | Description |
|---|---|---|---|
bjj-eire/artifact |
bjj-eire |
0.2.3 | Umbrella, plus the seeder hook Job |
bjj-eire-api/artifact |
bjj-api |
0.1.7 | Java 25 / Spring Boot REST API |
bjj-eire-web/artifact |
bjj-frontend |
0.1.6 | React 19 SPA served by Caddy |
bjj-eire-mongodb/artifact |
bjj-mongodb |
0.1.5 | MongoDB 8.2 with persistent storage |
The umbrella depends on its siblings by file:// path. charts/ and
Chart.lock are gitignored build output — run helm dependency build after
cloning.
1. Merge a conventional commit touching the chart's directory
2. Merge the release PR → tag → publish-chart.yml → oci://ghcr.io/…:<version>
3. Bump the OCIRepository tag in bjjeire-gitops → Flux reconciles
Publishing a chart does not deploy it. Step 3 is required, and for a subchart change the umbrella's dependency pin has to be bumped first. Full procedure: docs/runbooks/release-a-chart.md.
The OCI tag is the chart version without the v — git tag
umbrella-v0.2.3 publishes bjj-eire:0.2.3.
| File | Consumed by |
|---|---|
values.yaml |
Every render — chart defaults |
values-ephemeral.yaml |
Preview environments, via a copy in bjjeire-gitops |
values-local.yaml |
helm install on minikube / kind |
values-dev.yaml, values-staging.yaml, values-prod.yaml |
Nothing — legacy |
Deployed configuration lives in bjjeire-gitops, which supplies values:
inline in its HelmRelease and never reads the files here. The dev, staging,
and prod files are left over from the pre-GitOps era, when this repository
deployed with a kubeconfig and nginx Ingress — the clusters now run Istio
ambient with Gateway API. See
ADR-0005.
helm dependency build bjj-eire/artifact
MONGO_PW=$(echo -n 'change-me' | base64)
helm upgrade --install bjj-eire bjj-eire/artifact \
--namespace bjjeire-app --create-namespace \
-f bjj-eire/artifact/values.yaml \
-f bjj-eire/artifact/values-local.yaml \
--set "bjj-api.secrets.mongodbRootPassword.value=${MONGO_PW}" \
--set "bjj-mongodb.secrets.mongodbRootPassword.value=${MONGO_PW}" \
--wait --timeout 10mAdd app.bjj.local and api.bjj.local to /etc/hosts. Full walkthrough,
including building the images: docs/runbooks/local-install.md.
Every pull request runs helm lint across all charts, renders the umbrella,
validates with kubeconform (default schemas plus the datree CRDs catalog),
and reviews the rendered workloads with kube-score (advisory).
Details: docs/ci-cd.md.
Release-Please manages four independent release lines driven by Conventional Commits:
| Chart | Tag |
|---|---|
| Umbrella | umbrella-v* |
| API | api-v* |
| Frontend | web-v* |
| MongoDB | mongodb-v* |
Merging a release PR bumps the version, writes the changelog, tags, and
dispatches publish-chart.yml. Never create a release tag by hand —
ADR-0004 explains what that
breaks.
| Repository | Owns |
|---|---|
| bjjeire-deploy (this repo) | Helm charts and their OCI artifacts |
| bjjeire | Application code and the container images these charts reference |
| bjjeire-gitops | Flux resources; owns the live values and the chart version pin |
| bjjeire-terraform-azurerm-aks | Cluster, identities, Key Vault |
See CONTRIBUTING.md. This project follows Conventional Commits and the Contributor Covenant.
See SECURITY.md for the vulnerability disclosure policy.
MIT © Ian O'Flynn — see LICENSE.