Merge pull request sustainable-computing-io#22 from bradmccoydev/feat…

…/20/update-chart-for-artifacthub

feat: add ArtifactHub Metadata

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.

chart/kepler/Chart.yaml

@@ -1,9 +1,24 @@
 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) 
+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
+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
+

chart/kepler/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         | `{} `       |