Commit 24eb6011 authored by Taylor Thomas's avatar Taylor Thomas Committed by GitHub

Merge pull request #2105 from cblecker/docs-clean-home

Add script to clean homedir out of docs
parents a90638e4 ea636634
...@@ -91,6 +91,7 @@ docs: build ...@@ -91,6 +91,7 @@ docs: build
bin/helm docs --dir ./docs/helm bin/helm docs --dir ./docs/helm
bin/helm docs --dir ./docs/man/man1 --type man bin/helm docs --dir ./docs/man/man1 --type man
bin/helm docs --dir ./scripts --type bash bin/helm docs --dir ./scripts --type bash
scripts/docs-clean-home.sh
.PHONY: clean .PHONY: clean
clean: clean:
......
...@@ -61,6 +61,20 @@ The 'repository' URL should point to a Chart Repository. Helm expects that by ...@@ -61,6 +61,20 @@ The 'repository' URL should point to a Chart Repository. Helm expects that by
appending '/index.yaml' to the URL, it should be able to retrieve the chart appending '/index.yaml' to the URL, it should be able to retrieve the chart
repository's index. Note: 'repository' cannot be a repository alias. It must be repository's index. Note: 'repository' cannot be a repository alias. It must be
a URL. a URL.
Starting from 2.2.0, repository can be defined as the path to the directory of
the dependency charts stored locally. The path should start with a prefix of
"file://". For example,
# requirements.yaml
dependencies:
- name: nginx
version: "1.2.3"
repository: "file://../dependency_chart/nginx"
If the dependency chart is retrieved locally, it is not required to have the
repository added to helm by "helm add repo". Version matching is also supported
for this case.
` `
const dependencyListDesc = ` const dependencyListDesc = `
......
...@@ -24,6 +24,7 @@ Common actions from this point include: ...@@ -24,6 +24,7 @@ Common actions from this point include:
Environment: Environment:
$HELM_HOME set an alternative location for Helm files. By default, these are stored in ~/.helm $HELM_HOME set an alternative location for Helm files. By default, these are stored in ~/.helm
$HELM_HOST set an alternative Tiller host. The format is host:port $HELM_HOST set an alternative Tiller host. The format is host:port
$HELM_NO_PLUGINS disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins.
$TILLER_NAMESPACE set an alternative Tiller namespace (default "kube-namespace") $TILLER_NAMESPACE set an alternative Tiller namespace (default "kube-namespace")
$KUBECONFIG set an alternative Kubernetes configuration file (default "~/.kube/config") $KUBECONFIG set an alternative Kubernetes configuration file (default "~/.kube/config")
...@@ -54,12 +55,14 @@ Environment: ...@@ -54,12 +55,14 @@ Environment:
* [helm list](helm_list.md) - list releases * [helm list](helm_list.md) - list releases
* [helm package](helm_package.md) - package a chart directory into a chart archive * [helm package](helm_package.md) - package a chart directory into a chart archive
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories * [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
* [helm reset](helm_reset.md) - uninstalls Tiller from a cluster
* [helm rollback](helm_rollback.md) - roll back a release to a previous revision * [helm rollback](helm_rollback.md) - roll back a release to a previous revision
* [helm search](helm_search.md) - search for a keyword in charts * [helm search](helm_search.md) - search for a keyword in charts
* [helm serve](helm_serve.md) - start a local http web server * [helm serve](helm_serve.md) - start a local http web server
* [helm status](helm_status.md) - displays the status of the named release * [helm status](helm_status.md) - displays the status of the named release
* [helm test](helm_test.md) - test a release
* [helm upgrade](helm_upgrade.md) - upgrade a release * [helm upgrade](helm_upgrade.md) - upgrade a release
* [helm verify](helm_verify.md) - verify that a chart at the given path has been signed and is valid * [helm verify](helm_verify.md) - verify that a chart at the given path has been signed and is valid
* [helm version](helm_version.md) - print the client/server version information * [helm version](helm_version.md) - print the client/server version information
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -34,4 +34,4 @@ helm completion ...@@ -34,4 +34,4 @@ helm completion
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -53,4 +53,4 @@ helm create NAME ...@@ -53,4 +53,4 @@ helm create NAME
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -39,4 +39,4 @@ helm delete [flags] RELEASE_NAME [...] ...@@ -39,4 +39,4 @@ helm delete [flags] RELEASE_NAME [...]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -40,15 +40,19 @@ repository's index. Note: 'repository' cannot be a repository alias. It must be ...@@ -40,15 +40,19 @@ repository's index. Note: 'repository' cannot be a repository alias. It must be
a URL. a URL.
Starting from 2.2.0, repository can be defined as the path to the directory of Starting from 2.2.0, repository can be defined as the path to the directory of
the dependency charts stored locally. The path should start with a prefix of "file://". the dependency charts stored locally. The path should start with a prefix of
For example, "file://". For example,
# requirements.yaml # requirements.yaml
dependencies: dependencies:
- name: nginx - name: nginx
version: "1.2.3" version: "1.2.3"
repository: "file://../dependency_chart/nginx" repository: "file://../dependency_chart/nginx"
If the dependency chart is retrieved locally, it is not required to have the repository
added to helm by "helm add repo". Version matching is also supported for this case. If the dependency chart is retrieved locally, it is not required to have the
repository added to helm by "helm add repo". Version matching is also supported
for this case.
### Options inherited from parent commands ### Options inherited from parent commands
...@@ -66,4 +70,4 @@ added to helm by "helm add repo". Version matching is also supported for this ca ...@@ -66,4 +70,4 @@ added to helm by "helm add repo". Version matching is also supported for this ca
* [helm dependency list](helm_dependency_list.md) - list the dependencies for the given chart * [helm dependency list](helm_dependency_list.md) - list the dependencies for the given chart
* [helm dependency update](helm_dependency_update.md) - update charts/ based on the contents of requirements.yaml * [helm dependency update](helm_dependency_update.md) - update charts/ based on the contents of requirements.yaml
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -40,4 +40,4 @@ helm dependency build [flags] CHART ...@@ -40,4 +40,4 @@ helm dependency build [flags] CHART
### SEE ALSO ### SEE ALSO
* [helm dependency](helm_dependency.md) - manage a chart's dependencies * [helm dependency](helm_dependency.md) - manage a chart's dependencies
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -32,4 +32,4 @@ helm dependency list [flags] CHART ...@@ -32,4 +32,4 @@ helm dependency list [flags] CHART
### SEE ALSO ### SEE ALSO
* [helm dependency](helm_dependency.md) - manage a chart's dependencies * [helm dependency](helm_dependency.md) - manage a chart's dependencies
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -9,11 +9,16 @@ update charts/ based on the contents of requirements.yaml ...@@ -9,11 +9,16 @@ update charts/ based on the contents of requirements.yaml
Update the on-disk dependencies to mirror the requirements.yaml file. Update the on-disk dependencies to mirror the requirements.yaml file.
This command verifies that the required charts, as expressed in 'requirements.yaml', This command verifies that the required charts, as expressed in 'requirements.yaml',
are present in 'charts/' and are at an acceptable version. are present in 'charts/' and are at an acceptable version. It will pull down
the latest charts that satisfy the dependencies, and clean up old dependencies.
On successful update, this will generate a lock file that can be used to On successful update, this will generate a lock file that can be used to
rebuild the requirements to an exact version. rebuild the requirements to an exact version.
Dependencies are not required to be represented in 'requirements.yaml'. For that
reason, an update command will not remove charts unless they are (a) present
in the requirements.yaml file, but (b) at the wrong version.
``` ```
helm dependency update [flags] CHART helm dependency update [flags] CHART
...@@ -23,6 +28,7 @@ helm dependency update [flags] CHART ...@@ -23,6 +28,7 @@ helm dependency update [flags] CHART
``` ```
--keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg") --keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg")
--skip-refresh do not refresh the local repository cache
--verify verify the packages against signatures --verify verify the packages against signatures
``` ```
...@@ -39,4 +45,4 @@ helm dependency update [flags] CHART ...@@ -39,4 +45,4 @@ helm dependency update [flags] CHART
### SEE ALSO ### SEE ALSO
* [helm dependency](helm_dependency.md) - manage a chart's dependencies * [helm dependency](helm_dependency.md) - manage a chart's dependencies
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -49,4 +49,4 @@ helm fetch [flags] [chart URL | repo/chartname] [...] ...@@ -49,4 +49,4 @@ helm fetch [flags] [chart URL | repo/chartname] [...]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -44,4 +44,4 @@ helm get [flags] RELEASE_NAME ...@@ -44,4 +44,4 @@ helm get [flags] RELEASE_NAME
* [helm get manifest](helm_get_manifest.md) - download the manifest for a named release * [helm get manifest](helm_get_manifest.md) - download the manifest for a named release
* [helm get values](helm_get_values.md) - download the values file for a named release * [helm get values](helm_get_values.md) - download the values file for a named release
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -34,4 +34,4 @@ helm get hooks [flags] RELEASE_NAME ...@@ -34,4 +34,4 @@ helm get hooks [flags] RELEASE_NAME
### SEE ALSO ### SEE ALSO
* [helm get](helm_get.md) - download a named release * [helm get](helm_get.md) - download a named release
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -36,4 +36,4 @@ helm get manifest [flags] RELEASE_NAME ...@@ -36,4 +36,4 @@ helm get manifest [flags] RELEASE_NAME
### SEE ALSO ### SEE ALSO
* [helm get](helm_get.md) - download a named release * [helm get](helm_get.md) - download a named release
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -33,4 +33,4 @@ helm get values [flags] RELEASE_NAME ...@@ -33,4 +33,4 @@ helm get values [flags] RELEASE_NAME
### SEE ALSO ### SEE ALSO
* [helm get](helm_get.md) - download a named release * [helm get](helm_get.md) - download a named release
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -14,11 +14,11 @@ configures the maximum length of the revision list returned. ...@@ -14,11 +14,11 @@ configures the maximum length of the revision list returned.
The historical release set is printed as a formatted table, e.g: The historical release set is printed as a formatted table, e.g:
$ helm history angry-bird --max=4 $ helm history angry-bird --max=4
REVISION UPDATED STATUS CHART REVISION UPDATED STATUS CHART DESCRIPTION
1 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 1 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 Initial install
2 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 2 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 Upgraded successfully
3 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 3 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 Rolled back to 2
4 Mon Oct 3 10:15:13 2016 DEPLOYED alpine-0.1.0 4 Mon Oct 3 10:15:13 2016 DEPLOYED alpine-0.1.0 Upgraded successfully
``` ```
...@@ -44,4 +44,4 @@ helm history [flags] RELEASE_NAME ...@@ -44,4 +44,4 @@ helm history [flags] RELEASE_NAME
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -27,4 +27,4 @@ helm home ...@@ -27,4 +27,4 @@ helm home
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -53,4 +53,4 @@ helm init ...@@ -53,4 +53,4 @@ helm init
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -39,4 +39,4 @@ helm inspect [CHART] ...@@ -39,4 +39,4 @@ helm inspect [CHART]
* [helm inspect chart](helm_inspect_chart.md) - shows inspect chart * [helm inspect chart](helm_inspect_chart.md) - shows inspect chart
* [helm inspect values](helm_inspect_values.md) - shows inspect values * [helm inspect values](helm_inspect_values.md) - shows inspect values
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -35,4 +35,4 @@ helm inspect chart [CHART] ...@@ -35,4 +35,4 @@ helm inspect chart [CHART]
### SEE ALSO ### SEE ALSO
* [helm inspect](helm_inspect.md) - inspect a chart * [helm inspect](helm_inspect.md) - inspect a chart
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -35,4 +35,4 @@ helm inspect values [CHART] ...@@ -35,4 +35,4 @@ helm inspect values [CHART]
### SEE ALSO ### SEE ALSO
* [helm inspect](helm_inspect.md) - inspect a chart * [helm inspect](helm_inspect.md) - inspect a chart
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -80,6 +80,7 @@ helm install [CHART] ...@@ -80,6 +80,7 @@ helm install [CHART]
-f, --values valueFiles specify values in a YAML file (can specify multiple) (default []) -f, --values valueFiles specify values in a YAML file (can specify multiple) (default [])
--verify verify the package before installing it --verify verify the package before installing it
--version string specify the exact chart version to install. If this is not specified, the latest version is installed --version string specify the exact chart version to install. If this is not specified, the latest version is installed
--wait if set, will wait until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as --timeout
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
...@@ -95,4 +96,4 @@ helm install [CHART] ...@@ -95,4 +96,4 @@ helm install [CHART]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -37,4 +37,4 @@ helm lint [flags] PATH ...@@ -37,4 +37,4 @@ helm lint [flags] PATH
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -46,6 +46,7 @@ helm list [flags] [FILTER] ...@@ -46,6 +46,7 @@ helm list [flags] [FILTER]
--deployed show deployed releases. If no other is specified, this will be automatically enabled --deployed show deployed releases. If no other is specified, this will be automatically enabled
--failed show failed releases --failed show failed releases
-m, --max int maximum number of releases to fetch (default 256) -m, --max int maximum number of releases to fetch (default 256)
--namespace string show releases within a specific namespace
-o, --offset string next release name in the list, used to offset from start value -o, --offset string next release name in the list, used to offset from start value
-r, --reverse reverse the sort order -r, --reverse reverse the sort order
-q, --short output short (quiet) listing format -q, --short output short (quiet) listing format
...@@ -64,4 +65,4 @@ helm list [flags] [FILTER] ...@@ -64,4 +65,4 @@ helm list [flags] [FILTER]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -43,4 +43,4 @@ helm package [flags] [CHART_PATH] [...] ...@@ -43,4 +43,4 @@ helm package [flags] [CHART_PATH] [...]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -31,4 +31,4 @@ Example usage: ...@@ -31,4 +31,4 @@ Example usage:
* [helm repo remove](helm_repo_remove.md) - remove a chart repository * [helm repo remove](helm_repo_remove.md) - remove a chart repository
* [helm repo update](helm_repo_update.md) - update information on available charts in the chart repositories * [helm repo update](helm_repo_update.md) - update information on available charts in the chart repositories
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -33,4 +33,4 @@ helm repo add [flags] [NAME] [URL] ...@@ -33,4 +33,4 @@ helm repo add [flags] [NAME] [URL]
### SEE ALSO ### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories * [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -40,4 +40,4 @@ helm repo index [flags] [DIR] ...@@ -40,4 +40,4 @@ helm repo index [flags] [DIR]
### SEE ALSO ### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories * [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -24,4 +24,4 @@ helm repo list [flags] ...@@ -24,4 +24,4 @@ helm repo list [flags]
### SEE ALSO ### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories * [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -24,4 +24,4 @@ helm repo remove [flags] [NAME] ...@@ -24,4 +24,4 @@ helm repo remove [flags] [NAME]
### SEE ALSO ### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories * [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -30,4 +30,4 @@ helm repo update ...@@ -30,4 +30,4 @@ helm repo update
### SEE ALSO ### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories * [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
## helm reset
uninstalls Tiller from a cluster
### Synopsis
This command uninstalls Tiller (the helm server side component) from your
Kubernetes Cluster and optionally deletes local configuration in
$HELM_HOME (default ~/.helm/)
```
helm reset
```
### Options
```
-f, --force forces Tiller uninstall even if there are releases installed
--remove-helm-home if set deletes $HELM_HOME
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -24,6 +24,7 @@ helm rollback [flags] [RELEASE] [REVISION] ...@@ -24,6 +24,7 @@ helm rollback [flags] [RELEASE] [REVISION]
--no-hooks prevent hooks from running during rollback --no-hooks prevent hooks from running during rollback
--recreate-pods performs pods restart for the resource if applicable --recreate-pods performs pods restart for the resource if applicable
--timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300) --timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
--wait if set, will wait until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as --timeout
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
...@@ -39,4 +40,4 @@ helm rollback [flags] [RELEASE] [REVISION] ...@@ -39,4 +40,4 @@ helm rollback [flags] [RELEASE] [REVISION]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -36,4 +36,4 @@ helm search [keyword] ...@@ -36,4 +36,4 @@ helm search [keyword]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -10,7 +10,7 @@ This command starts a local chart repository server that serves charts from a lo ...@@ -10,7 +10,7 @@ This command starts a local chart repository server that serves charts from a lo
The new server will provide HTTP access to a repository. By default, it will The new server will provide HTTP access to a repository. By default, it will
scan all of the charts in '$HELM_HOME/repository/local' and serve those over scan all of the charts in '$HELM_HOME/repository/local' and serve those over
the a local IPv4 TCP port (default '127.0.0.1:8879'). the local IPv4 TCP port (default '127.0.0.1:8879').
``` ```
...@@ -22,6 +22,7 @@ helm serve ...@@ -22,6 +22,7 @@ helm serve
``` ```
--address string address to listen on (default "127.0.0.1:8879") --address string address to listen on (default "127.0.0.1:8879")
--repo-path string local directory path from which to serve charts (default "~/.helm/repository/local") --repo-path string local directory path from which to serve charts (default "~/.helm/repository/local")
--url string external URL of chart repository
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
...@@ -37,4 +38,4 @@ helm serve ...@@ -37,4 +38,4 @@ helm serve
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -12,6 +12,7 @@ The status consists of: ...@@ -12,6 +12,7 @@ The status consists of:
- k8s namespace in which the release lives - k8s namespace in which the release lives
- state of the release (can be: UNKNOWN, DEPLOYED, DELETED, SUPERSEDED, FAILED or DELETING) - state of the release (can be: UNKNOWN, DEPLOYED, DELETED, SUPERSEDED, FAILED or DELETING)
- list of resources that this release consists of, sorted by kind - list of resources that this release consists of, sorted by kind
- details on last test suite run, if applicable
- additional notes provided by the chart - additional notes provided by the chart
...@@ -38,4 +39,4 @@ helm status [flags] RELEASE_NAME ...@@ -38,4 +39,4 @@ helm status [flags] RELEASE_NAME
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
## helm test
test a release
### Synopsis
The test command runs the tests for a release.
The argument this command takes is the name of a deployed release.
The tests to be run are defined in the chart that was installed.
```
helm test [RELEASE]
```
### Options
```
--cleanup delete test pods upon completion
--timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -38,15 +38,17 @@ helm upgrade [RELEASE] [CHART] ...@@ -38,15 +38,17 @@ helm upgrade [RELEASE] [CHART]
``` ```
--dry-run simulate an upgrade --dry-run simulate an upgrade
-i, --install if a release by this name doesn't already exist, run an install -i, --install if a release by this name doesn't already exist, run an install
--keyring string path to the keyring that contains public singing keys (default "~/.gnupg/pubring.gpg") --keyring string path to the keyring that contains public signing keys (default "~/.gnupg/pubring.gpg")
--namespace string namespace to install the release into (only used if --install is set) (default "default") --namespace string namespace to install the release into (only used if --install is set) (default "default")
--no-hooks disable pre/post upgrade hooks --no-hooks disable pre/post upgrade hooks
--recreate-pods performs pods restart for the resource if applicable --recreate-pods performs pods restart for the resource if applicable
--reset-values when upgrading, reset the values to the ones built into the chart
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300) --timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
-f, --values valueFiles specify values in a YAML file (can specify multiple) (default []) -f, --values valueFiles specify values in a YAML file (can specify multiple) (default [])
--verify verify the provenance of the chart before upgrading --verify verify the provenance of the chart before upgrading
--version string specify the exact chart version to use. If this is not specified, the latest version is used --version string specify the exact chart version to use. If this is not specified, the latest version is used
--wait if set, will wait until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as --timeout
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
...@@ -62,4 +64,4 @@ helm upgrade [RELEASE] [CHART] ...@@ -62,4 +64,4 @@ helm upgrade [RELEASE] [CHART]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -39,4 +39,4 @@ helm verify [flags] PATH ...@@ -39,4 +39,4 @@ helm verify [flags] PATH
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
...@@ -48,4 +48,4 @@ helm version ...@@ -48,4 +48,4 @@ helm version
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 15-Jan-2017 ###### Auto generated by spf13/cobra on 11-Mar-2017
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -48,6 +48,7 @@ helm list: list releases of charts ...@@ -48,6 +48,7 @@ helm list: list releases of charts
Environment: Environment:
$HELM\_HOME set an alternative location for Helm files. By default, these are stored in \~/.helm $HELM\_HOME set an alternative location for Helm files. By default, these are stored in \~/.helm
$HELM\_HOST set an alternative Tiller host. The format is host:port $HELM\_HOST set an alternative Tiller host. The format is host:port
$HELM\_NO\_PLUGINS disable plugins. Set HELM\_NO\_PLUGINS=1 to disable plugins.
$TILLER\_NAMESPACE set an alternative Tiller namespace (default "kube\-namespace") $TILLER\_NAMESPACE set an alternative Tiller namespace (default "kube\-namespace")
$KUBECONFIG set an alternative Kubernetes configuration file (default "\~/.kube/config") $KUBECONFIG set an alternative Kubernetes configuration file (default "\~/.kube/config")
...@@ -76,9 +77,9 @@ Environment: ...@@ -76,9 +77,9 @@ Environment:
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\fBhelm\-completion(1)\fP, \fBhelm\-create(1)\fP, \fBhelm\-delete(1)\fP, \fBhelm\-dependency(1)\fP, \fBhelm\-fetch(1)\fP, \fBhelm\-get(1)\fP, \fBhelm\-history(1)\fP, \fBhelm\-home(1)\fP, \fBhelm\-init(1)\fP, \fBhelm\-inspect(1)\fP, \fBhelm\-install(1)\fP, \fBhelm\-lint(1)\fP, \fBhelm\-list(1)\fP, \fBhelm\-package(1)\fP, \fBhelm\-repo(1)\fP, \fBhelm\-rollback(1)\fP, \fBhelm\-search(1)\fP, \fBhelm\-serve(1)\fP, \fBhelm\-status(1)\fP, \fBhelm\-upgrade(1)\fP, \fBhelm\-verify(1)\fP, \fBhelm\-version(1)\fP \fBhelm\-completion(1)\fP, \fBhelm\-create(1)\fP, \fBhelm\-delete(1)\fP, \fBhelm\-dependency(1)\fP, \fBhelm\-fetch(1)\fP, \fBhelm\-get(1)\fP, \fBhelm\-history(1)\fP, \fBhelm\-home(1)\fP, \fBhelm\-init(1)\fP, \fBhelm\-inspect(1)\fP, \fBhelm\-install(1)\fP, \fBhelm\-lint(1)\fP, \fBhelm\-list(1)\fP, \fBhelm\-package(1)\fP, \fBhelm\-repo(1)\fP, \fBhelm\-reset(1)\fP, \fBhelm\-rollback(1)\fP, \fBhelm\-search(1)\fP, \fBhelm\-serve(1)\fP, \fBhelm\-status(1)\fP, \fBhelm\-test(1)\fP, \fBhelm\-upgrade(1)\fP, \fBhelm\-verify(1)\fP, \fBhelm\-version(1)\fP
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -71,4 +71,4 @@ $ source <(helm completion) ...@@ -71,4 +71,4 @@ $ source <(helm completion)
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -83,4 +83,4 @@ will be overwritten, but other files will be left alone. ...@@ -83,4 +83,4 @@ will be overwritten, but other files will be left alone.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -70,4 +70,4 @@ deleting them. ...@@ -70,4 +70,4 @@ deleting them.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -38,12 +38,12 @@ For example, this requirements file declares two dependencies: ...@@ -38,12 +38,12 @@ For example, this requirements file declares two dependencies:
.nf .nf
# requirements.yaml # requirements.yaml
dependencies: dependencies:
\- name: nginx \- name: nginx
version: "1.2.3" version: "1.2.3"
repository: "https://example.com/charts" repository: "https://example.com/charts"
\- name: memcached \- name: memcached
version: "3.2.1" version: "3.2.1"
repository: "https://another.example.com/charts" repository: "https://another.example.com/charts"
.fi .fi
.RE .RE
...@@ -61,6 +61,29 @@ appending '/index.yaml' to the URL, it should be able to retrieve the chart ...@@ -61,6 +61,29 @@ appending '/index.yaml' to the URL, it should be able to retrieve the chart
repository's index. Note: 'repository' cannot be a repository alias. It must be repository's index. Note: 'repository' cannot be a repository alias. It must be
a URL. a URL.
.PP
Starting from 2.2.0, repository can be defined as the path to the directory of
the dependency charts stored locally. The path should start with a prefix of
"file://". For example,
.PP
.RS
.nf
# requirements.yaml
dependencies:
\- name: nginx
version: "1.2.3"
repository: "file://../dependency\_chart/nginx"
.fi
.RE
.PP
If the dependency chart is retrieved locally, it is not required to have the
repository added to helm by "helm add repo". Version matching is also supported
for this case.
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
...@@ -91,4 +114,4 @@ a URL. ...@@ -91,4 +114,4 @@ a URL.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -66,4 +66,4 @@ of 'helm dependency update'. ...@@ -66,4 +66,4 @@ of 'helm dependency update'.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -55,4 +55,4 @@ if it cannot find a requirements.yaml. ...@@ -55,4 +55,4 @@ if it cannot find a requirements.yaml.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -19,18 +19,28 @@ Update the on\-disk dependencies to mirror the requirements.yaml file. ...@@ -19,18 +19,28 @@ Update the on\-disk dependencies to mirror the requirements.yaml file.
.PP .PP
This command verifies that the required charts, as expressed in 'requirements.yaml', This command verifies that the required charts, as expressed in 'requirements.yaml',
are present in 'charts/' and are at an acceptable version. are present in 'charts/' and are at an acceptable version. It will pull down
the latest charts that satisfy the dependencies, and clean up old dependencies.
.PP .PP
On successful update, this will generate a lock file that can be used to On successful update, this will generate a lock file that can be used to
rebuild the requirements to an exact version. rebuild the requirements to an exact version.
.PP
Dependencies are not required to be represented in 'requirements.yaml'. For that
reason, an update command will not remove charts unless they are (a) present
in the requirements.yaml file, but (b) at the wrong version.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg" \fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
keyring containing public keys keyring containing public keys
.PP
\fB\-\-skip\-refresh\fP[=false]
do not refresh the local repository cache
.PP .PP
\fB\-\-verify\fP[=false] \fB\-\-verify\fP[=false]
verify the packages against signatures verify the packages against signatures
...@@ -65,4 +75,4 @@ rebuild the requirements to an exact version. ...@@ -65,4 +75,4 @@ rebuild the requirements to an exact version.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -91,4 +91,4 @@ result in an error, and the chart will not be saved locally. ...@@ -91,4 +91,4 @@ result in an error, and the chart will not be saved locally.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -66,4 +66,4 @@ chart, the supplied values, and the generated manifest file. ...@@ -66,4 +66,4 @@ chart, the supplied values, and the generated manifest file.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -56,4 +56,4 @@ Hooks are formatted in YAML and separated by the YAML '\-\-\-\\n' separator. ...@@ -56,4 +56,4 @@ Hooks are formatted in YAML and separated by the YAML '\-\-\-\\n' separator.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -58,4 +58,4 @@ charts, those resources will also be included in the manifest. ...@@ -58,4 +58,4 @@ charts, those resources will also be included in the manifest.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -57,4 +57,4 @@ This command downloads a values file for a given release. ...@@ -57,4 +57,4 @@ This command downloads a values file for a given release.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -29,11 +29,11 @@ The historical release set is printed as a formatted table, e.g: ...@@ -29,11 +29,11 @@ The historical release set is printed as a formatted table, e.g:
.nf .nf
$ helm history angry\-bird \-\-max=4 $ helm history angry\-bird \-\-max=4
REVISION UPDATED STATUS CHART REVISION UPDATED STATUS CHART DESCRIPTION
1 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine\-0.1.0 1 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine\-0.1.0 Initial install
2 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine\-0.1.0 2 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine\-0.1.0 Upgraded successfully
3 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine\-0.1.0 3 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine\-0.1.0 Rolled back to 2
4 Mon Oct 3 10:15:13 2016 DEPLOYED alpine\-0.1.0 4 Mon Oct 3 10:15:13 2016 DEPLOYED alpine\-0.1.0 Upgraded successfully
.fi .fi
.RE .RE
...@@ -74,4 +74,4 @@ REVISION UPDATED STATUS CHART ...@@ -74,4 +74,4 @@ REVISION UPDATED STATUS CHART
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -48,4 +48,4 @@ any helm configuration files live. ...@@ -48,4 +48,4 @@ any helm configuration files live.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -90,4 +90,4 @@ To dump a manifest containing the Tiller deployment YAML, combine the ...@@ -90,4 +90,4 @@ To dump a manifest containing the Tiller deployment YAML, combine the
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -65,4 +65,4 @@ Inspect prints the contents of the Chart.yaml file and the values.yaml file. ...@@ -65,4 +65,4 @@ Inspect prints the contents of the Chart.yaml file and the values.yaml file.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -62,4 +62,4 @@ of the Charts.yaml file ...@@ -62,4 +62,4 @@ of the Charts.yaml file
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -62,4 +62,4 @@ of the values.yaml file ...@@ -62,4 +62,4 @@ of the values.yaml file
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -162,6 +162,10 @@ charts in a repository, use 'helm search'. ...@@ -162,6 +162,10 @@ charts in a repository, use 'helm search'.
\fB\-\-version\fP="" \fB\-\-version\fP=""
specify the exact chart version to install. If this is not specified, the latest version is installed specify the exact chart version to install. If this is not specified, the latest version is installed
.PP
\fB\-\-wait\fP[=false]
if set, will wait until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as \-\-timeout
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
...@@ -192,4 +196,4 @@ charts in a repository, use 'helm search'. ...@@ -192,4 +196,4 @@ charts in a repository, use 'helm search'.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -59,4 +59,4 @@ or recommendation, it will emit [WARNING] messages. ...@@ -59,4 +59,4 @@ or recommendation, it will emit [WARNING] messages.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -82,6 +82,10 @@ flag with the '\-\-offset' flag allows you to page through results. ...@@ -82,6 +82,10 @@ flag with the '\-\-offset' flag allows you to page through results.
\fB\-m\fP, \fB\-\-max\fP=256 \fB\-m\fP, \fB\-\-max\fP=256
maximum number of releases to fetch maximum number of releases to fetch
.PP
\fB\-\-namespace\fP=""
show releases within a specific namespace
.PP .PP
\fB\-o\fP, \fB\-\-offset\fP="" \fB\-o\fP, \fB\-\-offset\fP=""
next release name in the list, used to offset from start value next release name in the list, used to offset from start value
...@@ -124,4 +128,4 @@ flag with the '\-\-offset' flag allows you to page through results. ...@@ -124,4 +128,4 @@ flag with the '\-\-offset' flag allows you to page through results.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -78,4 +78,4 @@ Versioned chart archives are used by Helm package repositories. ...@@ -78,4 +78,4 @@ Versioned chart archives are used by Helm package repositories.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -52,4 +52,4 @@ Example usage: ...@@ -52,4 +52,4 @@ Example usage:
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -65,4 +65,4 @@ add a chart repository ...@@ -65,4 +65,4 @@ add a chart repository
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -66,4 +66,4 @@ into the existing index, with local charts taking priority over existing charts. ...@@ -66,4 +66,4 @@ into the existing index, with local charts taking priority over existing charts.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -47,4 +47,4 @@ list chart repositories ...@@ -47,4 +47,4 @@ list chart repositories
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -47,4 +47,4 @@ remove a chart repository ...@@ -47,4 +47,4 @@ remove a chart repository
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -52,4 +52,4 @@ future releases. ...@@ -52,4 +52,4 @@ future releases.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-reset \- uninstalls Tiller from a cluster
.SH SYNOPSIS
.PP
\fBhelm reset\fP
.SH DESCRIPTION
.PP
This command uninstalls Tiller (the helm server side component) from your
Kubernetes Cluster and optionally deletes local configuration in
$HELM\_HOME (default \~/.helm/)
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-force\fP[=false]
forces Tiller uninstall even if there are releases installed
.PP
\fB\-\-remove\-helm\-home\fP[=false]
if set deletes $HELM\_HOME
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-debug\fP[=false]
enable verbose output
.PP
\fB\-\-home\fP="~/.helm"
location of your Helm config. Overrides $HELM\_HOME
.PP
\fB\-\-host\fP=""
address of tiller. Overrides $HELM\_HOST
.PP
\fB\-\-kube\-context\fP=""
name of the kubeconfig context to use
.PP
\fB\-\-tiller\-namespace\fP="kube\-system"
namespace of tiller
.SH SEE ALSO
.PP
\fBhelm(1)\fP
.SH HISTORY
.PP
11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -40,6 +40,10 @@ second is a revision (version) number. To see revision numbers, run ...@@ -40,6 +40,10 @@ second is a revision (version) number. To see revision numbers, run
\fB\-\-timeout\fP=300 \fB\-\-timeout\fP=300
time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)
.PP
\fB\-\-wait\fP[=false]
if set, will wait until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as \-\-timeout
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
...@@ -70,4 +74,4 @@ second is a revision (version) number. To see revision numbers, run ...@@ -70,4 +74,4 @@ second is a revision (version) number. To see revision numbers, run
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -61,4 +61,4 @@ Repositories are managed with 'helm repo' commands. ...@@ -61,4 +61,4 @@ Repositories are managed with 'helm repo' commands.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -20,7 +20,7 @@ This command starts a local chart repository server that serves charts from a lo ...@@ -20,7 +20,7 @@ This command starts a local chart repository server that serves charts from a lo
.PP .PP
The new server will provide HTTP access to a repository. By default, it will The new server will provide HTTP access to a repository. By default, it will
scan all of the charts in '$HELM\_HOME/repository/local' and serve those over scan all of the charts in '$HELM\_HOME/repository/local' and serve those over
the a local IPv4 TCP port (default '127.0.0.1:8879'). the local IPv4 TCP port (default '127.0.0.1:8879').
.SH OPTIONS .SH OPTIONS
...@@ -32,6 +32,10 @@ the a local IPv4 TCP port (default '127.0.0.1:8879'). ...@@ -32,6 +32,10 @@ the a local IPv4 TCP port (default '127.0.0.1:8879').
\fB\-\-repo\-path\fP="~/.helm/repository/local" \fB\-\-repo\-path\fP="~/.helm/repository/local"
local directory path from which to serve charts local directory path from which to serve charts
.PP
\fB\-\-url\fP=""
external URL of chart repository
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
...@@ -62,4 +66,4 @@ the a local IPv4 TCP port (default '127.0.0.1:8879'). ...@@ -62,4 +66,4 @@ the a local IPv4 TCP port (default '127.0.0.1:8879').
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -21,6 +21,7 @@ The status consists of: ...@@ -21,6 +21,7 @@ The status consists of:
\- k8s namespace in which the release lives \- k8s namespace in which the release lives
\- state of the release (can be: UNKNOWN, DEPLOYED, DELETED, SUPERSEDED, FAILED or DELETING) \- state of the release (can be: UNKNOWN, DEPLOYED, DELETED, SUPERSEDED, FAILED or DELETING)
\- list of resources that this release consists of, sorted by kind \- list of resources that this release consists of, sorted by kind
\- details on last test suite run, if applicable
\- additional notes provided by the chart \- additional notes provided by the chart
...@@ -59,4 +60,4 @@ The status consists of: ...@@ -59,4 +60,4 @@ The status consists of:
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-test \- test a release
.SH SYNOPSIS
.PP
\fBhelm test [RELEASE]\fP
.SH DESCRIPTION
.PP
The test command runs the tests for a release.
.PP
The argument this command takes is the name of a deployed release.
The tests to be run are defined in the chart that was installed.
.SH OPTIONS
.PP
\fB\-\-cleanup\fP[=false]
delete test pods upon completion
.PP
\fB\-\-timeout\fP=300
time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-debug\fP[=false]
enable verbose output
.PP
\fB\-\-home\fP="~/.helm"
location of your Helm config. Overrides $HELM\_HOME
.PP
\fB\-\-host\fP=""
address of tiller. Overrides $HELM\_HOST
.PP
\fB\-\-kube\-context\fP=""
name of the kubeconfig context to use
.PP
\fB\-\-tiller\-namespace\fP="kube\-system"
namespace of tiller
.SH SEE ALSO
.PP
\fBhelm(1)\fP
.SH HISTORY
.PP
11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -67,7 +67,7 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis ...@@ -67,7 +67,7 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis
.PP .PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg" \fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
path to the keyring that contains public singing keys path to the keyring that contains public signing keys
.PP .PP
\fB\-\-namespace\fP="default" \fB\-\-namespace\fP="default"
...@@ -81,6 +81,10 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis ...@@ -81,6 +81,10 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis
\fB\-\-recreate\-pods\fP[=false] \fB\-\-recreate\-pods\fP[=false]
performs pods restart for the resource if applicable performs pods restart for the resource if applicable
.PP
\fB\-\-reset\-values\fP[=false]
when upgrading, reset the values to the ones built into the chart
.PP .PP
\fB\-\-set\fP=[] \fB\-\-set\fP=[]
set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
...@@ -101,6 +105,10 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis ...@@ -101,6 +105,10 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis
\fB\-\-version\fP="" \fB\-\-version\fP=""
specify the exact chart version to use. If this is not specified, the latest version is used specify the exact chart version to use. If this is not specified, the latest version is used
.PP
\fB\-\-wait\fP[=false]
if set, will wait until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as \-\-timeout
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
...@@ -131,4 +139,4 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis ...@@ -131,4 +139,4 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -62,4 +62,4 @@ the 'helm package \-\-sign' command. ...@@ -62,4 +62,4 @@ the 'helm package \-\-sign' command.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
.TH "HELM" "1" "Jan 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
...@@ -80,4 +80,4 @@ use '\-\-server'. ...@@ -80,4 +80,4 @@ use '\-\-server'.
.SH HISTORY .SH HISTORY
.PP .PP
15\-Jan\-2017 Auto generated by spf13/cobra 11\-Mar\-2017 Auto generated by spf13/cobra
...@@ -361,6 +361,8 @@ _helm_dependency_update() ...@@ -361,6 +361,8 @@ _helm_dependency_update()
flags+=("--keyring=") flags+=("--keyring=")
local_nonpersistent_flags+=("--keyring=") local_nonpersistent_flags+=("--keyring=")
flags+=("--skip-refresh")
local_nonpersistent_flags+=("--skip-refresh")
flags+=("--verify") flags+=("--verify")
local_nonpersistent_flags+=("--verify") local_nonpersistent_flags+=("--verify")
flags+=("--debug") flags+=("--debug")
...@@ -741,6 +743,8 @@ _helm_install() ...@@ -741,6 +743,8 @@ _helm_install()
local_nonpersistent_flags+=("--verify") local_nonpersistent_flags+=("--verify")
flags+=("--version=") flags+=("--version=")
local_nonpersistent_flags+=("--version=") local_nonpersistent_flags+=("--version=")
flags+=("--wait")
local_nonpersistent_flags+=("--wait")
flags+=("--debug") flags+=("--debug")
flags+=("--home=") flags+=("--home=")
flags+=("--host=") flags+=("--host=")
...@@ -803,6 +807,8 @@ _helm_list() ...@@ -803,6 +807,8 @@ _helm_list()
flags+=("--max=") flags+=("--max=")
two_word_flags+=("-m") two_word_flags+=("-m")
local_nonpersistent_flags+=("--max=") local_nonpersistent_flags+=("--max=")
flags+=("--namespace=")
local_nonpersistent_flags+=("--namespace=")
flags+=("--offset=") flags+=("--offset=")
two_word_flags+=("-o") two_word_flags+=("-o")
local_nonpersistent_flags+=("--offset=") local_nonpersistent_flags+=("--offset=")
...@@ -1004,6 +1010,33 @@ _helm_repo() ...@@ -1004,6 +1010,33 @@ _helm_repo()
noun_aliases=() noun_aliases=()
} }
_helm_reset()
{
last_command="helm_reset"
commands=()
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--force")
flags+=("-f")
local_nonpersistent_flags+=("--force")
flags+=("--remove-helm-home")
local_nonpersistent_flags+=("--remove-helm-home")
flags+=("--debug")
flags+=("--home=")
flags+=("--host=")
flags+=("--kube-context=")
flags+=("--tiller-namespace=")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
_helm_rollback() _helm_rollback()
{ {
last_command="helm_rollback" last_command="helm_rollback"
...@@ -1023,6 +1056,8 @@ _helm_rollback() ...@@ -1023,6 +1056,8 @@ _helm_rollback()
local_nonpersistent_flags+=("--recreate-pods") local_nonpersistent_flags+=("--recreate-pods")
flags+=("--timeout=") flags+=("--timeout=")
local_nonpersistent_flags+=("--timeout=") local_nonpersistent_flags+=("--timeout=")
flags+=("--wait")
local_nonpersistent_flags+=("--wait")
flags+=("--debug") flags+=("--debug")
flags+=("--home=") flags+=("--home=")
flags+=("--host=") flags+=("--host=")
...@@ -1077,6 +1112,8 @@ _helm_serve() ...@@ -1077,6 +1112,8 @@ _helm_serve()
local_nonpersistent_flags+=("--address=") local_nonpersistent_flags+=("--address=")
flags+=("--repo-path=") flags+=("--repo-path=")
local_nonpersistent_flags+=("--repo-path=") local_nonpersistent_flags+=("--repo-path=")
flags+=("--url=")
local_nonpersistent_flags+=("--url=")
flags+=("--debug") flags+=("--debug")
flags+=("--home=") flags+=("--home=")
flags+=("--host=") flags+=("--host=")
...@@ -1111,6 +1148,32 @@ _helm_status() ...@@ -1111,6 +1148,32 @@ _helm_status()
noun_aliases=() noun_aliases=()
} }
_helm_test()
{
last_command="helm_test"
commands=()
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--cleanup")
local_nonpersistent_flags+=("--cleanup")
flags+=("--timeout=")
local_nonpersistent_flags+=("--timeout=")
flags+=("--debug")
flags+=("--home=")
flags+=("--host=")
flags+=("--kube-context=")
flags+=("--tiller-namespace=")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
_helm_upgrade() _helm_upgrade()
{ {
last_command="helm_upgrade" last_command="helm_upgrade"
...@@ -1137,6 +1200,8 @@ _helm_upgrade() ...@@ -1137,6 +1200,8 @@ _helm_upgrade()
local_nonpersistent_flags+=("--no-hooks") local_nonpersistent_flags+=("--no-hooks")
flags+=("--recreate-pods") flags+=("--recreate-pods")
local_nonpersistent_flags+=("--recreate-pods") local_nonpersistent_flags+=("--recreate-pods")
flags+=("--reset-values")
local_nonpersistent_flags+=("--reset-values")
flags+=("--set=") flags+=("--set=")
local_nonpersistent_flags+=("--set=") local_nonpersistent_flags+=("--set=")
flags+=("--timeout=") flags+=("--timeout=")
...@@ -1148,6 +1213,8 @@ _helm_upgrade() ...@@ -1148,6 +1213,8 @@ _helm_upgrade()
local_nonpersistent_flags+=("--verify") local_nonpersistent_flags+=("--verify")
flags+=("--version=") flags+=("--version=")
local_nonpersistent_flags+=("--version=") local_nonpersistent_flags+=("--version=")
flags+=("--wait")
local_nonpersistent_flags+=("--wait")
flags+=("--debug") flags+=("--debug")
flags+=("--home=") flags+=("--home=")
flags+=("--host=") flags+=("--host=")
...@@ -1232,10 +1299,12 @@ _helm() ...@@ -1232,10 +1299,12 @@ _helm()
commands+=("list") commands+=("list")
commands+=("package") commands+=("package")
commands+=("repo") commands+=("repo")
commands+=("reset")
commands+=("rollback") commands+=("rollback")
commands+=("search") commands+=("search")
commands+=("serve") commands+=("serve")
commands+=("status") commands+=("status")
commands+=("test")
commands+=("upgrade") commands+=("upgrade")
commands+=("verify") commands+=("verify")
commands+=("version") commands+=("version")
......
#!/usr/bin/env bash
# Copyright 2016 The Kubernetes Authors All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
set -euo pipefail
if LANG=C sed --help 2>&1 | grep -q GNU; then
SED="sed"
elif which gsed &>/dev/null; then
SED="gsed"
else
echo "Failed to find GNU sed as sed or gsed. If you are on Mac: brew install gnu-sed." >&2
exit 1
fi
FILES=$(find ./docs -type f)
${SED} -i -e "s:${HOME}:~:" ${FILES}
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