Add support for enabling the Carbon Cost API (#211)

* Add support for enabling the Carbon Cost API Signed-off-by: Matt Ray <[email protected]> * Added helm-docs output Signed-off-by: Matt Ray <[email protected]> --------- Signed-off-by: Matt Ray <[email protected]>
opencost · Jun 14, 2024 · 8957642 · 8957642
1 parent 31a8cd6
commit 8957642
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/charts/opencost/Chart.yaml b/charts/opencost/Chart.yaml
@@ -9,7 +9,7 @@ keywords:
   - finops
   - monitoring
   - opencost
-version: 1.38.1
+version: 1.39.0
 maintainers:
   - name: mattray
     url: https://mattray.dev

diff --git a/charts/opencost/README.md b/charts/opencost/README.md
@@ -2,7 +2,7 @@
 
 OpenCost and OpenCost UI
 
-![Version: 1.37.1](https://img.shields.io/badge/Version-1.37.1-informational?style=flat-square)
+![Version: 1.39.0](https://img.shields.io/badge/Version-1.39.0-informational?style=flat-square)
 ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 ![AppVersion: 1.110.0](https://img.shields.io/badge/AppVersion-1.110.0-informational?style=flat-square)
 [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/opencost)](https://artifacthub.io/packages/search?repo=opencost)
@@ -42,6 +42,7 @@ $ helm install opencost opencost/opencost
 | networkPolicies.prometheus.namespace | string | `"prometheus-system"` | Namespace where internal Prometheus is installed |
 | networkPolicies.prometheus.port | int | `9090` | Pod port of in-cluster Prometheus |
 | opencost.affinity | object | `{}` | Affinity settings for pod assignment |
+| opencost.carbonCost.enabled | bool | `false` | Enable carbon cost exposed in the API |
 | opencost.cloudCost.enabled | bool | `false` | Enable cloud cost ingestion and querying, dependant on valid integration credentials |
 | opencost.cloudCost.monthToDateInterval | int | `6` | The number of standard runs before a Month-to-Date run occurs |
 | opencost.cloudCost.queryWindowDays | int | `7` | The max number of days that any single query will be made to construct Cloud Costs |
@@ -95,6 +96,7 @@ $ helm install opencost opencost/opencost
 | opencost.exporter.startupProbe.path | string | `"/healthz"` | Probe path |
 | opencost.exporter.startupProbe.periodSeconds | int | `5` | Probe frequency in seconds |
 | opencost.extraContainers | list | `[]` | extra sidecars to add to the pod.  Useful for things like oauth-proxy for the UI |
+| opencost.metrics.config.configmapName | string | `"custom-metrics"` | Customize the configmap name used for metrics |
 | opencost.metrics.config.disabledMetrics | list | `[]` | List of metrics to be disabled |
 | opencost.metrics.config.enabled | bool | `false` | Enables creating the metrics.json configuration as a ConfigMap |
 | opencost.metrics.kubeStateMetrics.emitKsmV1Metrics | bool | `nil` | Enable emission of KSM v1 metrics |

diff --git a/charts/opencost/templates/deployment.yaml b/charts/opencost/templates/deployment.yaml
@@ -121,6 +121,10 @@ spec:
             - name: API_PORT
               value: {{ .Values.opencost.exporter.apiPort | quote }}
             {{- end }}
+            {{- if .Values.opencost.carbonCost.enabled }}
+            - name: CARBON_ESTIMATES_ENABLED
+              value: {{ .Values.opencost.carbonCost.enabled | quote }}
+            {{- end }}
             - name: PROMETHEUS_SERVER_ENDPOINT
               value: {{ include "opencost.prometheusServerEndpoint" . | quote }}
             {{- if .Values.opencost.exporter.cloudProviderApiKey }}

diff --git a/charts/opencost/values.yaml b/charts/opencost/values.yaml
@@ -248,6 +248,10 @@ opencost:
   dataRetention:
     dailyResolutionDays: 15
 
+  carbonCost:
+    # -- Enable carbon cost exposed in the API
+    enabled: false
+
   cloudCost:
     # -- Enable cloud cost ingestion and querying, dependant on valid integration credentials
     enabled: false