add docs table of contents and update quick start

Signed-off-by: Jess Frazelle <me@jessfraz.com>
pull/1088/head
Jess Frazelle 8 years ago
parent 77171c0136
commit fed862985e
No known key found for this signature in database
GPG Key ID: 18F3685C0022BFF3

@ -28,20 +28,15 @@ Think of it like apt/yum/homebrew for Kubernetes.
- Charts can be stored on disk, or fetched from remote chart repositories - Charts can be stored on disk, or fetched from remote chart repositories
(like Debian or RedHat packages) (like Debian or RedHat packages)
Using Helm is as easy as this: ## Docs
```console - [Quick Start](docs/quickstart.md)
$ helm init # Initialize Helm as well as the Tiller server - [Architechture](docs/architecture.md)
- [Charts](docs/charts.md)
- [Chart Repository Guide](docs/chart_repository.md)
- [Syncing your Chart Repository](docs/chart_repository_sync_example.md)
- [Developers](docs/developers.md)
# From the root of this repository run the following to install an example from
the docs
$ helm install docs/examples/alpine # Install the example Alpine chart
happy-panda # <-- That's the name of your release
$ helm list # List all releases
happy-panda
quiet-kitten
```
## Install ## Install

@ -9,8 +9,8 @@ This guide covers how you can quickly get started using Helm.
## Install Helm ## Install Helm
Download a binary release of the Helm client from the official project Download a binary release of the Helm client from
page. [the official project page](https://github.com/kubernetes/helm/releases).
Alternately, you can clone the GitHub project and build your own Alternately, you can clone the GitHub project and build your own
client from source. The quickest route to installing from source is to client from source. The quickest route to installing from source is to
@ -25,19 +25,36 @@ install Tiller into your Kubernetes cluster in one step:
$ helm init $ helm init
``` ```
## Install an Existing Chart ## Install an Example Chart
To install an existing chart, you can run the `helm install` command: To install a chart, you can run the `helm install` command.
Let's use an example chart from this repository.
Make sure you are in the root directory of this repo.
_TODO:_ Might need instructions about repos.
```console ```console
$ helm install nginx-1.0.0 $ helm install docs/examples/alpine
Released smiling-penguin Released smiling-penguin
``` ```
In the example above, the `nginx` chart was released, and the name of In the example above, the `alpine` chart was released, and the name of
our new release is `smiling-penguin` our new release is `smiling-penguin`. You can view the details of the chart we just
installed by taking a look at the nginx chart in
[docs/examples/alpine/Chart.yaml](docs/examples/alpine/Chart.yaml).
## Change a Default Chart Value
A nice feature of helm is the ability to change certain values of the package for the install.
Let's install the `nginx` example from this repository but change the `replicaCount` to 7.
```console
$ helm install --set replicaCount=7 docs/examples/nginx
happy-panda
```
You can view the chart for this example in
[docs/examples/nginx/Chart.yaml](docs/examples/nginx/Chart.yaml) and the default values in
[docs/examples/nginx/values.yaml](docs/examples/nginx/values.yaml).
## Learn About The Release ## Learn About The Release

Loading…
Cancel
Save