docs: s,kubernetes/helm,helm/helm,g (#5404)

Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
pull/5413/head
Matthew Fisher 6 years ago committed by GitHub
parent dcc8aa5bb9
commit 2a82e6cbe6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,16 +1,15 @@
# Kubernetes Helm # Helm
[![CircleCI](https://circleci.com/gh/kubernetes/helm.svg?style=svg)](https://circleci.com/gh/kubernetes/helm) [![CircleCI](https://circleci.com/gh/helm/helm.svg?style=shield)](https://circleci.com/gh/helm/helm)
[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/helm)](https://goreportcard.com/report/github.com/kubernetes/helm) [![Go Report Card](https://goreportcard.com/badge/github.com/helm/helm)](https://goreportcard.com/report/github.com/helm/helm)
[![GoDoc](https://godoc.org/github.com/kubernetes/helm?status.svg)](https://godoc.org/github.com/kubernetes/helm) [![GoDoc](https://godoc.org/k8s.io/helm?status.svg)](https://godoc.org/k8s.io/helm)
Helm is a tool for managing Kubernetes charts. Charts are packages of Helm is a tool for managing Charts. Charts are packages of pre-configured Kubernetes resources.
pre-configured Kubernetes resources.
Use Helm to: Use Helm to:
- Find and use [popular software packaged as Kubernetes charts](https://github.com/helm/charts) - Find and use [popular software packaged as Helm Charts](https://github.com/helm/charts) to run in Kubernetes
- Share your own applications as Kubernetes charts - Share your own applications as Helm Charts
- Create reproducible builds of your Kubernetes applications - Create reproducible builds of your Kubernetes applications
- Intelligently manage your Kubernetes manifest files - Intelligently manage your Kubernetes manifest files
- Manage releases of Helm packages - Manage releases of Helm packages
@ -31,19 +30,17 @@ Think of it like apt/yum/homebrew for Kubernetes.
## Install ## Install
Binary downloads of the Helm client can be found at the following links:
- [OSX](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-darwin-amd64.tar.gz) Binary downloads of the Helm client can be found on [the Releases page](https://github.com/helm/helm/releases/latest).
- [Linux](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-linux-amd64.tar.gz)
- [Linux 32-bit](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-linux-386.tar.gz)
- [Windows](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-windows-amd64.tar.gz)
Unpack the `helm` binary and add it to your PATH and you are good to go! Unpack the `helm` binary and add it to your PATH and you are good to go!
If you want to use a package manager: If you want to use a package manager:
- macOS/[homebrew](https://brew.sh/) users can use `brew install kubernetes-helm`. - [Homebrew](https://brew.sh/) users can use `brew install kubernetes-helm`.
- Windows/[chocolatey](https://chocolatey.org/) users can use `choco install kubernetes-helm`. - [Chocolatey](https://chocolatey.org/) users can use `choco install kubernetes-helm`.
- [Scoop](https://scoop.sh/) users can use `scoop install helm`.
- [GoFish](https://gofi.sh/) users can use `gofish install helm`.
To rapidly get Helm up and running, start with the [Quick Start Guide](https://docs.helm.sh/using_helm/#quickstart-guide). To rapidly get Helm up and running, start with the [Quick Start Guide](https://docs.helm.sh/using_helm/#quickstart-guide).
@ -62,15 +59,14 @@ The [Helm roadmap uses Github milestones](https://github.com/helm/helm/milestone
You can reach the Helm community and developers via the following channels: You can reach the Helm community and developers via the following channels:
- [Kubernetes Slack](http://slack.k8s.io): - [Kubernetes Slack](https://kubernetes.slack.com):
- #helm-users - [#helm-users](https://kubernetes.slack.com/messages/helm-users)
- #helm-dev - [#helm-dev](https://kubernetes.slack.com/messages/helm-dev)
- #charts - [#charts](https://kubernetes.slack.com/messages/charts)
- Mailing Lists: - Mailing List:
- [Helm Mailing List](https://lists.cncf.io/g/cncf-kubernetes-helm) - [Helm Mailing List](https://lists.cncf.io/g/cncf-helm)
- [Kubernetes SIG Apps Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-apps) - Developer Call: Thursdays at 9:30-10:00 Pacific. [https://zoom.us/j/696660622](https://zoom.us/j/696660622)
- Developer Call: Thursdays at 9:30-10:00 Pacific. [https://zoom.us/j/4526666954](https://zoom.us/j/4526666954)
### Code of conduct ### Code of conduct
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md). Participation in the Helm community is governed by the [Code of Conduct](code-of-conduct.md).

@ -2,5 +2,5 @@ description: Empty testing chart
home: https://k8s.io/helm home: https://k8s.io/helm
name: empty name: empty
sources: sources:
- https://github.com/kubernetes/helm - https://github.com/helm/helm
version: 0.1.0 version: 0.1.0

@ -29,7 +29,7 @@ Upload the contents of the directory to your GCS bucket by running `scripts/sync
For example: For example:
```console ```console
$ pwd $ pwd
/Users/funuser/go/src/github.com/kubernetes/helm /Users/me/code/go/src/k8s.io/helm
$ scripts/sync-repo.sh fantastic-charts/ fantastic-charts $ scripts/sync-repo.sh fantastic-charts/ fantastic-charts
Getting ready to sync your local directory (fantastic-charts/) to a remote repository at gs://fantastic-charts Getting ready to sync your local directory (fantastic-charts/) to a remote repository at gs://fantastic-charts
Verifying Prerequisites.... Verifying Prerequisites....

@ -99,7 +99,7 @@ We accept changes to the code via GitHub Pull Requests (PRs). One
workflow for doing this is as follows: workflow for doing this is as follows:
1. Go to your `$GOPATH/src/k8s.io` directory and `git clone` the 1. Go to your `$GOPATH/src/k8s.io` directory and `git clone` the
`github.com/kubernetes/helm` repository. `github.com/helm/helm` repository.
2. Fork that repository into your GitHub account 2. Fork that repository into your GitHub account
3. Add your repository as a remote for `$GOPATH/src/k8s.io/helm` 3. Add your repository as a remote for `$GOPATH/src/k8s.io/helm`
4. Create a new working branch (`git checkout -b feat/my-feature`) and 4. Create a new working branch (`git checkout -b feat/my-feature`) and

@ -133,7 +133,7 @@ install, upgrade, and rollback.
## Helm Library ## Helm Library
It interacts directly with the Kubernetes API server to install, It interacts directly with the Kubernetes API server to install,
upgrade, query, and remove Kubernetes resources. upgrade, query, and remove Kubernetes resources.
## Repository (Repo, Chart Repository) ## Repository (Repo, Chart Repository)

@ -45,18 +45,18 @@ choco install kubernetes-helm
## From Script ## From Script
Helm now has an installer script that will automatically grab the latest version Helm now has an installer script that will automatically grab the latest version
of Helm and [install it locally](https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get). of Helm and [install it locally](https://raw.githubusercontent.com/helm/helm/master/scripts/get).
You can fetch that script, and then execute it locally. It's well documented so You can fetch that script, and then execute it locally. It's well documented so
that you can read through it and understand what it is doing before you run it. that you can read through it and understand what it is doing before you run it.
``` ```
$ curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get > get_helm.sh $ curl https://raw.githubusercontent.com/helm/helm/master/scripts/get > get_helm.sh
$ chmod 700 get_helm.sh $ chmod 700 get_helm.sh
$ ./get_helm.sh $ ./get_helm.sh
``` ```
Yes, you can `curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash` that if you want to live on the edge. Yes, you can `curl https://raw.githubusercontent.com/helm/helm/master/scripts/get | bash` that if you want to live on the edge.
### From Canary Builds ### From Canary Builds

@ -17,7 +17,7 @@ It is important to note that this document assumes that the git remote in your r
If you don't have an upstream remote, you can add one easily using something like: If you don't have an upstream remote, you can add one easily using something like:
```shell ```shell
git remote add upstream git@github.com:kubernetes/helm.git git remote add upstream git@github.com:helm/helm.git
``` ```
In this doc, we are going to reference a few environment variables as well, which you may want to set for convenience. For major/minor releases, use the following: In this doc, we are going to reference a few environment variables as well, which you may want to set for convenience. For major/minor releases, use the following:
@ -134,7 +134,7 @@ In order for others to start testing, we can now push the release branch upstrea
git push upstream $RELEASE_BRANCH_NAME git push upstream $RELEASE_BRANCH_NAME
``` ```
Make sure to check [helm on CircleCI](https://circleci.com/gh/kubernetes/helm) and make sure the release passed CI before proceeding. Make sure to check [helm on CircleCI](https://circleci.com/gh/helm/helm) and make sure the release passed CI before proceeding.
If anyone is available, let others peer-review the branch before continuing to ensure that all the proper changes have been made and all of the commits for the release are there. If anyone is available, let others peer-review the branch before continuing to ensure that all the proper changes have been made and all of the commits for the release are there.
@ -234,7 +234,7 @@ Download Helm X.Y. The common platform binaries are here:
- [Linux](https://storage.googleapis.com/kubernetes-helm/helm-vX.Y.Z-linux-amd64.tar.gz) - [Linux](https://storage.googleapis.com/kubernetes-helm/helm-vX.Y.Z-linux-amd64.tar.gz)
- [Windows](https://storage.googleapis.com/kubernetes-helm/helm-vX.Y.Z-windows-amd64.tar.gz) - [Windows](https://storage.googleapis.com/kubernetes-helm/helm-vX.Y.Z-windows-amd64.tar.gz)
The [Quickstart Guide](https://docs.helm.sh/using_helm/#quickstart-guide) will get you going from there. For **upgrade instructions** or detailed installation notes, check the [install guide](https://docs.helm.sh/using_helm/#installing-helm). You can also use a [script to install](https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get) on any system with `bash`. The [Quickstart Guide](https://docs.helm.sh/using_helm/#quickstart-guide) will get you going from there. For **upgrade instructions** or detailed installation notes, check the [install guide](https://docs.helm.sh/using_helm/#installing-helm). You can also use a [script to install](https://raw.githubusercontent.com/helm/helm/master/scripts/get) on any system with `bash`.
## What's Next ## What's Next

@ -40,7 +40,7 @@ import (
// //
// As of Kubernetes 1.4, the max limit on a name is 63 chars. We reserve 10 for // As of Kubernetes 1.4, the max limit on a name is 63 chars. We reserve 10 for
// charts to add data. Effectively, that gives us 53 chars. // charts to add data. Effectively, that gives us 53 chars.
// See https://github.com/kubernetes/helm/issues/1528 // See https://github.com/helm/helm/issues/1528
const releaseNameMaxLen = 53 const releaseNameMaxLen = 53
// NOTESFILE_SUFFIX that we want to treat special. It goes through the templating engine // NOTESFILE_SUFFIX that we want to treat special. It goes through the templating engine

Loading…
Cancel
Save