[−][src]Struct kube::Config
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<Vec<Certificate>>
The configured root certificate
headers: HeaderMap
Default headers to be used to communicate with the Kubernetes API
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
Implementations
impl Config
[src]
pub fn new(cluster_url: Url) -> Self
[src]
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>
[src]
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>
[src]
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>
[src]
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>
[src]
kubeconfig: Kubeconfig,
options: &KubeConfigOptions
) -> Result<Self>
Create configuration from a Kubeconfig
struct
This bypasses kube's normal config parsing to obtain custom functionality. Like if you need stacked kubeconfigs for instance - see #132
pub async fn get_auth_header(&self) -> Result<Option<HeaderValue>, ConfigError>
[src]
Get a valid HTTP Authorization
header that can authenticate to the cluster
Will renew tokens if required (and configured to).
NOTE: This is None
if the Config
isn't configured to use token-based authentication
(such as anonymous access, or certificate-based authentication).
pub fn proxy(self, proxy: Proxy) -> Self
[src]
Configure a proxy for this kube config
use kube::{Config, config}; #[tokio::main] async fn main() -> Result<(), kube::Error> { let mut config = Config::from_kubeconfig(&config::KubeConfigOptions::default()).await?; let proxy = reqwest::Proxy::http("https://localhost:8080")?; let config = config.proxy(proxy); Ok(()) }
Trait Implementations
impl Clone for Config
[src]
impl Debug for Config
[src]
impl From<Config> for ClientBuilder
[src]
impl TryFrom<Config> for Client
[src]
Auto Trait Implementations
impl !RefUnwindSafe for Config
[src]
impl Send for Config
[src]
impl Sync for Config
[src]
impl Unpin for Config
[src]
impl !UnwindSafe for Config
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,