client-go

README

= kumori client-go

Go client for Kumori objects (informers, listers...) in Kubernetes

== Code-generator

From the type definitions included in `pkg/apis/kumori/v1` and `pkg/apis_ambassador/getambassador.io/v1`, it is necessary to generate code to implement different functionalities (informers, listers, deep-copy, ...).

The "code-generator" package (https://pkg.go.dev/k8s.io/code-generator) is used for this purpose:

- Install the package, executing `go install k8s.io/code-generator@v0.21.9` 
- The package includes two scripts (only one is really used for us), to which execution permissions must be granted: 
```
chmod +x $GOPATH/pkg/mod/k8s.io/code-generator@v0.21.9/generate-groups.sh
chmod +x $GOPATH/pkg/mod/k8s.io/code-generator@v0.21.9/generate-internal-groups.sh
```
- When the package will be used, some executables will be installed in the go bin path:
```
$ ls $GOPATH/bin/ | grep "\-gen"
client-gen
deepcopy-gen
defaulter-gen
informer-gen
lister-gen
```
- To generate the code, just use the script included in the client-go repository:
```
$ ./hack/update-codegen.sh 
Generating clientset for kumori:v1 at gitlab.com/kumori-systems/community/libraries/client-go/pkg/generated/clientset
Generating listers for kumori:v1 at gitlab.com/kumori-systems/community/libraries/client-go/pkg/generated/listers
Generating informers for kumori:v1 at gitlab.com/kumori-systems/community/libraries/client-go/pkg/generated/informers
Generating deepcopy funcs
Generating clientset for getambassador.io:v1 at gitlab.com/kumori-systems/community/libraries/client-go/pkg/generated_ambassador/clientset
Generating listers for getambassador.io:v1 at gitlab.com/kumori-systems/community/libraries/client-go/pkg/generated_ambassador/listers
Generating informers for getambassador.io:v1 at gitlab.com/kumori-systems/community/libraries/client-go/pkg/generated_ambassador/informers
Generating deepcopy funcs
```

NOTE: The `update-codegen.sh` script contains a variable `CODEGEN_PKG` with the path to the code-generator package, that must be adjusted when a new version of the package is used.

WARNING: It might be necessary to run `go mod tidy` before generate the code (to avoid errors like `Hit an unsupported type invalid type for map[string]invalid type`).