From fed862985e77a8e65890f5b776dfc86108f9bb68 Mon Sep 17 00:00:00 2001 From: Jess Frazelle Date: Mon, 22 Aug 2016 11:18:28 -0700 Subject: [PATCH] add docs table of contents and update quick start Signed-off-by: Jess Frazelle --- README.md | 19 +++++++------------ docs/quickstart.md | 33 +++++++++++++++++++++++++-------- 2 files changed, 32 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index a6399a9f4..753304e08 100644 --- a/README.md +++ b/README.md @@ -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 (like Debian or RedHat packages) -Using Helm is as easy as this: +## Docs -```console -$ helm init # Initialize Helm as well as the Tiller server +- [Quick Start](docs/quickstart.md) +- [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 diff --git a/docs/quickstart.md b/docs/quickstart.md index 8d2c505a8..8df5a629a 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -9,8 +9,8 @@ This guide covers how you can quickly get started using Helm. ## Install Helm -Download a binary release of the Helm client from the official project -page. +Download a binary release of the Helm client from +[the official project page](https://github.com/kubernetes/helm/releases). Alternately, you can clone the GitHub project and build your own 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 ``` -## 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 -$ helm install nginx-1.0.0 +$ helm install docs/examples/alpine Released smiling-penguin ``` -In the example above, the `nginx` chart was released, and the name of -our new release is `smiling-penguin` +In the example above, the `alpine` chart was released, and the name of +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