Add more descriptive steps in Dev Documentation

Adds more descriptive steps in the Development Documentation,
like more information on obtaining dependencies, building, and
deploying an image of the ingress controller. Also adds more
descriptive information on deploying as well as some fixes
on grammar and spelling.
This commit is contained in:
Fernando Diaz 2017-08-02 23:02:02 -05:00
parent a58b800171
commit 86b52fa957
7 changed files with 178 additions and 122 deletions

View file

@ -13,7 +13,7 @@ $ kubectl apply -f default-backend.yaml
deployment "default-http-backend" created
service "default-http-backend" created
$ kubectl -n kube-system get po
$ kubectl -n kube-system get pods
NAME READY STATUS RESTARTS AGE
default-http-backend-2657704409-qgwdd 1/1 Running 0 28s
```
@ -22,23 +22,39 @@ default-http-backend-2657704409-qgwdd 1/1 Running 0 28s
You can deploy the controller as follows:
1. Disable the ingress addon:
```console
$ minikube addons disable ingress
```
2. Use the [docker daemon](https://github.com/kubernetes/minikube/blob/master/docs/reusing_the_docker_daemon.md)
3. [Build the image](../../../docs/dev/getting_started.md)
4. Create the [default-backend](default-backend.yaml):
```console
$ kubectl apply -f default-backend.yaml
```
5. Change [nginx-ingress-controller.yaml](nginx-ingress-controller.yaml) to use the appropriate image. Local images can be
seen by performing `docker images`.
```yaml
image: <IMAGE-NAME>:<TAG>
```
6. Create the nginx-ingress-controller deployment:
```console
$ kubectl apply -f nginx-ingress-controller.yaml
deployment "nginx-ingress-controller" created
$ kubectl -n kube-system get po
$ kubectl -n kube-system get pods
NAME READY STATUS RESTARTS AGE
default-http-backend-2657704409-qgwdd 1/1 Running 0 2m
nginx-ingress-controller-873061567-4n3k2 1/1 Running 0 42s
```
Note the default settings of this controller:
* serves a `/healthz` url on port 10254, as both a liveness and readiness probe
* serves a `/healthz` url on port 10254, as a status probe
* takes a `--default-backend-service` argument pointing to the Service created above
## Running on a cloud provider
If you're running this ingress controller on a cloudprovider, you should assume
If you're running this ingress controller on a cloud-provider, you should assume
the provider also has a native Ingress controller and set the annotation
`kubernetes.io/ingress.class: nginx` in all Ingresses meant for this controller.
You might also need to open a firewall-rule for ports 80/443 of the nodes the

View file

@ -13,7 +13,7 @@ a 404 page.
## Controller
The Nginx Ingress Controller uses nginx (surprisingly!) to loadbalance requests that are coming to
The Nginx Ingress Controller uses nginx (surprisingly!) to loadbalancer requests that are coming to
ports 80 and 443 to Services in the cluster.
```console