-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
K3sContainer: expose kubeConfig for docker network access #5097
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
kiview
merged 7 commits into
testcontainers:master
from
johnathana:k3s-kube-config-with-network-alias
May 18, 2022
Merged
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
52567ac
Expose kube config for docker network access
johnathana 008eaa3
Using withCopyFileToContainer instead of withFileSystemBind
johnathana 1182557
Test code refactor based on review comments
johnathana c46123d
Code refactor based on review comments
johnathana bba30de
Javadoc wording tweaks
johnathana e6a7897
Update KubectlContainerTest.java
bsideup 1a79ff1
Merge branch 'master' into k3s-kube-config-with-network-alias
bsideup File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
66 changes: 66 additions & 0 deletions
66
modules/k3s/src/test/java/org/testcontainers/k3s/KubectlContainerTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| package org.testcontainers.k3s; | ||
|
|
||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.junit.AfterClass; | ||
| import org.junit.BeforeClass; | ||
| import org.junit.Test; | ||
| import org.testcontainers.containers.GenericContainer; | ||
| import org.testcontainers.containers.Network; | ||
| import org.testcontainers.containers.output.WaitingConsumer; | ||
| import org.testcontainers.utility.DockerImageName; | ||
| import org.testcontainers.utility.MountableFile; | ||
|
|
||
| import java.nio.charset.StandardCharsets; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| import static org.testcontainers.containers.Network.newNetwork; | ||
| import static org.testcontainers.containers.output.OutputFrame.OutputType.STDOUT; | ||
johnathana marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| @Slf4j | ||
johnathana marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| public class KubectlContainerTest { | ||
|
|
||
| public static Network network = newNetwork(); | ||
johnathana marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| public static K3sContainer k3s = new K3sContainer(DockerImageName.parse("rancher/k3s:v1.21.3-k3s1")) | ||
| .withNetwork(network) | ||
| .withNetworkAliases("k3s"); | ||
|
|
||
| @BeforeClass | ||
| public static void setup() { | ||
| k3s.start(); | ||
| } | ||
|
|
||
| @AfterClass | ||
| public static void tearDown() { | ||
| k3s.stop(); | ||
| } | ||
johnathana marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| @Test | ||
| public void shouldExposeKubeConfigForNetworkAlias() throws Exception { | ||
johnathana marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| String kubeConfigYaml = k3s.getKubeConfigYaml("k3s"); | ||
|
|
||
| Path tempFile = Files.createTempFile(null, null); | ||
| Files.write(tempFile, kubeConfigYaml.getBytes(StandardCharsets.UTF_8)); | ||
bsideup marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| GenericContainer<?> kubectlContainer = new GenericContainer<>(DockerImageName.parse("rancher/kubectl:v1.23.3")) | ||
| .withNetwork(network) | ||
| .withCopyFileToContainer(MountableFile.forHostPath(tempFile.toAbsolutePath()), "/.kube/config") | ||
| .withCommand("get namespaces"); | ||
johnathana marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| kubectlContainer.start(); | ||
|
|
||
| WaitingConsumer consumer = new WaitingConsumer(); | ||
| kubectlContainer.followOutput(consumer, STDOUT); | ||
|
|
||
| consumer.waitUntil(frame -> | ||
| frame.getUtf8String().contains("kube-system"), 30, TimeUnit.SECONDS); | ||
johnathana marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| @Test(expected = IllegalArgumentException.class) | ||
| public void shouldThrowAnExceptionForUnknownNetworkAlias() { | ||
| k3s.getKubeConfigYaml("not-set-network-alias"); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To avoid confusion, IMO we should rename this method to something that will tell that the returned config is for internal communication, as otherwise someone may call
getKubeConfigYaml("k3s")and then expect it to work from their machine (in addition to in-network usage)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, my main thought with this PR is the risk of user confusion. This will be, I think, the first time in a module that we're outputting an address which is specifically not usable by the test host machine itself.
I think we need this method to be named to reflect that this returns a kubeconfig that is for use inside of the docker network.
We should also enhance the documentation here - both Javadocs and the
mddocs, so that people can understand when to use this. As @bsideup suggested, including the test into the docs would be a good way to demonstrate it.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rnorth BTW how do you feel about changing from
containerIsStartedto "get file every time"? IMOgetKubeConfigYamlshould return pre-calculated value fromcontainerIsStarted, whilegenerateInternalKubeConfigYaml(or whatever the name is) can do it on demand (or maybe from the same file, just by changing the host)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that
getKubeConfigYamlbeing a side-effect-free simple getter would feel better and be the more intuitive API.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I think it would be nicer to keep the fetch of the kubeconfig file in
containerIsStarted. It would make it clearer that the file is effectively immutable rather than something that k3s might be changing over time.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have updated the code. The documentation part is missing, I will include it on another commit.