[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
This commit is contained in:
jeff-knurek
2018-02-07 07:04:49 -08:00
committed by k8s-ci-robot
parent 5219aac23f
commit 2aeb34e5c6
5 changed files with 21 additions and 10 deletions
+4 -7
View File
@@ -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
+12 -1
View File
@@ -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.
+5
View File
@@ -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
@@ -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 }}"
-1
View File
@@ -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