Skip to content

chore(helm): add helm charts for operator installation #608

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Oct 8, 2025
Merged

chore(helm): add helm charts for operator installation #608

merged 2 commits into from
Oct 8, 2025

Conversation

sthaha
Copy link
Collaborator

@sthaha sthaha commented Oct 2, 2025

No description provided.

@github-actions github-actions bot added ci Changes to the CI pipeline chore Routine tasks or maintenance labels Oct 2, 2025
@codecov Codecov
Copy link

codecov bot commented Oct 2, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.26%. Comparing base (4f52a99) to head (ba4b4d8).
⚠️ Report is 5 commits behind head on v1alpha1.

Additional details and impacted files 
@@            Coverage Diff            @@
##           v1alpha1     #608   +/-   ##
=========================================
  Coverage     77.26%   77.26%           
=========================================
  Files            11       11           
  Lines          1267     1267           
=========================================
  Hits            979      979           
  Misses          258      258           
  Partials         30       30

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sthaha sthaha changed the title Feat helm chart chore(helm): add helm charts for operator installation Oct 2, 2025
@sthaha sthaha requested review from Copilot and vprashar2929 October 2, 2025 16:47
Copilot
Copilot AI reviewed Oct 2, 2025
View reviewed changes
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive Helm chart support for the Kepler Operator, enabling deployment via Helm in addition to the existing kustomize-based installation method.

  • Adds complete Helm chart with templates for all operator resources
  • Implements CRD synchronization and validation tooling
  • Includes comprehensive documentation and CI integration

