Skip to content

feat: add Helm chart for Kepler deployment #2220

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 3 commits into from
Jul 11, 2025
Merged

feat: add Helm chart for Kepler deployment #2220

merged 3 commits into from
Jul 11, 2025

Conversation

sthaha
Copy link
Collaborator

@sthaha sthaha commented Jul 11, 2025

Enhancements include:

  • Add complete Helm chart under manifests/helm/kepler/ with templates for all Kubernetes resources
  • Integrate Helm chart packaging and release into GitHub Actions workflow
  • Create comprehensive installation documentation with Helm, Docker Compose, and Kustomize methods
  • Update README.md to highlight Helm as recommended Kubernetes deployment method
  • Include ServiceMonitor, RBAC, ConfigMap, and DaemonSet templates with configurable values
  • Add documentation links for installation, configuration, and metrics guides
  • Automated chart versioning and GitHub release integration

@github-actions github-actions bot added feat A new feature or enhancement ci Changes to the CI pipeline labels Jul 11, 2025
@github-actions GitHub Actions
Copy link
Contributor

⚠️ Config changes detected in this PR
Please make sure that the config changes are updated in the following places as part of this PR:

  • docs/configuration/configuration.md
  • compose/dev/kepler-dev/etc/kepler/config.yaml
  • hack/config.yaml
  • manifests/k8s/configmap.yaml

@sthaha sthaha mentioned this pull request Jul 11, 2025
Open
@sthaha sthaha force-pushed the chore-helm-chart branch from 2b8f394 to e0ffb1d Compare July 11, 2025 03:08
@github-actions github-actions bot added the docs Documentation changes label Jul 11, 2025
@github-actions GitHub Actions
Copy link
Contributor

⚠️ Config changes detected in this PR
Please make sure that the config changes are updated in the following places as part of this PR:

  • docs/configuration/configuration.md
  • compose/dev/kepler-dev/etc/kepler/config.yaml
  • hack/config.yaml
  • manifests/k8s/configmap.yaml

@sthaha sthaha force-pushed the chore-helm-chart branch from e0ffb1d to 90e7bba Compare July 11, 2025 03:11
@github-actions GitHub Actions
Copy link
Contributor

⚠️ Config changes detected in this PR
Please make sure that the config changes are updated in the following places as part of this PR:

  • docs/configuration/configuration.md
  • compose/dev/kepler-dev/etc/kepler/config.yaml
  • hack/config.yaml
  • manifests/k8s/configmap.yaml

@sthaha sthaha force-pushed the chore-helm-chart branch from 90e7bba to 475efc0 Compare July 11, 2025 03:43
@github-actions GitHub Actions
Copy link
Contributor

⚠️ Config changes detected in this PR
Please make sure that the config changes are updated in the following places as part of this PR:

  • docs/configuration/configuration.md
  • compose/dev/kepler-dev/etc/kepler/config.yaml
  • hack/config.yaml
  • manifests/k8s/configmap.yaml

@sthaha sthaha force-pushed the chore-helm-chart branch from 475efc0 to b5293d6 Compare July 11, 2025 04:40
@github-actions GitHub Actions
Copy link
Contributor

⚠️ Config changes detected in this PR
Please make sure that the config changes are updated in the following places as part of this PR:

  • docs/configuration/configuration.md
  • compose/dev/kepler-dev/etc/kepler/config.yaml
  • hack/config.yaml
  • manifests/k8s/configmap.yaml

@sthaha
feat: add Helm chart for Kepler deployment
b76d4ff 
- Add complete Helm chart under manifests/helm/kepler/ with templates
  for all Kubernetes resources
- Set chart version to 0.0.0-dev for automatic versioning during releases
- Include ServiceMonitor, RBAC, ConfigMap, and DaemonSet templates
  with configurable values

