feat: adding namespace override (#171)

* feat: adding namespace override Signed-off-by: Rafael Brito <[email protected]> * Version bump and README update Signed-off-by: Matt Ray <[email protected]> --------- Signed-off-by: Rafael Brito <[email protected]> Signed-off-by: Matt Ray <[email protected]> Co-authored-by: Matt Ray <[email protected]>
opencost · Jan 16, 2024 · 28e114a · 28e114a
1 parent c6eaa8f
commit 28e114a
Show file tree

Hide file tree

Showing 15 changed files with 51 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -3,11 +3,11 @@
 
 ## Maintainers
 
-| Name | Email | Url |
-| ---- | ------ | --- |
-| mattray | [email protected] | <https://mattray.dev> |
-| toscott |  |
-| brito-rafa |  |
+| Name |
+| ---- |
+| mattray |
+| toscott |
+| brito-rafa |
 
 ## Usage
 

diff --git a/charts/opencost/Chart.yaml b/charts/opencost/Chart.yaml
@@ -9,9 +9,9 @@ keywords:
   - kubecost
   - opencost
   - monitoring
-version: 1.28.3
+version: 1.29.0
 maintainers:
   - name: mattray
-    url: https://mattray.dev
   - name: toscott
+  - name: brito-rafa
 home: https://github.com/opencost/opencost-helm-chart
diff --git a/charts/opencost/README.md b/charts/opencost/README.md
@@ -2,7 +2,7 @@
 
 OpenCost and OpenCost UI
 
-![Version: 1.28.2](https://img.shields.io/badge/Version-1.28.2-informational?style=flat-square)
+![Version: 1.29.0](https://img.shields.io/badge/Version-1.29.0-informational?style=flat-square)
 ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 ![AppVersion: 1.108.0](https://img.shields.io/badge/AppVersion-1.108.0-informational?style=flat-square)
 

diff --git a/charts/opencost/README.md.gotmpl b/charts/opencost/README.md.gotmpl
@@ -10,12 +10,31 @@
 
 ## Installing the Chart
 
-To install the chart with the release name `opencost`:
+To install the chart with the release name `opencost` on `opencost` namespace:
 
 ```console
-$ helm install opencost opencost/{{ template "chart.name" . }}
+$ helm install opencost opencost/{{ template "chart.name" . }} --namespace opencost --create-namespace
 ```
 
+In order to have a working opencost installation, you need to provide one running instance of Prometheus.
+The following will install a prometheus instance on the namespace `prometheus-system`, where the default helm chart is expecting:
+
+```
+helm install prometheus --repo https://prometheus-community.github.io/helm-charts prometheus \
+  --namespace prometheus-system --create-namespace \
+  --set prometheus-pushgateway.enabled=false \
+  --set alertmanager.enabled=false \
+  -f https://raw.githubusercontent.com/opencost/opencost/develop/kubernetes/prometheus/extraScrapeConfigs.yaml
+```
+
+During installation, you can specify the following parameters if you have your own internal Prometheus:
+
+```
+`--set opencost.prometheus.internal.namespace=<your-namespace>`
+`--set opencost.prometheus.internal.service=<your-service>`
+```
+
+
 {{ template "chart.requirementsSection" . }}
 
 {{ template "chart.valuesSection" . }}

diff --git a/charts/opencost/templates/_helpers.tpl b/charts/opencost/templates/_helpers.tpl
@@ -30,6 +30,17 @@ We truncate at 63 chars because some Kubernetes name fields are limited to this
   {{- end -}}
 {{- end -}}
 
+{{/*
+Allow the release namespace to be overridden
+*/}}
+{{- define "opencost.namespace" -}}
+  {{- if .Values.namespaceOverride -}}
+    {{- .Values.namespaceOverride -}}
+  {{- else -}}
+    {{- .Release.Namespace -}}
+  {{- end -}}
+{{- end -}}
+
 {{/*
 Create a default fully qualified app name.
 We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).

diff --git a/charts/opencost/templates/clusterrolebinding.yaml b/charts/opencost/templates/clusterrolebinding.yaml
@@ -14,5 +14,5 @@ roleRef:
 subjects:
   - kind: ServiceAccount
     name: {{ template "opencost.serviceAccountName" . }}
-    namespace: {{ .Release.Namespace }}
+    namespace: {{ include "opencost.namespace" . }}
 {{- end }}
diff --git a/charts/opencost/templates/configmap-custom-pricing.yaml b/charts/opencost/templates/configmap-custom-pricing.yaml
@@ -3,6 +3,7 @@ apiVersion: v1
 kind: ConfigMap
 metadata:
   name: {{ .Values.opencost.customPricing.configmapName }}
+  namespace: {{ include "opencost.namespace" . }}
 data:
   {{ include "opencost.configFileName" . }}.json: |-
     {

diff --git a/charts/opencost/templates/deployment.yaml b/charts/opencost/templates/deployment.yaml
@@ -3,6 +3,7 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: {{ include "opencost.fullname" . }}
+  namespace: {{ include "opencost.namespace" . }}
   labels: {{- include "opencost.labels" . | nindent 4 }}
   {{- with .Values.annotations }}
   annotations: {{- toYaml . | nindent 4 }}

diff --git a/charts/opencost/templates/ingress.yaml b/charts/opencost/templates/ingress.yaml
@@ -3,6 +3,7 @@ apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
   name: {{ include "opencost.fullname" . }}-ingress
+  namespace: {{ include "opencost.namespace" . }}
   labels: {{- include "opencost.labels" . | nindent 4 }}
   {{- with .Values.opencost.ui.ingress.annotations }}
   annotations: {{- toYaml . | nindent 4 }}

diff --git a/charts/opencost/templates/networkpolicy.yaml b/charts/opencost/templates/networkpolicy.yaml
@@ -6,7 +6,7 @@
 kind: NetworkPolicy
 metadata:
   name: {{ .Release.Name }}-opencost
-  namespace: {{ .Release.Namespace }}
+  namespace: {{ include "opencost.namespace" . }}
 spec:
   podSelector:
     matchLabels:

diff --git a/charts/opencost/templates/pvc.yaml b/charts/opencost/templates/pvc.yaml
@@ -3,6 +3,7 @@ kind: PersistentVolumeClaim
 apiVersion: v1
 metadata:
   name: {{ include "opencost.fullname" . }}-pvc
+  namespace: {{ include "opencost.namespace" . }}
   labels: {{- include "opencost.labels" . | nindent 4 }}
   {{- with .Values.opencost.exporter.persistence.annotations  }}
   annotations: {{- toYaml . | nindent 4 }}

diff --git a/charts/opencost/templates/secret.yaml b/charts/opencost/templates/secret.yaml
@@ -3,6 +3,7 @@ apiVersion: v1
 kind: Secret
 metadata:
   name: {{ include "opencost.prometheus.secretname" . }}
+  namespace: {{ include "opencost.namespace" . }}
   labels: {{- include "opencost.labels" . | nindent 4 }}
   {{- with .Values.secretAnnotations }}
   annotations: {{- toYaml . | nindent 4 }}

diff --git a/charts/opencost/templates/service.yaml b/charts/opencost/templates/service.yaml
@@ -3,6 +3,7 @@ apiVersion: v1
 kind: Service
 metadata:
   name: {{ include "opencost.fullname" . }}
+  namespace: {{ include "opencost.namespace" . }}
   labels:
     {{- include "opencost.labels" . | nindent 4 }}
     {{- with .Values.service.labels }}

diff --git a/charts/opencost/templates/serviceaccount.yaml b/charts/opencost/templates/serviceaccount.yaml
@@ -3,6 +3,7 @@ apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: {{ template "opencost.serviceAccountName" . }}
+  namespace: {{ include "opencost.namespace" . }}
   labels: {{- include "opencost.labels" . | nindent 4 }}
   {{- with .Values.serviceAccount.annotations }}
   annotations: {{- toYaml . | nindent 4 }}

diff --git a/charts/opencost/values.yaml b/charts/opencost/values.yaml
@@ -2,6 +2,8 @@
 nameOverride: ""
 # -- Overwrite all resources name created by the chart
 fullnameOverride: ""
+# -- Override the deployment namespace
+namespaceOverride: ""
 
 # -- List of secret names to use for pulling the images
 imagePullSecrets: []