Struct K3s 

pub struct K3s { /* private fields */ }

Available on crate feature k3s only.

Module to work with K3s inside of tests.

Starts an instance of K3s, a single-node server fully-functional Kubernetes cluster so you are able to interact with the cluster using standard Kubernetes API exposed at KUBE_SECURE_PORT port

This module is based on the official K3s docker image.

Example

use std::env::temp_dir;

use testcontainers_modules::{
    k3s::{K3s, KUBE_SECURE_PORT},
    testcontainers::{runners::SyncRunner, ImageExt},
};

let k3s_instance = K3s::default()
    .with_conf_mount(&temp_dir())
    .with_privileged(true)
    .with_userns_mode("host")
    .start()
    .unwrap();

let kube_port = k3s_instance.get_host_port_ipv4(KUBE_SECURE_PORT);
let kube_conf = k3s_instance
    .image()
    .read_kube_config()
    .expect("Cannot read kube conf");
// use kube_port and kube_conf to connect and control k3s cluster

Implementations

impl K3s

pub fn with_conf_mount(self, conf_mount_path: impl AsRef<Path>) -> Self

Mounts a host directory to the K3s configuration directory.

This allows you to access the K3s configuration files (like kubeconfig) from the host filesystem. The kubeconfig file will be created at {conf_mount_path}/k3s.yaml and can be read using read_kube_config.

Example

use std::path::Path;

use testcontainers_modules::k3s::K3s;

let k3s = K3s::default().with_conf_mount(Path::new("/tmp/k3s-config"));

pub fn read_kube_config(&self) -> Result<String>

Reads the kubeconfig file from the mounted configuration directory.

This method reads the k3s.yaml file from the mounted configuration directory that was set up using with_conf_mount. The kubeconfig can be used to connect kubectl or other Kubernetes clients to the K3s cluster.

Example

use std::path::Path;

use testcontainers_modules::k3s::K3s;

let k3s = K3s::default().with_conf_mount(Path::new("/tmp/k3s-config"));
// After starting the container...
let kubeconfig = k3s.read_kube_config().expect("Failed to read kubeconfig");

Trait Implementations

impl Clone for K3s

fn clone(&self) -> K3s

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for K3s

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

Formats the value using the given formatter.

impl Default for K3s

fn default() -> K3s

Returns the “default value” for a type.

impl Image for K3s

fn name(&self) -> &str

The name of the docker image to pull from the Docker Hub registry.

fn tag(&self) -> &str

Implementations are encouraged to include a tag that will not change (i.e. NOT latest) in order to prevent test code from randomly breaking because the underlying docker suddenly changed.

fn ready_conditions(&self) -> Vec<WaitFor>

Returns a list of conditions that need to be met before a started container is considered ready.

fn env_vars( &self, ) -> impl IntoIterator<Item = (impl Into<Cow<'_, str>>, impl Into<Cow<'_, str>>)>

Returns the environment variables that needs to be set when a container is created.

fn mounts(&self) -> impl IntoIterator<Item = &Mount>

Returns the mounts that needs to be created when a container is created.

fn cmd(&self) -> impl IntoIterator<Item = impl Into<Cow<'_, str>>>

Returns the CMD this image needs to be created with.

fn expose_ports(&self) -> &[ContainerPort]

Returns the ports that needs to be exposed when a container is created.

fn copy_to_sources(&self) -> impl IntoIterator<Item = &CopyToContainer>

Returns the files to be copied into the container at startup.

fn entrypoint(&self) -> Option<&str>

Returns the entrypoint this image needs to be created with.

fn exec_after_start( &self, cs: ContainerState, ) -> Result<Vec<ExecCommand>, TestcontainersError>

Returns the commands that needs to be executed after a container is started i.e. commands to be run in a running container.

fn exec_before_ready( &self, cs: ContainerState, ) -> Result<Vec<ExecCommand>, TestcontainersError>

Returns commands that will be executed after the container has started, but before the Image::ready_conditions are awaited for.