ingress-nginx-helm/README.md

# Ingress NGINX Controller

[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5691/badge)](https://bestpractices.coreinfrastructure.org/projects/5691)
[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/ingress-nginx)](https://goreportcard.com/report/github.com/kubernetes/ingress-nginx)
[![GitHub license](https://img.shields.io/github/license/kubernetes/ingress-nginx.svg)](https://github.com/kubernetes/ingress-nginx/blob/main/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/kubernetes/ingress-nginx.svg)](https://github.com/kubernetes/ingress-nginx/stargazers)
[![GitHub stars](https://img.shields.io/badge/contributions-welcome-orange.svg)](https://github.com/kubernetes/ingress-nginx/blob/main/CONTRIBUTING.md)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fkubernetes%2Fingress-nginx.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fkubernetes%2Fingress-nginx?ref=badge_shield)

## Overview

ingress-nginx is an Ingress controller for Kubernetes using [NGINX](https://www.nginx.org/) as a reverse proxy and load balancer.

[Learn more about Ingress on the main Kubernetes documentation site](https://kubernetes.io/docs/concepts/services-networking/ingress/).

## Get started

See the [Getting Started](https://kubernetes.github.io/ingress-nginx/deploy/) document.

## Troubleshooting

If you encounter issues, review the [troubleshooting docs](docs/troubleshooting.md), [file an issue](https://github.com/kubernetes/ingress-nginx/issues), or talk to us on the [#ingress-nginx channel](https://kubernetes.slack.com/messages/ingress-nginx) on the Kubernetes Slack server.

## Changelog

See [the list of releases](https://github.com/kubernetes/ingress-nginx/releases) to find out about feature changes.
For detailed changes for each release; please check the [Changelog.md](Changelog.md) file.
For detailed changes on the `ingress-nginx` helm chart, please check the following [CHANGELOG.md](charts/ingress-nginx/CHANGELOG.md) file.

### Support Versions table 

| Ingress-NGINX version | k8s supported version        | Alpine Version | Nginx Version |
|-----------------------|------------------------------|----------------|---------------|
| v1.3.0                | 1.24, 1.23, 1.22, 1.21, 1.20 | 3.16.0         | 1.19.10†      |
| v1.2.1                | 1.23, 1.22, 1.21, 1.20, 1.19 | 3.14.6         | 1.19.10†      |
| v1.1.3                | 1.23, 1.22, 1.21, 1.20, 1.19 | 3.14.4         | 1.19.10†      |
| v1.1.2                | 1.23, 1.22, 1.21, 1.20, 1.19 | 3.14.2         | 1.19.9†       |
| v1.1.1                | 1.23, 1.22, 1.21, 1.20, 1.19 | 3.14.2         | 1.19.9†       |
| v1.1.0                | 1.22, 1.21, 1.20, 1.19       | 3.14.2         | 1.19.9†       |
| v1.0.5                | 1.22, 1.21, 1.20, 1.19       | 3.14.2         | 1.19.9†       |
| v1.0.4                | 1.22, 1.21, 1.20, 1.19       | 3.14.2         | 1.19.9†       |
| v1.0.3                | 1.22, 1.21, 1.20, 1.19       | 3.14.2         | 1.19.9†       |
| v1.0.2                | 1.22, 1.21, 1.20, 1.19       | 3.14.2         | 1.19.9†       |
| v1.0.1                | 1.22, 1.21, 1.20, 1.19       | 3.14.2         | 1.19.9†       |
| v1.0.0                | 1.22, 1.21, 1.20, 1.19       | 3.13.5         | 1.20.1        |
| v0.51.0               | 1.21, 1.20, 1.19             | 3.14.4         | 1.19.10†       |
| v0.49.3               | 1.21, 1.20, 1.19             | 3.14.2         | 1.19.9†       |
| v0.49.2               | 1.21, 1.20, 1.19             | 3.14.2         | 1.19.9†       |
| v0.49.1               | 1.21, 1.20, 1.19             | 3.14.2         | 1.19.9†       |
| v0.49.0               | 1.21, 1.20, 1.19             | 3.13.5         | 1.20.1        |
| v0.48.1               | 1.21, 1.20, 1.19             | 3.13.5         | 1.20.1        |

† _This build is [patched against CVE-2021-23017](https://github.com/openresty/openresty/commit/4b5ec7edd78616f544abc194308e0cf4b788725b#diff-42ef841dc27fe0b5aa2d06bd31308bb63a59cdcddcbcddd917248349d22020a3)._

See [this article](https://kubernetes.io/blog/2021/07/26/update-with-ingress-nginx/) if you want upgrade to the stable Ingress API. 

## Get Involved

Thanks for taking the time to join our community and start contributing!

- This project adheres to the [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md). By participating in this project, you agree to abide by its terms.

- **Contributing**: Contributions of all kind are welcome!
  
  - Read [`CONTRIBUTING.md`](CONTRIBUTING.md) for information about setting up your environment, the workflow that we expect, and instructions on the developer certificate of origin that we require.

  - Join our Kubernetes Slack channel for developer discussion : [#ingress-nginx-dev](https://kubernetes.slack.com/archives/C021E147ZA4).
  
  - Submit github issues for any feature enhancements, bugs or documentation problems. Please make sure to read the [Issue Reporting Checklist](https://github.com/kubernetes/ingress-nginx/blob/main/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines **may be closed immediately**.

- **Support**: Join the [#ingress-nginx-users](https://kubernetes.slack.com/messages/CANQGM8BA/) channel inside the [Kubernetes Slack](http://slack.kubernetes.io/) to ask questions or get support from the maintainers and other users.
  
  - The [github issues](https://github.com/kubernetes/ingress-nginx/issues) in the repository are **exclusively** for bug reports and feature requests.

- **Discuss**: Tweet using the `#IngressNginx` hashtag.

## License

[Apache License 2.0](https://github.com/kubernetes/ingress-nginx/blob/main/LICENSE)
Minor documentation cleanup (#7826) * clarify link * Add section headers * console blocks * grpc example json was not valid * multi-tls update text The preceding point 1 related to https://github.com/kubernetes-retired/contrib/blob/4f2cb51ef82b4dddb625f6053ad132c1faf07aa1/ingress/controllers/nginx/examples/ingress.yaml and the deployments referenced in https://github.com/kubernetes-retired/contrib/blob/4f2cb51ef82b4dddb625f6053ad132c1faf07aa1/ingress/controllers/nginx/examples/README.md They are not relevant to the current instructions. * add whitespace around parens * grammar setup would be a proper noun, but it is not the intended concept, which is a state * grammar * is-only * via * Use bullets for choices * ingress-controller nginx is a distinct brand. generally this repo talks about ingress-controller, although it is quite inconsistent about how... * drop stray paren * OAuth is a brand and needs an article here also GitHub is a brand * Indent text under numbered lists * use e.g. * Document that customer header config maps changes do not trigger updates This should be removed if https://github.com/kubernetes/ingress-nginx/issues/5238 is fixed. * article * period * infinitive verb + period * clarify that the gRPC server is responsible for listening for TCP traffic and not some other part of the backend application * avoid using ; and reword * whitespace * brand: gRPC * only-does is the right form `for` adds nothing here * spelling: GitHub * punctuation `;` is generally not the right punctuation... * drop stray `to` * sentence * backticks * fix link * Improve readability of compare/vs * Renumber list * punctuation * Favor Ingress-NGINX and Ingress NGINX * Simplify custom header restart text * Undo typo damage Co-authored-by: Josh Soref <jsoref@users.noreply.github.com> 2022-01-17 00:57:28 +00:00			`# Ingress NGINX Controller`
Update readme 2017-10-06 22:47:46 +00:00
Add OpenSSF Best practices badge (#8277) 2022-03-01 04:27:47 +00:00			`[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5691/badge)](https://bestpractices.coreinfrastructure.org/projects/5691)`
Clean readme 2017-10-08 19:43:22 +00:00			`[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/ingress-nginx)](https://goreportcard.com/report/github.com/kubernetes/ingress-nginx)`
reorder contributing infos (#7394) * reorder contributing infos * Change requests of PR 2021-07-27 13:18:45 +00:00			`[![GitHub license](https://img.shields.io/github/license/kubernetes/ingress-nginx.svg)](https://github.com/kubernetes/ingress-nginx/blob/main/LICENSE)`
Improve readme file 2018-04-26 23:48:41 +00:00			`[![GitHub stars](https://img.shields.io/github/stars/kubernetes/ingress-nginx.svg)](https://github.com/kubernetes/ingress-nginx/stargazers)`
reorder contributing infos (#7394) * reorder contributing infos * Change requests of PR 2021-07-27 13:18:45 +00:00			`[![GitHub stars](https://img.shields.io/badge/contributions-welcome-orange.svg)](https://github.com/kubernetes/ingress-nginx/blob/main/CONTRIBUTING.md)`
Add FOSSA status badge 2018-07-10 03:09:44 +00:00			`[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fkubernetes%2Fingress-nginx.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fkubernetes%2Fingress-nginx?ref=badge_shield)`
Improve readme file 2018-04-26 23:48:41 +00:00
Cleanup README.md (#5037) 2020-02-07 13:53:03 +00:00			`## Overview`
Update readme 2017-10-06 22:47:46 +00:00
Cleanup README.md (#5037) 2020-02-07 13:53:03 +00:00			`ingress-nginx is an Ingress controller for Kubernetes using [NGINX](https://www.nginx.org/) as a reverse proxy and load balancer.`
Update readme 2017-10-06 22:47:46 +00:00
Update README.md Small typo improves 2021-01-13 15:18:51 +00:00			`[Learn more about Ingress on the main Kubernetes documentation site](https://kubernetes.io/docs/concepts/services-networking/ingress/).`
Update readme 2017-10-06 22:47:46 +00:00
Cleanup README.md (#5037) 2020-02-07 13:53:03 +00:00			`## Get started`
Update readme 2017-10-06 22:47:46 +00:00
Cleanup README.md (#5037) 2020-02-07 13:53:03 +00:00			`See the [Getting Started](https://kubernetes.github.io/ingress-nginx/deploy/) document.`
Update readme 2017-10-06 22:47:46 +00:00
Cleanup README.md (#5037) 2020-02-07 13:53:03 +00:00			`## Troubleshooting`
Update readme 2017-10-06 22:47:46 +00:00
Cleanup README.md (#5037) 2020-02-07 13:53:03 +00:00			`If you encounter issues, review the [troubleshooting docs](docs/troubleshooting.md), [file an issue](https://github.com/kubernetes/ingress-nginx/issues), or talk to us on the [#ingress-nginx channel](https://kubernetes.slack.com/messages/ingress-nginx) on the Kubernetes Slack server.`
Improve readme file 2018-04-26 23:48:41 +00:00
			`## Changelog`

Update README.md Small typo improves 2021-01-13 15:18:51 +00:00			`See [the list of releases](https://github.com/kubernetes/ingress-nginx/releases) to find out about feature changes.`
			`For detailed changes for each release; please check the [Changelog.md](Changelog.md) file.`
Add a link to the helm ingress-nginx `CHANGELOG.md` file to the `README.md` 2020-12-09 13:17:30 +00:00			For detailed changes on the `ingress-nginx` helm chart, please check the following [CHANGELOG.md](charts/ingress-nginx/CHANGELOG.md) file.
Improve readme file 2018-04-26 23:48:41 +00:00
update docs with supported version of k8s, alpine and nginx (#7214) 2021-06-08 16:21:34 +00:00			`### Support Versions table`

Minor documentation cleanup (#7826) * clarify link * Add section headers * console blocks * grpc example json was not valid * multi-tls update text The preceding point 1 related to https://github.com/kubernetes-retired/contrib/blob/4f2cb51ef82b4dddb625f6053ad132c1faf07aa1/ingress/controllers/nginx/examples/ingress.yaml and the deployments referenced in https://github.com/kubernetes-retired/contrib/blob/4f2cb51ef82b4dddb625f6053ad132c1faf07aa1/ingress/controllers/nginx/examples/README.md They are not relevant to the current instructions. * add whitespace around parens * grammar setup would be a proper noun, but it is not the intended concept, which is a state * grammar * is-only * via * Use bullets for choices * ingress-controller nginx is a distinct brand. generally this repo talks about ingress-controller, although it is quite inconsistent about how... * drop stray paren * OAuth is a brand and needs an article here also GitHub is a brand * Indent text under numbered lists * use e.g. * Document that customer header config maps changes do not trigger updates This should be removed if https://github.com/kubernetes/ingress-nginx/issues/5238 is fixed. * article * period * infinitive verb + period * clarify that the gRPC server is responsible for listening for TCP traffic and not some other part of the backend application * avoid using ; and reword * whitespace * brand: gRPC * only-does is the right form `for` adds nothing here * spelling: GitHub * punctuation `;` is generally not the right punctuation... * drop stray `to` * sentence * backticks * fix link * Improve readability of compare/vs * Renumber list * punctuation * Favor Ingress-NGINX and Ingress NGINX * Simplify custom header restart text * Undo typo damage Co-authored-by: Josh Soref <jsoref@users.noreply.github.com> 2022-01-17 00:57:28 +00:00			`\| Ingress-NGINX version \| k8s supported version \| Alpine Version \| Nginx Version \|`
changes for release v1.1.1 (#8125) 2022-01-12 16:48:37 +00:00			`\|-----------------------\|------------------------------\|----------------\|---------------\|`
Release v1.3.0 (#8811) * Release v1.3.0 * Update charts/ingress-nginx/CHANGELOG.md Co-authored-by: Jintao Zhang <tao12345666333@163.com> * Update charts/ingress-nginx/README.md * Update Changelog.md Co-authored-by: Jintao Zhang <tao12345666333@163.com> Co-authored-by: James Strong <strong.james.e@gmail.com> Co-authored-by: Jintao Zhang <tao12345666333@163.com> 2022-07-12 13:30:50 +00:00			`\| v1.3.0 \| 1.24, 1.23, 1.22, 1.21, 1.20 \| 3.16.0 \| 1.19.10† \|`
Update supported version readme (#8654) bump versions to 1.2.1 2022-05-31 22:27:23 +00:00			`\| v1.2.1 \| 1.23, 1.22, 1.21, 1.20, 1.19 \| 3.14.6 \| 1.19.10† \|`
release 1.1.3 details (#8411) * release 1.1.3 details fix the readme with right sha and version remove helm label fix issue 8329 fix the 1.20 service after the fix for ipv6 udpate readme and change for patches * update helm doc Signed-off-by: James Strong <strong.james.e@gmail.com> 2022-04-01 16:14:46 +00:00			`\| v1.1.3 \| 1.23, 1.22, 1.21, 1.20, 1.19 \| 3.14.4 \| 1.19.10† \|`
			`\| v1.1.2 \| 1.23, 1.22, 1.21, 1.20, 1.19 \| 3.14.2 \| 1.19.9† \|`
			`\| v1.1.1 \| 1.23, 1.22, 1.21, 1.20, 1.19 \| 3.14.2 \| 1.19.9† \|`
			`\| v1.1.0 \| 1.22, 1.21, 1.20, 1.19 \| 3.14.2 \| 1.19.9† \|`
			`\| v1.0.5 \| 1.22, 1.21, 1.20, 1.19 \| 3.14.2 \| 1.19.9† \|`
			`\| v1.0.4 \| 1.22, 1.21, 1.20, 1.19 \| 3.14.2 \| 1.19.9† \|`
			`\| v1.0.3 \| 1.22, 1.21, 1.20, 1.19 \| 3.14.2 \| 1.19.9† \|`
			`\| v1.0.2 \| 1.22, 1.21, 1.20, 1.19 \| 3.14.2 \| 1.19.9† \|`
			`\| v1.0.1 \| 1.22, 1.21, 1.20, 1.19 \| 3.14.2 \| 1.19.9† \|`
			`\| v1.0.0 \| 1.22, 1.21, 1.20, 1.19 \| 3.13.5 \| 1.20.1 \|`
Replace release v0.50.0 for v0.51.0 on readme (#8543) 2022-05-05 08:44:20 +00:00			`\| v0.51.0 \| 1.21, 1.20, 1.19 \| 3.14.4 \| 1.19.10† \|`
release 1.1.3 details (#8411) * release 1.1.3 details fix the readme with right sha and version remove helm label fix issue 8329 fix the 1.20 service after the fix for ipv6 udpate readme and change for patches * update helm doc Signed-off-by: James Strong <strong.james.e@gmail.com> 2022-04-01 16:14:46 +00:00			`\| v0.49.3 \| 1.21, 1.20, 1.19 \| 3.14.2 \| 1.19.9† \|`
			`\| v0.49.2 \| 1.21, 1.20, 1.19 \| 3.14.2 \| 1.19.9† \|`
			`\| v0.49.1 \| 1.21, 1.20, 1.19 \| 3.14.2 \| 1.19.9† \|`
			`\| v0.49.0 \| 1.21, 1.20, 1.19 \| 3.13.5 \| 1.20.1 \|`
			`\| v0.48.1 \| 1.21, 1.20, 1.19 \| 3.13.5 \| 1.20.1 \|`
update docs with supported version of k8s, alpine and nginx (#7214) 2021-06-08 16:21:34 +00:00
Add a note to README.md with context on CVE-2021-23017 patch (#7735) 2021-10-03 14:19:06 +00:00			`† _This build is [patched against CVE-2021-23017](https://github.com/openresty/openresty/commit/4b5ec7edd78616f544abc194308e0cf4b788725b#diff-42ef841dc27fe0b5aa2d06bd31308bb63a59cdcddcbcddd917248349d22020a3)._`
add issue triage information (#7658) * add issue triage information * change requests * change requests from PR 2021-09-30 14:04:09 +00:00
			`See [this article](https://kubernetes.io/blog/2021/07/26/update-with-ingress-nginx/) if you want upgrade to the stable Ingress API.`

reorder contributing infos (#7394) * reorder contributing infos * Change requests of PR 2021-07-27 13:18:45 +00:00			`## Get Involved`
Improve readme file 2018-04-26 23:48:41 +00:00
reorder contributing infos (#7394) * reorder contributing infos * Change requests of PR 2021-07-27 13:18:45 +00:00			`Thanks for taking the time to join our community and start contributing!`
Improve readme file 2018-04-26 23:48:41 +00:00
reorder contributing infos (#7394) * reorder contributing infos * Change requests of PR 2021-07-27 13:18:45 +00:00			`- This project adheres to the [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md). By participating in this project, you agree to abide by its terms.`

			`- Contributing: Contributions of all kind are welcome!`

			- Read [`CONTRIBUTING.md`](CONTRIBUTING.md) for information about setting up your environment, the workflow that we expect, and instructions on the developer certificate of origin that we require.

			`- Join our Kubernetes Slack channel for developer discussion : [#ingress-nginx-dev](https://kubernetes.slack.com/archives/C021E147ZA4).`

			`- Submit github issues for any feature enhancements, bugs or documentation problems. Please make sure to read the [Issue Reporting Checklist](https://github.com/kubernetes/ingress-nginx/blob/main/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.`
Improve readme file 2018-04-26 23:48:41 +00:00
Fix several typos (#8701) * Fix minor typo - "Kubernetess" * Fix more typos * Fix typo: double "the" 2022-06-15 21:33:11 +00:00			`- Support: Join the [#ingress-nginx-users](https://kubernetes.slack.com/messages/CANQGM8BA/) channel inside the [Kubernetes Slack](http://slack.kubernetes.io/) to ask questions or get support from the maintainers and other users.`
reorder contributing infos (#7394) * reorder contributing infos * Change requests of PR 2021-07-27 13:18:45 +00:00
			`- The [github issues](https://github.com/kubernetes/ingress-nginx/issues) in the repository are exclusively for bug reports and feature requests.`

			- Discuss: Tweet using the `#IngressNginx` hashtag.
Improve readme file 2018-04-26 23:48:41 +00:00
			`## License`

reorder contributing infos (#7394) * reorder contributing infos * Change requests of PR 2021-07-27 13:18:45 +00:00			`[Apache License 2.0](https://github.com/kubernetes/ingress-nginx/blob/main/LICENSE)`