From ef499aaff1820008ba5deaa23f874db8783ed9d5 Mon Sep 17 00:00:00 2001 From: Fernando Diaz Date: Thu, 3 Aug 2017 11:29:02 -0500 Subject: [PATCH] Minor fixes for Development Documentation Further cleans up the development documentation with spacing and more readable text. --- docs/dev/README.md | 6 +++--- ...stom_controller.md => custom-controller.md} | 0 .../{getting_started.md => getting-started.md} | 18 +++++++++--------- .../dev/{setup_cluster.md => setup-cluster.md} | 2 +- examples/deployment/nginx/README.md | 10 +++------- examples/deployment/nginx/kubeadm/README.md | 2 +- 6 files changed, 17 insertions(+), 21 deletions(-) rename docs/dev/{custom_controller.md => custom-controller.md} (100%) rename docs/dev/{getting_started.md => getting-started.md} (91%) rename docs/dev/{setup_cluster.md => setup-cluster.md} (99%) diff --git a/docs/dev/README.md b/docs/dev/README.md index 134d81342..968ffc3da 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md @@ -12,7 +12,7 @@ branch, but release branches of Kubernetes should not change. ## Navigation -* [Build, test, release](getting_started.md) an existing controller -* [Setup a cluster](setup_cluster.md) to hack at an existing controller -* [Write your own](custom_controller.md) controller +* [Build, test, release](getting-started.md) an existing controller +* [Setup a cluster](setup-cluster.md) to hack at an existing controller +* [Write your own](custom-controller.md) controller diff --git a/docs/dev/custom_controller.md b/docs/dev/custom-controller.md similarity index 100% rename from docs/dev/custom_controller.md rename to docs/dev/custom-controller.md diff --git a/docs/dev/getting_started.md b/docs/dev/getting-started.md similarity index 91% rename from docs/dev/getting_started.md rename to docs/dev/getting-started.md index f0c5357d0..fec83823c 100644 --- a/docs/dev/getting_started.md +++ b/docs/dev/getting-started.md @@ -9,7 +9,7 @@ The build uses dependencies in the `ingress/vendor` directory, which must be installed before building a binary/image. Occasionally, you might need to update the dependencies. -This guide requires you to install the[godep](https://github.com/tools/godep)dependency +This guide requires you to install the [godep](https://github.com/tools/godep) dependency tool. Check the version of `godep` you are using and make sure it is up to date. @@ -32,7 +32,7 @@ $ cd $GOPATH/src/ingress $ godep save ./... ``` -In general, you can follow [this guide](https://github.com/kubernetes/kubernetes/blob/release-1.5/docs/devel/godep.md#using-godep-to-manage-dependencies)to update dependencies. +In general, you can follow [this guide](https://github.com/kubernetes/kubernetes/blob/release-1.5/docs/devel/godep.md#using-godep-to-manage-dependencies) to update dependencies. To update a particular dependency, eg: Kubernetes: ```console $ cd $GOPATH/src/k8s.io/ingress @@ -54,10 +54,10 @@ requirements you can build a raw server binary, a local container image, or push an image to a remote repository. 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 -* export DOCKER=docker -* export REGISTRY=index.docker.io - +```console +$ export DOCKER=docker +$ export 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/): @@ -75,12 +75,12 @@ $ make controllers Build a local container image ```console -$ make docker-build PREFIX=$USER/ingress-controller +$ make docker-build TAG= PREFIX=$USER/ingress-controller ``` Push the container image to a remote repository ```console -$ make docker-push PREFIX=$USER/ingress-controller +$ make docker-push TAG= PREFIX=$USER/ingress-controller ``` ### GCE Controller @@ -90,7 +90,7 @@ $ make docker-push PREFIX=$USER/ingress-controller ## Deploying 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) * [gce controller](../../examples/deployment/gce/README.md) diff --git a/docs/dev/setup_cluster.md b/docs/dev/setup-cluster.md similarity index 99% rename from docs/dev/setup_cluster.md rename to docs/dev/setup-cluster.md index cb82c0483..06aa9a630 100644 --- a/docs/dev/setup_cluster.md +++ b/docs/dev/setup-cluster.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 can deploy/test an ingress controller. Note that you can also setup the ingress controller diff --git a/examples/deployment/nginx/README.md b/examples/deployment/nginx/README.md index df30d39a8..2eff41f2b 100644 --- a/examples/deployment/nginx/README.md +++ b/examples/deployment/nginx/README.md @@ -27,17 +27,13 @@ You can deploy the controller as follows: $ 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 +3. [Build the image](../../../docs/dev/getting-started.md) +4. 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: : ``` -6. Create the nginx-ingress-controller deployment: +5. Create the nginx-ingress-controller deployment: ```console $ kubectl apply -f nginx-ingress-controller.yaml deployment "nginx-ingress-controller" created diff --git a/examples/deployment/nginx/kubeadm/README.md b/examples/deployment/nginx/kubeadm/README.md index 49bdbf1a7..3cb0f0b85 100644 --- a/examples/deployment/nginx/kubeadm/README.md +++ b/examples/deployment/nginx/kubeadm/README.md @@ -13,7 +13,7 @@ a 404 page. ## 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. ```console