Unverified Commit 04352463 authored by Sam Foo's avatar Sam Foo Committed by GitHub
Browse files

Merge pull request #764 from GuessWhoSamFoo/helm-examples

Update CLI reference and concepts with Helm registry
parents 6f6294c8 a0efc074
......@@ -12,7 +12,7 @@ as an example.*
A registry is given a string identifier, which must be unique within a ksonnet application.
There are two supported registry protocols: **github** and **fs**.
There are three supported registry protocols: **github**, **fs**, and **Helm**.
GitHub registries expect a path in a GitHub repository, and filesystem based
registries expect a path on the local filesystem.
......@@ -44,6 +44,9 @@ ks registry add databases github.com/example
# Add a registry with the name 'databases' at the uri
# 'github.com/org/example/tree/0.0.1/registry' (0.0.1 is the branch name)
ks registry add databases github.com/org/example/tree/0.0.1/registry
# Add a registry with a Helm Charts Repository uri
ks registry add helm-stable https://kubernetes-charts.storage.googleapis.com
```
### Options
......
......@@ -30,7 +30,7 @@ ksonnet's package management schema can be summed up as follows:
### Application
A ksonnet application represents a well-structured directory of Kubernetes [manifests](#manifest). This directory is autogenerated by [`ksonnet init`](/docs/cli-reference/ksonnet_init.md). These manifests typically tie together in some way—for example, they might collectively define a web service like the following:
A ksonnet application represents a well-structured directory of Kubernetes [manifests](#manifest). This directory is autogenerated by [`ks init`](/docs/cli-reference/ks_init.md). These manifests typically tie together in some way—for example, they might collectively define a web service like the following:
<p align="center">
<img alt="ksonnet application diagram" src="/docs/img/guestbook_app.svg" height="250px">
......@@ -216,7 +216,12 @@ You can use *default* or *custom* registries:
* By **default**, ksonnet allows you do download *packages* from the [`ksonnet/parts/incubator`](https://github.com/ksonnet/parts/tree/master/incubator) registry.
* You can set up your own **custom** registry with `ks registry add`, which accepts **any valid Github path**. *Note that this path needs to point a directory with the following structure:*
* You can set up a registry with three different protocols:
* **Github** - a Github URI
* **Filesystem** - a valid path to a local registry
* **Helm** - a URI to a Helm repository
A registry contains a `registry.yaml` file with directories containing packages similar to the following structure:
```
.
......
......@@ -38,7 +38,7 @@ as an example.*
A registry is given a string identifier, which must be unique within a ksonnet application.
There are two supported registry protocols: **github** and **fs**.
There are three supported registry protocols: **github**, **fs**, and **Helm**.
GitHub registries expect a path in a GitHub repository, and filesystem based
registries expect a path on the local filesystem.
......@@ -61,7 +61,10 @@ ks registry add databases github.com/example
# Add a registry with the name 'databases' at the uri
# 'github.com/org/example/tree/0.0.1/registry' (0.0.1 is the branch name)
ks registry add databases github.com/org/example/tree/0.0.1/registry`
ks registry add databases github.com/org/example/tree/0.0.1/registry
# Add a registry with a Helm Charts Repository uri
ks registry add helm-stable https://kubernetes-charts.storage.googleapis.com`
)
func newRegistryAddCmd(a app.App) *cobra.Command {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment