chazgorman/client-go-examples

Collection of mini-programs demonstrating Kubernetes client-go usage.

Kubernetes client-go examples

! Support development of this project > patreon.com/iximiuz

A collection of mini-programs demonstrating various client-go use cases augmented by a preconfigured online development environment. Inspired by client-go/examples.

The intention is to test a (more or less) fresh version of Go and k8s.io packages against the currently maintained Kubernetes release branches.

What is tested at the moment:

• go 1.22.0
• k8s.io/client-go 0.26.13 0.27.10 0.28.6 0.29.1 (maintained release branches)
• Kubernetes 1.26.14 1.27.11 1.28.7 1.29.2 (best-effort match with versions supported by kind)

Setup

Most examples expect at least two Kubernetes clusters - shared1 and shared2.

curl -sLS https://get.arkade.dev | sudo sh
arkade get kind kubectl

kind create cluster --name shared1
kind create cluster --name shared2

Run

Oversimplified (for now):

cd <program>
make test

# or from the root folder:
make test-all

TODO

• Add more assertions to mini-programs
• Examples to be covered
  • setting API request timeout
  • configuring API request throttling
  • delete
  • delete collection
  • list filtration
  • watch filtration
  • informer filtration
  • patch with different strategies
  • Server Side Apply (SSA)
  • working with subresources
  • ownerReference (one and many)
  • optimistic locking
  • https://stackoverflow.com/questions/56115197/how-to-idiomatically-fill-empty-fields-with-default-values-for-kubernetes-api-ob

Contribution

Contributions are always welcome! Want to participate but don't know where to start? The TODO list above could give you some ideas. Before jumping to the code, please create an issue describing the addition/change first. This will allow me to coordinate the effort and make sure multiple people don't work on the same task.