Skip to main content

kube

A Kubernetes client library written in Rust. It is the Rust counterpart to Go's client-go and is hosted as a CNCF Sandbox project.

use kube::{Api, Client};
use k8s_openapi::api::core::v1::Pod;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let client = Client::try_default().await?;
    let pods: Api<Pod> = Api::default_namespaced(client);

    for pod in pods.list(&Default::default()).await? {
        println!("{}", pod.metadata.name.unwrap_or_default());
    }
    Ok(())
}

About This Guide​

This guide is for those who use kube but want a deeper understanding of how it works internally. Rather than covering basic usage, it traces through the actual code implementation to explain why it was designed this way and what happens under the hood.

Prerequisites​

  • Rust fundamentals (traits, generics, async/await)
  • Kubernetes basics (Pod, Deployment, CRD, watch, controller)

Table of Contents​

SectionDescription
ArchitectureCrate structure, type system, Client internals, request flow
Runtime InternalsHow watcher/reflector/Controller work
PatternsCorrect usage patterns and common pitfalls
ProductionMonitoring, testing, optimization, security, availability, validation

Basic Setup​

Cargo.toml
[dependencies]
kube = { version = "3.0.1", features = ["runtime", "derive"] }
k8s-openapi = { version = "0.27.0", features = ["latest", "schemars"] }
schemars = "1"
tokio = { version = "1", features = ["full"] }
serde = { version = "1", features = ["derive"] }
serde_json = "1"
anyhow = "1"

References​