Merge pull request #613 from sthaha/ci-release-helm-charts

ci(release): publish helm charts

Author: vprashar2929

.github/workflows/release.yaml

@@ -38,6 +38,10 @@ jobs:
           VERSION: ${{ github.event.inputs.tag }}
       - name: Install all tools
         uses: ./.github/tools-cache
+      - name: Setup Helm
+        uses: azure/setup-helm@v4
+        with:
+          version: latest
       - name: Build Operator
         run: |
           make operator-build
@@ -49,6 +53,21 @@ jobs:
         env:
           IMG_BASE: ${{ vars.IMG_BASE }}
           VERSION_REPLACED: ${{ github.event.inputs.version-replace }}
+      - name: Update Helm Chart Version
+        shell: bash
+        run: |
+          VERSION=${{ github.event.inputs.tag }}
+          # Update Chart.yaml with the release version
+          sed -i "s/^version:.*/version: $VERSION/" manifests/helm/kepler-operator/Chart.yaml
+          sed -i "s/^appVersion:.*/appVersion: \"v$VERSION\"/" manifests/helm/kepler-operator/Chart.yaml
+      - name: Package Helm Chart
+        shell: bash
+        run: |
+          mkdir -p helm-releases
+          VERSION=${{ github.event.inputs.tag }}
+          helm package manifests/helm/kepler-operator -d helm-releases
+          # Rename the helm chart to include 'helm' identifier
+          mv helm-releases/kepler-operator-${VERSION}.tgz helm-releases/kepler-operator-helm-${VERSION}.tgz
       - name: Git set user
         run: |
           git config  user.name "$USERNAME"
@@ -106,3 +125,10 @@ jobs:
           generate_release_notes: true
           draft: false
           prerelease: false
+          files: |
+            helm-releases/*.tgz
+      - name: Push Helm Chart to OCI registry
+        shell: bash
+        run: |
+          VERSION=${{ github.event.inputs.tag }}
+          helm push helm-releases/kepler-operator-helm-${VERSION}.tgz oci://quay.io/sustainable_computing_io/charts

docs/developer/helm-chart-maintenance.md

@@ -413,6 +413,112 @@ When releasing a new version:
 
 ---
 
+## 🚀 Manual Build and Publish
+
+For manual chart publishing (outside of automated release workflow):
+
+### Prerequisites
+
+- Helm >=3.0.0
+- Access to Quay.io registry (`BOT_NAME` and `BOT_TOKEN`)
+- Chart version updated in `Chart.yaml`
+
+### Build and Publish Process
+
+**1. Update Chart Version**:
+
+```bash
+VERSION=0.22.0
+
+# Update Chart.yaml with the release version
+sed -i "s/^version:.*/version: $VERSION/" manifests/helm/kepler-operator/Chart.yaml
+sed -i "s/^appVersion:.*/appVersion: \"v$VERSION\"/" manifests/helm/kepler-operator/Chart.yaml
+
+# Verify changes
+cat manifests/helm/kepler-operator/Chart.yaml
+```
+
+**2. Validate Chart**:
+
+```bash
+make helm-validate
+```
+
+**3. Package Chart**:
+
+```bash
+# Create output directory
+mkdir -p helm-releases
+
+# Package the chart
+helm package manifests/helm/kepler-operator -d helm-releases
+
+# Optional: Rename with -helm- identifier for clarity
+mv helm-releases/kepler-operator-${VERSION}.tgz \
+   helm-releases/kepler-operator-helm-${VERSION}.tgz
+```
+
+**4. Login to OCI Registry**:
+
+```bash
+# Login to Quay.io
+helm registry login quay.io/sustainable_computing_io \
+  --username "$BOT_NAME" \
+  --password "$BOT_TOKEN"
+```
+
+**5. Push to OCI Registry**:
+
+```bash
+# Push to Quay.io OCI registry
+helm push helm-releases/kepler-operator-helm-${VERSION}.tgz \
+  oci://quay.io/sustainable_computing_io/charts
+```
+
+**6. Verify Publication**:
+
+```bash
+# Pull the chart to verify it's available
+helm pull oci://quay.io/sustainable_computing_io/charts/kepler-operator \
+  --version ${VERSION} \
+  -d /tmp
+
+# Inspect the downloaded chart
+tar -tzf /tmp/kepler-operator-${VERSION}.tgz | head -20
+```
+
+### Install from OCI Registry
+
+Users can install the published chart directly from the OCI registry:
+
+```bash
+# Install latest version
+helm install kepler-operator \
+  oci://quay.io/sustainable_computing_io/charts/kepler-operator \
+  --namespace kepler-operator \
+  --create-namespace
+
+# Install specific version
+helm install kepler-operator \
+  oci://quay.io/sustainable_computing_io/charts/kepler-operator \
+  --version 0.22.0 \
+  --namespace kepler-operator \
+  --create-namespace
+```
+
+### Automated Release
+
+The GitHub release workflow (`.github/workflows/release.yaml`) automatically:
+
+1. Updates Chart.yaml version
+2. Packages the chart
+3. Attaches chart to GitHub release
+4. Pushes to OCI registry at `oci://quay.io/sustainable_computing_io/charts`
+
+To trigger automated release, use the workflow dispatch with the desired version tag.
+
+---
+
 ## 📚 Additional Resources
 
 - **Helm Best Practices**: <https://helm.sh/docs/chart_best_practices/>

