Helm repository¶

The chart is published to GitHub Pages when a git tag v* is pushed.

User install¶

helm repo add virtfoundry https://virtfoundry.github.io/helm-charts
helm repo update
helm search repo virtfoundry/virtfoundry --versions

Install a specific version:

helm install virtfoundry virtfoundry/virtfoundry --version 1.4.1 \
  --namespace virtfoundry-system --create-namespace \
  --set secrets.rootPassword='...' \
  --set secrets.jwtSecret='...'

Optional values overlays (Gateway API, public networking, image tags) can be passed with -f on helm upgrade --install.

GitHub Pages layout¶

Path	Content
`https://virtfoundry.github.io/helm-charts/`	Helm `index.yaml` + `.tgz` packages
`https://virtfoundry.github.io/helm-charts/docs/`	MkDocs documentation (this site)

Both live on the gh-pages branch: chart-releaser writes packages at the root; the Docs workflow publishes MkDocs under docs/.

One-time setup: enable Pages

If /docs/ returns 404 but CI succeeded, GitHub Pages is probably disabled. Enable it once in the repo:

Settings → Pages → Build and deployment → Source: Deploy from a branch → gh-pages / / (root)

Or via CLI (repo admin):

gh api repos/virtfoundry/helm-charts/pages -X POST --input - <<'EOF'
{
  "build_type": "legacy",
  "source": { "branch": "gh-pages", "path": "/" }
}
EOF

First deploy can take 1–2 minutes after enabling.

Maintainer: publish a release¶

Bump version and appVersion in charts/virtfoundry/Chart.yaml
Update CHANGELOG.md and default image tags in values.yaml
Merge to main
Tag both virtfoundry and helm-charts:

git tag v1.1.0
git push origin v1.1.0

Workflows publish Helm package + rebuild docs

Verify:

curl -sL https://virtfoundry.github.io/helm-charts/index.yaml | head

See Versioning for SemVer policy.