Commit cc0069c3 authored by Matt Butcher's avatar Matt Butcher
Browse files

docs(workflow): note unimplemented commands

This notes which commands are not currently implemented.
parent 7d6b8254
main Release add-codeql dependabot/go_modules/github.com/docker/distribution-2.8.2incompatible dependabot/go_modules/github.com/lib/pq-1.10.9 dependabot/go_modules/github.com/rubenv/sql-migrate-1.4.0 dependabot/go_modules/golang.org/x/crypto-0.9.0 dependabot/go_modules/golang.org/x/term-0.8.0 dependabot/go_modules/k8s.io/klog/v2-2.100.1 dev-v2 feat-v3/event-emitter-lua kube-update-test release-2.0 release-2.1 release-2.10 release-2.11 release-2.12 release-2.13 release-2.14 release-2.15 release-2.16 release-2.17 release-2.2 release-2.3 release-2.4 release-2.5 release-2.6 release-2.7 release-2.8 release-2.9 release-3.0 release-3.1 release-3.10 release-3.11 release-3.12 release-3.2 release-3.3 release-3.4 release-3.5 release-3.6 release-3.6.1 release-3.6.2 release-3.7 release-3.8 release-3.9 release-v3.0.0-beta.4 1.999.0 v3.12.0 v3.12.0-rc.1 v3.12.0-dev.1 v3.11.3 v3.11.2 v3.11.1 v3.11.0 v3.11.0-rc.2 v3.11.0-rc.1 v3.10.3 v3.10.2 v3.10.1 v3.10.0 v3.10.0-rc.1 v3.9.4 v3.9.3 v3.9.2 v3.9.1 v3.9.0 v3.9.0-rc.1 v3.8.2 v3.8.1 v3.8.0 v3.8.0-rc.2 v3.8.0-rc.1 v3.7.2 v3.7.1 v3.7.0 v3.7.0-rc.3 v3.7.0-rc.2 v3.7.0-rc.1 v3.6.3 v3.6.2 v3.6.1 v3.6.0 v3.6.0-rc.1 v3.5.4 v3.5.3 v3.5.2 v3.5.1 v3.5.0 v3.5.0-rc.2 v3.5.0-rc.1 v3.4.2 v3.4.1 v3.4.0 v3.4.0-rc.1 v3.3.4 v3.3.3 v3.3.2 v3.3.1 v3.3.0 v3.3.0-rc.2 v3.3.0-rc.1 v3.2.4 v3.2.3 v3.2.2 v3.2.1 v3.2.0 v3.2.0-rc.1 v3.1.3 v3.1.2 v3.1.1 v3.1.0 v3.1.0-rc.3 v3.1.0-rc.2 v3.1.0-rc.1 v3.0.3 v3.0.2 v3.0.1 v3.0.0 v3.0.0-rc.4 v3.0.0-rc.3 v3.0.0-rc.2 v3.0.0-rc.1 v3.0.0-beta.5 v3.0.0-beta.4 v3.0.0-beta.3 v3.0.0-beta.2 v3.0.0-beta.1 v3.0.0-alpha.2 v3.0.0-alpha.1 v2.17.0 v2.17.0-rc.1 v2.16.12 v2.16.11 v2.16.10 v2.16.9 v2.16.8 v2.16.7 v2.16.6 v2.16.5 v2.16.4 v2.16.3 v2.16.2 v2.16.1 v2.16.0 v2.16.0-rc.2 v2.16.0-rc.1 v2.15.2 v2.15.1 v2.15.0 v2.15.0-rc.2 v2.15.0-rc.1 v2.14.3 v2.14.2 v2.14.1 v2.14.0 v2.14.0-rc.2 v2.14.0-rc.1 v2.13.1 v2.13.1-rc.1 v2.13.0 v2.13.0-rc.2 v2.13.0-rc.1 v2.12.3 v2.12.2 v2.12.1 v2.12.0 v2.12.0-rc.2 v2.12.0-rc.1 v2.11.0 v2.11.0-rc.4 v2.11.0-rc.3 v2.11.0-rc.2 v2.11.0-rc.1 v2.10.0 v2.10.0-rc.3 v2.10.0-rc.2 v2.10.0-rc.1 v2.9.1 v2.9.0 v2.9.0-rc5 v2.9.0-rc4 v2.9.0-rc3 v2.9.0-rc2 v2.9.0-rc1 v2.8.2 v2.8.2-rc1 v2.8.1 v2.8.0 v2.8.0-rc.1 v2.7.2 v2.7.1 v2.7.0 v2.7.0-rc1 v2.6.2 v2.6.1 v2.6.0 v2.5.1 v2.5.0 v2.4.2 v2.4.1 v2.4.0 v2.3.1 v2.3.0 v2.2.3 v2.2.2 v2.2.1 v2.2.0 v2.1.3 v2.1.2 v2.1.1 v2.1.0 v2.0.2 v2.0.1 v2.0.0 v2.0.0-rc.2 v2.0.0-rc.1 v2.0.0-beta.2 v2.0.0-beta.1 v2.0.0-alpha.5 v2.0.0-alpha.4 v2.0.0-alpha.3 v2.0.0-alpha.2 v2.0.0-alpha.1
No related merge requests found
Showing with 33 additions and 7 deletions
+33 -7
...@@ -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
``` ```
......
Supports Markdown
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