README.md

Documentation: helm.sh/helm/v3

     1# Helm
     2
     3[![Build Status](https://github.com/helm/helm/workflows/release/badge.svg)](https://github.com/helm/helm/actions?workflow=release)
     4[![Go Report Card](https://goreportcard.com/badge/github.com/helm/helm)](https://goreportcard.com/report/github.com/helm/helm)
     5[![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/helm.sh/helm/v3)
     6[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3131/badge)](https://bestpractices.coreinfrastructure.org/projects/3131)
     7
     8Helm is a tool for managing Charts. Charts are packages of pre-configured Kubernetes resources.
     9
    10Use Helm to:
    11
    12- Find and use [popular software packaged as Helm Charts](https://artifacthub.io/packages/search?kind=0) to run in Kubernetes
    13- Share your own applications as Helm Charts
    14- Create reproducible builds of your Kubernetes applications
    15- Intelligently manage your Kubernetes manifest files
    16- Manage releases of Helm packages
    17
    18## Helm in a Handbasket
    19
    20Helm is a tool that streamlines installing and managing Kubernetes applications.
    21Think of it like apt/yum/homebrew for Kubernetes.
    22
    23- Helm 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
    33Binary downloads of the Helm client can be found on [the Releases page](https://github.com/helm/helm/releases/latest).
    34
    35Unpack the `helm` binary and add it to your PATH and you are good to go!
    36
    37If you want to use a package manager:
    38
    39- [Homebrew](https://brew.sh/) users can use `brew install helm`.
    40- [Chocolatey](https://chocolatey.org/) users can use `choco install kubernetes-helm`.
    41- [Scoop](https://scoop.sh/) users can use `scoop install helm`.
    42- [Snapcraft](https://snapcraft.io/) users can use `snap install helm --classic`
    43
    44To rapidly get Helm up and running, start with the [Quick Start Guide](https://helm.sh/docs/intro/quickstart/).
    45
    46See the [installation guide](https://helm.sh/docs/intro/install/) for more options,
    47including installing pre-releases.
    48
    49## Docs
    50
    51Get started with the [Quick Start guide](https://helm.sh/docs/intro/quickstart/) or plunge into the [complete documentation](https://helm.sh/docs)
    52
    53## Roadmap
    54
    55The [Helm roadmap uses GitHub milestones](https://github.com/helm/helm/milestones) to track the progress of the project.
    56
    57## Community, discussion, contribution, and support
    58
    59You can reach the Helm community and developers via the following channels:
    60
    61- [Kubernetes Slack](https://kubernetes.slack.com):
    62  - [#helm-users](https://kubernetes.slack.com/messages/helm-users)
    63  - [#helm-dev](https://kubernetes.slack.com/messages/helm-dev)
    64  - [#charts](https://kubernetes.slack.com/messages/charts)
    65- Mailing List:
    66  - [Helm Mailing List](https://lists.cncf.io/g/cncf-helm)
    67- Developer Call: Thursdays at 9:30-10:00 Pacific ([meeting details](https://github.com/helm/community/blob/master/communication.md#meetings))
    68
    69### Contribution
    70
    71If you're interested in contributing, please refer to the [Contributing Guide](CONTRIBUTING.md) **before submitting a pull request**.
    72
    73### Code of conduct
    74
    75Participation in the Helm community is governed by the [Code of Conduct](code-of-conduct.md).
View as plain text