ingress-nginx README

The project's README from github.com/kubernetes/ingress-nginx. As one markdown file: README.md.

Ingress NGINX Retirement

Retiring

What You Need to Know about Ingress NGINX Retirement:

Ingress NGINX Controller

CII Best Practices Go Report Card GitHub license GitHub stars

Overview

ingress-nginx was an Ingress controller for Kubernetes using NGINX as a reverse proxy and load balancer.

Learn more about Ingress on the Kubernetes documentation site.

Usage warnings

If you are not already using ingress-nginx, you should not be deploying it as it is not being developed. Instead you should identify a Gateway API implementation and use it.

Do not use in multi-tenant Kubernetes production installations. This project assumes that users that can create Ingress objects are administrators of the cluster. See the FAQ for more.

Troubleshooting

If you encounter issues, review the troubleshooting docs, search for an issue, or talk to us on the #ingress-nginx-users channel on the Kubernetes Slack server.

Changelog

See the list of releases for all changes. For detailed changes for each release, please check the changelog-$version.md file for the release version. For detailed changes on the ingress-nginx helm chart, please check the changelog folder for a specific version. CHANGELOG-$current-version.md file.

Supported Versions table

Supported versions for the ingress-nginx project mean that we have completed E2E tests, and they are passing for the versions listed. Ingress-Nginx versions may work on older versions, but the project does not make that guarantee.

Supported Ingress-NGINX version k8s supported version Alpine Version Nginx Version Helm Chart Version
🔄 v1.15.1 1.35, 1.34, 1.33, 1.32, 1.31 3.23.3 1.27.1 4.15.1
🔄 v1.15.0 1.35, 1.34, 1.33, 1.32, 1.31 3.23.3 1.27.1 4.15.0
🔄 v1.14.5 1.34, 1.33, 1.32, 1.31, 1.30 3.23.3 1.27.1 4.14.5
🔄 v1.14.4 1.34, 1.33, 1.32, 1.31, 1.30 3.23.3 1.27.1 4.14.4
🔄 v1.14.3 1.34, 1.33, 1.32, 1.31, 1.30 3.23.2 1.27.1 4.14.3
🔄 v1.14.2 1.34, 1.33, 1.32, 1.31, 1.30 3.23.2 1.27.1 4.14.2
🔄 v1.14.1 1.34, 1.33, 1.32, 1.31, 1.30 3.22.2 1.27.1 4.14.1
🔄 v1.14.0 1.34, 1.33, 1.32, 1.31, 1.30 3.22.2 1.27.1 4.14.0
🔄 v1.13.9 1.33, 1.32, 1.31, 1.30, 1.29 3.23.3 1.27.1 4.13.9
🔄 v1.13.8 1.33, 1.32, 1.31, 1.30, 1.29 3.23.3 1.27.1 4.13.8
🔄 v1.13.7 1.33, 1.32, 1.31, 1.30, 1.29 3.23.2 1.27.1 4.13.7
🔄 v1.13.6 1.33, 1.32, 1.31, 1.30, 1.29 3.23.2 1.27.1 4.13.6
🔄 v1.13.5 1.33, 1.32, 1.31, 1.30, 1.29 3.22.2 1.27.1 4.13.5
🔄 v1.13.4 1.33, 1.32, 1.31, 1.30, 1.29 3.22.2 1.27.1 4.13.4
🔄 v1.13.3 1.33, 1.32, 1.31, 1.30, 1.29 3.22.1 1.27.1 4.13.3
🔄 v1.13.2 1.33, 1.32, 1.31, 1.30, 1.29 3.22.1 1.27.1 4.13.2
🔄 v1.13.1 1.33, 1.32, 1.31, 1.30, 1.29 3.22.1 1.27.1 4.13.1
🔄 v1.13.0 1.33, 1.32, 1.31, 1.30, 1.29 3.22.0 1.27.1 4.13.0
v1.12.8 1.32, 1.31, 1.30, 1.29, 1.28 3.22.2 1.25.5 4.12.8
v1.12.7 1.32, 1.31, 1.30, 1.29, 1.28 3.22.1 1.25.5 4.12.7
v1.12.6 1.32, 1.31, 1.30, 1.29, 1.28 3.22.1 1.25.5 4.12.6
v1.12.5 1.32, 1.31, 1.30, 1.29, 1.28 3.22.1 1.25.5 4.12.5
v1.12.4 1.32, 1.31, 1.30, 1.29, 1.28 3.22.0 1.25.5 4.12.4
v1.12.3 1.32, 1.31, 1.30, 1.29, 1.28 3.21.3 1.25.5 4.12.3
v1.12.2 1.32, 1.31, 1.30, 1.29, 1.28 3.21.3 1.25.5 4.12.2
v1.12.1 1.32, 1.31, 1.30, 1.29, 1.28 3.21.3 1.25.5 4.12.1
v1.12.0 1.32, 1.31, 1.30, 1.29, 1.28 3.21.0 1.25.5 4.12.0
v1.12.0-beta.0 1.32, 1.31, 1.30, 1.29, 1.28 3.20.3 1.25.5 4.12.0-beta.0
v1.11.8 1.30, 1.29, 1.28, 1.27, 1.26 3.22.0 1.25.5 4.11.8
v1.11.7 1.30, 1.29, 1.28, 1.27, 1.26 3.21.3 1.25.5 4.11.7
v1.11.6 1.30, 1.29, 1.28, 1.27, 1.26 3.21.3 1.25.5 4.11.6
v1.11.5 1.30, 1.29, 1.28, 1.27, 1.26 3.21.3 1.25.5 4.11.5
v1.11.4 1.30, 1.29, 1.28, 1.27, 1.26 3.21.0 1.25.5 4.11.4
v1.11.3 1.30, 1.29, 1.28, 1.27, 1.26 3.20.3 1.25.5 4.11.3
v1.11.2 1.30, 1.29, 1.28, 1.27, 1.26 3.20.0 1.25.5 4.11.2
v1.11.1 1.30, 1.29, 1.28, 1.27, 1.26 3.20.0 1.25.5 4.11.1
v1.11.0 1.30, 1.29, 1.28, 1.27, 1.26 3.20.0 1.25.5 4.11.0
v1.10.6 1.30, 1.29, 1.28, 1.27, 1.26 3.21.0 1.25.5 4.10.6
v1.10.5 1.30, 1.29, 1.28, 1.27, 1.26 3.20.3 1.25.5 4.10.5
v1.10.4 1.30, 1.29, 1.28, 1.27, 1.26 3.20.0 1.25.5 4.10.4
v1.10.3 1.30, 1.29, 1.28, 1.27, 1.26 3.20.0 1.25.5 4.10.3
v1.10.2 1.30, 1.29, 1.28, 1.27, 1.26 3.20.0 1.25.5 4.10.2
v1.10.1 1.30, 1.29, 1.28, 1.27, 1.26 3.19.1 1.25.3 4.10.1
v1.10.0 1.29, 1.28, 1.27, 1.26 3.19.1 1.25.3 4.10.0
v1.9.6 1.29, 1.28, 1.27, 1.26, 1.25 3.19.0 1.21.6 4.9.1
v1.9.5 1.28, 1.27, 1.26, 1.25 3.18.4 1.21.6 4.9.0
v1.9.4 1.28, 1.27, 1.26, 1.25 3.18.4 1.21.6 4.8.3
v1.9.3 1.28, 1.27, 1.26, 1.25 3.18.4 1.21.6 4.8.*
v1.9.1 1.28, 1.27, 1.26, 1.25 3.18.4 1.21.6 4.8.*
v1.9.0 1.28, 1.27, 1.26, 1.25 3.18.2 1.21.6 4.8.*
v1.8.4 1.27, 1.26, 1.25, 1.24 3.18.2 1.21.6 4.7.*
v1.7.1 1.27, 1.26, 1.25, 1.24 3.17.2 1.21.6 4.6.*
v1.6.4 1.26, 1.25, 1.24, 1.23 3.17.0 1.21.6 4.5.*
v1.5.1 1.25, 1.24, 1.23 3.16.2 1.21.6 4.4.*
v1.4.0 1.25, 1.24, 1.23, 1.22 3.16.2 1.19.10† 4.3.0
v1.3.1 1.24, 1.23, 1.22, 1.21, 1.20 3.16.2 1.19.10† 4.2.5

