root
/
helm
mirror of https://github.com/helm/helm.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity
helm/README.md

87 lines
4.4 KiB
Markdown
Raw Permalink Normal View History

docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
2019-03-06 03:57:39 +08:00
# Helm
feat(tiller): stub out environment
2016-04-12 03:26:33 +08:00
Updates based on feedback Signed-off-by: Andrew Block <andy.block@gmail.com>
2023-02-27 11:22:30 +08:00
[![Build Status](https://github.com/helm/helm/workflows/release/badge.svg)](https://github.com/helm/helm/actions?workflow=release)
fix: Fix go report card badge reference/link Signed-off-by: George Jenkins <gvjenkins@gmail.com>
2025-03-02 09:50:15 +08:00
[![Go Report Card](https://goreportcard.com/badge/helm.sh/helm/v4)](https://goreportcard.com/report/helm.sh/helm/v4)
Updating to helm.sh/helm/v4 Since Helm is going through breaking changes with Helm v4, the version path to Helm needs to be updated. Signed-off-by: Matt Farina <matt.farina@suse.com>
2024-12-27 05:33:51 +08:00
[![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/helm.sh/helm/v4)
docs: Add best practices compliance badge (#6320) This is now required by CNCF for graduation from incubation. Signed-off-by: Matt Butcher <matt.butcher@microsoft.com>
2019-08-31 03:06:38 +08:00
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3131/badge)](https://bestpractices.coreinfrastructure.org/projects/3131)
Added the scorecard github action and its badge Signed-off-by: harshitasao <harshitasao@gmail.com>
2024-08-06 08:09:03 +08:00
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/helm/helm/badge)](https://scorecard.dev/viewer/?uri=github.com/helm/helm)
fix: LFX health score badge link Signed-off-by: Gašper Grom <gasper.grom@gmail.com>
2025-07-19 14:17:54 +08:00
[![LFX Health Score](https://insights.production.lfx.dev/api/badge/health-score?project=helm)](https://insights.linuxfoundation.org/project/helm)
docs(ci): add cicleci badge to readme
2016-07-07 01:38:34 +08:00
docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
2019-03-06 03:57:39 +08:00
Helm is a tool for managing Charts. Charts are packages of pre-configured Kubernetes resources.
feat(tiller): stub out environment
2016-04-12 03:26:33 +08:00
Update README.md There should be a colon because it precedes an explanation or an enumeration, or list.
2017-10-19 14:14:28 +08:00
Use Helm to:
fix(README): add features list
2016-04-29 07:09:33 +08:00
Replace Helm Hub with Artifact Hub (#8626) * Replace Helm Hub with Artifact Hub Signed-off-by: Scott Rigby <scott@r6by.com> * Update link to new doc entry for Monocular compatible search API Signed-off-by: Scott Rigby <scott@r6by.com> * Add struct for Artifact Hub data, and return correct URL for both artifact hub instances and backwards compatibility for Monocular search API Signed-off-by: Scott Rigby <scott@r6by.com> * Keep default endpoint hub.helm.sh, so the helm org controls the domain. At least until artifacthub moves to CNCF incubation Signed-off-by: Scott Rigby <scott@r6by.com>
2020-12-18 03:17:04 +08:00
- Find and use [popular software packaged as Helm Charts](https://artifacthub.io/packages/search?kind=0) to run in Kubernetes
docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
2019-03-06 03:57:39 +08:00
- Share your own applications as Helm Charts
docs(README): update README with basic information The README reflected an earlier stage of project development. This update gives more useful "Why Helm?" documentation at the top, and updates several of the instructions to be more reflective of current status.
2016-07-20 21:30:10 +08:00
- 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.
Removed inaccurate statement re library (#6771) This PR is a self-admitted exercise in pedantry. The previous wording suggested a distinction between the Helm client and Helm library, but from a user perspective the usage of the library is hidden. As a user, I use the Helm client to render my templates and communicate with k8s, so mentioning the library in this section reduces clarity. Signed-off-by: Mike Ryan <mike@fadedink.co.uk>
2019-10-24 18:34:20 +08:00
- Helm renders your templates and communicates with the Kubernetes API
docs(README): update README with basic information The README reflected an earlier stage of project development. This update gives more useful "Why Helm?" documentation at the top, and updates several of the instructions to be more reflective of current status.
2016-07-20 21:30:10 +08:00
- 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)
Updating to helm.sh/helm/v4 Since Helm is going through breaking changes with Helm v4, the version path to Helm needs to be updated. Signed-off-by: Matt Farina <matt.farina@suse.com>
2024-12-27 05:33:51 +08:00
## Helm Development and Stable Versions
Helm v4 is currently under development on the `main` branch. This is unstable and the APIs within the Go SDK and at the command line are changing.
Helm v3 (current stable) is maintained on the `dev-v3` branch. APIs there follow semantic versioning.
docs(README): remove the build from source instructions docs/developers.md already has these instructions. And 80% of the time someone looking at this project is interested in getting started not hacking directly.
2016-09-11 05:04:13 +08:00
## Install
docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
2019-03-06 03:57:39 +08:00
Binary downloads of the Helm client can be found on [the Releases page](https://github.com/helm/helm/releases/latest).
docs(README): update download information
2016-10-11 02:59:06 +08:00
Update docs for homebrew formula
2016-12-22 02:26:32 +08:00
Unpack the `helm` binary and add it to your PATH and you are good to go!
Updates readme with choco install command
2018-04-06 05:51:21 +08:00
If you want to use a package manager:
Signed-off-by: Jonathan Meyers <jonathan@cybrary.it>
2019-11-18 14:35:01 +08:00
- [Homebrew](https://brew.sh/) users can use `brew install helm`.
docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
2019-03-06 03:57:39 +08:00
- [Chocolatey](https://chocolatey.org/) users can use `choco install kubernetes-helm`.
ading info to install helm , referring the documentation Signed-off-by: shahbazaamir <shahbaz07dbit@gmail.com>
2025-01-12 02:41:47 +08:00
- [Winget](https://learn.microsoft.com/en-us/windows/package-manager/) users can use `winget install Helm.Helm`.
docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
2019-03-06 03:57:39 +08:00
- [Scoop](https://scoop.sh/) users can use `scoop install helm`.
Doc: add Flox as an installation option. Amending for new checks to run. Signed-off-by: Bryan Honof <bryan@floxdev.com> Signed-off-by: Robert Sirchia <rsirchia@outlook.com>
2024-07-31 16:59:09 +08:00
- [Snapcraft](https://snapcraft.io/) users can use `snap install helm --classic`.
- [Flox](https://flox.dev) users can use `flox install kubernetes-helm`.
docs(README): remove the build from source instructions docs/developers.md already has these instructions. And 80% of the time someone looking at this project is interested in getting started not hacking directly.
2016-09-11 05:04:13 +08:00
Fix Quick Start Guide Link in README.md The previous link https://docs.helm.sh/using_helm/#quickstart-guide was redirecting into https://helm.sh/ja/docs/intro/ which is a Japanese version of the docs. I've fixed the link so it goes into the English version instead. Signed-off-by: Tero <31454692+tero-dev@users.noreply.github.com>
2020-08-06 22:00:14 +08:00
To rapidly get Helm up and running, start with the [Quick Start Guide](https://helm.sh/docs/intro/quickstart/).
feat(helm): remove the requirement that fetch/install need version This removes the requirement that a fetch or install command must explicitly state the version number to install. Instead, this goes to the strategy used by OS package managers: Install the latest until told to do otherwise. Closes #1198
2016-10-06 02:43:06 +08:00
fix(reame): update links to docs Signed-off-by: flynnduism <flynnduism@gmail.com>
2019-11-13 06:27:30 +08:00
See the [installation guide](https://helm.sh/docs/intro/install/) for more options,
docs(install): Add information on using canary releases This includes documentation on how to use Helm and Tiller canary releases.
2016-10-05 05:48:08 +08:00
including installing pre-releases.
add docs table of contents and update quick start Signed-off-by: Jess Frazelle <me@jessfraz.com>
2016-08-23 02:18:28 +08:00
## Docs
docs(README): update README with basic information The README reflected an earlier stage of project development. This update gives more useful "Why Helm?" documentation at the top, and updates several of the instructions to be more reflective of current status.
2016-07-20 21:30:10 +08:00
[docs] Typofix in README Signed-off-by: André Pedersen <andrped94@gmail.com>
2025-06-26 01:29:54 +08:00
Get started with the [Quick Start guide](https://helm.sh/docs/intro/quickstart/) or plunge into the [complete documentation](https://helm.sh/docs).
feat(README): add community contact points Add the sig-apps mailing list, developer call details, and #helm slack channel. Based on https://github.com/kubernetes/kubernetes-template-project/blob/master/README.md
2016-09-13 08:22:45 +08:00
feat(README): Adding roadmap location To exit incubation the roadmap needs to be listed in the wiki per the incubator documentation. For more detail see https://github.com/kubernetes/community/blob/master/incubator.md
2017-02-02 23:12:36 +08:00
## Roadmap
chore: Spelling (#9410) * spelling: annotate Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: asserts Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: behavior Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: binary Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: contain Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: copied Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: dependency Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: depending Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: deprecated Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: doesn't Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: donot Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: github Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: inputting Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: iteration Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: jabberwocky Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: kubernetes Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: length Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: mismatch Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: multiple Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: nonexistent Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: outputs Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: panicking Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: plugins Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: parsing Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: porthos Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: regular Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: resource Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: repositories Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: something Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: strict Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: string Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: unknown Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2021-03-16 09:11:57 +08:00
The [Helm roadmap uses GitHub milestones](https://github.com/helm/helm/milestones) to track the progress of the project.
feat(README): Adding roadmap location To exit incubation the roadmap needs to be listed in the wiki per the incubator documentation. For more detail see https://github.com/kubernetes/community/blob/master/incubator.md
2017-02-02 23:12:36 +08:00
Updating docs around v3 and v4 The README and contributing document now directly address Helm v4 and v3 to direct contributors. Signed-off-by: Matt Farina <matt@mattfarina.com>
2024-11-14 05:49:19 +08:00
The development of Helm v4 is currently happening on the `main` branch while the development of Helm v3, the stable branch, is happening on the `dev-v3` branch. Changes should be made to the `main` branch prior to being added to the `dev-v3` branch so that all changes are carried along to Helm v4.
feat(README): add community contact points Add the sig-apps mailing list, developer call details, and #helm slack channel. Based on https://github.com/kubernetes/kubernetes-template-project/blob/master/README.md
2016-09-13 08:22:45 +08:00
## Community, discussion, contribution, and support
You can reach the Helm community and developers via the following channels:
docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
2019-03-06 03:57:39 +08:00
- [Kubernetes Slack](https://kubernetes.slack.com):
- [#helm-users](https://kubernetes.slack.com/messages/helm-users)
- [#helm-dev](https://kubernetes.slack.com/messages/helm-dev)
- [#charts](https://kubernetes.slack.com/messages/charts)
- Mailing List:
- [Helm Mailing List](https://lists.cncf.io/g/cncf-helm)
Linking to a more complete list of meeting details. Signed-off-by: Bridget Kromhout <bridget@kromhout.org>
2020-10-15 08:31:27 +08:00
- Developer Call: Thursdays at 9:30-10:00 Pacific ([meeting details](https://github.com/helm/community/blob/master/communication.md#meetings))
feat(README): call out the code of conduct Lifted from https://raw.githubusercontent.com/kubernetes/kubernetes-template-project/master/README.md
2016-09-14 00:36:41 +08:00
added Contributing.md section and ref link in the README Signed-off-by: abhiram11 <abhiramsatpute@gmail.com>
2023-02-12 20:38:13 +08:00
### Contribution
If you're interested in contributing, please refer to the [Contributing Guide](CONTRIBUTING.md) **before submitting a pull request**.
feat(README): call out the code of conduct Lifted from https://raw.githubusercontent.com/kubernetes/kubernetes-template-project/master/README.md
2016-09-14 00:36:41 +08:00
### Code of conduct
docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
2019-03-06 03:57:39 +08:00
Participation in the Helm community is governed by the [Code of Conduct](code-of-conduct.md).