Cleanup deploy docs and remove old yaml manifests
This commit is contained in:
Manuel Alejandro de Brito Fontes
parent
ab3a789caa
commit
fd23ebc6d1
19 changed files with 56 additions and 985 deletions
|
|
@ -1,48 +1,34 @@
|
|||
# Installation Guide
|
||||
|
||||
!!! attention
|
||||
The default configuration watches Ingress object from **all the namespaces**.
|
||||
|
||||
To change this behavior use the flag `--watch-namespace` to limit the scope to a particular namespace.
|
||||
|
||||
!!! warning
|
||||
If multiple Ingresses define paths for the same host, the ingress controller **merges the definitions**.
|
||||
|
||||
## Contents
|
||||
|
||||
- [Prerequisite Generic Deployment Command](#prerequisite-generic-deployment-command)
|
||||
- [Provider Specific Steps](#provider-specific-steps)
|
||||
- [Docker for Mac](#docker-for-mac)
|
||||
- [minikube](#minikube)
|
||||
- [AWS](#aws)
|
||||
- [GCE - GKE](#gce-gke)
|
||||
- [Azure](#azure)
|
||||
- [Bare-metal](#bare-metal)
|
||||
- [Provider Specific Steps](#provider-specific-steps)
|
||||
- [Docker for Mac](#docker-for-mac)
|
||||
- [minikube](#minikube)
|
||||
- [AWS](#aws)
|
||||
- [GCE - GKE](#gce-gke)
|
||||
- [Azure](#azure)
|
||||
- [Bare-metal](#bare-metal)
|
||||
- [Verify installation](#verify-installation)
|
||||
- [Detect installed version](#detect-installed-version)
|
||||
- [Using Helm](#using-helm)
|
||||
|
||||
## Prerequisite Generic Deployment Command
|
||||
|
||||
!!! attention
|
||||
The default configuration watches Ingress object from *all the namespaces*.
|
||||
To change this behavior use the flag `--watch-namespace` to limit the scope to a particular namespace.
|
||||
|
||||
!!! warning
|
||||
If multiple Ingresses define different paths for the same host, the ingress controller will merge the definitions.
|
||||
|
||||
!!! attention
|
||||
If you're using GKE you need to initialize your user as a cluster-admin with the following command:
|
||||
```console
|
||||
kubectl create clusterrolebinding cluster-admin-binding \
|
||||
--clusterrole cluster-admin \
|
||||
--user $(gcloud config get-value account)
|
||||
```
|
||||
|
||||
### Provider Specific Steps
|
||||
|
||||
There are cloud provider specific yaml files.
|
||||
|
||||
#### Docker for Mac
|
||||
|
||||
Kubernetes is available in Docker for Mac (from [version 18.06.0-ce](https://docs.docker.com/docker-for-mac/release-notes/#stable-releases-of-2018))
|
||||
|
||||
[enable]: https://docs.docker.com/docker-for-mac/#kubernetes
|
||||
|
||||
Create a service
|
||||
|
||||
```console
|
||||
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud/deploy.yaml
|
||||
```
|
||||
|
|
@ -57,14 +43,14 @@ minikube addons enable ingress
|
|||
|
||||
For development:
|
||||
|
||||
1. Disable the ingress addon:
|
||||
- Disable the ingress addon:
|
||||
|
||||
```console
|
||||
minikube addons disable ingress
|
||||
```
|
||||
|
||||
2. Execute `make dev-env`
|
||||
3. Confirm the `nginx-ingress-controller` deployment exists:
|
||||
- Execute `make dev-env`
|
||||
- Confirm the `nginx-ingress-controller` deployment exists:
|
||||
|
||||
```console
|
||||
$ kubectl get pods -n ingress-nginx
|
||||
|
|
@ -82,23 +68,29 @@ In AWS we use a Network load balancer (NLB) to expose the NGINX Ingress controll
|
|||
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/aws/deploy.yaml
|
||||
```
|
||||
|
||||
##### TLS termination in the Load Balancer (ELB)
|
||||
##### TLS termination in AWS Load Balancer (ELB)
|
||||
|
||||
In some scenarios is required to terminate TLS in the Load Balancer and not in the ingress controller.
|
||||
|
||||
In some scenarios is not possible to terminate TLS in the ingress controller but in the Load Balancer.
|
||||
For this purpose we provide a template:
|
||||
|
||||
1. Download [deploy-tls-termination.yaml](https://raw.githubusercontent.com/kubernetes/ingress-nginx/204739fb6650c48fd41dc9505f8fd9ef6bc768e1/deploy/static/provider/aws/deploy-tls-termination.yaml)
|
||||
- Download [deploy-tls-termination.yaml](https://raw.githubusercontent.com/kubernetes/ingress-nginx/204739fb6650c48fd41dc9505f8fd9ef6bc768e1/deploy/static/provider/aws/deploy-tls-termination.yaml)
|
||||
|
||||
```console
|
||||
wget https://raw.githubusercontent.com/kubernetes/ingress-nginx/204739fb6650c48fd41dc9505f8fd9ef6bc768e1/deploy/static/provider/aws/deploy-tls-termination.yaml
|
||||
```
|
||||
|
||||
2. Change:
|
||||
- Edit the file and change:
|
||||
|
||||
- Set the VPC CIDR: `proxy-real-ip-cidr: XXX.XXX.XXX/XX`
|
||||
- Change the AWS Certificate Manager (ACM) ID `service.beta.kubernetes.io/aws-load-balancer-ssl-cert: arn:aws:acm:us-west-2:XXXXXXXX:certificate/XXXXXX-XXXXXXX-XXXXXXX-XXXXXXXX`
|
||||
- VPC CIDR in use for the Kubernetes cluster:
|
||||
|
||||
3. Deploy the manifests:
|
||||
`proxy-real-ip-cidr: XXX.XXX.XXX/XX`
|
||||
|
||||
- AWS Certificate Manager (ACM) ID
|
||||
|
||||
`arn:aws:acm:us-west-2:XXXXXXXX:certificate/XXXXXX-XXXXXXX-XXXXXXX-XXXXXXXX`
|
||||
|
||||
- Deploy the manifest:
|
||||
|
||||
```console
|
||||
kubectl apply -f deploy-tls-termination.yaml
|
||||
|
|
@ -109,19 +101,31 @@ kubectl apply -f deploy-tls-termination.yaml
|
|||
In some scenarios users will need to modify the value of the NLB idle timeout. Users need to ensure the idle timeout is less than the [keepalive_timeout](http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout) that is configured for NGINX.
|
||||
By default NGINX `keepalive_timeout` is set to `75s`.
|
||||
|
||||
The default NLB idle timeout will work for most scenarios, unless the NGINX [keepalive_timeout](http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout) has been modified, in which case `service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout` will need to be modified to ensure it is less than the `keepalive_timeout` the user has configured.
|
||||
The default NLB idle timeout works for most scenarios, unless the NGINX [keepalive_timeout](http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout) has been modified, in which case the annotation
|
||||
|
||||
_Please Note: An idle timeout of `3600s` is recommended when using WebSockets._
|
||||
`service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout` value must be modified to ensure it is less than the configured `keepalive_timeout`.
|
||||
|
||||
More information with regards to idle timeouts for your Load Balancer can be found in the [official AWS documentation](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#connection-idle-timeout).
|
||||
!!! note ""
|
||||
An idle timeout of `3600` is recommended when using WebSockets
|
||||
|
||||
More information with regards to timeouts for can be found in the [official AWS documentation](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#connection-idle-timeout)
|
||||
|
||||
#### GCE-GKE
|
||||
|
||||
!!! info
|
||||
Initialize your user as a cluster-admin with the following command:
|
||||
```console
|
||||
kubectl create clusterrolebinding cluster-admin-binding \
|
||||
--clusterrole cluster-admin \
|
||||
--user $(gcloud config get-value account)
|
||||
```
|
||||
|
||||
```console
|
||||
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud/deploy.yaml
|
||||
```
|
||||
|
||||
**Important Note:** proxy protocol is not supported in GCE/GKE
|
||||
!!! warning Important
|
||||
Proxy protocol is not supported in GCE/GKE
|
||||
|
||||
#### Azure
|
||||
|
||||
|
|
@ -145,10 +149,12 @@ kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/mast
|
|||
To check if the ingress controller pods have started, run the following command:
|
||||
|
||||
```console
|
||||
kubectl get pods --all-namespaces -l app.kubernetes.io/name=ingress-nginx --watch
|
||||
kubectl get pods -n ingress-nginx \
|
||||
-l app.kubernetes.io/name=ingress-nginx --watch
|
||||
```
|
||||
|
||||
Once the operator pods are running, you can cancel the above command by typing `Ctrl+C`.
|
||||
Once the ingress controller pods are running, you can cancel the command typing `Ctrl+C`.
|
||||
|
||||
Now, you are ready to create your first ingress.
|
||||
|
||||
### Detect installed version
|
||||
|
|
@ -168,18 +174,18 @@ NGINX Ingress controller can be installed via [Helm](https://helm.sh/) using the
|
|||
To install the chart with the release name `ingress-nginx`:
|
||||
|
||||
```console
|
||||
helm repo add k8s-ingress-nginx https://kubernetes.github.io/ingress-nginx/
|
||||
helm install ingress-nginx k8s-ingress-nginx
|
||||
helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
|
||||
helm install ingress-nginx
|
||||
```
|
||||
|
||||
If you are using [Helm 2](https://v2.helm.sh/) then specify release name using `--name` flag
|
||||
|
||||
```console
|
||||
helm repo add k8s-ingress-nginx https://kubernetes.github.io/ingress-nginx/
|
||||
helm install k8s-ingress-nginx --name ingress-nginx
|
||||
helm repo add https://kubernetes.github.io/ingress-nginx/
|
||||
helm install --name ingress-nginx
|
||||
```
|
||||
|
||||
### Detect installed version:
|
||||
## Detect installed version:
|
||||
|
||||
```console
|
||||
POD_NAME=$(kubectl get pods -l app.kubernetes.io/name=ingress-nginx -o jsonpath='{.items[0].metadata.name}')
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue