Helm gh pages

[razinbouzar]

Helm Chart GitHub Pages Publishing Summary

Branch

The Helm chart publishing changes are on the helm-gh-pages branch.

Goal

Publish the Druid Operator Helm chart from this repository using the gh-pages branch, while matching the same repository layout DataInfra uses for charts.datainfra.io.

Files Changed

• .asf.yaml

  • Enables GitHub Pages publishing from the root of the gh-pages branch.
  • Adds:
    • ghp_branch: gh-pages
    • ghp_path: /

• .github/workflows/helm-chart.yml

  • Adds a new GitHub Actions workflow named Helm Chart.
  • Runs on pushes to master when the chart or workflow changes.
  • Also supports manual runs through workflow_dispatch.
  • Packages chart/ with Helm.
  • Publishes packaged charts to gh-pages/helm-releases/.
  • Regenerates gh-pages/index.yaml.
  • Pushes the updated chart package and index back to the gh-pages branch.

• docs/getting_started.md

  • Replaces the old DataInfra Helm repository with the Apache GitHub Pages repository:
    • https://apache.github.io/druid-operator
  • Updates install examples to use:
    • apache-druid/druid-operator

• tutorials/druid-on-kind/README.md

  • Updates the tutorial Helm repo and install command to use the Apache chart repository.

Published Repository Layout

The workflow publishes files to the gh-pages branch in this shape:

gh-pages/
  index.yaml
  helm-releases/
    druid-operator-<chart-version>.tgz

For the current chart version, the package would be:

gh-pages/helm-releases/druid-operator-0.3.9.tgz

And index.yaml will point Helm clients to:

https://apache.github.io/druid-operator/helm-releases/druid-operator-0.3.9.tgz

User Install Flow

After the workflow publishes the chart, users install with:

helm repo add apache-druid https://apache.github.io/druid-operator
helm repo update
helm upgrade -i cluster-druid-operator apache-druid/druid-operator \
  -n druid-operator-system \
  --create-namespace

Comparison With DataInfra

DataInfra publishes charts from a separate datainfrahq/helm-charts repository. Its layout is:

index.yaml
helm-releases/
  druid-operator-<chart-version>.tgz

This change keeps the same Helm repository layout, but uses this repository's gh-pages branch instead of a separate chart repository.

Validation Performed

The following checks passed locally:

make helm-lint
make helm-template
git diff --check

A local Helm publishing simulation also passed and generated an index.yaml entry pointing at /helm-releases/druid-operator-0.3.9.tgz.

Notes

• The workflow does not overwrite an already-published chart package if the same chart version already exists and is already indexed.
• Each chart release should bump chart/Chart.yaml version before publishing.
• make rat was run earlier and failed only because of pre-existing untracked files in the local worktree, not because of the Helm publishing workflow.

Fixes #XXXX.

Description

---

This PR has:

• been tested on a real K8S cluster to ensure creation of a brand new Druid cluster works.
• been tested for backward compatibility on a real K*S cluster by applying the changes introduced here on an existing Druid cluster. If there are any backward incompatible changes then they have been noted in the PR description.
• added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
• added documentation for new or modified features or behaviors.

---

Key changed/added files in this PR

• MyFoo
• OurBar
• TheirBaz

[AdheipSingh]

@razinbouzar seems like this PR has your other PR changes also, can you please check once.

[AdheipSingh]

Keep helm chart changes only

[razinbouzar]

Keep helm chart changes only

@AdheipSingh pushed the fix, thank you for catching that.