Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added chart documentation for cert-manager #123

Merged
merged 1 commit into from
Aug 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .helmdocsignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
charts/cert-manager/
charts/kafka-manager/
charts/kube-prometheus-stack/
charts/radar-backend/
Expand Down
13 changes: 12 additions & 1 deletion charts/cert-manager/Chart.yaml
Original file line number Diff line number Diff line change
@@ -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
Empty file.
43 changes: 43 additions & 0 deletions charts/cert-manager/README.md
Original file line number Diff line number Diff line change
@@ -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 |
18 changes: 18 additions & 0 deletions charts/cert-manager/README.md.gotmpl
Original file line number Diff line number Diff line change
@@ -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" . }}
9 changes: 5 additions & 4 deletions charts/cert-manager/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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