ingress-nginx-helm/README.md

## Help us to improve the NGINX Ingress controller [completing the survey](https://docs.google.com/forms/d/15ULTOvYDsV920V0GWrspew4yyjEmTAi740Wr34UgKwA/viewform)

---

# NGINX Ingress Controller

[![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)
[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/ingress-nginx)](https://goreportcard.com/report/github.com/kubernetes/ingress-nginx)

## Description

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.

Learn more about using Ingress on [k8s.io](http://kubernetes.io/docs/user-guide/ingress/)

### 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.

The Ingress resource embodies this idea, and an Ingress controller is meant to handle all the quirks associated with a specific "class" of Ingress.

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.

## Documentation

See [docs/index.md](docs/index.md) for detailed documentation.
Fix survey link (#2321) 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)`
Improve title README, add examples outline 2016-11-25 01:51:05 +00:00
Clean readme 2017-10-08 19:43:22 +00:00			`---`
Update readme 2017-10-06 22:47:46 +00:00
Clean readme 2017-10-08 19:43:22 +00:00			`# NGINX Ingress Controller`
Update readme 2017-10-06 22:47:46 +00:00
Clean readme 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)`
Migrate to codecov.io (#2120) * Migrate to codecov.io * Fix data race * Update nginx to 1.13.9 2018-02-20 16:27:02 +00:00			`[![Coverage Status](https://codecov.io/gh/kubernetes/ingress-nginx/branch/master/graph/badge.svg)](https://codecov.io/gh/kubernetes/ingress-nginx)`
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)`
Update readme 2017-10-06 22:47:46 +00:00
Clean readme 2017-10-08 19:43:22 +00:00			`## Description`
Update readme 2017-10-06 22:47:46 +00:00
Fix doc links (#1925) * Fix documentation links * Replace external-traffic annotation * Update awesome_bot docker image 2018-01-18 15:30:29 +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.`
Update readme 2017-10-06 22:47:46 +00:00
Clean readme 2017-10-08 19:43:22 +00:00			`Learn more about using Ingress on [k8s.io](http://kubernetes.io/docs/user-guide/ingress/)`
Update readme 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.`

Cleanup examples directory 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.`
Update readme 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.

Move all documentation under docs/ 2018-04-24 09:36:16 +00:00			`## Documentation`
Update readme 2017-10-06 22:47:46 +00:00
Move all documentation under docs/ 2018-04-24 09:36:16 +00:00			`See [docs/index.md](docs/index.md) for detailed documentation.`