Struct kube_client::Config

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>,
    // some fields omitted
}

This is supported on crate feature config only.

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 ceritifacts

proxy_url: Option<Uri>

Optional proxy URL.

Implementations

impl Config

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.

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

Infer the configuration from the environment

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

Fails if inference from both sources fails

pub fn from_cluster_env() -> Result<Self>

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.

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

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.

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

Create configuration from a Kubeconfig struct

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

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConfigExt for Config

This is supported on crate feature client only.

fn base_uri_layer(&self) -> BaseUriLayer

Layer to set the base URI of requests to the configured server.

fn auth_layer(&self) -> Result<Option<AuthLayer>>

Optional layer to set up Authorization header depending on the config.

fn native_tls_connector(&self) -> Result<TlsConnector>

This is supported on crate feature native-tls only.

Create native_tls::TlsConnector based on config.

fn native_tls_https_connector(&self) -> Result<HttpsConnector<HttpConnector>>

This is supported on crate feature native-tls only.

Create hyper_tls::HttpsConnector based on config.

fn rustls_client_config(&self) -> Result<ClientConfig>

This is supported on crate feature rustls-tls only.

Create rustls::ClientConfig based on config.

fn rustls_https_connector(&self) -> Result<HttpsConnector<HttpConnector>>

This is supported on crate feature rustls-tls only.

Create hyper_rustls::HttpsConnector based on config.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl TryFrom<Config> for Client

This is supported on crate feature client only.

fn try_from(config: Config) -> Result<Self>

Convert Config into a Client

type Error = Error

The type returned in the event of a conversion error.