Struct kube_client::Config

source · [−]

pub struct Config {
    pub cluster_url: Uri,
    pub default_namespace: String,
    pub root_cert: Option<Vec<Vec<u8>>>,
    pub timeout: Option<Duration>,
    pub accept_invalid_certs: bool,
    pub proxy_url: Option<Uri>,
    /* private fields */
}

Available on crate feature config only.

Expand description

Configuration object detailing things like cluster URL, default namespace, root certificates, and timeouts.

Usage

Construct a Config instance by using one of the many constructors.

Prefer Config::infer unless you have particular issues, and avoid manually managing the data in this struct unless you have particular needs. It exists to be consumed by the Client.

If you are looking to parse the kubeconfig found in a user’s home directory see Kubeconfig.

Fields

cluster_url: Uri

The configured cluster url

default_namespace: String

The configured default namespace

root_cert: Option<Vec<Vec<u8>>>

The configured root certificate

timeout: Option<Duration>

Timeout for calls to the Kubernetes API.

A value of None means no timeout

accept_invalid_certs: bool

Whether to accept invalid certificates

proxy_url: Option<Uri>

Optional proxy URL.

Implementations

source

impl Config

source

pub fn new(cluster_url: Uri) -> Self

Construct a new config where only the cluster_url is set by the user. and everything else receives a default value.

Most likely you want to use Config::infer to infer the config from the environment.

source

pub async fn infer() -> Result<Self, InferConfigError>

Infer the configuration from the environment

Done by attempting to load the local kubec-config first, and then if that fails, trying the in-cluster environment variables .

Fails if inference from both sources fails

Applies debug overrides, see Config::apply_debug_overrides for more details

source

pub fn from_cluster_env() -> Result<Self, InClusterError>

Create configuration from the cluster’s environment variables

This follows the standard API Access from a Pod and relies on you having the service account’s token mounted, as well as having given the service account rbac access to do what you need.

source

pub async fn from_kubeconfig(
options: &KubeConfigOptions
) -> Result<Self, KubeconfigError>

Create configuration from the default local config file

This will respect the $KUBECONFIG evar, but otherwise default to ~/.kube/config. You can also customize what context/cluster/user you want to use here, but it will default to the current-context.

source

pub async fn from_custom_kubeconfig(
kubeconfig: Kubeconfig,
options: &KubeConfigOptions
) -> Result<Self, KubeconfigError>

Create configuration from a Kubeconfig struct

This bypasses kube’s normal config parsing to obtain custom functionality.

source

pub fn apply_debug_overrides(&mut self)

Override configuration based on environment variables

This is only intended for use as a debugging aid, and the specific variables and their behaviour should not be considered stable across releases.

Currently, the following overrides are supported:

KUBE_RS_DEBUG_IMPERSONATE_USER: A Kubernetes user to impersonate, for example: system:serviceaccount:default:foo will impersonate the ServiceAccount foo in the Namespace default
KUBE_RS_DEBUG_IMPERSONATE_GROUP: A Kubernetes group to impersonate, multiple groups may be specified by separating them with commas
KUBE_RS_DEBUG_OVERRIDE_URL: A Kubernetes cluster URL to use rather than the one specified in the config, useful for proxying traffic through kubectl proxy