From 2aeb34e5c603e6593df45fc807ecc24fa096d71f Mon Sep 17 00:00:00 2001 From: jeff-knurek Date: Wed, 7 Feb 2018 16:04:49 +0100 Subject: [PATCH] [stable/kube-lego] kube-lego is in maintenance mode, in favor of cert-manager (#3395) * [stable/kube-lego] kube-lego is in maintenance mode, in favor of cert-manager * [stable/kube-lego] update Chart.yaml with note about deprecation * [stable/kube-lego] change the note to link to the helm chart of cert-manager, since the user is looking at the helm README * [stable/kube-lego] remove the required attribute for config.LEGO_EMAIL this allows for the linter to pass. it's no longer so important now that this chart is deprecated * [stable/kube-lego] update the Chart version looks like our forked version was a bit too out-of-date to accept the previous version update * [stable/kube-lego] add other notes about deprecation as per the best practice guide * [stable/kube-lego] add back in a default email so the tests pass --- stable/kube-lego/Chart.yaml | 11 ++++------- stable/kube-lego/README.md | 13 ++++++++++++- stable/kube-lego/templates/NOTES.txt | 5 +++++ stable/kube-lego/templates/deployment.yaml | 1 - stable/kube-lego/values.yaml | 1 - 5 files changed, 21 insertions(+), 10 deletions(-) diff --git a/stable/kube-lego/Chart.yaml b/stable/kube-lego/Chart.yaml index afd57071e2..21ea4d9efb 100644 --- a/stable/kube-lego/Chart.yaml +++ b/stable/kube-lego/Chart.yaml @@ -1,15 +1,12 @@ apiVersion: v1 -description: Automatically requests certificates from Let's Encrypt +description: DEPRECATED Automatically requests certificates from Let's Encrypt name: kube-lego -version: 0.3.0 +version: 0.4.0 +# The kube-lego chart is deprecated and no longer maintained. +deprecated: true keywords: - kube-lego - letsencrypt sources: - https://github.com/jetstack/kube-lego/tree/master/examples/nginx -maintainers: - - name: jackzampolin - email: jack.zampolin@gmail.com - - name: mgoodness - email: mgoodness@gmail.com engine: gotpl diff --git a/stable/kube-lego/README.md b/stable/kube-lego/README.md index 2954f2f0b0..52f559a8e7 100644 --- a/stable/kube-lego/README.md +++ b/stable/kube-lego/README.md @@ -2,6 +2,16 @@ [kube-lego](https://github.com/jetstack/kube-lego) automatically requests certificates for Kubernetes Ingress resources from Let's Encrypt. +> :warning: +> +> kube-lego is in maintenance mode only. There is no plan to support any new +> features. The latest Kubernetes release that kube-lego officially supports +> is **1.8**. The officially endorsed successor is **[cert-manager](https://hub.kubeapps.com/charts/stable/cert-manager)**. +> +> If you are a current user of kube-lego, you can find a migration guide [here](https://github.com/jetstack/cert-manager/blob/master/docs/user-guides/migrating-from-kube-lego.md). +> +> :warning: + ## TL;DR; ```console @@ -20,8 +30,9 @@ This chart bootstraps a kube-lego deployment on a [Kubernetes](http://kubernetes To install the chart with the release name `my-release`: ```console -$ helm install --name my-release stable/kube-lego +$ helm install --name my-release stable/kube-lego --set config.LEGO_EMAIL=my@email.tld ``` +**NOTE:** `config.LEGO_EMAIL` is required The command deploys kube-lego on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. diff --git a/stable/kube-lego/templates/NOTES.txt b/stable/kube-lego/templates/NOTES.txt index 748fc77cd9..5f0db0436d 100644 --- a/stable/kube-lego/templates/NOTES.txt +++ b/stable/kube-lego/templates/NOTES.txt @@ -1,5 +1,10 @@ This chart installs kube-lego to generate TLS certs for Ingresses. +NOTE: +> kube-lego is in maintenance mode only. There is no plan to support any new +> features. The officially endorsed successor is cert-manager +> https://hub.kubeapps.com/charts/stable/cert-manager + EXAMPLE INGRESS YAML: apiVersion: extensions/v1beta1 diff --git a/stable/kube-lego/templates/deployment.yaml b/stable/kube-lego/templates/deployment.yaml index c4dd49bd1a..bb3876cf55 100644 --- a/stable/kube-lego/templates/deployment.yaml +++ b/stable/kube-lego/templates/deployment.yaml @@ -33,7 +33,6 @@ spec: valueFrom: fieldRef: fieldPath: status.podIP - # {{ required "config.LEGO_EMAIL is a required field" .Values.config.LEGO_EMAIL }} {{- range $key, $value := .Values.config }} - name: "{{ $key }}" value: "{{ $value }}" diff --git a/stable/kube-lego/values.yaml b/stable/kube-lego/values.yaml index f17cf42d22..7ea40f23cd 100644 --- a/stable/kube-lego/values.yaml +++ b/stable/kube-lego/values.yaml @@ -4,7 +4,6 @@ config: ## Email address to use for registration with Let's Encrypt ## - # LEGO_EMAIL: my@email.tld LEGO_EMAIL: foo@example.com ## Let's Encrypt API endpoint