Golang client

    In that way, you should use the kruise-api repository, which only includes schema definition and clientsets of Kruise.

    DO NOT bring the whole repository as dependency into your project.

    Then, there are two ways to use kruise-api in your code: use it directly or with controller-runtime.

    It is recommended that you can use it with controller-runtime if your project is generated by or operator-sdk, which means controller-runtime is already imported in your project. Otherwise, you may use it directly.

    1. New Kruise client using your rest config:
    1. import kruiseclientset "github.com/openkruise/kruise-api/client/clientset/versioned"
    3. // cfg is the rest config defined in client-go, you should get it using kubeconfig or serviceaccount
    4. kruiseClient := kruiseclientset.NewForConfigOrDie(cfg)
    1. Get/List Kruise resources:
    1. cloneSet, err := kruiseClient.AppsV1alpha1().CloneSets(namespace).Get(name, metav1.GetOptions{})
    2. cloneSetList, err := kruiseClient.AppsV1alpha1().CloneSets(namespace).List(metav1.ListOptions{})
    1. Create/Update Kruise resources:
    1. // Get first
    2. cloneSet, err := kruiseClient.AppsV1alpha1().CloneSets(namespace).Get(name, metav1.GetOptions{})
    3. if err != nil {
    4.     return err
    5. }
    7. // Modify object, such as replicas or template
    8. cloneSet.Spec.Replicas = utilpointer.Int32Ptr(5)
    10. // This might get conflict, should retry it
    11. if err = kruiseClient.AppsV1alpha1().CloneSets(namespace).Update(&cloneSet, metav1.UpdateOptions); err != nil {
    12.     return err
    13. }
    1. Watch Kruise resources:
    1. import kruiseinformer "github.com/openkruise/kruise-api/client/informers/externalversions"
    3. kruiseInformerFactory := kruiseinformer.NewSharedInformerFactory(kruiseClient, 0)
    4. kruiseInformerFactory.Apps().V1alpha1().CloneSets().Informer().AddEventHandler(...)
    5. kruiseInformerFactory.Start(...)

    Use kruise-api with controller-runtime

    1. Add kruise apis into the scheme in your main.go
    1. New client

    If your project is generated by or operator-sdk, you should get the client from mgr.GetClient() instead of the example below.

    1. import "sigs.k8s.io/controller-runtime/pkg/client"
    3. apiClient, err := client.New(c, client.Options{Scheme: scheme})
    1. Get/List
    1. import (
    2.     kruiseappsv1alpha1 "github.com/openkruise/kruise-api/apps/v1alpha1"
    3.     "sigs.k8s.io/controller-runtime/pkg/client"
    4. )
    8. cloneSetList := kruiseappsv1alpha1.CloneSetList{}
    9. err = apiClient.List(context.TODO(), &cloneSetList, client.InNamespace(instance.Namespace))
    1. Create/Update/Delete

    Create a new CloneSet:

    1. import kruiseappsv1alpha1 "github.com/openkruise/kruise-api/apps/v1alpha1"
    3. // Get first
    4. cloneSet := kruiseappsv1alpha1.CloneSet{}
    5. if err = apiClient.Get(context.TODO(), types.NamespacedName{Namespace: namespace, Name: name}, &cloneSet); err != nil {
    6.     return err
    7. }
    9. // Modify object, such as replicas or template
    10. cloneSet.Spec.Replicas = utilpointer.Int32Ptr(5)
    12. // Update
    13. // This might get conflict, should retry it
    14. if err = apiClient.Update(context.TODO(), &cloneSet); err != nil {
    15.     return err
    16. }

    If your project is generated by or operator-sdk and get the client from mgr.GetClient(), then methods like /List have already queried from informer instead of apiserver.