Commit d8687442 authored by Matt Butcher's avatar Matt Butcher

Merge pull request #524 from technosophos/docs/wokflow-mvp

docs(workflow): note unimplemented commands
parents 007b300d cc0069c3
...@@ -18,18 +18,20 @@ kicker" and "standard user" personas. ...@@ -18,18 +18,20 @@ kicker" and "standard user" personas.
Currently, the client can be used with no installation. However, installing the server side component is done like this: Currently, the client can be used with no installation. However, installing the server side component is done like this:
``` ```
$ helm dm install $ helm server install
``` ```
- Client uses existing `kubectl` configuration to install built-in manifests. - Client uses existing `kubectl` configuration to install built-in manifests.
General pattern: General pattern:
``` ```
helm dm install helm server install
``` ```
#### Searching #### Searching
*Not implemented yet*
``` ```
$ helm search bar $ helm search bar
helm:example.com/foo/bar - A basic chart helm:example.com/foo/bar - A basic chart
...@@ -49,7 +51,7 @@ helm search PATTERN ...@@ -49,7 +51,7 @@ helm search PATTERN
#### Simple deployment: #### Simple deployment:
``` ```
$ helm deploy helm:example.com/foo/bar $ helm deploy -n wonky-panda helm:example.com/foo/bar
Created wonky-panda Created wonky-panda
``` ```
...@@ -65,6 +67,8 @@ helm deploy [-f CONFIG] [-n NAME] [CHART] ...@@ -65,6 +67,8 @@ helm deploy [-f CONFIG] [-n NAME] [CHART]
#### Find out about params: #### Find out about params:
*Not implemented yet*
In this operation, helm reads a chart and returns the list of parameters In this operation, helm reads a chart and returns the list of parameters
that can be supplied in a template: that can be supplied in a template:
...@@ -78,12 +82,13 @@ Params: ...@@ -78,12 +82,13 @@ Params:
- The client sends the request to the API server - The client sends the request to the API server
- The API server fetches the chart, analyzes it, and returns the list of - The API server fetches the chart, analyzes it, and returns the list of
parameters. parameters.
General pattern: General pattern:
``` ```
helm chart show CHART helm chart show CHART
``` ```
*Not implemented yet*
#### Generate the params for me: #### Generate the params for me:
...@@ -110,7 +115,7 @@ In this operation, the user deploys a chart with an associated values ...@@ -110,7 +115,7 @@ In this operation, the user deploys a chart with an associated values
file. file.
``` ```
$ helm deploy -f values.yaml helm:example.com/foo/bar $ helm deploy -f values.yaml -n taco-tuesday helm:example.com/foo/bar
Created taco-tuesday Created taco-tuesday
``` ```
...@@ -154,6 +159,8 @@ helm status NAME ...@@ -154,6 +159,8 @@ helm status NAME
#### Edit and redeploy: #### Edit and redeploy:
*Not implemented yet*
Redeployment is taking an existing _instance_ and changing its template Redeployment is taking an existing _instance_ and changing its template
values, and then re-deploying it. values, and then re-deploying it.
...@@ -202,6 +209,9 @@ This follows the deployment process above. The server _must_ ensure that ...@@ -202,6 +209,9 @@ This follows the deployment process above. The server _must_ ensure that
the name is unique. the name is unique.
#### Get values for an app: #### Get values for an app:
*Not implemented yet*
``` ```
$ helm deployment params taco-tuesday $ helm deployment params taco-tuesday
Stored in values.yaml Stored in values.yaml
...@@ -221,6 +231,8 @@ When more than one name is specified, the resulting file will contain configs fo ...@@ -221,6 +231,8 @@ When more than one name is specified, the resulting file will contain configs fo
#### Get fully generated manifest files #### Get fully generated manifest files
*Not implemented yet*
``` ```
$ helm deployment manifest taco-tuesday $ helm deployment manifest taco-tuesday
Created manifest.yaml Created manifest.yaml
...@@ -250,9 +262,11 @@ helm doctor ...@@ -250,9 +262,11 @@ helm doctor
#### Listing all installed charts #### Listing all installed charts
*Not implemented yet*
``` ```
$ helm chart list $ helm chart list
helm:example.com/foo/bar#1.1.1 helm:example.com/foo/bar#1.1.1
helm:example.com/foo/bar#1.1.2 helm:example.com/foo/bar#1.1.2
helm:example.com/foo/barbecue#0.1.0 helm:example.com/foo/barbecue#0.1.0
``` ```
...@@ -270,7 +284,7 @@ helm chart list ...@@ -270,7 +284,7 @@ helm chart list
NB: We might rename this `helm chart instances`, as that is less vague. NB: We might rename this `helm chart instances`, as that is less vague.
``` ```
$ helm chart get helm:example.com/foo/bar $ helm chart get helm:example.com/foo/bar
taco-tuesday taco-tuesday
taco-wednesday taco-wednesday
``` ```
...@@ -304,6 +318,8 @@ helm deployment list ...@@ -304,6 +318,8 @@ helm deployment list
### Getting details of a deployment ### Getting details of a deployment
*Not implemented yet*
_NB: Might not need this._ _NB: Might not need this._
``` ```
...@@ -348,6 +364,8 @@ General pattern for lint: ...@@ -348,6 +364,8 @@ General pattern for lint:
``` ```
helm lint PATH helm lint PATH
``` ```
*Lint is not implemented yet*
#### Packaging and Releasing packages #### Packaging and Releasing packages
...@@ -360,6 +378,8 @@ Created foo-1.1.2.tgz ...@@ -360,6 +378,8 @@ Created foo-1.1.2.tgz
Releasing a chart: Releasing a chart:
*Not implemented yet*
``` ```
$ helm release -u https://example.com/bucket ./foo-1.1.2.tgz $ helm release -u https://example.com/bucket ./foo-1.1.2.tgz
Uploaded to https://example.com/bucket/foo-1.1.2.tgz Uploaded to https://example.com/bucket/foo-1.1.2.tgz
...@@ -444,6 +464,8 @@ helm repo list ...@@ -444,6 +464,8 @@ helm repo list
#### Adding credentials #### Adding credentials
*Not implemented yet*
``` ```
$ helm credential add aff34... 89897a... $ helm credential add aff34... 89897a...
Created token-foo Created token-foo
...@@ -486,6 +508,8 @@ helm repo rm REPO_URL ...@@ -486,6 +508,8 @@ helm repo rm REPO_URL
#### Listing Credentials #### Listing Credentials
*Not implemented yet*
``` ```
$ helm credential list $ helm credential list
token-foo: TOKEN token-foo: TOKEN
...@@ -501,6 +525,8 @@ helm credential list [PATTERN] ...@@ -501,6 +525,8 @@ helm credential list [PATTERN]
#### Removing credentials #### Removing credentials
*Not implemented yet*
``` ```
$ helm credential rm token-foo $ helm credential rm token-foo
``` ```
......
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