From a5d3a55d12dfb76e530f0e07d56745fae204dba3 Mon Sep 17 00:00:00 2001 From: hendrikKahl <39563366+hendrikKahl@users.noreply.github.com> Date: Tue, 21 Dec 2021 16:17:31 +0100 Subject: [PATCH] add more context info to client guide (#5203) * add more context info * Update docs/development/kubernetes-clients.md Co-authored-by: Tim Ebert Co-authored-by: Tim Ebert --- docs/development/kubernetes-clients.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/development/kubernetes-clients.md b/docs/development/kubernetes-clients.md index a0b5c0393e1..908ee19e050 100644 --- a/docs/development/kubernetes-clients.md +++ b/docs/development/kubernetes-clients.md @@ -12,6 +12,7 @@ Please familiarize yourself with the following basic Kubernetes API concepts fir - [Extending the Kubernetes API](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/) (including Custom Resources and aggregation layer / extension API servers) - [Extend the Kubernetes API with CustomResourceDefinitions](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/) - [Working with Kubernetes Objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/) +- [Sample Controller](https://github.com/kubernetes/sample-controller/blob/master/docs/controller-client-go.md) (the diagram helps to build an understanding of an controller's basic structure) ## Client Types: Client-Go, Generated, Controller-Runtime @@ -75,6 +76,8 @@ err := c.Update(ctx, deployment) err = c.Update(ctx, shoot) ``` +A brief introduction to controller-runtime and its basic constructs can be found [here](https://pkg.go.dev/sigs.k8s.io/controller-runtime). + _Important characteristics of controller-runtime clients:_ - The client functions take a generic `client.Object` or `client.ObjectList` value. These interfaces are implemented by all Golang types, that represent Kubernetes API objects or lists respectively which can be interacted with via usual API requests. [1]