Categorygithub.com/simplekube/kit
repository
0.0.0-20220512062022-4d57693db111
Repository: https://github.com/simplekube/kit.git
Documentation: pkg.go.dev
Overview
Dependencies
0
Dependents
0

# Packages

No description provided by the author

# README

kit

Kubernetes' operations made simple. This is done by exposing ready to use functions.

Motivation

Project kit is based on the experiences we had while building & conforming Kubernetes operations as well as its operators. These operations spanned across projects such as OpenEBS & Metacontroller.

In addition, this project is a result of the knowledge gained while building infrastructure platforms at various organisations.

There was a need for utility functions to solve higher order challenges faced by teams using Kubernetes.

Take for example the following challenges faced by the platform team:

  • Will migration of Linkerd from version A to B result in outages of all services dependent on Linkerd?
  • Is there a way to assert running of existing services when their underlying service mesh is swapped with another?
  • How to compare performance between two releases of a given service?

This project is an attempt to solve above challenges by exposing the way Kubernetes work into atomic APIs. Teams can then compose these APIs as building blocks to build their solutions.

Use as a library

This project is primarily meant to be consumed as a library by various out-of-tree golang projects

Technical Details

Build & Test

  • Testing pkg/k8s requires setting up the test environment
  • Run below command to execute tests
make

Setup test environment aka envtest

  • Install envtest binary
    • refer: setup-envtest
    • go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
  • Run below to download kubectl, apiserver & etcd binaries
setup-envtest --bin-dir=/usr/local/kubebuilder/bin use
  • On Mac, you get similar output
Version: 1.23.5
OS/Arch: darwin/amd64
md5: /UKeR3sIKE/Y5zd8A2Tjog==
Path: /usr/local/kubebuilder/bin/k8s/1.23.5-darwin-amd64
  • Verify presence of images
ls -ltr /usr/local/kubebuilder/bin/k8s/1.23.5-darwin-amd64/
  • Move these binaries to the default lookup path used by controller-runtime
mv /usr/local/kubebuilder/bin/k8s/1.23.5-darwin-amd64/* /usr/local/kubebuilder/bin/

References