Environment
Environment variables
Section titled “Environment variables”The environment variables
KUBEE_USER_NAME
Section titled “KUBEE_USER_NAME”KUBEE_USER_NAME: the connection username (default to default)
Used in the creation of a config file
KUBEE_CLUSTER_NAME
Section titled “KUBEE_CLUSTER_NAME”KUBEE_CLUSTER_NAME defines the default cluster name.
You can set it also via the -c or --cluster command line option.
The cluster name is used:
- in connection
- in the detection of a cluster project
KUBEE_CLUSTERS_PATH
Section titled “KUBEE_CLUSTERS_PATH”KUBEE_CLUSTERS_PATH defines a list of directory path where you could find cluster definitions (environment, values and
inventory file)
Example
export KUBEE_CLUSTERS_PATH="$HOME/argocd/clusters:$HOME/argocd-2/clusters"KUBEE_CHARTS_PATH
Section titled “KUBEE_CHARTS_PATH”The $KUBEE_CHARTS_PATH environment variable defines a path environment variable where each path is a directory that
contains
kubee charts.
It should be set in your .bashrc
Example:
export KUBEE_CHARTS_PATH=$HOME/my-kubee-charts:$HOME/my-other-kubee-chartsKUBEE_BUSYBOX_IMAGE
Section titled “KUBEE_BUSYBOX_IMAGE”The image used by kubee-shell when asking for a shell in a busybox.
Default to ghcr.io/gerardnico/busybox:latest
export KUBEE_BUSYBOX_IMAGE=ghcr.io/gerardnico/busybox:latestKUBEE_CONNECTION_NAMESPACE_DEFAULT
Section titled “KUBEE_CONNECTION_NAMESPACE_DEFAULT”KUBEE_CONNECTION_NAMESPACE_DEFAULT: the default connection namespace.
KUBEE_PASS_HOME
Section titled “KUBEE_PASS_HOME”KUBEE_PASS_HOME: the home directory in pass (default to kubee) for the location of
the connection secrets
Connection environment
Section titled “Connection environment”Connection namespace
Section titled “Connection namespace”Connection Namespace Order of precedence: In order, the connection namespace value used is:
defaultif the flag--all-namespaceis passed- the option value of the flag
-n|--namespace - KUBEE_CONNECTION_NAMESPACE_DEFAULT if it exists
- otherwise
default
Connection Context Name
Section titled “Connection Context Name”The connection context name in the config file is derived as $KUBEE_USER@$KUBEE_CLUSTER/$KUBEE_CONNECTION_NAMESPACE
Connection Secrets Path
Section titled “Connection Secrets Path”client-certificate-data:$KUBEE_PASS_HOME/users/$KUBEE_USER_NAME/client-certificate-dataclient-key-data:$KUBEE_PASS_HOME/users/$KUBEE_USER_NAME/client-key-dataclient-token:$KUBEE_PASS_HOME/users/$KUBEE_USER_NAME/client-token
To get the env in the prompt such as cluster and namespace, check kube-ps1