github.com/strongmonkey/helm@v2.7.2+incompatible/pkg/helm/environment/environment.go (about)

     1  /*
     2  Copyright 2016 The Kubernetes Authors All rights reserved.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  /*Package environment describes the operating environment for Tiller.
    18  
    19  Tiller's environment encapsulates all of the service dependencies Tiller has.
    20  These dependencies are expressed as interfaces so that alternate implementations
    21  (mocks, etc.) can be easily generated.
    22  */
    23  package environment
    24  
    25  import (
    26  	"os"
    27  	"path/filepath"
    28  
    29  	"github.com/spf13/pflag"
    30  
    31  	"k8s.io/client-go/util/homedir"
    32  	"k8s.io/helm/pkg/helm/helmpath"
    33  )
    34  
    35  // DefaultHelmHome is the default HELM_HOME.
    36  var DefaultHelmHome = filepath.Join(homedir.HomeDir(), ".helm")
    37  
    38  // EnvSettings describes all of the environment settings.
    39  type EnvSettings struct {
    40  	// TillerHost is the host and port of Tiller.
    41  	TillerHost string
    42  	// TillerNamespace is the namespace in which Tiller runs.
    43  	TillerNamespace string
    44  	// Home is the local path to the Helm home directory.
    45  	Home helmpath.Home
    46  	// Debug indicates whether or not Helm is running in Debug mode.
    47  	Debug bool
    48  	// KubeContext is the name of the kubeconfig context.
    49  	KubeContext string
    50  }
    51  
    52  // AddFlags binds flags to the given flagset.
    53  func (s *EnvSettings) AddFlags(fs *pflag.FlagSet) {
    54  	fs.StringVar((*string)(&s.Home), "home", DefaultHelmHome, "location of your Helm config. Overrides $HELM_HOME")
    55  	fs.StringVar(&s.TillerHost, "host", "", "address of Tiller. Overrides $HELM_HOST")
    56  	fs.StringVar(&s.KubeContext, "kube-context", "", "name of the kubeconfig context to use")
    57  	fs.BoolVar(&s.Debug, "debug", false, "enable verbose output")
    58  	fs.StringVar(&s.TillerNamespace, "tiller-namespace", "kube-system", "namespace of Tiller")
    59  }
    60  
    61  // Init sets values from the environment.
    62  func (s *EnvSettings) Init(fs *pflag.FlagSet) {
    63  	for name, envar := range envMap {
    64  		setFlagFromEnv(name, envar, fs)
    65  	}
    66  }
    67  
    68  // PluginDirs is the path to the plugin directories.
    69  func (s EnvSettings) PluginDirs() string {
    70  	if d, ok := os.LookupEnv("HELM_PLUGIN"); ok {
    71  		return d
    72  	}
    73  	return s.Home.Plugins()
    74  }
    75  
    76  // envMap maps flag names to envvars
    77  var envMap = map[string]string{
    78  	"debug":            "HELM_DEBUG",
    79  	"home":             "HELM_HOME",
    80  	"host":             "HELM_HOST",
    81  	"tiller-namespace": "TILLER_NAMESPACE",
    82  }
    83  
    84  func setFlagFromEnv(name, envar string, fs *pflag.FlagSet) {
    85  	if fs.Changed(name) {
    86  		return
    87  	}
    88  	if v, ok := os.LookupEnv(envar); ok {
    89  		fs.Set(name, v)
    90  	}
    91  }
    92  
    93  // Deprecated
    94  const (
    95  	HomeEnvVar          = "HELM_HOME"
    96  	PluginEnvVar        = "HELM_PLUGIN"
    97  	PluginDisableEnvVar = "HELM_NO_PLUGINS"
    98  	HostEnvVar          = "HELM_HOST"
    99  	DebugEnvVar         = "HELM_DEBUG"
   100  )