Struct kube::config::Kubeconfig

pub struct Kubeconfig {
    pub preferences: Option<Preferences>,
    pub clusters: Vec<NamedCluster, Global>,
    pub auth_infos: Vec<NamedAuthInfo, Global>,
    pub contexts: Vec<NamedContext, Global>,
    pub current_context: Option<String>,
    pub extensions: Option<Vec<NamedExtension, Global>>,
    pub kind: Option<String>,
    pub api_version: Option<String>,
}

Available on crate feature config only.

Kubeconfig represents information on how to connect to a remote Kubernetes cluster

Stored in ~/.kube/config by default, but can be distributed across multiple paths in passed through KUBECONFIG. An analogue of the config type from client-go.

This type (and its children) are exposed primarily for convenience.

Config is the intended developer interface to help create a Client, and this will handle the difference between in-cluster deployment and local development.

Fields

preferences: Option<Preferences>

General information to be use for cli interactions

clusters: Vec<NamedCluster, Global>

Referencable names to cluster configs

auth_infos: Vec<NamedAuthInfo, Global>

Referencable names to user configs

contexts: Vec<NamedContext, Global>

Referencable names to context configs

current_context: Option<String>

The name of the context that you would like to use by default

extensions: Option<Vec<NamedExtension, Global>>

Additional information for extenders so that reads and writes don’t clobber unknown fields.

kind: Option<String>

Legacy field from TypeMeta

api_version: Option<String>

Legacy field from TypeMeta

Implementations

impl Kubeconfig

Some helpers on the raw Config object are exposed for people needing to parse it

pub fn read_from<P>(path: P) -> Result<Kubeconfig, KubeconfigError>where
    P: AsRef<Path>,

Read a Config from an arbitrary location

pub fn from_yaml(text: &str) -> Result<Kubeconfig, KubeconfigError>

Read a Config from an arbitrary YAML string

This is preferable to using serde_yaml::from_str() because it will correctly parse multi-document YAML text and merge them into a single Kubeconfig

pub fn read() -> Result<Kubeconfig, KubeconfigError>

Read a Config from KUBECONFIG or the the default location.

pub fn from_env() -> Result<Option<Kubeconfig>, KubeconfigError>

Create Kubeconfig from KUBECONFIG environment variable. Supports list of files to be merged.

Panics

Panics if KUBECONFIG value contains the NUL character.

pub fn merge(self, next: Kubeconfig) -> Result<Kubeconfig, KubeconfigError>

Merge kubeconfig file according to the rules described in https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#merging-kubeconfig-files

Merge the files listed in the KUBECONFIG environment variable according to these rules:

• Ignore empty filenames.
• Produce errors for files with content that cannot be deserialized.
• The first file to set a particular value or map key wins.
• Never change the value or map key. Example: Preserve the context of the first file to set current-context. Example: If two files specify a red-user, use only values from the first file’s red-user. Even if the second file has non-conflicting entries under red-user, discard them.

Trait Implementations

impl Clone for Kubeconfig

fn clone(&self) -> Kubeconfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Kubeconfig

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

Formats the value using the given formatter.

impl Default for Kubeconfig

fn default() -> Kubeconfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Kubeconfig

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Kubeconfig, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Kubeconfig

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.