Helm

module

v3.0.0-beta.1+incompat... Latest Latest Go to latest Published: Aug 26, 2019 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kubernetes/Helm

README ¶

Helm

Helm is a tool for managing Charts. Charts are packages of pre-configured Kubernetes resources.

Use Helm to:

Find and use popular software packaged as Helm Charts to run in Kubernetes
Share your own applications as Helm Charts
Create reproducible builds of your Kubernetes applications
Intelligently manage your Kubernetes manifest files
Manage releases of Helm packages

Helm in a Handbasket

Helm is a tool that streamlines installing and managing Kubernetes applications. Think of it like apt/yum/homebrew for Kubernetes.

Helm has two parts: a client (helm) and a library
The library renders your templates and communicates with the Kubernetes API
Helm runs on your laptop, CI/CD, or wherever you want it to run.
Charts are Helm packages that contain at least two things:
- A description of the package (Chart.yaml)
- One or more templates, which contain Kubernetes manifest files
Charts can be stored on disk, or fetched from remote chart repositories (like Debian or RedHat packages)

Install

Binary downloads of the Helm client can be found on the Releases page.

Unpack the helm binary and add it to your PATH and you are good to go!

If you want to use a package manager:

Homebrew users can use brew install kubernetes-helm.
Chocolatey users can use choco install kubernetes-helm.
Scoop users can use scoop install helm.
GoFish users can use gofish install helm.

To rapidly get Helm up and running, start with the Quick Start Guide.

See the installation guide for more options, including installing pre-releases.

Docs

Get started with the Quick Start guide or plunge into the complete documentation

Roadmap

The Helm roadmap uses Github milestones to track the progress of the project.

Community, discussion, contribution, and support

You can reach the Helm community and developers via the following channels:

Kubernetes Slack:
Mailing List:
- Helm Mailing List
Developer Call: Thursdays at 9:30-10:00 Pacific. https://zoom.us/j/696660622

Code of conduct

Participation in the Helm community is governed by the Code of Conduct.

Directories ¶

Path	Synopsis
cmd
helm
helm/require
helm/search Package search provides client-side repository searching.	Package search provides client-side repository searching.
internal
experimental/registry
ignore Package ignore provides tools for writing ignore files (a la .gitignore).	Package ignore provides tools for writing ignore files (a la .gitignore).
monocular Package monocular contains the logic for interacting with monocular instances like the Helm Hub.	Package monocular contains the logic for interacting with monocular instances like the Helm Hub.
resolver
sympath
test
test/ensure
tlsutil
urlutil
version
pkg
action Package action contains the logic for each action that Helm can perform.	Package action contains the logic for each action that Helm can perform.
chart
chart/loader
chartutil Package chartutil contains tools for working with charts.	Package chartutil contains tools for working with charts.
cli Package cli describes the operating environment for the Helm CLI.	Package cli describes the operating environment for the Helm CLI.
cli/values
downloader Package downloader provides a library for downloading charts.	Package downloader provides a library for downloading charts.
engine Package engine implements the Go template engine as a Tiller Engine.	Package engine implements the Go template engine as a Tiller Engine.
gates Package gates provides a general tool for working with experimental feature gates.	Package gates provides a general tool for working with experimental feature gates.
getter Package getter provides a generalize tool for fetching data by scheme.	Package getter provides a generalize tool for fetching data by scheme.
helmpath Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.	Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
helmpath/xdg
kube
kube/fake Package fake implements various fake KubeClients for use in testing	Package fake implements various fake KubeClients for use in testing
lint
lint/rules
lint/support Package support contains tools for linting charts.	Package support contains tools for linting charts.
plugin
plugin/cache Package cache provides a key generator for vcs urls.	Package cache provides a key generator for vcs urls.
plugin/installer Package installer provides an interface for installing Helm plugins.	Package installer provides an interface for installing Helm plugins.
provenance Package provenance provides tools for establishing the authenticity of a chart.	Package provenance provides tools for establishing the authenticity of a chart.
release
releaseutil
repo Package repo implements the Helm Chart Repository.	Package repo implements the Helm Chart Repository.
repo/repotest Package repotest provides utilities for testing.	Package repotest provides utilities for testing.
storage
storage/driver
strvals Package strvals provides tools for working with strval lines.	Package strvals provides tools for working with strval lines.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL