Struct kube::Config

pub struct Config {
    pub cluster_url: Url,
    pub default_ns: String,
    pub root_cert: Option<Certificate>,
    pub headers: HeaderMap,
    pub timeout: Duration,
    pub accept_invalid_certs: bool,
    // some fields omitted
}

Configuration object detailing things like cluster_url, default namespace, root certificates, and timeouts

Fields

cluster_url: Url

The configured cluster url

default_ns: String

The configured default namespace

root_cert: Option<Certificate>

The configured root certificate

headers: HeaderMap

Default headers to be used to communicate with the Kubernetes API

timeout: Duration

Timeout for calls to the Kubernetes API.

A value of None means no timeout

accept_invalid_certs: bool

Whether to accept invalid ceritifacts

Methods

impl Config

pub fn new(cluster_url: Url) -> 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 config 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 new_from_cluster_env() -> Result<Self>

Read the config from the cluster's environment variables

pub async fn new_from_kubeconfig<'_>(
    options: &'_ KubeConfigOptions
) -> Result<Self>

Returns a client builder based on the cluster information from the kubeconfig file.

This allows to create your custom reqwest client for using with the cluster API.

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 Debug for Config

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

Formats the value using the given formatter.

impl From<Config> for ClientBuilder

fn from(config: Config) -> Self

Performs the conversion.

impl TryFrom<Config> for Client

type Error = Error

The type returned in the event of a conversion error.

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

Convert Config into a Client