docs: using gitlab-ci with kubernetes through kubedock guide #2943
Conversation
✅ Deploy Preview for testcontainers-go ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
amirsalarsafaei
changed the title
There was a problem hiding this comment.
LGTM, thanks!
@eddumelendez you probably want to take a look, to include it in Java.
|
@mdelapenya I can include it java doc as well :D |
|
|
||
| This applies if your executor is `kubernetes` and you don't want to use DinD. One option is to use [kubedock](https://github.com/joyrex2001/kubedock). This library is a minimal implementation of the Docker API that will orchestrate containers on a Kubernetes cluster. | ||
|
|
||
| Here is the example Kubernetes configuration you must create: |
There was a problem hiding this comment.
@amirsalarsafaei can you include the location of this k8s configuration file? 🙏
I'm currently reproducing this guide into Gitlab, and I don't know where to put that file.
Thanks!
There was a problem hiding this comment.
You should apply the configuration into the Kubernetes namespace that you are using to run your pipelines, there is no need to create any files. If you think that need clarification in guides, let me know.
There was a problem hiding this comment.
@amirsalarsafaei so we first need to create the k8s cluster in gitlab, right? Please forgive me but my k8s kungfu is very limited
There was a problem hiding this comment.
That's OK :D. I'd be happy to explain. So gitlab gives you the option to run your gitlab runners in Kubernetes, you can see the guide on how to do that alongside some useful information here
gitlab's kubernetes executer guide
You will need access to a Gitlab server (I believe hosted privately) and a Kubernetes namespace to do achieve this. Although I think you can test this with a minikube (it's a version of kubernetes that can run on your local machine).
Context:
Kubernetes uses containerd to spawn up docker images (kind of like docker swarm but way different). and because of this architecture there is no docker socket and server to use in runner environment unless you explicitly have a docker in the image or mount it from the sidecar or etc. The best approach is using kubedock which spawns new pod for each container that testcontainer request just like how gitlab kubernetes executer works.
There was a problem hiding this comment.
After you created your minikube environment apply the configurations in the gitlab runner guide and the guide I provided.
There was a problem hiding this comment.
Could you help me out with this deployment? https://gitlab.com/mdelapenya/testcontainers-go-compose/-/jobs/9061157375
I created a local kind cluster with Docker Desktop, I can see the runner in the Gitlab settings page for the project, but it fails to build.
Sorry for bugging you with this, but as I said I'm neglected with k8s stuff
| name: kubedock | ||
| namespace: gitlab-runner | ||
|
|
||
| # Role for Kubedock |
There was a problem hiding this comment.
bug: could you separate all different k8s objects with ---? My Docker Desktop's kind cluster complained with:
Error from server (BadRequest): error when creating "kubedoc.yml": Service in version "v1" cannot be handled as a Service: strict decoding error: unknown field "roleRef", unknown field "rules", unknown field "subjects"
I was able to apply the file once I added them to the file.
There was a problem hiding this comment.
Ok, thats odd cause in k8s you can do that, but I can separate them.
I've requested access to repository through Gitlab. I'll be happy to help:) |
|
@mdelapenya Hi, I looked into your project but I don't have sufficient access to determine the issue. it looks like that the CI environment is not recognizing the service at all could you give me temporary access so I can debug it? |
|
@amirsalarsafaei I elevated you to the maintainer role in the Gitlab project. Please let me know about your findings 🙏 |
What does this PR do?
Adds guide for how to use testcontainers on a gitlab-ci configuration with kubernetes.
I also fixed the code blocks language issue where yamls were specified as ymls, resulting in syntax highlighting being disabled.
Why is it important?
I had a hell of time configuring testcontainers on our kubernetes runners and I think this can help other users.
Related issues