ingress-nginx-helm/README.md

78 lines
4 KiB
Markdown
Raw Normal View History

2018-04-09 17:33:30 +00:00
## Help us to improve the NGINX Ingress controller [completing the survey](https://docs.google.com/forms/d/15ULTOvYDsV920V0GWrspew4yyjEmTAi740Wr34UgKwA/viewform)
2017-10-08 19:43:22 +00:00
---
2017-10-06 22:47:46 +00:00
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
[![Build Status](https://travis-ci.org/kubernetes/ingress-nginx.svg?branch=master)](https://travis-ci.org/kubernetes/ingress-nginx)
[![Coverage Status](https://codecov.io/gh/kubernetes/ingress-nginx/branch/master/graph/badge.svg)](https://codecov.io/gh/kubernetes/ingress-nginx)
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)
# Get Involved
* **Contributing**: Pull requests are welcome!
* Read [`CONTRIBUTING.md`](CONTRIBUTING.md) and check out [help-wanted](https://github.com/kubernetes/ingress-nginx/labels/help%20wanted) issues
2018-04-26 23:48:41 +00:00
* Submit github issues for any feature enhancements, bugs or documentation problems
* **Support**: Join to [Kubernetes Slack](http://slack.kubernetes.io/) to ask questions to get support from the maintainers and other developers
* Questions/comments can also be posted as [github issues](https://github.com/kubernetes/ingress-nginx/issues)
2018-04-27 00:39:37 +00:00
* **Discuss**: Tweet using the `#IngressNginx` hashtag
2018-04-26 23:48:41 +00:00
2017-10-06 22:47:46 +00:00
2017-10-08 19:43:22 +00:00
## Description
2017-10-06 22:47:46 +00:00
This repository contains the NGINX controller built around the [Kubernetes Ingress resource](http://kubernetes.io/docs/user-guide/ingress/) that uses [ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#understanding-configmaps-and-pods) to store the NGINX configuration.
2017-10-06 22:47:46 +00:00
2017-10-08 19:43:22 +00:00
Learn more about using Ingress on [k8s.io](http://kubernetes.io/docs/user-guide/ingress/)
2017-10-06 22:47:46 +00:00
### What is an Ingress Controller?
Configuring a webserver or loadbalancer is harder than it should be. Most webserver configuration files are very similar. There are some applications that have weird little quirks that tend to throw a wrench in things, but for the most part you can apply the same logic to them and achieve a desired result.
2017-10-07 21:29:41 +00:00
The Ingress resource embodies this idea, and an Ingress controller is meant to handle all the quirks associated with a specific "class" of Ingress.
2017-10-06 22:47:46 +00:00
An Ingress Controller is a daemon, deployed as a Kubernetes Pod, that watches the apiserver's `/ingresses` endpoint for updates to the [Ingress resource](https://kubernetes.io/docs/concepts/services-networking/ingress/). Its job is to satisfy requests for Ingresses.
2018-04-26 23:48:41 +00:00
2018-04-24 09:36:16 +00:00
## Documentation
2017-10-06 22:47:46 +00:00
2018-04-26 23:48:41 +00:00
To check out [Live Docs](https://kubernetes.github.io/ingress-nginx/)
## Questions
For questions and support please use the kubernetes-users room in the [Kubernetes Slack](http://slack.kubernetes.io/) or [kubernetes-users](https://groups.google.com/forum/#!forum/kubernetes-users) mailing list. The issue list of this repo is **exclusively** for bug reports and feature requests.
## Issues
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.
## Changelog
Detailed changes for each release are documented in the [CHANGELOG.md](CHANGELOG.md)
## Contribution
Please make sure to read the [Contributing Guide](CONTRIBUTING.md) before making a pull request.
2018-04-26 23:48:41 +00:00
Thank you to all the people who already contributed to NGINX Ingress Controller!
## Code of Conduct
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.
## License
[Apache License 2.0](https://github.com/kubernetes/ingress-nginx/blob/master/LICENSE)