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

68 lines
2.7 KiB
Markdown
Raw Normal View History

docs(README): udate core docs pre-merge
2016-04-28 04:40:40 +08:00
# Kubernetes Helm
feat(tiller): stub out environment
2016-04-12 03:26:33 +08:00
docs(ci): add cicleci badge to readme
2016-07-07 01:38:34 +08:00
[![CircleCI](https://circleci.com/gh/kubernetes/helm.svg?style=svg)](https://circleci.com/gh/kubernetes/helm)
feat(readme): Display the Go Report Card
2016-12-14 22:56:08 +08:00
[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/helm)](https://goreportcard.com/report/github.com/kubernetes/helm)
docs(ci): add cicleci badge to readme
2016-07-07 01:38:34 +08:00
docs(README): udate core docs pre-merge
2016-04-28 04:40:40 +08:00
Helm is a tool for managing Kubernetes charts. Charts are packages of
pre-configured Kubernetes resources.
feat(tiller): stub out environment
2016-04-12 03:26:33 +08:00
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
Use Helm to...
fix(README): add features list
2016-04-29 07:09:33 +08:00
Link to the Helm Chart repository from the Helm project The current README makes no mention of the Chart repository or where to find it. You have to Google to find it or stumble upon it. It was frustrating to come to the Helm project and not easily be able to find where the chart repository was - even though I knew it existed. This patch will make that easier for others.
2017-03-04 06:29:49 +08:00
- Find and use [popular software packaged as Kubernetes charts](https://github.com/kubernetes/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
- Share your own applications as Kubernetes 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 server (`tiller`)
- Tiller runs inside of your Kubernetes cluster, and manages releases (installations)
of your charts.
- 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)
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
chore(*): bump to v2.0.0
2016-11-17 07:31:44 +08:00
Binary downloads of the Helm client can be found at the following links:
docs(README): update download information
2016-10-11 02:59:06 +08:00
chore(*): bump to v2.3.0
2017-04-07 03:52:45 +08:00
- [OSX](https://kubernetes-helm.storage.googleapis.com/helm-v2.3.0-darwin-amd64.tar.gz)
- [Linux](https://kubernetes-helm.storage.googleapis.com/helm-v2.3.0-linux-amd64.tar.gz)
- [Linux 32-bit](https://kubernetes-helm.storage.googleapis.com/helm-v2.3.0-linux-386.tar.gz)
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!
macOS/[homebrew](https://brew.sh/) users can also use `brew 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
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
To rapidly get Helm up and running, start with the [Quick Start Guide](docs/quickstart.md).
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
See the [installation guide](docs/install.md) for more options,
including installing pre-releases.
docs(README): update download information
2016-10-11 02:59:06 +08:00
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(index): Move doc index into a separate file. This removes the full TOC from the README and puts it in an index. This will help when we begin to autogenerate a website based on documentation.
2017-02-16 07:52:58 +08:00
Get started with the [Quick Start guide](docs/quickstart.md) or plunge into the [complete documentation](docs/index.md)
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
The [Helm roadmap is currently located on the wiki](https://github.com/kubernetes/helm/wiki/Roadmap).
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:
- [Kubernetes Slack](https://slack.k8s.io): #helm
- Mailing List: https://groups.google.com/forum/#!forum/kubernetes-sig-apps
- Developer Call: Thursdays at 9:30-10:00 Pacific. https://engineyard.zoom.us/j/366425549
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
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).