Struct kube_client::config::Kubeconfig

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

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>

Referencable names to cluster configs

§auth_infos: Vec<NamedAuthInfo>

Referencable names to user configs

§contexts: Vec<NamedContext>

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>>

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§

source§

impl Kubeconfig

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

source

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

Read a Config from an arbitrary location

source

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

source

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

Read a Config from KUBECONFIG or the the default location.

source

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

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

§Panics

Panics if KUBECONFIG value contains the NUL character.

source

pub fn merge(self, next: Kubeconfig) -> Result<Self, 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§

source§

impl Clone for Kubeconfig

source§

fn clone(&self) -> Kubeconfig

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Kubeconfig

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Kubeconfig

source§

fn default() -> Kubeconfig

Returns the “default value” for a type. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Serialize for Kubeconfig

source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,