mirror of https://github.com/helm/helm
Merge pull request #2105 from cblecker/docs-clean-home
Add script to clean homedir out of docspull/2120/head
Taylor Thomas
8 years ago
committed by
GitHub
commit
24eb6011b5
@ -0,0 +1,38 @@
|
||||
## 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
|
||||
@ -0,0 +1,39 @@
|
||||
## 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
|
||||
@ -0,0 +1,62 @@
|
||||
.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
|
||||
@ -0,0 +1,64 @@
|
||||
.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
|
||||
@ -0,0 +1,30 @@
|
||||
#!/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}
|
||||
Loading…
Reference in new issue