|
| 1 | +# cloudcost-exporter |
| 2 | + |
| 3 | +Cloud Cost Exporter exports cloud provider agnostic cost metrics to Prometheus. |
| 4 | + |
| 5 | +   |
| 6 | + |
| 7 | +## Installing the Chart |
| 8 | + |
| 9 | +To install the chart with the release name `my-release`: |
| 10 | + |
| 11 | +```console |
| 12 | +helm repo add grafana https://grafana.github.io/helm-charts |
| 13 | +helm repo update |
| 14 | +helm install my-release grafana/cloudcost-exporter |
| 15 | +``` |
| 16 | + |
| 17 | +## Configuration per cloud service provider (CSP) |
| 18 | + |
| 19 | +The Helm chart can be used with the general `values.yaml` manifest. |
| 20 | +The project includes CSP-specific configuration (e.g. `values.<csp>.yaml`) that can be used in combination with the general values. |
| 21 | +The deployment itself will depend on each deployment pipeline and tooling available. |
| 22 | + |
| 23 | +Documentation per CSP will vary (especially when it comes to authentication). Below are links to docs to help with this: |
| 24 | +* [AWS](https://github.com/grafana/cloudcost-exporter/tree/main/docs/deploying/aws) |
| 25 | + |
| 26 | +## Values |
| 27 | + |
| 28 | +| Key | Type | Default | Description | |
| 29 | +|-----|------|---------|-------------| |
| 30 | +| affinity | object | `{}` | Node/pod affinities | |
| 31 | +| containerArgs | list | `[]` | Container arguments, usually to configure the deployment per CSP | |
| 32 | +| fullnameOverride | string | `""` | Override the full name of the chart and release | |
| 33 | +| image.pullPolicy | string | `"IfNotPresent"` | Pull policy for the image | |
| 34 | +| image.repository | string | `"grafana/cloudcost-exporter"` | Image to use for deploying | |
| 35 | +| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. | |
| 36 | +| imagePullSecrets | list | `[]` | Secrets to use for pulling the image | |
| 37 | +| minReadySeconds | int | `10` | Seconds a pod should be ready to be considered available | |
| 38 | +| nameOverride | string | `""` | Override the name of the release | |
| 39 | +| nodeSelector | object | `{}` | Node selector | |
| 40 | +| podAnnotations | object | `{}` | Annotations to add to the pod | |
| 41 | +| replicaCount | int | `1` | Number of replicas | |
| 42 | +| resources.limits.cpu | string | `"2"` | CPU limit | |
| 43 | +| resources.limits.memory | string | `"2Gi"` | Memory limit | |
| 44 | +| resources.requests.cpu | string | `"1"` | CPU request | |
| 45 | +| resources.requests.memory | string | `"1Gi"` | Memory request | |
| 46 | +| revisionHistoryLimit | int | `10` | Number of old versions to retain to allow rollback | |
| 47 | +| securityContext.fsGroup | int | `10001` | Filesystem group to associate for each pod | |
| 48 | +| service.port | int | `8080` | Service port | |
| 49 | +| service.portName | string | `"http"` | Service port name | |
| 50 | +| service.protocol | string | `"TCP"` | Service protocol | |
| 51 | +| service.type | string | `"ClusterIP"` | Service type | |
| 52 | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | |
| 53 | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | |
| 54 | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | |
| 55 | +| tolerations | list | `[]` | List of node taints to tolerate | |
| 56 | +| volumeMounts | list | `[]` | List of volume mounts | |
| 57 | +| volumes | list | `[]` | List of volumes | |
| 58 | + |
| 59 | +---------------------------------------------- |
| 60 | +Autogenerated from chart metadata using [helm-docs v1.8.1](https://github.com/norwoodj/helm-docs/releases/v1.8.1) |
| 61 | + |
| 62 | +## Contribute |
| 63 | + |
| 64 | +Check out the [docs](https://github.com/grafana/cloudcost-exporter/tree/main//docs/contribute/releases.md#helm-chart) |
| 65 | +for more information on how to contribute to the `cloudcost-explorer`'s Helm chart. |
0 commit comments