ingress-nginx-helm/README.md

64 lines
4.2 KiB
Markdown
Raw Normal View History

2017-10-08 19:43:22 +00:00
# NGINX Ingress Controller
2017-10-06 22:47:46 +00:00
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)
2018-04-26 23:48:41 +00:00
[![GitHub license](https://img.shields.io/github/license/kubernetes/ingress-nginx.svg)](https://github.com/kubernetes/ingress-nginx/blob/master/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/master/CONTRIBUTING.md)
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)
2018-04-26 23:48:41 +00:00
2020-02-07 13:53:03 +00:00
## Overview
2017-10-06 22:47:46 +00:00
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.
2017-10-06 22:47:46 +00:00
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/).
2017-10-06 22:47:46 +00:00
2020-02-07 13:53:03 +00:00
## Get started
2017-10-06 22:47:46 +00:00
2020-02-07 13:53:03 +00:00
See the [Getting Started](https://kubernetes.github.io/ingress-nginx/deploy/) document.
2017-10-06 22:47:46 +00:00
2020-02-07 13:53:03 +00:00
## Troubleshooting
2017-10-06 22:47:46 +00:00
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.
2018-04-26 23:48:41 +00:00
2020-02-07 13:53:03 +00:00
## Contributing
2018-04-26 23:48:41 +00:00
2020-02-07 13:53:03 +00:00
Thanks for taking the time to join our community and start contributing!
2018-04-26 23:48:41 +00:00
2020-02-07 13:53:03 +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.
- See [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.
- Check out the [open issues](https://github.com/kubernetes/ingress-nginx).
- Join our Kubernetes Slack channel for developer discussion : [#ingress-nginx-dev](https://kubernetes.slack.com/archives/C021E147ZA4).
2018-04-26 23:48:41 +00:00
## Changelog
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.
For detailed changes on the `ingress-nginx` helm chart, please check the following [CHANGELOG.md](charts/ingress-nginx/CHANGELOG.md) file.
2018-04-26 23:48:41 +00:00
### Support Versions table
2021-07-14 19:06:19 +00:00
| Ingress-nginx version | k8s supported version | Alpine Version | Nginx Version |
|-----------------------|------------- |----------------|---------------|
| v1.0.0-alpha.2 | 1.22, 1.21, 1.20, 1.19 | 3.13.5 | 1.20.1 |
| v1.0.0-alpha.1 | 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 |
2020-02-07 13:53:03 +00:00
# Get Involved
2018-04-26 23:48:41 +00:00
2020-02-07 13:53:03 +00:00
- **Contributing**: Pull requests are welcome!
2021-01-13 15:18:51 +00:00
- Read [`CONTRIBUTING.md`](CONTRIBUTING.md) and check out [help-wanted](https://github.com/kubernetes/ingress-nginx/labels/help%20wanted) issues.
- Submit github issues for any feature enhancements, bugs or documentation problems.
- **Support**: Join to [Kubernetes Slack](http://slack.kubernetes.io/) in the [#ingress-nginx-users](https://kubernetes.slack.com/messages/CANQGM8BA/) channel to ask questions to get support from the maintainers and other users.
2020-02-07 13:53:03 +00:00
- The [github issues](https://github.com/kubernetes/ingress-nginx/issues) in the repository are **exclusively** for bug reports and feature requests.
2021-01-13 15:18:51 +00:00
- **Discuss**: Tweet using the `#IngressNginx` hashtag.
2018-04-26 23:48:41 +00:00
2020-02-07 13:53:03 +00:00
## Issues
2018-04-26 23:48:41 +00:00
2020-02-07 13:53:03 +00:00
Please make sure to read the [Issue Reporting Checklist](https://github.com/kubernetes/ingress-nginx/blob/master/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines **may be closed immediately**.
2018-04-26 23:48:41 +00:00
## License
[Apache License 2.0](https://github.com/kubernetes/ingress-nginx/blob/master/LICENSE)