Package org.testcontainers.k3s

Class K3sContainer

java.lang.Object
org.testcontainers.containers.GenericContainer<K3sContainer>
org.testcontainers.k3s.K3sContainer
All Implemented Interfaces:
AutoCloseable, org.testcontainers.containers.Container<K3sContainer>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable
public class K3sContainer extends org.testcontainers.containers.GenericContainer<K3sContainer>
Testcontainers implementation for K3S

Supported image: rancher/k3s

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

    org.testcontainers.containers.Container.ExecResult

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static int
    KUBE_SECURE_PORT
     
    static int
    RANCHER_WEBHOOK_PORT
     

    Fields inherited from class org.testcontainers.containers.GenericContainer

    CONTAINER_RUNNING_TIMEOUT_SEC, dependencies, dockerClient, INTERNAL_HOST_HOSTNAME, waitStrategy

    Fields inherited from interface org.testcontainers.containers.ContainerState

    STATE_HEALTHY

  • Constructor Summary

    Constructors
    Constructor
    Description
    K3sContainer(org.testcontainers.utility.DockerImageName dockerImageName)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
     
    String
    generateInternalKubeConfigYaml(String networkAlias)
    Generate a kubernetes client configuration for use on a docker internal network.
    String
    getKubeConfigYaml()
    Return the kubernetes client configuration to access k3s from the host machine.

    Methods inherited from class org.testcontainers.containers.GenericContainer

    addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, canBeReused, configure, containerIsCreated, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPortNumbers, getLivenessCheckPorts, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isHostAccessible, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setContainerDef, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, stop, toString, waitingFor, waitUntilContainerStarted, withAccessToHost, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCopyToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withImagePullPolicy, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withReuse, withSharedMemorySize, withStartupAttempts, withStartupCheckStrategy, withStartupTimeout, withTmpFs, withVolumesFrom, withWorkingDirectory

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.testcontainers.containers.Container

    addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

    Methods inherited from interface org.testcontainers.containers.ContainerState

    copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, execInContainer, execInContainer, execInContainerWithUser, execInContainerWithUser, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

    Methods inherited from interface org.testcontainers.lifecycle.Startable

    close

  • Field Details

    • KUBE_SECURE_PORT

      public static int KUBE_SECURE_PORT

    • RANCHER_WEBHOOK_PORT

      public static int RANCHER_WEBHOOK_PORT

  • Constructor Details

    • K3sContainer

      public K3sContainer(org.testcontainers.utility.DockerImageName dockerImageName)

  • Method Details

    • containerIsStarted

      protected void containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
      Overrides:
      containerIsStarted in class org.testcontainers.containers.GenericContainer<K3sContainer>

    • getKubeConfigYaml

      public String getKubeConfigYaml()
      Return the kubernetes client configuration to access k3s from the host machine.
      Returns:
      the kubeConfig yaml.

    • generateInternalKubeConfigYaml

      public String generateInternalKubeConfigYaml(String networkAlias)
      Generate a kubernetes client configuration for use on a docker internal network. The kubeConfig can be used by another docker container running in the same network as the k3s container. For access from the host, use the getKubeConfigYaml() method instead.
      Parameters:
      networkAlias - a valid network alias of the k3s container.
      Returns:
      the kubeConfig yaml.