Skip to content
Permalink
Browse files

docs(install,developer): update installation info

This updates the installation docs to (a) make the install docs more
reliable, and (b) make the developer docs clearer.
  • Loading branch information
technosophos committed Feb 14, 2018
1 parent e396730 commit 8a998a27b446ae27124dd40dfb07e68e36b46c5f
Showing with 21 additions and 10 deletions.
  1. +12 −4 docs/topics/developers.md
  2. +9 −6 docs/topics/install.md
@@ -83,13 +83,21 @@ Docker daemon:
$ eval $(minikube docker-env)
```

Running `make docker-build docker-push` will push the Brigade images to the Minikube Docker
Running `VERSION=latest make docker-build docker-push` will push the Brigade images to the Minikube Docker
daemon.

Now create a custom `values.yaml` file for the chart, and set the images to all
pull the `latest` image:

```
$ helm inspect values ./charts/brigade > myvalues.yaml
$ open myvalues.yaml # Change all `tag:` fields to be `tag: latest`
```

From here, you can install Brigade into Minikube using the Helm chart:

```
$ helm install -n brigade ./charts/brigade
$ helm install -n brigade ./charts/brigade -f myvalues.yaml
```

Don't forget to also create a project (`$ helm install -n empty-testbed charts/brigade-project`).
@@ -107,11 +115,11 @@ you will need to do two things:
## Running Brigade (brigade-server) Locally (against Minikube)

Assuing you have Brigade installed (either on minikube or another cluster) and
your `$KUBECONFIG` is pointing to that cluster, you can run `brigade` (brigade-server)
your `$KUBECONFIG` is pointing to that cluster, you can run `brigade-controller`
locally.

```
$ ./bin/brigade --kubeconfig $KUBECONFIG
$ ./bin/brigade-controller --kubeconfig $KUBECONFIG
```

(The default location for `$KUBECONFIG` on UNIX-like systems is `$HOME/.kube`.)
@@ -26,16 +26,17 @@ $ helm install brigade/brigade
If you are developing Brigade, or are interested in testing the latest features
(at the cost of additional time and energy), you can build Brigade from source.

The `master` branch typically contains newer code than the last release. However,
the charts will install the last released version.
This example shows how to check out the latest Brigade release:

```console
$ git clone https://github.com/azure/brigade.git
$ cd brigade
$ # optionally check out a tagged release: git checkout v0.5.0
$ git checkout $(git tag -l | tail -n 1)
$ helm install ./charts/brigade
```

(If you are interested in building from `master`, see the [developer docs](developer.md).)

Once you have Brigade installed, you can proceed to [creating a project](projects.md).
The remainder of this guide covers special configurations of Brigade.

@@ -46,11 +47,13 @@ The remainder of this guide covers special configurations of Brigade.
### Customizing Installations

Both of these options use the Brigade binaries stored in DockerHub. But you can override
this behavior by supplying an alternative image during install:
Both of these options use the latest Brigade release from DockerHub. But you can override
this behavior by supplying alternate images during installation.

For each component of Brigade, you can set it's image and tag separately:

```console
$ helm install brigade/brigade --set image.name=my-image --set image.tag=1.2.3
$ helm install brigade/brigade --set controller.name=my-image --set controller.tag=1.2.3
```

There are a variety of other configuration options for Brigade. Run `helm fetch values ./charts/brigade`

0 comments on commit 8a998a2

Please sign in to comment.
You can’t perform that action at this time.