My Kubernetes Book

Ludovic Rivallain calendar Feb 2, 2021  · 2 min read  ·
Share on: bluesky linkedin copy
kubernetes event-driven book

I recently started my journey to the Kubernetes world, switching from theory knowledge to practical use-cases for customers.

This is a wonderful new technical area to discover with a lot of new:

  • Tools
  • Features/Capabilities
  • Documenations
  • Communities
  • Best-practices
  • …

Of course, I am far-far-away to master those new competencies but I learn more and more on a daily basis.

At the begining, I started a small wiki for my own usage to keep some useful commands, tips, how-to documentations. But I know think that this content may help others to centralize some re-usable content.

So I started a new side project to this blog: My Kubernetes Book: https://k8s-book.vupti.me/

Screenshot of My Kubernetes Book

This is not a substitution to official projects documentation, just a quick way for me to get the information I need.

Content

Currently, the 'book' content is the following:

  1. Deploy a K3S cluster
    1. All nodes pre-requisites
    2. Initial master node
    3. Worker node(s)
    4. Additional master nodes
  2. Setup a powerful Kubernetes client
    1. Basics tools
    2. Arkade
    3. k9s
    4. kubens & kubectx
    5. jsonnet
    6. Octant
    7. Argo cli
    8. OpenFaaS CLI
  3. Cluster customizations
    1. Traefik as ingress controler
    2. Monitoring with Prometheus
  4. Cluster usage
    1. Kubectl tips

Of course, the content will hopefully increase in the next months or years.

Engine

This website is built on Hugo static website engine with the learn theme.

Contributions

This new website is open to external contributions through:

  • Comments: All pages contains a comment feature based on GitHub issues (with utterances integration)
  • Direct GitHub issues (+)

You can also submit changes through GitHub pull request features:

  1. As a pre-requesite to local build, you will need Hugo engine installed: Quick Start
  2. Clone the repository with submodules:
1git clone --recursive https://github.com/lrivallain/git-book-kubernetes.git
  1. Push changes to a new branch:
1# new branch:
2git checkout -b "my-changes"
3# <do changes here !>
4# test your changes with:
5hugo server
6# <git add / git commit / git push>
  1. Create a pull request on the project.
  2. Once accepted and merged to master, the static will be run through this Publish GitHub Action