Signed-off-by: Sunil Thaha <sthaha@redhat.com>
@sthaha sthaha force-pushed the chore-helm-chart branch from b5293d6 to f9bd648 Compare July 11, 2025 05:17
@github-actions GitHub Actions
Copy link
Contributor

⚠️ Config changes detected in this PR
Please make sure that the config changes are updated in the following places as part of this PR:

  • docs/configuration/configuration.md
  • compose/dev/kepler-dev/etc/kepler/config.yaml
  • hack/config.yaml
  • manifests/k8s/configmap.yaml

@sthaha sthaha requested a review from vprashar2929 July 11, 2025 05:24
@sthaha sthaha force-pushed the chore-helm-chart branch from f9bd648 to 64ca005 Compare July 11, 2025 05:28
@github-actions GitHub Actions
Copy link
Contributor

⚠️ Config changes detected in this PR
Please make sure that the config changes are updated in the following places as part of this PR:

  • docs/configuration/configuration.md
  • compose/dev/kepler-dev/etc/kepler/config.yaml
  • hack/config.yaml
  • manifests/k8s/configmap.yaml

vprashar2929
vprashar2929 reviewed Jul 11, 2025
View reviewed changes
docs/user/installation.md Outdated
Comment on lines 233 to 236
- `kepler_container_joules_total`
- `kepler_node_energy_total`
- `kepler_process_energy_total`

Copy link
Collaborator

Choose a reason for hiding this comment

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

Metrics need updation

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thank you!

vprashar2929
vprashar2929 reviewed Jul 11, 2025
View reviewed changes
vprashar2929
vprashar2929 reviewed Jul 11, 2025
View reviewed changes
docs/user/installation.md Outdated
- **Documentation**: <https://sustainable-computing.io/kepler/>
- **Issues**: <https://github.com/sustainable-computing-io/kepler/issues>
- **Discussions**: <https://github.com/sustainable-computing-io/kepler/discussions>
- **Slack**: #kepler channel in CNCF Slack
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 add our slack channel like here?

sthaha added 2 commits July 11, 2025 05:03
@sthaha
docs: add Helm chart documentation
932c8f7 
- New user doc with comprehensive installation steps using
  Helm, Docker Compose, and Kustomize methods
- Update README.md to highlight Helm as recommended Kubernetes
  deployment method

Signed-off-by: Sunil Thaha <sthaha@redhat.com>
@sthaha
ci: release helm chart as an artifact
aa29a26 
Signed-off-by: Sunil Thaha <sthaha@redhat.com>
@sthaha sthaha force-pushed the chore-helm-chart branch from 64ca005 to aa29a26 Compare July 11, 2025 09:03
@github-actions GitHub Actions
Copy link
Contributor

⚠️ Config changes detected in this PR
Please make sure that the config changes are updated in the following places as part of this PR:

  • docs/configuration/configuration.md
  • compose/dev/kepler-dev/etc/kepler/config.yaml
  • hack/config.yaml
  • manifests/k8s/configmap.yaml

vprashar2929
vprashar2929 reviewed Jul 11, 2025
View reviewed changes
.github/k8s/action.yaml
- name: Lint Helm chart
shell: bash
run: |
helm lint manifests/helm/kepler
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not using precommit hook here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hmmm .. good idea

@vprashar2929
Copy link
Collaborator

In another PR, We may need to update the CI to capture the must gather in both deployments before removing them: https://github.com/sustainable-computing-io/kepler/actions/runs/16216178026/job/45786036196?pr=2220#step:3:1913

@sthaha sthaha mentioned this pull request Jul 11, 2025
Closed
@sthaha sthaha mentioned this pull request Jul 11, 2025
Closed
@sthaha sthaha merged commit 1682b1d into sustainable-computing-io:main Jul 11, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vprashar2929 vprashar2929 vprashar2929 approved these changes

Assignees
No one assigned
Labels
ci Changes to the CI pipeline docs Documentation changes feat A new feature or enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sthaha @vprashar2929