Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more descriptive steps in Dev Documentation #1065

Merged
merged 3 commits into from
Aug 4, 2017
Merged

Add more descriptive steps in Dev Documentation #1065

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
86b52fa
Add more descriptive steps in Dev Documentation
Aug 3, 2017
ef499aa
Minor fixes for Development Documentation
Aug 3, 2017
827658a
Add common Env-Variable options to Dev Docs
Aug 3, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/dev/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 docs/dev/custom_controller.md → docs/dev/custom-controller.md
View file
Open in desktop
File renamed without changes.
18 changes: 9 additions & 9 deletions docs/dev/getting_started.md → docs/dev/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -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=<your-docker-registry>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about this as a tradeoff, list common options like:

# "gcloud docker" (default) or "docker"
$ export DOCKER=<docker>

# "gcr.io/google_containers" (default), "index.docker.io", or your own registry
$ export REGISTRY=<registry>

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect, updated!

```
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/):
Expand All @@ -75,12 +75,12 @@ $ make controllers

Build a local container image
```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
```console
$ make docker-push PREFIX=$USER/ingress-controller
$ make docker-push TAG=<tag> PREFIX=$USER/ingress-controller
```

### GCE Controller
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/setup_cluster.md → docs/dev/setup-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
10 changes: 3 additions & 7 deletions examples/deployment/nginx/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <IMAGE-NAME>:<TAG>
```
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
Expand Down
2 changes: 1 addition & 1 deletion examples/deployment/nginx/kubeadm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down