Update docs and add one missing place

Signed-off-by: Alexander Nesterenko <nestorf250@gmail.com>
pull/5166/head
Alexander Nesterenko 7 years ago
parent 2fd840c0e9
commit 945d87e394

@ -38,8 +38,7 @@ import (
const initDesc = ` const initDesc = `
This command sets up local configuration in $XDG_CONFIG_HOME/helm This command sets up local configuration in $XDG_CONFIG_HOME/helm
($HOME/.config/helm on Linux, %APPDATA%\helm on Windows and ($HOME/.config/helm on Linux, %APPDATA%\helm on Windows and
$HOME/Library/Preferences on OSX). $HOME/Library/Preferences/helm on macOS).
NOTE: if there is old-style "$HOME/.helm" directory, it will be preffered.
` `
const ( const (

@ -45,12 +45,12 @@ Common actions from this point include:
Environment: Environment:
$HELM_HOME set an alternative location for Helm files. By default, these are stored in $HELM_HOME set an alternative location for Helm files. By default, these are stored in
"$XDG_CONFIG_DIR/helm" ("$HOME/.config/helm" on Linux, $XDG_CONFIG_DIR/helm ($HOME/.config/helm on Linux, %APPDATA%\helm on Windows
"%APPDATA%\helm" on Windows and "$HOME/Library/Preferences" on OSX). and $HOME/Library/Preferences/helm on macOS).
NOTE: if there is old-style "$HOME/.helm" directory, it will be used. NOTE: if there is old-style $HOME/.helm directory, it will be used.
$HELM_DRIVER set the backend storage driver. Values are: configmap, secret, memory $HELM_DRIVER set the backend storage driver. Values are: configmap, secret, memory
$HELM_NO_PLUGINS disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins. $HELM_NO_PLUGINS disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins.
$KUBECONFIG set an alternative Kubernetes configuration file (default "$HOME/.kube/config") $KUBECONFIG set an alternative Kubernetes configuration file (default $HOME/.kube/config)
` `
// TODO: 'c helm.Interface' is deprecated in favor of actionConfig // TODO: 'c helm.Interface' is deprecated in favor of actionConfig

@ -26,7 +26,7 @@ We provide it because it is useful, but we suggest that users carefully read the
script first. What we'd really like, though, are better packaged releases of script first. What we'd really like, though, are better packaged releases of
Helm. Helm.
### How do I put the Helm client files somewhere other than ~/.helm? ### How do I put the Helm client files somewhere other than default location?
Set the `$HELM_HOME` environment variable, and then run `helm init`: Set the `$HELM_HOME` environment variable, and then run `helm init`:
@ -44,8 +44,11 @@ with `helm repo add...`.
### I want to delete my local Helm. Where are all its files? ### I want to delete my local Helm. Where are all its files?
Along with the `helm` binary, Helm stores some files in `$HELM_HOME`, which is Along with the `helm` binary, Helm stores some files in `$HELM_HOME`, which is
located by default in `~/.helm`. located by default in one of following directories:
* `$HOME/.config/helm` on Linux
* `$HOME/Library/Preferences/helm` on macOS
* `%APPDATA%\helm` on Windows
* `$HOME/.helm` if you have used helm before 3rd release
## Troubleshooting ## Troubleshooting

@ -57,7 +57,11 @@ capitalized. When speaking of the client, _helm_ is in lowercase.
## Helm Home (HELM_HOME) ## Helm Home (HELM_HOME)
The Helm client stores information in a local directory referred to as The Helm client stores information in a local directory referred to as
_helm home_. By default, this is in the `$HOME/.helm` directory. _helm home_. By default, it is located in one of these directories:
* `$HOME/.config/helm` on Linux
* `$HOME/Library/Preferences/helm` on OSx
* `%APPDATA%\helm` on Windows
* `$HOME/.helm` if you have used helm before 3rd release
This directory contains configuration and cache data, and is created by This directory contains configuration and cache data, and is created by
`helm init`. `helm init`.

@ -25,8 +25,8 @@ import (
// New default helm home, with different paths for different OS: // New default helm home, with different paths for different OS:
// - %APPDATA%\helm on Windows // - %APPDATA%\helm on Windows
// - $HOME/Library/Preferences/helm on OSX // - $HOME/Library/Preferences/helm on macOS
// - $kXDG_CONFIG_HOME/helm (typically $HOME/.config/helm for Linux) // - $XDG_CONFIG_HOME/helm (typically $HOME/.config/helm for Linux)
var defaultHelmHome = xdg.App{Name: "helm"}.ConfigPath("") var defaultHelmHome = xdg.App{Name: "helm"}.ConfigPath("")
// Old default helm home, it's old good $HELM/.helm // Old default helm home, it's old good $HELM/.helm

Loading…
Cancel
Save