Deployment¶

Log in to your cluster and deploy:

oc login
just deploy

This installs the newest release of the oci://quay.io/project-aibom/aibom-console chart, which runs the image built for that release, into the aibom-console-plugin namespace. Pass --namespace=<ns> to change it.

Common options¶

Pin a release, or install the newest dev build from main:

just deploy --version=0.1.0
just deploy --devel

Deploy from a different Quay org or with custom values:

just deploy --repo=quay.io/your-org --values=values-prod.yaml

Or use Helm directly:

helm upgrade -i aibom-console-plugin oci://quay.io/project-aibom/aibom-console \
  -n aibom-console-plugin --create-namespace

See charts/aibom-console/values.yaml for all configuration options.

Uninstall¶

just uninstall

This removes the Helm release (including the ConsolePlugin CR) and un-registers the plugin from the console operator. Pass --namespace=<ns> if you deployed elsewhere.

Or do it by hand. helm uninstall removes the chart's resources but does not undo the patcher job's edit to the console operator, which added the plugin to spec.plugins:

helm uninstall aibom-console-plugin -n aibom-console-plugin
oc get consoles.operator.openshift.io cluster -o json \
  | jq '.spec.plugins -= ["aibom-console-plugin"]' \
  | oc apply -f -

Feature flags¶

Value	Default	Description
`plugin.featureFlags.telemetryTab`	`true`	Shows the Telemetry tab on the Detail and Compare views.
`plugin.featureFlags.csvExport`	`false`	Shows the CSV Download menu on the List and Detail views. Off by default.

For example, to turn on CSV export:

helm upgrade -i aibom-console-plugin oci://quay.io/project-aibom/aibom-console \
  -n aibom-console-plugin --create-namespace --set plugin.featureFlags.csvExport=true

The flags are rendered into a ConfigMap the plugin reads at runtime, so changing them needs no image rebuild.

Building and pushing¶

Container image¶

just docker-build    # build the image locally
just docker-push     # push to Quay (requires `docker login quay.io`)
just deploy-local    # build, push and deploy in one go

Every push to main builds the image through .github/workflows/images.yml, tagged :latest and :<short sha>.

Helm chart¶

just chart-push      # requires `helm registry login quay.io`

Without --version, this publishes a dev build versioned from the latest release tag: the next patch, the commits since the tag and the SHA (for example 0.1.1-dev.5.gabc1234 five commits after v0.1.0). Newer builds sort higher, and all sort below the next release. Helm skips these unless you pass --devel or the exact version. CI does this on every merge to main that touches the chart.

Releases. Push a vX.Y.Z tag. .github/workflows/release.yml builds the image as quay.io/project-aibom/aibom-console-plugin:X.Y.Z, then runs just chart-push --version=X.Y.Z, which publishes the chart with version and appVersion set to X.Y.Z, so its image defaults to that build. A release is only ever pushed once. Chart.yaml's version is unused and never needs bumping.