Skip to content

Commit

Permalink
add more context info to client guide (gardener#5203)
Browse files Browse the repository at this point in the history
* add more context info

* Update docs/development/kubernetes-clients.md

Co-authored-by: Tim Ebert <timebertt@gmail.com>

Co-authored-by: Tim Ebert <timebertt@gmail.com>
  • Loading branch information
hendrikKahl and timebertt authored Dec 21, 2021
1 parent ab51bb9 commit a5d3a55
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/development/kubernetes-clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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]
Expand Down

0 comments on commit a5d3a55

Please sign in to comment.