clusterapi-client-go

README

= kumori clusterapi-client-go

Go-client for ClusterAPI and OpenStack.

== Prerequisites

`code-generator` package is able, using a set of GO definitions (structs), to generate
the elements that constitute a client-go library: "informers", "listers",...

The `code-generator` package (https://pkg.go.dev/k8s.io/code-generator) must
be installed. +
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
```

Currently, v0.25.6 version is used.

NOTE: To investigate: avoid installing the code-generator package, and simply
declare the dependency in this project.

== Source code

GO definitions are stored in these directories:
----
└── pkg
    ├── apis_bootstrap
    │   └── bootstrap
    │       └── v1beta1
    ├── apis_clusterapi
    │   └── clusterapi
    │       ├── errors
    │       ├── feature
    │       └── v1beta1
    ├── apis_controlplane
    │   └── controlplane
    │       └── v1beta1
    └── apis_openstack
        └── openstack
            └── v1alpha6
----

They are "more or less" a copy of certain directories of these repositories:

* https://pkg.go.dev/sigs.k8s.io/cluster-api@v1.6.1/api/v1beta1#Cluster
* https://pkg.go.dev/sigs.k8s.io/cluster-api@v1.6.1/api/v1beta1#MachineDeployment
* https://pkg.go.dev/sigs.k8s.io/cluster-api@v1.6.1/controlplane/kubeadm/api/v1beta1#KubeadmControlPlane
* https://pkg.go.dev/sigs.k8s.io/cluster-api@v1.6.1/bootstrap/kubeadm/api/v1beta1#KubeadmConfigTemplate
* https://pkg.go.dev/sigs.k8s.io/cluster-api-provider-openstack/api/v1alpha6#OpenStackCluster
* https://pkg.go.dev/sigs.k8s.io/cluster-api-provider-openstack/api/v1alpha6#OpenStackMachineTemplate

They are not exact copies, as directives have been added to instruct `code-generator`. +
Moreover, the OpenStack directories has been reduced to contain just the GO
definitions (original files contain a lot of logic).

== Generating the client-go libraries

Libraries can be re-generated executing the `update-codegen.sh` script:
----
$	go mod tidy // Required!

$ ./hack/update-codegen.sh
Generating clientset for clusterapi:v1beta1 at gitlab.com/kumori-systems/community/libraries/clusterapi-client-go/pkg/generated-clusterapi/clientset
Generating listers for clusterapi:v1beta1 at gitlab.com/kumori-systems/community/libraries/clusterapi-client-go/pkg/generated-clusterapi/listers
Generating informers for clusterapi:v1beta1 at gitlab.com/kumori-systems/community/libraries/clusterapi-client-go/pkg/generated-clusterapi/informers
Generating deepcopy funcs
Generating clientset for bootstrap:v1beta1 at gitlab.com/kumori-systems/community/libraries/clusterapi-client-go/pkg/generated-bootstrap/clientset
Generating listers for bootstrap:v1beta1 at gitlab.com/kumori-systems/community/libraries/clusterapi-client-go/pkg/generated-bootstrap/listers
Generating informers for bootstrap:v1beta1 at gitlab.com/kumori-systems/community/libraries/clusterapi-client-go/pkg/generated-bootstrap/informers
Generating deepcopy funcs
Generating clientset for controlplane:v1beta1 at gitlab.com/kumori-systems/community/libraries/clusterapi-client-go/pkg/generated-controlplane/clientset
Generating listers for controlplane:v1beta1 at gitlab.com/kumori-systems/community/libraries/clusterapi-client-go/pkg/generated-controlplane/listers
Generating informers for controlplane:v1beta1 at gitlab.com/kumori-systems/community/libraries/clusterapi-client-go/pkg/generated-controlplane/informers
Generating deepcopy funcs
Generating clientset for openstack:v1alpha6 at gitlab.com/kumori-systems/community/libraries/clusterapi-client-go/pkg/generated-openstack/clientset
Generating listers for openstack:v1alpha6 at gitlab.com/kumori-systems/community/libraries/clusterapi-client-go/pkg/generated-openstack/listers
Generating informers for openstack:v1alpha6 at gitlab.com/kumori-systems/community/libraries/clusterapi-client-go/pkg/generated-openstack/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.

Then, several `zz_generated.deepcopy.go` files will be created inside the source
directories, and several new directories (named `generated-xxx`) will be created.