1614027cd4
* clarify link * Add section headers * console blocks * grpc example json was not valid * multi-tls update text The preceding point 1 related to4f2cb51ef8/ingress/controllers/nginx/examples/ingress.yamland the deployments referenced in4f2cb51ef8/ingress/controllers/nginx/examples/README.mdThey 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>
76 lines
5.3 KiB
Markdown
76 lines
5.3 KiB
Markdown
# Ingress NGINX Controller
|
|
|
|
[](https://goreportcard.com/report/github.com/kubernetes/ingress-nginx)
|
|
[](https://github.com/kubernetes/ingress-nginx/blob/main/LICENSE)
|
|
[](https://github.com/kubernetes/ingress-nginx/stargazers)
|
|
[](https://github.com/kubernetes/ingress-nginx/blob/main/CONTRIBUTING.md)
|
|
[](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.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.50.0 | 1.21, 1.20, 1.19 | 3.14.2 | 1.19.9† |
|
|
| 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 |
|
|
| v0.47.0 | 1.21, 1.20, 1.19 | 3.13.5 | 1.20.1 |
|
|
| v0.46.0 | 1.21, 1.20, 1.19 | 3.13.2 | 1.19.6 |
|
|
|
|
† _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 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)
|