From 2f18e6a7b26753a66e654020319b2802a2a8578f Mon Sep 17 00:00:00 2001 From: Jayapriya Pai Date: Wed, 28 Jul 2021 14:04:03 +0530 Subject: [PATCH] Update main README --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e7c49f6..c2a0db6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ # client-go-examples -client-go examples +## Motivation + +The motivation for this repo is that I found it very hard to write kube controllers for the operators since I am not much familiar with [client-go](https://github.com/kubernetes/client-go). I am from a SRE background and transitioned into Software Engineering. I found it very hard to understand kubernetes programming, so I am trying ways to simplify this by trying to get a structured approach. Getting familiar with client-go is first step towards it. Organized programs based on usage in this repo. + +## Pre-requisites + +Most of the examples will need a running kubernetes cluster + + +## Usage + +Navigate to each directory for respective usage + +## Examples + +1. [listitems](listitems) +1. [workqueue](queue) +1. [controller](controller) + +## References + +1. https://github.com/kubernetes/client-go/tree/master/examples +1. https://leftasexercise.com/category/kubernetes/