Reviewed Changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
manifests/helm/kepler-operator/values.yaml Default configuration values for operator deployment
manifests/helm/kepler-operator/templates/*.yaml Template files for all Kubernetes resources
manifests/helm/kepler-operator/crds/*.yaml Custom Resource Definitions synced from config/crd/bases
manifests/helm/kepler-operator/Chart.yaml Chart metadata and dependencies
docs/developer/helm-chart-maintenance.md Developer guide for maintaining the Helm chart
hack/helm-validate.sh Validation script for chart consistency
Makefile Helm-related targets for installation and testing

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

hack/helm/validate.sh Outdated
Comment on lines 67 to 72
helm template kepler-operator "$HELM_CHART_DIR" \
--namespace kepler-operator \
--set image.tag=0.21.0 \
--set kepler.image.tag=latest \
--set kubeRbacProxy.image.tag=v0.18.1 \
--set metrics.serviceMonitor.enabled=true
Copy link

Copilot AI Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same incorrect value paths as above. These --set parameters don't match the values.yaml structure.

Copilot uses AI. Check for mistakes.

vprashar2929
vprashar2929 reviewed Oct 5, 2025
View reviewed changes
.github/workflows/pr-checks.yaml Outdated
Comment on lines 412 to 418
- name: Use Kepler Action for Kind cluster
uses: sustainable-computing-io/[email protected]
with:
ebpfprovider: libbpf
cluster_provider: kind
env:
PROMETHEUS_ENABLE: "true"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should use make cluster-up which will also deploy cert-manager so no need to manually deploy and verify in .github/helm-e2e/action.yaml

@sthaha
chore(tools): install helm
97b97e7 
Signed-off-by: Sunil Thaha <[email protected]>
@sthaha sthaha force-pushed the feat-helm-chart branch 5 times, most recently from ec5b8ac to 768feb9 Compare October 7, 2025 06:54
@github-actions github-actions bot removed the ci Changes to the CI pipeline label Oct 7, 2025
vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
hack/helm/validate.sh Outdated
info "Validating Helm templates render successfully..."
if helm template kepler-operator "$HELM_CHART_DIR" \
--namespace kepler-operator \
--set operator.image=quay.io/sustainable_computing_io/kepler-operator:0.21.0 \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we keep the version's in variable?

vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
hack/helm/validate.sh Outdated
ok "Helm templates render successfully"
else
fail "Helm template rendering failed"
helm template kepler-operator "$HELM_CHART_DIR" \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since its the same command can we define it once?

vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
hack/helm/validate.sh Outdated
)

local rendered
rendered=$(helm template kepler-operator "$HELM_CHART_DIR" \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here as well

vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
.github/workflows/pr-checks.yaml Outdated
Comment on lines 411 to 413
KIND_VERSION: 0.27.0
GO111MODULE: on
KUBECONFIG: /tmp/.kube/config
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove these?

vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
.github/helm-e2e/action.yaml Outdated
env:
VERSION: ${{ inputs.version }}

- name: Capture cluster state
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we capture this in the script itself?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, and no .. I think it is best to have this step run no matter what ( if: always ). yes, we can move this to a hack/ci/capture.sh (perhaps in a separate pr? )

vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
tests/helm.sh Outdated
Comment on lines 85 to 86
--set kepler.image=quay.io/sustainable_computing_io/kepler:latest \
--set kube-rbac-proxy.image=quay.io/brancz/kube-rbac-proxy:v0.19.0 \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Versions as variable?

vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
tests/helm.sh Outdated
header "Deploy PowerMonitor"

# Create fake CPU meter ConfigMap
create_fake_cpu_configmap "$POWERMONITOR_NS"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we control this via flag just like in operator e2e?
Something like:
if --running-on-vm then create_fake_cpu_configmap

vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
.github/workflows/pr-checks.yaml Outdated
uses: ./.github/compute-version
id: version

- name: Build and load operator image
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e2e supports building operator. Shouldn't we use that instead of doing it here?

vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
hack/cert-manager/verify.sh Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good to remove this?

vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
hack/cert-manager/test-certificate.yaml Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same for this

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔

vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
hack/ci/powermonitor-fake-cpu.yaml Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same for this

vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
vprashar2929
vprashar2929 reviewed Oct 7, 2025
View reviewed changes
@github-actions github-actions bot added the ci Changes to the CI pipeline label Oct 7, 2025
@github-actions github-actions bot removed the ci Changes to the CI pipeline label Oct 8, 2025
@sthaha sthaha marked this pull request as ready for review October 8, 2025 05:19
vprashar2929
vprashar2929 reviewed Oct 8, 2025
View reviewed changes
Makefile Outdated
HELM_TIMEOUT ?= 2m

.PHONY: check-cert-manager
check-cert-manager: ## Check if cert-manager is installed
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need a target for this?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, used to need it when the setup was only using kind.

Makefile Outdated
Comment on lines 348 to 350
cp config/crd/bases/kepler.system.sustainable.computing.io_powermonitors.yaml \
$(HELM_CHART_DIR)/crds/
cp config/crd/bases/kepler.system.sustainable.computing.io_powermonitorinternals.yaml \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cp the whole dir instead of individual?

vprashar2929
vprashar2929 reviewed Oct 8, 2025
View reviewed changes
Makefile Outdated

.PHONY: helm-lint
helm-lint: helm ## Lint the Helm chart
helm lint $(HELM_CHART_DIR)
Copy link
Collaborator

@vprashar2929 vprashar2929 Oct 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HELM ?= $(LOCALBIN)/helm
We need to use $(HELM) instead of helm

@sthaha
chore(helm): support deployment using helm chart
ba4b4d8 
Add Helm chart for deploying Kepler Operator with automated
validation and testing infrastructure.

Changes:
- Add Helm chart in manifests/helm/kepler-operator/ with templates for all
  operator resources (deployment, RBAC, webhooks, cert-manager integration)
- Add Makefile targets for Helm operations (lint, template, install, validate)
- Add hack/helm/validate.sh for three-layer validation (syntax, rendering,
  consistency with kustomize)
- Add hack/ci/ resources for CI testing with fake CPU meter
- Add hack/cert-manager/ utilities for certificate verification
- Add comprehensive documentation in docs/developer/helm-chart-maintenance.md
- Update pre-commit hooks to validate Helm chart syntax
- Update README.md with Helm deployment option

The chart follows hybrid automation approach: manual templates with automated
CRD sync and validation against kustomize output.

Signed-off-by: Sunil Thaha <[email protected]>
@sthaha sthaha merged commit 44ee561 into sustainable-computing-io:v1alpha1 Oct 8, 2025
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@vprashar2929 vprashar2929 vprashar2929 approved these changes

Assignees

No one assigned

Labels

chore Routine tasks or maintenance

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@sthaha @vprashar2929