Struct testcontainers_modules::k3s::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 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::RunnableImage;
use testcontainers::runners::SyncRunner;
use testcontainers_modules::k3s::{K3s, KUBE_SECURE_PORT};

let k3s_instance = RunnableImage::from(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

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

Trait Implementations

impl Clone for K3s

fn clone(&self) -> K3s

Returns a copy 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

type Args = K3sArgs

A type representing the arguments for an Image.

fn name(&self) -> String

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

fn tag(&self) -> String

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) -> Box<dyn Iterator<Item = (&String, &String)> + '_>

There are a couple of things regarding the environment variables of images:

fn mounts(&self) -> Box<dyn Iterator<Item = &Mount> + '_>

There are a couple of things regarding the mounts of images:

fn expose_ports(&self) -> Vec<u16>

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

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

Returns the entrypoint this instance was 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.