github.com/umeshredd/helm@v3.0.0-alpha.1+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  The following prerequisites are required for a successful and properly secured use of Helm.
     8  
     9  1. A Kubernetes cluster
    10  2. Deciding what security configurations to apply to your installation, if any
    11  3. Installing and configuring Helm.
    12  
    13  
    14  ### Install Kubernetes or have access to a cluster
    15  - You must have Kubernetes installed. For the latest release of Helm, we recommend the latest stable release of Kubernetes, which in most cases is the second-latest minor release.
    16  - You should also have a local configured copy of `kubectl`.
    17  
    18  NOTE: Kubernetes versions prior to 1.6 have limited or no support for role-based access controls (RBAC).
    19  
    20  
    21  ### Understand your Security Context
    22  
    23  As with all powerful tools, ensure you are installing it correctly for your scenario.
    24  
    25  If you're using Helm on a cluster that you completely control, like minikube or a cluster on a private network in which sharing is not a concern, the default installation -- which applies no security configuration -- is fine, and it's definitely the easiest. To install Helm without additional security steps, [install Helm](#Install-Helm) and then [initialize Helm](#initialize-helm).
    26  
    27  However, if your cluster is exposed to a larger network or if you share your cluster with others -- production clusters fall into this category -- you must take extra steps to secure your installation to prevent careless or malicious actors from damaging the cluster or its data. To apply configurations that secure Helm for use in production environments and other multi-tenant scenarios, see [Securing a Helm installation](securing_installation.md)
    28  
    29  If your cluster has Role-Based Access Control (RBAC) enabled, you may want
    30  to [configure a service account and rules](rbac.md) before proceeding.
    31  
    32  ## Install Helm
    33  
    34  Download a binary release of the Helm client. You can use tools like
    35  `homebrew`, or look at [the official releases page](https://github.com/helm/helm/releases).
    36  
    37  For more details, or for other options, see [the installation
    38  guide](install.md).
    39  
    40  ## Initialize Helm
    41  
    42  Once you have Helm ready, you can initialize the local CLI:
    43  
    44  ```console
    45  $ helm init
    46  ```
    47  
    48  
    49  ## Install an Example Chart
    50  
    51  To install a chart, you can run the `helm install` command. Helm has
    52  several ways to find and install a chart, but the easiest is to use one
    53  of the official `stable` charts.
    54  
    55  ```console
    56  $ helm repo update              # Make sure we get the latest list of charts
    57  $ helm install stable/mysql
    58  Released smiling-penguin
    59  ```
    60  
    61  In the example above, the `stable/mysql` chart was released, and the name of
    62  our new release is `smiling-penguin`. You get a simple idea of the
    63  features of this MySQL chart by running `helm inspect stable/mysql`.
    64  
    65  Whenever you install a chart, a new release is created. So one chart can
    66  be installed multiple times into the same cluster. And each can be
    67  independently managed and upgraded.
    68  
    69  The `helm install` command is a very powerful command with many
    70  capabilities. To learn more about it, check out the [Using Helm
    71  Guide](using_helm.md)
    72  
    73  ## Learn About Releases
    74  
    75  It's easy to see what has been released using Helm:
    76  
    77  ```console
    78  $ helm ls
    79  NAME             VERSION   UPDATED                   STATUS    CHART
    80  smiling-penguin  1         Wed Sep 28 12:59:46 2016  DEPLOYED  mysql-0.1.0
    81  ```
    82  
    83  The `helm list` function will show you a list of all deployed releases.
    84  
    85  ## Uninstall a Release
    86  
    87  To uninstall a release, use the `helm uninstall` command:
    88  
    89  ```console
    90  $ helm uninstall smiling-penguin
    91  Removed smiling-penguin
    92  ```
    93  
    94  This will uninstall `smiling-penguin` from Kubernetes, but you will
    95  still be able to request information about that release:
    96  
    97  ```console
    98  $ helm status smiling-penguin
    99  Status: UNINSTALLED
   100  ...
   101  ```
   102  
   103  Because Helm tracks your releases even after you've uninstalled them, you
   104  can audit a cluster's history, and even undelete a release (with `helm
   105  rollback`).
   106  
   107  ## Reading the Help Text
   108  
   109  To learn more about the available Helm commands, use `helm help` or type
   110  a command followed by the `-h` flag:
   111  
   112  ```console
   113  $ helm get -h
   114  ```