msb-public
/
helm
mirror of https://github.com/helm/helm
1
0
Code Issues Projects Releases Wiki Activity

update readme example and change repository to https

Browse Source 
Signed-off-by: Jess Frazelle <me@jessfraz.com>
pull/1068/head
Jess Frazelle 8 years ago
parent 6e4344ba17
commit 67778cbcd1
No known key found for this signature in database
GPG Key ID: 18F3685C0022BFF3
3 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File

4
README.md
Unescape View File

@ -32,8 +32,12 @@ Using Helm is as easy as this:
```console
$ helm init # Initialize Helm as well as the Tiller server
# From the root of this repository run the following to install an example from
the docs
$ helm install docs/examples/alpine # Install the example Alpine chart
happy-panda # <-- That's the name of your release
$ helm list # List all releases
happy-panda
quiet-kitten

18
docs/chart_repository.md
Unescape View File

@ -10,9 +10,9 @@ A _chart repository_ is an HTTP server that houses one or more packaged charts.
Because a chart repository can be any HTTP server that can serve YAML and tar files and can answer GET requests, you have a plethora of options when it comes down to hosting your own chart repository. For example, you can use a Google Cloud Storage(GCS) bucket, Amazon S3 bucket, or even create your own web server.
### The chart repository structure
A chart repository consists of packaged charts and a special file called `index.yaml` which contains an index of all of the charts in the repository. A chart repository has a flat structure. Given a repository URL, you should be able to download a chart via a GET request to `URL/chartname-version.tgz`.
A chart repository consists of packaged charts and a special file called `index.yaml` which contains an index of all of the charts in the repository. A chart repository has a flat structure. Given a repository URL, you should be able to download a chart via a GET request to `URL/chartname-version.tgz`.
For example, if a repository lives at the URL: `http://helm-charts.com`, the `alpine-0.1.0` chart would live at `http://helm-charts.com/alpine-0.1.0.tgz`. The index file would also live in the same chart repository at `http://helm-charts.com/index.yaml`.
For example, if a repository lives at the URL: `https://helm-charts.com`, the `alpine-0.1.0` chart would live at `https://helm-charts.com/alpine-0.1.0.tgz`. The index file would also live in the same chart repository at `https://helm-charts.com/index.yaml`.
#### The index file
The index file is a yaml file called `index.yaml`. It contains some metadata about the package as well as a dump of the Chart.yaml file of a packaged chart. A valid chart repository must have an index file. The index file contains information about each chart in the chart repository. The `helm repo index` command will generate an index file based on a given local directory that contains packaged charts.
@ -21,7 +21,7 @@ This is an example of an index file:
```
alpine-0.1.0:
name: alpine
url: http://storage.googleapis.com/kubernetes-charts/alpine-0.1.0.tgz
url: https://storage.googleapis.com/kubernetes-charts/alpine-0.1.0.tgz
created: 2016-05-26 11:23:44.086354411 +0000 UTC
checksum: a61575c2d3160e5e39abf2a5ec984d6119404b18
chartfile:
@ -31,7 +31,7 @@ alpine-0.1.0:
home: https://github.com/example-charts/alpine
redis-2.0.0:
name: redis
url: http://storage.googleapis.com/kubernetes-charts/redis-2.0.0.tgz
url: https://storage.googleapis.com/kubernetes-charts/redis-2.0.0.tgz
created: 2016-05-26 11:23:44.087939192 +0000 UTC
checksum: 2cea3048cf85d588204e1b1cc0674472b4517919
chartfile:
@ -59,7 +59,7 @@ Congratulations, now you have an empty GCS bucket ready to serve charts!
## Store charts in your chart repository
Now that you have a chart repository, let's upload a chart and an index file to the repository.
Charts in a chart repository must be packaged (`helm package chart-name/`) and versioned correctly (following [SemVer 2](http://semver.org/) guidelines).
Charts in a chart repository must be packaged (`helm package chart-name/`) and versioned correctly (following [SemVer 2](https://semver.org/) guidelines).
These next steps compose an example workflow, but you are welcome to use whatever workflow you fancy for storing and updating charts in your chart repository.
@ -75,7 +75,7 @@ $ mv alpine-0.1.0.tgz fantastic-charts/
Outside of your directory, run the `helm repo index [DIR] [URL]` command. This command takes the path of the local directory that you just created and the URL of your remote chart repository and composes an index.yaml file inside the given directory path.
```console
$ helm repo index fantastic-charts http://storage.googleapis.com/fantastic-charts
$ helm repo index fantastic-charts https://storage.googleapis.com/fantastic-charts
```
Now, you can upload the chart and the index file to your chart repository using a sync tool or manually. If you're using Google Cloud Storage, check out this [example workflow](chart_repository_sync_example.md) using the gsutil client.
@ -87,14 +87,14 @@ When you've created another chart, move the new packaged chart into the fantasti
## Share your charts with others
When you're ready to share your charts, simply let someone know what the url of your repository is.
*Note: A public GCS bucket can be accessed via simple http at this address `http://storage.googleapis.com/bucket-name`.*
*Note: A public GCS bucket can be accessed via simple http at this address `https://storage.googleapis.com/bucket-name`.*
From there, they will add the repository to their helm client via the `helm repo add [NAME] [URL]` command with any name they would like to use to reference the repository.
```console
$ helm repo add fantastic-charts http://storage.googleapis.com/fantastic-charts
$ helm repo add fantastic-charts https://storage.googleapis.com/fantastic-charts
$ helm repo list
fantastic-charts http://storage.googleapis.com/fantastic-charts
fantastic-charts https://storage.googleapis.com/fantastic-charts
```
*Note: A repository will not be added if it does not contain a valid index.yaml.*

2
docs/chart_repository_sync_example.md
Unescape View File

@ -19,7 +19,7 @@ $ mv alpine-0.1.0.tgz fantastic-charts/
Use helm to generate an updated index.yaml file by passing in the directory path and the url of the remote repository to the `helm repo index` command like this:
```console
$ helm repo index fantastic-charts/ http://storage.googleapis.com/fantastic-charts
$ helm repo index fantastic-charts/ https://storage.googleapis.com/fantastic-charts
```
This will generate an updated index.yaml file and place in the `fantastic-charts/` directory.

Write Preview
Loading…
Cancel
Save