config

Documentation

Index

• Constants
• Variables
• func CreateConfig(namespace string, clientCfg *restclient.Config) (*clientcmdapi.Config, error)
• func FindExistingContextName(haystack clientcmdapi.Config, needle clientcmdapi.Context) string
• func GetClusterNicknameFromConfig(clientCfg *restclient.Config) (string, error)
• func GetClusterNicknameFromURL(apiServerLocation string) (string, error)
• func GetContextNickname(namespace, clusterNick, userNick string) string
• func GetContextNicknameFromConfig(namespace string, clientCfg *restclient.Config) (string, error)
• func GetUserNicknameFromCert(clusterNick string, chain ...*x509.Certificate) (string, error)
• func GetUserNicknameFromConfig(clientCfg *restclient.Config) (string, error)
• func MergeConfig(startingConfig, addition clientcmdapi.Config) (*clientcmdapi.Config, error)
• func NewOpenShiftClientConfigLoadingRules() *clientcmd.ClientConfigLoadingRules
• func NewPathOptions(cmd *cobra.Command) *kubecmdconfig.PathOptions
• func NewPathOptionsWithConfig(configPath string) *kubecmdconfig.PathOptions
• func NormalizeServerURL(s string) (string, error)
• func RelativizeClientConfigPaths(cfg *clientcmdapi.Config, base string) (err error)

Constants

const (
	OpenShiftConfigPathEnvVar      = "KUBECONFIG"
	OpenShiftConfigFlagName        = "config"
	OpenShiftConfigHomeDir         = ".kube"
	OpenShiftConfigHomeFileName    = "config"
	OpenShiftConfigHomeDirFileName = OpenShiftConfigHomeDir + "/" + OpenShiftConfigHomeFileName
)

Variables

var RecommendedHomeFile = path.Join(homedir.HomeDir(), OpenShiftConfigHomeDirFileName)

Functions

func CreateConfig

func CreateConfig(namespace string, clientCfg *restclient.Config) (*clientcmdapi.Config, error)

CreateConfig takes a clientCfg and builds a config (kubeconfig style) from it.

func FindExistingContextName

func FindExistingContextName(haystack clientcmdapi.Config, needle clientcmdapi.Context) string

FindExistingContextName finds the nickname for the passed context

func GetClusterNicknameFromConfig

func GetClusterNicknameFromConfig(clientCfg *restclient.Config) (string, error)

GetClusterNicknameFromConfig returns host:port of the clientConfig.Host, with .'s replaced by -'s

func GetClusterNicknameFromURL

func GetClusterNicknameFromURL(apiServerLocation string) (string, error)

GetClusterNicknameFromURL returns host:port of the apiServerLocation, with .'s replaced by -'s

func GetContextNickname

func GetContextNickname(namespace, clusterNick, userNick string) string

func GetContextNicknameFromConfig

func GetContextNicknameFromConfig(namespace string, clientCfg *restclient.Config) (string, error)

GetContextNicknameFromConfig returns "namespace/GetClusterNicknameFromConfig/username(as known by the server)". This allows tab completion for switching projects/context to work easily. First tab is the most selective on project. Second stanza in the next most selective on cluster name. The chances of a user trying having one projects on a single server that they want to operate against with two identities is low, so username is last.

func GetUserNicknameFromCert

func GetUserNicknameFromCert(clusterNick string, chain ...*x509.Certificate) (string, error)

func GetUserNicknameFromConfig

func GetUserNicknameFromConfig(clientCfg *restclient.Config) (string, error)

GetUserNicknameFromConfig returns "username(as known by the server)/GetClusterNicknameFromConfig". This allows tab completion for switching users to work easily and obviously.

func MergeConfig

func MergeConfig(startingConfig, addition clientcmdapi.Config) (*clientcmdapi.Config, error)

MergeConfig adds the additional Config stanzas to the startingConfig. It blindly stomps clusters and users, but it searches for a matching context before writing a new one.

func NewOpenShiftClientConfigLoadingRules

func NewOpenShiftClientConfigLoadingRules() *clientcmd.ClientConfigLoadingRules

NewOpenShiftClientConfigLoadingRules returns file priority loading rules for OpenShift. 1. --config value 2. if KUBECONFIG env var has a value, use it. Otherwise, ~/.kube/config file

func NewPathOptions

func NewPathOptions(cmd *cobra.Command) *kubecmdconfig.PathOptions

func NewPathOptionsWithConfig

func NewPathOptionsWithConfig(configPath string) *kubecmdconfig.PathOptions

func NormalizeServerURL

func NormalizeServerURL(s string) (string, error)

NormalizeServerURL is opinionated normalization of a string that represents a URL. Returns the URL provided matching the format expected when storing a URL in a config. Sets a scheme and port if not present, removes unnecessary trailing slashes, etc. Can be used to normalize a URL provided by user input.

func RelativizeClientConfigPaths

func RelativizeClientConfigPaths(cfg *clientcmdapi.Config, base string) (err error)

TODO should be moved upstream