From 4ac3e1ff2c4cf3f78a57079cb48c6248d24a1fb5 Mon Sep 17 00:00:00 2001 From: Manuel Alejandro de Brito Fontes Date: Tue, 24 Nov 2020 18:12:24 -0300 Subject: [PATCH] Remove helm2 support and update docs --- .github/workflows/helm.yaml | 2 +- charts/ingress-nginx/CHANGELOG.md | 4 ++++ charts/ingress-nginx/Chart.yaml | 7 ++++--- charts/ingress-nginx/README.md | 26 +++++++------------------- docs/deploy/index.md | 12 +++++------- 5 files changed, 21 insertions(+), 30 deletions(-) diff --git a/.github/workflows/helm.yaml b/.github/workflows/helm.yaml index f753a2992..4a9bdad42 100644 --- a/.github/workflows/helm.yaml +++ b/.github/workflows/helm.yaml @@ -49,6 +49,6 @@ jobs: git config --global user.email "$GITHUB_ACTOR@users.noreply.github.com" - name: Run chart-releaser - uses: helm/chart-releaser-action@v1.0.0-rc.2 + uses: helm/chart-releaser-action@v1.1.0 env: CR_TOKEN: "${{ secrets.PERSONAL_TOKEN }}" diff --git a/charts/ingress-nginx/CHANGELOG.md b/charts/ingress-nginx/CHANGELOG.md index a9f6aac28..420898358 100644 --- a/charts/ingress-nginx/CHANGELOG.md +++ b/charts/ingress-nginx/CHANGELOG.md @@ -4,6 +4,10 @@ This file documents all notable changes to [ingress-nginx](https://github.com/ku ### Unreleased +### 3.12.0 + +- [X] [#6514](https://github.com/kubernetes/ingress-nginx/pull/6514) Remove helm2 support and update docs + ### 3.11.1 - [X] [#6505](https://github.com/kubernetes/ingress-nginx/pull/6505) Reorder HPA resource list to work with GitOps tooling diff --git a/charts/ingress-nginx/Chart.yaml b/charts/ingress-nginx/Chart.yaml index 49edcdfca..b20949771 100644 --- a/charts/ingress-nginx/Chart.yaml +++ b/charts/ingress-nginx/Chart.yaml @@ -1,8 +1,8 @@ -apiVersion: v1 +apiVersion: v2 name: ingress-nginx # When the version is modified, make sure the artifacthub.io/changes list is updated # Also update CHANGELOG.md -version: 3.11.1 +version: 3.12.0 appVersion: 0.41.2 home: https://github.com/kubernetes/ingress-nginx description: Ingress controller for Kubernetes using NGINX as a reverse proxy and load balancer @@ -12,6 +12,7 @@ keywords: - nginx sources: - https://github.com/kubernetes/ingress-nginx +type: application maintainers: - name: ChiefAlexander engine: gotpl @@ -20,4 +21,4 @@ annotations: # List of changes for the release in artifacthub.io # https://artifacthub.io/packages/helm/ingress-nginx/ingress-nginx?modal=changelog artifacthub.io/changes: | - - Reorder HPA resource list to work with GitOps tooling + - Remove helm2 support and update docs diff --git a/charts/ingress-nginx/README.md b/charts/ingress-nginx/README.md index 1a157d578..d4d9bfd3c 100644 --- a/charts/ingress-nginx/README.md +++ b/charts/ingress-nginx/README.md @@ -14,18 +14,15 @@ This chart bootstraps an ingress-nginx deployment on a [Kubernetes](http://kuber ```console helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx -helm repo add stable https://charts.helm.sh/stable -helm repo update +helm update ``` ## Install Chart -```console -# Helm 3 -$ helm install [RELEASE_NAME] ingress-nginx/ingress-nginx +**Important:** only helm3 is supported -# Helm 2 -$ helm install --name [RELEASE_NAME] ingress-nginx/ingress-nginx +```console +helm install [RELEASE_NAME] ingress-nginx/ingress-nginx ``` The command deploys ingress-nginx on the Kubernetes cluster in the default configuration. @@ -37,11 +34,7 @@ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documen ## Uninstall Chart ```console -# Helm 3 -$ helm uninstall [RELEASE_NAME] - -# Helm 2 -# helm delete --purge [RELEASE_NAME] +helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. @@ -51,8 +44,7 @@ _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command doc ## Upgrading Chart ```console -# Helm 3 or 2 -$ helm upgrade [RELEASE_NAME] [CHART] --install +helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ @@ -80,11 +72,7 @@ Note that there are some different and upgraded configurations between the two c See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console -# Helm 2 -$ helm inspect values ingress-nginx/ingress-nginx - -# Helm 3 -$ helm show values ingress-nginx/ingress-nginx +helm show values ingress-nginx/ingress-nginx ``` ### PodDisruptionBudget diff --git a/docs/deploy/index.md b/docs/deploy/index.md index ad1f4c00e..299932840 100644 --- a/docs/deploy/index.md +++ b/docs/deploy/index.md @@ -190,21 +190,19 @@ kubectl exec -it $POD_NAME -n $POD_NAMESPACE -- /nginx-ingress-controller --vers ## Using Helm +!!! attention + Only helm3 is supported + NGINX Ingress controller can be installed via [Helm](https://helm.sh/) using the chart from the project repository. To install the chart with the release name `ingress-nginx`: ```console helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx +helm update + helm install my-release ingress-nginx/ingress-nginx ``` -If you are using [Helm 2](https://v2.helm.sh/) then specify release name using `--name` flag - -```console -helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx/ -helm install --name ingress-nginx ingress-nginx/ingress-nginx -``` - ## Detect installed version: ```console