See Updating NGINX-Ingress to use the stable Ingress API (July 26, 2021) to upgrade to the stable Ingress API before upgrading to Kubernetes 1.22.

Get Involved

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

License

Apache License 2.0

ingress-nginx (kubernetes/ingress-nginx)

Searching Database…

19.4K ·GitHub
Ingress-nginx
archived
这是干什么的？ingress-nginx 是 Kubernetes 的一个 Ingress 控制器，使用 NGINX 作为反向代理和负载均衡器，把流量路由进集群。该项目现已退役。
如果我的集群还在用它，里面部署的到底是什么？一个运行在你集群内部、驱动 NGINX 作为流量通道的控制器，通过官方 Helm chart 安装。即使项目已退役，chart 和容器镜像仍然可以获取。
新建集群的话，我应该选它吗？不应该。README 说得很直白：如果你现在没有在用 ingress-nginx，就不要部署它——先确定一种 Gateway API 实现，改用那个。
最终版本支持哪些 Kubernetes 版本？最后的 v1.15.x 系列针对 Kubernetes 1.31-1.35 做过测试，内置 NGINX 1.27.1。更早的版本面向更旧的集群，比如 v1.11.x 对应 1.26-1.30。
我看到它已经退役了——这对还在用它的人到底意味着什么？尽力而为的维护会持续到 2026 年 3 月；之后不再有新版本，也没有 bug 修复和安全修复。已经部署好的实例不会因此坏掉。
在共享的多租户生产集群里用它合适吗？不合适。项目明确表示不要在多租户生产环境中使用它，并且假定任何能创建 Ingress 对象的人都是集群管理员。
在 Kubernetes 里，Ingress 到底是什么？它是 Kubernetes 把服务暴露给外部流量的机制。像这样的 ingress 控制器会监听 Ingress 对象，并把它们转换成 NGINX 的反向代理和负载均衡规则。
它曾是 Kubernetes 的官方项目吗？是的——它位于 kubernetes GitHub 组织下，遵循 Kubernetes 社区行为准则，用户支持通过 Kubernetes Slack 上的 #ingress-nginx-users 频道提供。
它的兼容性表里“受支持的版本”是什么意思？指该项目已完成 E2E 测试并且全部通过的组合。这些版本在更旧的 Kubernetes 版本上可能也能运行，但没有任何保证。
What are similar projects?apisix, k3s, cilium, containerd, tengine, traefik, distribution, Reloader
Which topics is it in?helm-charts, gateway, k8s, load-balancer, nginx, cncf, infrastructure, reverse-proxy, containers, cloud-native, http, kubernetes
Creator
kubernetes
Size
147.8 MB
Stars
19.4K
Updated
CommitMar 19Releasecontroller-v1.15.1Mar 19
Age
9y
Commits · 90 Days