tcwlab/k8s repository overview

⁠k8s

⁠tl;dr

This image contains kubectl, kustomize and helm all-in-one alpine image. Every image contains the latest stable version of both tools at build time. The goal is to make CI/CD tasks as easy as possible. We only set up this project, because all other projects we found 'in the wild' seems to be somehow orphaned.

⁠Quick reference

• Maintained by: Sascha Willomitzer⁠ (of the TCWlab project)⁠
• Where to get help: file an issue⁠
• Supported architectures: linux/amd64
• Published image artifact details: see source code repository⁠
• Documentation:
  • kubectl: see reference⁠
  • kustomize: SIG documentation⁠
  • helm: official documentation⁠
  • How everything works together: https://kubectl.docs.kubernetes.io/⁠

⁠Getting started

This image is intended to be used both locally and as a part of a pipeline. Find the steps how to use it below, depending on your needs.

⁠Using it locally

⁠Using ~/.kube as volume

We thought it would be easy to just mount all of your kubernetes configs inside the container, so that you can easily interact with it. It's as easy as calling:

docker run --rm -v ~/.kube:/.kube tcwlab/k8s:latest kubectl get no
docker run --rm -v ~/.kube:/.kube tcwlab/k8s:latest helm list

or in interactive mode:

docker run -it --rm -v ~/.kube:/.kube tcwlab/k8s:latest /bin/bash

⁠Using only one specific kubeconfig

Instead of mounting all your kubeconfigs to the container, you could also only set one specific config as environment variable:

docker run -e KUBE_CONFIG_B64="$(base64 -i ~/.kube/config)" tcwlab/k8s:latest kubectl version
docker run -e KUBE_CONFIG_B64="$(base64 -i ~/.kube/config)" tcwlab/k8s:latest helm version

⁠Using as CI/CD image

As we are using GitLab ourselves, this only describes the GitLab CI/CD way, using this .gitlab-ci.yml snippet:

k8s-example:
  stage: demo
  image: tcwlab/k8s:latest
  variables:
    KUBE_CONFIG_B64: $YOUR_ENV_VAR_CONTAINING_B64_KUBECONFIG
  script:
    - kubectl get nodes

If you'd like to see some example configurations, have a look at our bootstrap project⁠.

⁠Roadmap

If you are interested in the upcoming/planned features, ideas and milestones, please have a look at our board⁠.

⁠License

This project is licensed under Apache License v2⁠.

⁠Project status

This project is maintained "best effort", which means, we strive for automation as much as we can A lot of updates will be done "automagically".

We do not have a specific dedicated set of people to work on this project.

It absolutely comes with no warranty.