github.com/aaronmell/helm@v3.0.0-beta.2+incompatible/README.md (about)

     1  # Helm
     2  
     3  [![CircleCI](https://circleci.com/gh/helm/helm.svg?style=shield)](https://circleci.com/gh/helm/helm)
     4  [![Go Report Card](https://goreportcard.com/badge/github.com/helm/helm)](https://goreportcard.com/report/github.com/helm/helm)
     5  [![GoDoc](https://godoc.org/helm.sh/helm?status.svg)](https://godoc.org/helm.sh/helm)
     6  
     7  Helm is a tool for managing Charts. Charts are packages of pre-configured Kubernetes resources.
     8  
     9  Use Helm to:
    10  
    11  - Find and use [popular software packaged as Helm Charts](https://github.com/helm/charts) to run in Kubernetes
    12  - Share your own applications as Helm Charts
    13  - Create reproducible builds of your Kubernetes applications
    14  - Intelligently manage your Kubernetes manifest files
    15  - Manage releases of Helm packages
    16  
    17  ## Helm in a Handbasket
    18  
    19  Helm is a tool that streamlines installing and managing Kubernetes applications.
    20  Think of it like apt/yum/homebrew for Kubernetes.
    21  
    22  - Helm has two parts: a client (`helm`) and a library
    23  - The library renders your templates and communicates with the Kubernetes API
    24  - Helm runs on your laptop, CI/CD, or wherever you want it to run.
    25  - Charts are Helm packages that contain at least two things:
    26    - A description of the package (`Chart.yaml`)
    27    - One or more templates, which contain Kubernetes manifest files
    28  - Charts can be stored on disk, or fetched from remote chart repositories
    29    (like Debian or RedHat packages)
    30  
    31  ## Install
    32  
    33  
    34  Binary downloads of the Helm client can be found on [the Releases page](https://github.com/helm/helm/releases/latest).
    35  
    36  Unpack the `helm` binary and add it to your PATH and you are good to go!
    37  
    38  If you want to use a package manager:
    39  
    40  - [Homebrew](https://brew.sh/) users can use `brew install kubernetes-helm`.
    41  - [Chocolatey](https://chocolatey.org/) users can use `choco install kubernetes-helm`.
    42  - [Scoop](https://scoop.sh/) users can use `scoop install helm`.
    43  - [GoFish](https://gofi.sh/) users can use `gofish install helm`.
    44  
    45  To rapidly get Helm up and running, start with the [Quick Start Guide](https://docs.helm.sh/using_helm/#quickstart-guide).
    46  
    47  See the [installation guide](https://docs.helm.sh/using_helm/#installing-helm) for more options,
    48  including installing pre-releases.
    49  
    50  ## Docs
    51  
    52  Get started with the [Quick Start guide](https://docs.helm.sh/using_helm/#quickstart-guide) or plunge into the [complete documentation](https://docs.helm.sh)
    53  
    54  ## Roadmap
    55  
    56  The [Helm roadmap uses Github milestones](https://github.com/helm/helm/milestones) to track the progress of the project.
    57  
    58  ## Community, discussion, contribution, and support
    59  
    60  You can reach the Helm community and developers via the following channels:
    61  
    62  - [Kubernetes Slack](https://kubernetes.slack.com):
    63    - [#helm-users](https://kubernetes.slack.com/messages/helm-users)
    64    - [#helm-dev](https://kubernetes.slack.com/messages/helm-dev)
    65    - [#charts](https://kubernetes.slack.com/messages/charts)
    66  - Mailing List:
    67    - [Helm Mailing List](https://lists.cncf.io/g/cncf-helm)
    68  - Developer Call: Thursdays at 9:30-10:00 Pacific. [https://zoom.us/j/696660622](https://zoom.us/j/696660622)
    69  
    70  ### Code of conduct
    71  
    72  Participation in the Helm community is governed by the [Code of Conduct](code-of-conduct.md).