From 6e2ddc240a7d98246cc0a3cbc80e57a6a7224a90 Mon Sep 17 00:00:00 2001 From: James Munnelly Date: Mon, 5 Feb 2018 13:48:28 +0000 Subject: [PATCH] Update helm chart to align with k/charts review --- contrib/charts/cert-manager/Chart.yaml | 5 ++- contrib/charts/cert-manager/README.md | 31 ++++++++++++------- .../charts/cert-manager/templates/NOTES.txt | 14 +++++++-- contrib/charts/cert-manager/values.yaml | 16 +++++----- hack/deploy/rbac-values.yaml | 10 ++++++ hack/deploy/without-rbac-values.yaml | 11 +++++++ 6 files changed, 64 insertions(+), 23 deletions(-) diff --git a/contrib/charts/cert-manager/Chart.yaml b/contrib/charts/cert-manager/Chart.yaml index 094a6bcbc..135149201 100644 --- a/contrib/charts/cert-manager/Chart.yaml +++ b/contrib/charts/cert-manager/Chart.yaml @@ -1,5 +1,5 @@ name: cert-manager -version: 0.2.1 +version: 0.2.2 appVersion: 0.2.3 description: A Helm chart for cert-manager home: https://github.com/jetstack/cert-manager @@ -10,3 +10,6 @@ keywords: - tls sources: - https://github.com/jetstack/cert-manager +maintainers: + - name: munnerz + email: james@jetstack.io diff --git a/contrib/charts/cert-manager/README.md b/contrib/charts/cert-manager/README.md index e49cfd432..e7a010068 100644 --- a/contrib/charts/cert-manager/README.md +++ b/contrib/charts/cert-manager/README.md @@ -6,28 +6,35 @@ TLS certificates from various issuing sources. It will ensure certificates are valid and up to date periodically, and attempt to renew certificates at an appropriate time before expiry. -## TL;DR; - -```console -$ helm install . -``` - -## Introduction - -This chart creates a cert-manager deployment on a Kubernetes cluster using the Helm package manager. - ## Prerequisites -- Kubernetes cluster with support for CustomResourceDefinition or ThirdPartyResource +- Kubernetes 1.7+ ## Installing the Chart +Full installation instructions, including details on how to configure extra +functionality in cert-manager can be found in the [official deploying docs](https://github.com/jetstack/cert-manager/blob/master/docs/user-guides/deploying.md#addendum). + To install the chart with the release name `my-release`: ```console -$ helm install --name my-release . +$ helm install --name my-release stable/cert-manager ``` +In order to begin issuing certificates, you will need to set up a ClusterIssuer +or Issuer resource (for example, by creating a 'letsencrypt-staging' issuer). + +More information on the different types of issuers and how to configure them +can be found in our documentation: + +https://github.com/jetstack/cert-manager/tree/master/docs/api-types/issuer + +For information on how to configure cert-manager to automatically provision +Certificates for Ingress resources, take a look at the `ingress-shim` +documentation: + +https://github.com/jetstack/cert-manager/blob/master/docs/user-guides/ingress-shim.md + > **Tip**: List all releases using `helm list` ## Uninstalling the Chart diff --git a/contrib/charts/cert-manager/templates/NOTES.txt b/contrib/charts/cert-manager/templates/NOTES.txt index 547ca086a..dd4b7a188 100644 --- a/contrib/charts/cert-manager/templates/NOTES.txt +++ b/contrib/charts/cert-manager/templates/NOTES.txt @@ -1,5 +1,15 @@ cert-manager has been deployed successfully! -You may now go ahead and create issuers and certificates. +In order to begin issuing certificates, you will need to set up a ClusterIssuer +or Issuer resource (for example, by creating a 'letsencrypt-staging' issuer). -See https://github.com/jetstack/cert-manager/blob/master/docs/README.md +More information on the different types of issuers and how to configure them +can be found in our documentation: + +https://github.com/jetstack/cert-manager/tree/v0.2.3/docs/api-types/issuer + +For information on how to configure cert-manager to automatically provision +Certificates for Ingress resources, take a look at the `ingress-shim` +documentation: + +https://github.com/jetstack/cert-manager/blob/v0.2.3/docs/user-guides/ingress-shim.md diff --git a/contrib/charts/cert-manager/values.yaml b/contrib/charts/cert-manager/values.yaml index b290ed98d..ccd0ad3de 100644 --- a/contrib/charts/cert-manager/values.yaml +++ b/contrib/charts/cert-manager/values.yaml @@ -27,10 +27,10 @@ extraArgs: [] # supporting resources required for each ClusterIssuer (default is kube-system) # - --cluster-resource-namespace=kube-system -resources: - requests: - cpu: 10m - memory: 32Mi +resources: {} + # requests: + # cpu: 10m + # memory: 32Mi nodeSelector: {} @@ -40,10 +40,10 @@ ingressShim: # Optional additional arguments for ingress-shim extraArgs: [] - resources: - requests: - cpu: 10m - memory: 32Mi + resources: {} + # requests: + # cpu: 10m + # memory: 32Mi image: repository: quay.io/jetstack/cert-manager-ingress-shim diff --git a/hack/deploy/rbac-values.yaml b/hack/deploy/rbac-values.yaml index e69de29bb..112a30e11 100644 --- a/hack/deploy/rbac-values.yaml +++ b/hack/deploy/rbac-values.yaml @@ -0,0 +1,10 @@ +resources: + requests: + cpu: 10m + memory: 32Mi + +ingressShim: + resources: + requests: + cpu: 10m + memory: 32Mi diff --git a/hack/deploy/without-rbac-values.yaml b/hack/deploy/without-rbac-values.yaml index 652979972..afc09aa8c 100644 --- a/hack/deploy/without-rbac-values.yaml +++ b/hack/deploy/without-rbac-values.yaml @@ -3,3 +3,14 @@ rbac: serviceAccount: create: false + +resources: + requests: + cpu: 10m + memory: 32Mi + +ingressShim: + resources: + requests: + cpu: 10m + memory: 32Mi