Clean readme
This commit is contained in:
Manuel de Brito Fontes
parent
4479b54953
commit
a27706b582
1 changed files with 31 additions and 42 deletions
57
README.md
57
README.md
|
|
@ -1,3 +1,7 @@
|
|||
The GCE ingress controller was moved to [github.com/kubernetes/ingress-gce](https://github.com/kubernetes/ingress-gce).
|
||||
|
||||
---
|
||||
|
||||
# NGINX Ingress Controller
|
||||
|
||||
[](https://travis-ci.org/kubernetes/ingress-nginx)
|
||||
|
|
@ -7,22 +11,9 @@
|
|||
|
||||
## Description
|
||||
|
||||
This repository contains the NGINX controller built around the [Kubernetes Ingress resource](http://kubernetes.io/docs/user-guide/ingress/).
|
||||
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/configmap/#understanding-configmaps) to store the NGINX configuration.
|
||||
|
||||
The GCE ingress controller was moved to [github.com/kubernetes/ingress-gce](https://github.com/kubernetes/ingress-gce).
|
||||
|
||||
## Navigation
|
||||
|
||||
* Learn more about using Ingress
|
||||
* See our user documentation on [k8s.io](http://kubernetes.io/docs/user-guide/ingress/)
|
||||
* Follow through to the respective platform specific [examples](examples/README.md)
|
||||
* Deploy existing Ingress controllers
|
||||
* See our [admin documentation](docs/admin.md)
|
||||
* Contribute
|
||||
* See the [contributor guidelines](CONTRIBUTING.md)
|
||||
* Debug
|
||||
* Peruse the [FAQ section](docs/faq/README.md)
|
||||
* Ask on one of the [user-support channels](CONTRIBUTING.md#support-channels)
|
||||
Learn more about using Ingress on [k8s.io](http://kubernetes.io/docs/user-guide/ingress/)
|
||||
|
||||
### What is an Ingress Controller?
|
||||
|
||||
|
|
@ -32,16 +23,12 @@ The Ingress resource embodies this idea, and an Ingress controller is meant to h
|
|||
|
||||
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.
|
||||
|
||||
### Introduction
|
||||
|
||||
This is an nginx Ingress controller that uses [ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configmap/#understanding-configmaps) to store the nginx configuration. See [Ingress controller documentation](../README.md) for details on how it works.
|
||||
|
||||
## Contents
|
||||
|
||||
* [Conventions](#conventions)
|
||||
* [Requirements](#requirements)
|
||||
* [Contribute](#contribute)
|
||||
* [Command line arguments](#command-line-arguments)
|
||||
* [Dry running](#try-running-the-ingress-controller)
|
||||
* [Deployment](#deployment)
|
||||
* [HTTP](#http)
|
||||
* [HTTPS](#https)
|
||||
|
|
@ -70,12 +57,16 @@ This is an nginx Ingress controller that uses [ConfigMap](https://kubernetes.io/
|
|||
## Conventions
|
||||
|
||||
Anytime we reference a tls secret, we mean (x509, pem encoded, RSA 2048, etc). You can generate such a certificate with:
|
||||
`openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ${KEY_FILE} -out ${CERT_FILE} -subj "/CN=${HOST}/O=${HOST}"`
|
||||
and create the secret via `kubectl create secret tls ${CERT_NAME} --key ${KEY_FILE} --cert ${CERT_FILE}`
|
||||
`openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ${KEY_FILE} -out ${CERT_FILE} -subj "/CN=${HOST}/O=${HOST}"`
|
||||
and create the secret via `kubectl create secret tls ${CERT_NAME} --key ${KEY_FILE} --cert ${CERT_FILE}`
|
||||
|
||||
## Requirements
|
||||
|
||||
- Default backend [404-server](https://github.com/kubernetes/ingress/tree/master/images/404-server)
|
||||
Default backend [404-server](https://github.com/kubernetes/ingress/tree/master/images/404-server)
|
||||
|
||||
## Contribute
|
||||
|
||||
See the [contributor guidelines](CONTRIBUTING.md)
|
||||
|
||||
## Command line arguments
|
||||
|
||||
|
|
@ -136,6 +127,7 @@ Usage of :
|
|||
## Deployment
|
||||
|
||||
First create a default backend and it's corresponding service:
|
||||
|
||||
```console
|
||||
kubectl create -f examples/default-backend.yaml
|
||||
```
|
||||
|
|
@ -344,9 +336,7 @@ To disable this behavior use `hsts=false` in the NGINX config map.
|
|||
|
||||
### Automated Certificate Management with Kube-Lego
|
||||
|
||||
[Kube-Lego] automatically requests missing or expired certificates from
|
||||
[Let's Encrypt] by monitoring ingress resources and their referenced secrets. To
|
||||
enable this for an ingress resource you have to add an annotation:
|
||||
[Kube-Lego] automatically requests missing or expired certificates from [Let's Encrypt] by monitoring ingress resources and their referenced secrets. To enable this for an ingress resource you have to add an annotation:
|
||||
|
||||
```console
|
||||
kubectl annotate ing ingress-demo kubernetes.io/tls-acme="true"
|
||||
|
|
@ -485,17 +475,13 @@ To extract the information in JSON format the module provides a custom URL: `/ng
|
|||
|
||||
### Running multiple ingress controllers
|
||||
|
||||
If you're running multiple ingress controllers, or running on a cloudprovider that natively handles
|
||||
ingress, you need to specify the annotation `kubernetes.io/ingress.class: "nginx"` in all ingresses
|
||||
that you would like this controller to claim. Not specifying the annotation will lead to multiple
|
||||
ingress controllers claiming the same ingress. Specifying the wrong value will result in all ingress
|
||||
controllers ignoring the ingress. Multiple ingress controllers running in the same cluster was not
|
||||
supported in Kubernetes versions < 1.3.
|
||||
If you're running multiple ingress controllers, or running on a cloudprovider that natively handles ingress, you need to specify the annotation `kubernetes.io/ingress.class: "nginx"` in all ingresses that you would like this controller to claim.
|
||||
Not specifying the annotation will lead to multiple ingress controllers claiming the same ingress. Specifying the wrong value will result in all ingress controllers ignoring the ingress.
|
||||
Multiple ingress controllers running in the same cluster was not supported in Kubernetes versions < 1.3.
|
||||
|
||||
### Running on Cloudproviders
|
||||
|
||||
If you're running this ingress controller on a cloudprovider, you should assume the provider also has a native
|
||||
Ingress controller and specify the ingress.class annotation as indicated in this section.
|
||||
If you're running this ingress controller on a cloudprovider, you should assume the provider also has a native Ingress controller and specify the ingress.class annotation as indicated in this section.
|
||||
In addition to this, you will need to add a firewall rule for each port this controller is listening on, i.e :80 and :443.
|
||||
|
||||
### Disabling NGINX ingress controller
|
||||
|
|
@ -565,6 +551,9 @@ I0316 12:24:37.610073 1 command.go:69] change in configuration detected. R
|
|||
- `--v=3` shows details about the service, Ingress rule, endpoint changes and it dumps the nginx configuration in JSON format
|
||||
- `--v=5` configures NGINX in [debug mode](http://nginx.org/en/docs/debugging_log.html)
|
||||
|
||||
Peruse the [FAQ section](docs/faq/README.md)
|
||||
Ask on one of the [user-support channels](CONTRIBUTING.md#support-channels)
|
||||
|
||||
### Limitations
|
||||
|
||||
- Ingress rules for TLS require the definition of the field `host`
|
||||
|
|
|
|||
Loading…
Reference in a new issue