mirror of https://github.com/helm/helm
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
76 lines
1.6 KiB
76 lines
1.6 KiB
# Quickstart Guide
|
|
|
|
This guide covers how you can quickly get started using Helm.
|
|
|
|
## Prerequisites
|
|
|
|
- You must have Kubernetes installed, and have a local configured copy
|
|
of `kubectl`.
|
|
|
|
## Install Helm
|
|
|
|
Download a binary release of the Helm client from the official project
|
|
page.
|
|
|
|
Alternately, you can clone the GitHub project and build your own
|
|
client from source. The quickest route to installing from source is to
|
|
run `make boostrap build`, and then use `bin/helm`.
|
|
|
|
## Initialize Helm and Install Tiller
|
|
|
|
Once you have Helm ready, you can initialize the local CLI and also
|
|
install Tiller into your Kubernetes cluster in one step:
|
|
|
|
```console
|
|
$ helm init
|
|
```
|
|
|
|
## Install an Existing Chart
|
|
|
|
To install an existing chart, you can run the `helm install` command:
|
|
|
|
_TODO:_ Might need instructions about repos.
|
|
|
|
```console
|
|
$ helm install nginx-1.0.0
|
|
Released smiling-penguin
|
|
```
|
|
|
|
In the example above, the `nginx` chart was released, and the name of
|
|
our new release is `smiling-penguin`
|
|
|
|
## Learn About The Release
|
|
|
|
To find out about our release, run `helm status`:
|
|
|
|
```console
|
|
$ helm status smiling-penguin
|
|
Status: DEPLOYED
|
|
```
|
|
|
|
## Uninstall a Release
|
|
|
|
To remove a release, use the `helm remove` command:
|
|
|
|
```console
|
|
$ helm remove smiling-penguin
|
|
Removed smiling-penguin
|
|
```
|
|
|
|
This will uninstall `smiling-penguin` from Kubernetes, but you will
|
|
still be able to request information about that release:
|
|
|
|
```console
|
|
$ helm status smiling-penguin
|
|
Status: DELETED
|
|
```
|
|
|
|
## Reading the Help Text
|
|
|
|
To learn more about the available Helm commands, use `helm help` or type
|
|
a command followed by the `-h` flag:
|
|
|
|
```console
|
|
$ helm get -h
|
|
```
|