Merge pull request #123 from RADAR-base/document-cert-manager

Added chart documentation for cert-manager

.helmdocsignore

@@ -1,4 +1,3 @@
-charts/cert-manager/
 charts/kafka-manager/
 charts/kube-prometheus-stack/
 charts/radar-backend/

charts/cert-manager/Chart.yaml

@@ -1,5 +1,16 @@
 apiVersion: v1
 appVersion: "1.0"
-description: A Helm chart for Kubernetes
+description: A Helm chart for cert-manager. This chart is an overly just to make sure `clusterissuer.yaml` is installed with the cluster and some default values. For more info refer to the cert-manager docs.
 name: cert-manager
 version: 0.1.0
+kubeVersion: "<=1.17"
+engine: gotpl
+sources: ["https://github.com/jetstack/cert-manager"]
+deprecated: false
+type: application
+home: "https://cert-manager.io"
+maintainers:
+  - email: [email protected]
+    name: Keyvan Hedayati
+  - email: [email protected]
+    name: Joris Borgdorff

charts/cert-manager/README.md

@@ -0,0 +1,43 @@
+
+
+# cert-manager
+
+![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0](https://img.shields.io/badge/AppVersion-1.0-informational?style=flat-square)
+
+A Helm chart for cert-manager. This chart is an overly just to make sure `clusterissuer.yaml` is installed with the cluster and some default values. For more info refer to the cert-manager docs.
+
+**Homepage:** <https://cert-manager.io>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| Keyvan Hedayati | [email protected] |  |
+| Joris Borgdorff | [email protected] |  |
+
+## Source Code
+
+* <https://github.com/jetstack/cert-manager>
+
+## Prerequisites
+* Kubernetes 1.17+
+* Kubectl 1.17+
+* Helm 3.1.0+
+
+## Requirements
+
+Kubernetes: `<=1.17`
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://charts.jetstack.io | cert-manager | v1.1.0 |
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| server_name | string | `"localhost"` | Domain name of the server |
+| maintainer_email | string | `"[email protected]"` | Email address of cluster maintainer |
+| installCRDs | bool | `true` | Install CRDs that are needed by cert-manager |
+| prometheus.enabled | bool | `true` | Enable Prometheus monitoring |
+| prometheus.servicemonitor.enabled | bool | `true` | Enable Prometheus Operator ServiceMonitor monitoring |

charts/cert-manager/README.md.gotmpl

@@ -0,0 +1,18 @@
+{{ template "chart.header" . }}
+{{ template "chart.deprecationWarning" . }}
+
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
+
+{{ template "chart.homepageLine" . }}
+
+{{ template "chart.maintainersSection" . }}
+
+{{ template "chart.sourcesSection" . }}
+
+{{ template "common.prerequisites" . }}
+
+{{ template "chart.requirementsSection" . }}
+
+{{ template "chart.valuesSection" . }}

charts/cert-manager/values.yaml

@@ -2,15 +2,16 @@
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
 
+# -- Domain name of the server
 server_name: localhost
+# -- Email address of cluster maintainer
 maintainer_email: [email protected]
+# -- Install CRDs that are needed by cert-manager
 installCRDs: true
 
 prometheus:
+  # -- Enable Prometheus monitoring
   enabled: true
   servicemonitor:
+    # -- Enable Prometheus Operator ServiceMonitor monitoring
     enabled: true
-webhook:
-  enabled: false
-cainjector:
-  enabled: false