Minor fixes for Development Documentation
Further cleans up the development documentation with spacing and more readable text.
This commit is contained in:
parent
86b52fa957
commit
ef499aaff1
6 changed files with 17 additions and 21 deletions
|
@ -12,7 +12,7 @@ branch, but release branches of Kubernetes should not change.
|
||||||
|
|
||||||
## Navigation
|
## Navigation
|
||||||
|
|
||||||
* [Build, test, release](getting_started.md) an existing controller
|
* [Build, test, release](getting-started.md) an existing controller
|
||||||
* [Setup a cluster](setup_cluster.md) to hack at an existing controller
|
* [Setup a cluster](setup-cluster.md) to hack at an existing controller
|
||||||
* [Write your own](custom_controller.md) controller
|
* [Write your own](custom-controller.md) controller
|
||||||
|
|
||||||
|
|
|
@ -54,10 +54,10 @@ requirements you can build a raw server binary, a local container image,
|
||||||
or push an image to a remote repository.
|
or push an image to a remote repository.
|
||||||
|
|
||||||
In order to use your local Docker, you may need to set the following environment variables:
|
In order to use your local Docker, you may need to set the following environment variables:
|
||||||
* export TAG=0.0 # or whatever you want the version to be named
|
```console
|
||||||
* export DOCKER=docker
|
$ export DOCKER=docker
|
||||||
* export REGISTRY=index.docker.io
|
$ export REGISTRY=<your-docker-registry>
|
||||||
|
```
|
||||||
To find the registry simply run: `docker system info | grep Registry`
|
To find the registry simply run: `docker system info | grep Registry`
|
||||||
|
|
||||||
Otherwise by default you will be using the [Google Cloud Platform](https://cloud.google.com/sdk/gcloud/):
|
Otherwise by default you will be using the [Google Cloud Platform](https://cloud.google.com/sdk/gcloud/):
|
||||||
|
@ -75,12 +75,12 @@ $ make controllers
|
||||||
|
|
||||||
Build a local container image
|
Build a local container image
|
||||||
```console
|
```console
|
||||||
$ make docker-build PREFIX=$USER/ingress-controller
|
$ make docker-build TAG=<tag> PREFIX=$USER/ingress-controller
|
||||||
```
|
```
|
||||||
|
|
||||||
Push the container image to a remote repository
|
Push the container image to a remote repository
|
||||||
```console
|
```console
|
||||||
$ make docker-push PREFIX=$USER/ingress-controller
|
$ make docker-push TAG=<tag> PREFIX=$USER/ingress-controller
|
||||||
```
|
```
|
||||||
|
|
||||||
### GCE Controller
|
### GCE Controller
|
||||||
|
@ -90,7 +90,7 @@ $ make docker-push PREFIX=$USER/ingress-controller
|
||||||
## Deploying
|
## Deploying
|
||||||
|
|
||||||
There are several ways to deploy the ingress controller onto a cluster. If you don't have a cluster start by
|
There are several ways to deploy the ingress controller onto a cluster. If you don't have a cluster start by
|
||||||
creating one [here](setup_cluster.md).
|
creating one [here](setup-cluster.md).
|
||||||
|
|
||||||
* [nginx controller](../../examples/deployment/nginx/README.md)
|
* [nginx controller](../../examples/deployment/nginx/README.md)
|
||||||
* [gce controller](../../examples/deployment/gce/README.md)
|
* [gce controller](../../examples/deployment/gce/README.md)
|
|
@ -1,4 +1,4 @@
|
||||||
# Cluster getting Started
|
# Cluster Getting Started
|
||||||
|
|
||||||
This doc outlines the steps needed to setup a local dev cluster within which you
|
This doc outlines the steps needed to setup a local dev cluster within which you
|
||||||
can deploy/test an ingress controller. Note that you can also setup the ingress controller
|
can deploy/test an ingress controller. Note that you can also setup the ingress controller
|
|
@ -27,17 +27,13 @@ You can deploy the controller as follows:
|
||||||
$ minikube addons disable ingress
|
$ minikube addons disable ingress
|
||||||
```
|
```
|
||||||
2. Use the [docker daemon](https://github.com/kubernetes/minikube/blob/master/docs/reusing_the_docker_daemon.md)
|
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)
|
3. [Build the image](../../../docs/dev/getting-started.md)
|
||||||
4. Create the [default-backend](default-backend.yaml):
|
4. Change [nginx-ingress-controller.yaml](nginx-ingress-controller.yaml) to use the appropriate image. Local images can be
|
||||||
```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`.
|
seen by performing `docker images`.
|
||||||
```yaml
|
```yaml
|
||||||
image: <IMAGE-NAME>:<TAG>
|
image: <IMAGE-NAME>:<TAG>
|
||||||
```
|
```
|
||||||
6. Create the nginx-ingress-controller deployment:
|
5. Create the nginx-ingress-controller deployment:
|
||||||
```console
|
```console
|
||||||
$ kubectl apply -f nginx-ingress-controller.yaml
|
$ kubectl apply -f nginx-ingress-controller.yaml
|
||||||
deployment "nginx-ingress-controller" created
|
deployment "nginx-ingress-controller" created
|
||||||
|
|
|
@ -13,7 +13,7 @@ a 404 page.
|
||||||
|
|
||||||
## Controller
|
## Controller
|
||||||
|
|
||||||
The Nginx Ingress Controller uses nginx (surprisingly!) to loadbalancer requests that are coming to
|
The Nginx Ingress Controller uses nginx (surprisingly!) to loadbalance requests that are coming to
|
||||||
ports 80 and 443 to Services in the cluster.
|
ports 80 and 443 to Services in the cluster.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
|
|
Loading…
Reference in a new issue