manifests/helm/kepler-operator/README.md

@@ -20,21 +20,38 @@ kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/
 
 ### Install Kepler Operator
 
-**From source repository:**
+**From OCI registry (recommended for users):**
+
+```bash
+# Install latest version
+helm install kepler-operator \
+  oci://quay.io/sustainable_computing_io/charts/kepler-operator \
+  --namespace kepler-operator \
+  --create-namespace
+
+# Install specific version
+helm install kepler-operator \
+  oci://quay.io/sustainable_computing_io/charts/kepler-operator \
+  --version 0.21.0 \
+  --namespace kepler-operator \
+  --create-namespace
+```
+
+**From source repository (for developers):**
 
 ```bash
 make helm-install
 ```
 
-**Using Helm directly:**
+**Using Helm directly (local development):**
 
 ```bash
 helm install kepler-operator ./manifests/helm/kepler-operator \
   --namespace kepler-operator \
   --create-namespace
 ```
 
-**From packaged chart:**
+**From packaged chart file:**
 
 ```bash
 helm install kepler-operator kepler-operator-0.21.0.tgz \
@@ -44,19 +61,46 @@ helm install kepler-operator kepler-operator-0.21.0.tgz \
 
 ### Install with custom values
 
+**From OCI registry with custom values:**
+
 ```bash
-helm install kepler-operator ./manifests/helm/kepler-operator \
+helm install kepler-operator \
+  oci://quay.io/sustainable_computing_io/charts/kepler-operator \
   --namespace kepler-operator \
   --create-namespace \
   --set operator.image=quay.io/sustainable_computing_io/kepler-operator:v0.21.0 \
   --set kepler.image=quay.io/sustainable_computing_io/kepler:v0.11.0 \
   --set metrics.serviceMonitor.enabled=true
 ```
 
-Or create a custom `values.yaml` and install:
+**From local source with custom values:**
 
 ```bash
 helm install kepler-operator ./manifests/helm/kepler-operator \
+  --namespace kepler-operator \
+  --create-namespace \
+  --set operator.image=quay.io/sustainable_computing_io/kepler-operator:v0.21.0 \
+  --set kepler.image=quay.io/sustainable_computing_io/kepler:v0.11.0 \
+  --set metrics.serviceMonitor.enabled=true
+```
+
+**Using custom values file:**
+
+```bash
+# Create custom-values.yaml
+cat > custom-values.yaml <<EOF
+operator:
+  image: quay.io/sustainable_computing_io/kepler-operator:v0.21.0
+kepler:
+  image: quay.io/sustainable_computing_io/kepler:v0.11.0
+metrics:
+  serviceMonitor:
+    enabled: true
+EOF
+
+# Install with custom values
+helm install kepler-operator \
+  oci://quay.io/sustainable_computing_io/charts/kepler-operator \
   --namespace kepler-operator \
   --create-namespace \
   --values custom-values.yaml
@@ -100,13 +144,28 @@ spec:
 
 ## Upgrading
 
+**From OCI registry:**
+
+```bash
+# Upgrade to latest version
+helm upgrade kepler-operator \
+  oci://quay.io/sustainable_computing_io/charts/kepler-operator \
+  --namespace kepler-operator
+
+# Upgrade to specific version
+helm upgrade kepler-operator \
+  oci://quay.io/sustainable_computing_io/charts/kepler-operator \
+  --version 0.22.0 \
+  --namespace kepler-operator
+```
+
 **From source repository:**
 
 ```bash
 make helm-install  # Uses helm upgrade --install
 ```
 
-**Using Helm directly:**
+**Using Helm directly (local development):**
 
 ```bash
 helm upgrade kepler-operator ./manifests/helm/kepler-operator \