Merge pull request #6514 from aledbf/helm

Remove helm2 support and update docs
This commit is contained in:
Kubernetes Prow Robot 2020-11-24 14:26:39 -08:00 committed by GitHub
commit 8bba70b3b5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 21 additions and 30 deletions

View file

@ -49,6 +49,6 @@ jobs:
git config --global user.email "$GITHUB_ACTOR@users.noreply.github.com" git config --global user.email "$GITHUB_ACTOR@users.noreply.github.com"
- name: Run chart-releaser - name: Run chart-releaser
uses: helm/chart-releaser-action@v1.0.0-rc.2 uses: helm/chart-releaser-action@v1.1.0
env: env:
CR_TOKEN: "${{ secrets.PERSONAL_TOKEN }}" CR_TOKEN: "${{ secrets.PERSONAL_TOKEN }}"

View file

@ -4,6 +4,10 @@ This file documents all notable changes to [ingress-nginx](https://github.com/ku
### Unreleased ### Unreleased
### 3.12.0
- [X] [#6514](https://github.com/kubernetes/ingress-nginx/pull/6514) Remove helm2 support and update docs
### 3.11.1 ### 3.11.1
- [X] [#6505](https://github.com/kubernetes/ingress-nginx/pull/6505) Reorder HPA resource list to work with GitOps tooling - [X] [#6505](https://github.com/kubernetes/ingress-nginx/pull/6505) Reorder HPA resource list to work with GitOps tooling

View file

@ -1,8 +1,8 @@
apiVersion: v1 apiVersion: v2
name: ingress-nginx name: ingress-nginx
# When the version is modified, make sure the artifacthub.io/changes list is updated # When the version is modified, make sure the artifacthub.io/changes list is updated
# Also update CHANGELOG.md # Also update CHANGELOG.md
version: 3.11.1 version: 3.12.0
appVersion: 0.41.2 appVersion: 0.41.2
home: https://github.com/kubernetes/ingress-nginx home: https://github.com/kubernetes/ingress-nginx
description: Ingress controller for Kubernetes using NGINX as a reverse proxy and load balancer description: Ingress controller for Kubernetes using NGINX as a reverse proxy and load balancer
@ -12,6 +12,7 @@ keywords:
- nginx - nginx
sources: sources:
- https://github.com/kubernetes/ingress-nginx - https://github.com/kubernetes/ingress-nginx
type: application
maintainers: maintainers:
- name: ChiefAlexander - name: ChiefAlexander
engine: gotpl engine: gotpl
@ -20,4 +21,4 @@ annotations:
# List of changes for the release in artifacthub.io # List of changes for the release in artifacthub.io
# https://artifacthub.io/packages/helm/ingress-nginx/ingress-nginx?modal=changelog # https://artifacthub.io/packages/helm/ingress-nginx/ingress-nginx?modal=changelog
artifacthub.io/changes: | artifacthub.io/changes: |
- Reorder HPA resource list to work with GitOps tooling - Remove helm2 support and update docs

View file

@ -14,18 +14,15 @@ This chart bootstraps an ingress-nginx deployment on a [Kubernetes](http://kuber
```console ```console
helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
helm repo add stable https://charts.helm.sh/stable helm update
helm repo update
``` ```
## Install Chart ## Install Chart
```console **Important:** only helm3 is supported
# Helm 3
$ helm install [RELEASE_NAME] ingress-nginx/ingress-nginx
# Helm 2 ```console
$ helm install --name [RELEASE_NAME] ingress-nginx/ingress-nginx helm install [RELEASE_NAME] ingress-nginx/ingress-nginx
``` ```
The command deploys ingress-nginx on the Kubernetes cluster in the default configuration. 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 ## Uninstall Chart
```console ```console
# Helm 3 helm uninstall [RELEASE_NAME]
$ helm uninstall [RELEASE_NAME]
# Helm 2
# helm delete --purge [RELEASE_NAME]
``` ```
This removes all the Kubernetes components associated with the chart and deletes the release. 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 ## Upgrading Chart
```console ```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._ _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: 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 ```console
# Helm 2 helm show values ingress-nginx/ingress-nginx
$ helm inspect values ingress-nginx/ingress-nginx
# Helm 3
$ helm show values ingress-nginx/ingress-nginx
``` ```
### PodDisruptionBudget ### PodDisruptionBudget

View file

@ -190,21 +190,19 @@ kubectl exec -it $POD_NAME -n $POD_NAMESPACE -- /nginx-ingress-controller --vers
## Using Helm ## 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. 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`: To install the chart with the release name `ingress-nginx`:
```console ```console
helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
helm update
helm install my-release ingress-nginx/ingress-nginx 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: ## Detect installed version:
```console ```console