From 6f5be77513b3fc237b43737a8b63eed6bc0e55f7 Mon Sep 17 00:00:00 2001 From: Brad McCoy Date: Wed, 3 May 2023 10:17:04 +1000 Subject: [PATCH 1/3] feat: add ArtifactHub Metadata Signed-off-by: Brad McCoy --- README.md | 1 + chart/kepler/Chart.yaml | 22 +++++++++-- chart/kepler/templates/README.md | 63 ++++++++++++++++++++++++++++++++ 3 files changed, 82 insertions(+), 4 deletions(-) create mode 100644 chart/kepler/templates/README.md diff --git a/README.md b/README.md index 3f1d80d..baa60cb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/kepler)](https://artifacthub.io/packages/search?repo=kepler) ![GitHub](https://img.shields.io/github/license/sustainable-computing-io/kepler-helm-chart) # kepler-helm-chart This repository is for the Helm chart for Kepler. We are using `gh-pages` branch to host and index the chart. When modifying the chart please bump the version in the [Chart.yaml](/chart/kepler/Chart.yaml) file. diff --git a/chart/kepler/Chart.yaml b/chart/kepler/Chart.yaml index 4435a2c..2e6a3f3 100644 --- a/chart/kepler/Chart.yaml +++ b/chart/kepler/Chart.yaml @@ -1,9 +1,23 @@ apiVersion: v2 name: kepler -description: A Helm chart for kepler -type: application -version: 0.3.6 -appVersion: v0.4.11-23-g2b59dbd-linux-amd64 +description: A Helm chart for kepler (Kubernetes-based Efficient Power Level Exporter) home: https://sustainable-computing.io/html/index.html sources: - https://github.com/sustainable-computing-io/kepler +keywords: + - cloud-native + - sustainable-computing + - kepler + - ebpf +annotations: + artifacthub.io/links: | + - name: support + url: https://github.com/sustainable-computing-io/kepler/issues/new + - name: docs + url: https://sustainable-computing.io/ + artifacthub.io/license: "Apache-2.0" + +type: application +version: 0.3.7 +appVersion: v0.4.11-23-g2b59dbd-linux-amd64 + diff --git a/chart/kepler/templates/README.md b/chart/kepler/templates/README.md new file mode 100644 index 0000000..942a52b --- /dev/null +++ b/chart/kepler/templates/README.md @@ -0,0 +1,63 @@ +# Kepler +Kepler (Kubernetes-based Efficient Power Level Exporter) uses eBPF to probe energy related system stats and exports as Prometheus metrics + +## Parameters + +| Name | Description | Value | +| ---------------------------- | -------------------------------------- | ------------ | +| `nameOverride` | overrides the name of the chart | `""` | +| `fullnameOverride` | replaces the generated name | `""` | +| `image.repository` | repository to pull the image from | `"quay.io/sustainable_computing_io/kepler"` | +| `image.tag` | image tag defaults to chart appVersion | `""` | +| `image.pullPolicy` | image pull policy | `Always` | +| `imagePullSecrets` | Secret name for pulling images from private repository | `[]` | +| `podAnnotations` | Additional pod annotations | `{}` | +| `podSecurityContext` | privileges and access control settings for a Pod | `{}` | +| `securityContext.privileged` | privileges and access control settings | `true` | +| `nodeSelector` | node selection constraint | `{}` | +| `tolerations[].effect` | toleration effect | `NoSchedule` | +| `tolerations[].key` | toleration key | `node-role.kubernetes.io/master` | +| `affinity` | affinity rules | `{}` | + +## Resources +| Name | Description | Value | +| ---------------------------- | ------------------------------------- | ------------ | +| `resources.requests.cpu` | cpu request | `100m` | +| `resources.requests.memory` | memory request | `200Mi` | +| `resources.limits.cpu` | cpu limit | `100m` | +| `resources.limits.memory` | memory limit | `200Mi` | + +## Environment Variables +| Name | Description | Value | +| ---------------------------------------- | ------------------------------ | -------- | +| `extraEnvVars.KEPLER_LOG_LEVEL` | the kepler log level | `"1"` | +| `extraEnvVars.ENABLE_GPU` | enable GPU | `"true"` | +| `extraEnvVars.ENABLE_EBPF_CGROUPID` | enable EBPF CGROUPID | `"true"` | +| `extraEnvVars.EXPOSE_IRQ_COUNTER_METRICS`| expose IRQ Counter metrics | `"true"` | +| `extraEnvVars.EXPOSE_KUBELET_METRICS` | expose kubelet metrics | `"true"` | +| `extraEnvVars.ENABLE_PROCESS_METRICS` | enable process metrics | `"true"` | +| `extraEnvVars.CPU_ARCH_OVERRIDE` | override CPU architechure | `""` | +| `extraEnvVars.CGROUP_METRICS` | specify CGROUP Metrics | `"*"` | + +## Service +| Name | Description | Value | +| ---------------------------- | -------------------------------------- | ------------ | +| `service.annotations` | annotations for the service | `{}` | +| `service.type` | the service type | `ClusterIP` | +| `service.port` | the service port | `9102` | + +## Service Account +| Name | Description | Value | +| ---------------------------- | -------------------------------------- | ------------ | +| `serviceAccount.create` | whether the service account is created | `false` | +| `serviceAccount.annotations` | annotations for the service account | `{}` | +| `serviceAccount.name` | name override | `""` | + +## Service Monitor +| Name | Description | Value | +| ----------------------------- | -------------------------------------- | ----------- | +| `serviceMonitor.enabled` | whether the service monitor is enabled | `false` | +| `serviceMonitor.namespace` | which namespace to put it in | `""` | +| `serviceMonitor.interval` | the scrape interval | `30s` | +| `serviceMonitor.scrapeTimeout`| the scrape timeout | `5s` | +| `serviceMonitor.labels` | labels for the service monitor | `{} ` | From c81d2e0b761edba793bf0d52453bdd05b18be8b7 Mon Sep 17 00:00:00 2001 From: Brad McCoy Date: Wed, 3 May 2023 10:23:23 +1000 Subject: [PATCH 2/3] feat: add project icon to chart.yaml Signed-off-by: Brad McCoy --- chart/kepler/Chart.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/chart/kepler/Chart.yaml b/chart/kepler/Chart.yaml index 2e6a3f3..76f9274 100644 --- a/chart/kepler/Chart.yaml +++ b/chart/kepler/Chart.yaml @@ -1,6 +1,7 @@ apiVersion: v2 name: kepler description: A Helm chart for kepler (Kubernetes-based Efficient Power Level Exporter) +icon: "https://avatars.githubusercontent.com/u/91567619?s=200&v=4" home: https://sustainable-computing.io/html/index.html sources: - https://github.com/sustainable-computing-io/kepler From 0b929260b1302ed6c67a214d3c35d121015c81b9 Mon Sep 17 00:00:00 2001 From: Brad McCoy Date: Wed, 3 May 2023 17:08:34 +1000 Subject: [PATCH 3/3] feat: move artifacthub readme to higher level Signed-off-by: Brad McCoy --- chart/kepler/{templates => }/README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename chart/kepler/{templates => }/README.md (100%) diff --git a/chart/kepler/templates/README.md b/chart/kepler/README.md similarity index 100% rename from chart/kepler/templates/README.md rename to chart/kepler/README.md