github.com/zoumo/helm@v2.5.0+incompatible/docs/quickstart.md (about)

     1  # Quickstart Guide
     2  
     3  This guide covers how you can quickly get started using Helm.
     4  
     5  ## Prerequisites
     6  
     7  - You must have Kubernetes installed. We recommend version 1.4.1 or
     8    later.
     9  - You should also have a local configured copy of `kubectl`.
    10  
    11  Helm will figure out where to install Tiller by reading your Kubernetes
    12  configuration file (usually `$HOME/.kube/config`). This is the same file
    13  that `kubectl` uses.
    14  
    15  To find out which cluster Tiller would install to, you can run
    16  `kubectl config current-context` or `kubectl cluster-info`.
    17  
    18  ```console
    19  $ kubectl config current-context
    20  my-cluster
    21  ```
    22  
    23  ## Install Helm
    24  
    25  Download a binary release of the Helm client. You can use tools like
    26  `homebrew`, or look at [the official releases page](https://github.com/kubernetes/helm/releases).
    27  
    28  For more details, or for other options, see [the installation
    29  guide](install.md).
    30  
    31  ## Initialize Helm and Install Tiller
    32  
    33  Once you have Helm ready, you can initialize the local CLI and also
    34  install Tiller into your Kubernetes cluster in one step:
    35  
    36  ```console
    37  $ helm init
    38  ```
    39  
    40  This will install Tiller into the Kubernetes cluster you saw with
    41  `kubectl config current-context`.
    42  
    43  **TIP:** Want to install into a different cluster? Use the
    44  `--kube-context` flag.
    45  
    46  **TIP:** When you want to upgrade Tiller, just run `helm init --upgrade`.
    47  
    48  ## Install an Example Chart
    49  
    50  To install a chart, you can run the `helm install` command. Helm has
    51  several ways to find and install a chart, but the easiest is to use one
    52  of the official `stable` charts.
    53  
    54  ```console
    55  $ helm repo update              # Make sure we get the latest list of charts
    56  $ helm install stable/mysql
    57  Released smiling-penguin
    58  ```
    59  
    60  In the example above, the `stable/mysql` chart was released, and the name of
    61  our new release is `smiling-penguin`. You get a simple idea of the
    62  features of this MySQL chart by running `helm inspect stable/mysql`.
    63  
    64  Whenever you install a chart, a new release is created. So one chart can
    65  be installed multiple times into the same cluster. And each can be
    66  independently managed and upgraded.
    67  
    68  The `helm install` command is a very powerful command with many
    69  capabilities. To learn more about it, check out the [Using Helm
    70  Guide](using_helm.md)
    71  
    72  ## Learn About Releases
    73  
    74  It's easy to see what has been released using Helm:
    75  
    76  ```console
    77  $ helm ls
    78  NAME           	VERSION	 UPDATED                       	STATUS         	CHART
    79  smiling-penguin	 1      	Wed Sep 28 12:59:46 2016      	DEPLOYED       	mysql-0.1.0
    80  ```
    81  
    82  The `helm list` function will show you a list of all deployed releases.
    83  
    84  ## Uninstall a Release
    85  
    86  To uninstall a release, use the `helm delete` command:
    87  
    88  ```console
    89  $ helm delete smiling-penguin
    90  Removed smiling-penguin
    91  ```
    92  
    93  This will uninstall `smiling-penguin` from Kubernetes, but you will
    94  still be able to request information about that release:
    95  
    96  ```console
    97  $ helm status smiling-penguin
    98  Status: DELETED
    99  ...
   100  ```
   101  
   102  Because Helm tracks your releases even after you've deleted them, you
   103  can audit a cluster's history, and even undelete a release (with `helm
   104  rollback`).
   105  
   106  ## Reading the Help Text
   107  
   108  To learn more about the available Helm commands, use `helm help` or type
   109  a command followed by the `-h` flag:
   110  
   111  ```console
   112  $ helm get -h
   113  ```