Merge pull request #1687 from dsyer/remove-annotations

Removes Kubernetes annotations from Spring integration

Author: k8s-ci-robot

examples/examples-release-13/src/main/java/io/kubernetes/client/examples/SpringControllerExample.java

@@ -13,28 +13,24 @@
 package io.kubernetes.client.examples;
 
 import io.kubernetes.client.extended.controller.Controller;
+import io.kubernetes.client.extended.controller.builder.ControllerBuilder;
+import io.kubernetes.client.extended.controller.builder.DefaultControllerBuilder;
 import io.kubernetes.client.extended.controller.reconciler.Reconciler;
 import io.kubernetes.client.extended.controller.reconciler.Request;
 import io.kubernetes.client.extended.controller.reconciler.Result;
+import io.kubernetes.client.informer.SharedIndexInformer;
 import io.kubernetes.client.informer.SharedInformer;
 import io.kubernetes.client.informer.SharedInformerFactory;
 import io.kubernetes.client.informer.cache.Lister;
+import io.kubernetes.client.openapi.ApiClient;
 import io.kubernetes.client.openapi.models.V1Endpoints;
 import io.kubernetes.client.openapi.models.V1EndpointsList;
 import io.kubernetes.client.openapi.models.V1Node;
 import io.kubernetes.client.openapi.models.V1NodeList;
 import io.kubernetes.client.openapi.models.V1Pod;
 import io.kubernetes.client.openapi.models.V1PodList;
-import io.kubernetes.client.spring.extended.controller.annotation.GroupVersionResource;
-import io.kubernetes.client.spring.extended.controller.annotation.KubernetesInformer;
-import io.kubernetes.client.spring.extended.controller.annotation.KubernetesInformers;
-import io.kubernetes.client.spring.extended.controller.annotation.KubernetesReconciler;
-import io.kubernetes.client.spring.extended.controller.annotation.KubernetesReconcilerReadyFunc;
-import io.kubernetes.client.spring.extended.controller.annotation.KubernetesReconcilerWatch;
-import io.kubernetes.client.spring.extended.controller.annotation.KubernetesReconcilerWatches;
-import io.kubernetes.client.spring.extended.controller.factory.KubernetesControllerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.beans.factory.annotation.Qualifier;
+import io.kubernetes.client.util.generic.GenericKubernetesApi;
+import java.time.Duration;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.CommandLineRunner;
 import org.springframework.boot.SpringApplication;
@@ -55,8 +51,7 @@ public static class AppConfig {
 
     @Bean
     public CommandLineRunner commandLineRunner(
-        SharedInformerFactory sharedInformerFactory,
-        @Qualifier("node-printing-controller") Controller nodePrintingController) {
+        SharedInformerFactory sharedInformerFactory, Controller nodePrintingController) {
       return args -> {
         System.out.println("starting informers..");
         sharedInformerFactory.startAllRegisteredInformers();
@@ -66,63 +61,72 @@ public CommandLineRunner commandLineRunner(
       };
     }
 
-    // *REQUIRED*
-    // factorybean to crete controller
-    @Bean("node-printing-controller")
-    public KubernetesControllerFactory kubernetesReconcilerConfigurer(
-        SharedInformerFactory sharedInformerFactory, Reconciler reconciler) {
-      return new KubernetesControllerFactory(sharedInformerFactory, reconciler);
+    @Bean
+    public Controller nodePrintingController(
+        SharedInformerFactory sharedInformerFactory, NodePrintingReconciler reconciler) {
+      DefaultControllerBuilder builder = ControllerBuilder.defaultBuilder(sharedInformerFactory);
+      builder =
+          builder.watch(
+              (q) -> {
+                return ControllerBuilder.controllerWatchBuilder(V1Node.class, q)
+                    .withResyncPeriod(Duration.ofMinutes(1))
+                    .build();
+              });
+      builder.withWorkerCount(2);
+      builder.withReadyFunc(reconciler::informerReady);
+      return builder.withReconciler(reconciler).withName("nodePrintingController").build();
+    }
+
+    @Bean
+    public SharedIndexInformer<V1Endpoints> endpointsInformer(
+        ApiClient apiClient, SharedInformerFactory sharedInformerFactory) {
+      GenericKubernetesApi<V1Endpoints, V1EndpointsList> genericApi =
+          new GenericKubernetesApi<>(
+              V1Endpoints.class, V1EndpointsList.class, "", "v1", "endpoints", apiClient);
+      return sharedInformerFactory.sharedIndexInformerFor(genericApi, V1Endpoints.class, 0);
+    }
+
+    @Bean
+    public SharedIndexInformer<V1Node> nodeInformer(
+        ApiClient apiClient, SharedInformerFactory sharedInformerFactory) {
+      GenericKubernetesApi<V1Node, V1NodeList> genericApi =
+          new GenericKubernetesApi<>(V1Node.class, V1NodeList.class, "", "v1", "nodes", apiClient);
+      return sharedInformerFactory.sharedIndexInformerFor(genericApi, V1Node.class, 60 * 1000L);
+    }
+
+    @Bean
+    public SharedIndexInformer<V1Pod> podInformer(
+        ApiClient apiClient, SharedInformerFactory sharedInformerFactory) {
+      GenericKubernetesApi<V1Pod, V1PodList> genericApi =
+          new GenericKubernetesApi<>(V1Pod.class, V1PodList.class, "", "v1", "pods", apiClient);
+      return sharedInformerFactory.sharedIndexInformerFor(genericApi, V1Pod.class, 0);
     }
   }
 
-  @KubernetesInformers({ // Defining what resources is the informer-factory actually watching.
-    @KubernetesInformer(
-        apiTypeClass = V1Endpoints.class,
-        apiListTypeClass = V1EndpointsList.class,
-        groupVersionResource =
-            @GroupVersionResource(apiGroup = "", apiVersion = "v1", resourcePlural = "endpoints")),
-    @KubernetesInformer(
-        apiTypeClass = V1Node.class,
-        apiListTypeClass = V1NodeList.class,
-        groupVersionResource =
-            @GroupVersionResource(apiGroup = "", apiVersion = "v1", resourcePlural = "nodes"),
-        resyncPeriodMillis = 60 * 1000L),
-    @KubernetesInformer(
-        apiTypeClass = V1Pod.class,
-        apiListTypeClass = V1PodList.class,
-        groupVersionResource =
-            @GroupVersionResource(apiGroup = "", apiVersion = "v1", resourcePlural = "pods")),
-  })
-  @Component
-  public static class MySharedInformerFactory extends SharedInformerFactory {}
-
-  // As long as a reconciler bean attached `@KubernetesReconciler` detected in the context, we
-  // will
-  // be automatically creating a conresponding controller bean implementing {@link
-  // io.kubernetes.client.extended.controller.Controller}
-  // with the name specified and registering it to the spring bean-factory.
-  @KubernetesReconciler(
-      watches =
-          @KubernetesReconcilerWatches({
-            @KubernetesReconcilerWatch(
-                apiTypeClass = V1Node.class,
-                resyncPeriodMillis = 60 * 1000L // fully resync every 1 minute
-                ),
-          }))
   @Component
   public static class NodePrintingReconciler implements Reconciler {
 
     @Value("${namespace}")
     private String namespace;
 
-    @Autowired private SharedInformer<V1Node> nodeInformer;
-    @Autowired private SharedInformer<V1Pod> podInformer;
-    @Autowired private Lister<V1Node> nodeLister;
-    @Autowired private Lister<V1Pod> podLister;
+    private SharedInformer<V1Node> nodeInformer;
+
+    private SharedInformer<V1Pod> podInformer;
+
+    private Lister<V1Node> nodeLister;
+
+    private Lister<V1Pod> podLister;
+
+    public NodePrintingReconciler(
+        SharedIndexInformer<V1Node> nodeInformer, SharedIndexInformer<V1Pod> podInformer) {
+      this.nodeInformer = nodeInformer;
+      this.podInformer = podInformer;
+      this.nodeLister = new Lister<>(nodeInformer.getIndexer(), namespace);
+      this.podLister = new Lister<>(podInformer.getIndexer(), namespace);
+    }
 
     // *OPTIONAL*
-    // If you feed like hold the controller from running util some condition..
-    @KubernetesReconcilerReadyFunc
+    // If you want to hold the controller from running util some condition..
     public boolean informerReady() {
       return podInformer.hasSynced() && nodeInformer.hasSynced();
     }

examples/examples-release-13/src/main/java/io/kubernetes/client/examples/SpringLoadBalancerExample.java

@@ -15,6 +15,7 @@
 import io.kubernetes.client.extended.network.EndpointsLoadBalancer;
 import io.kubernetes.client.extended.network.LoadBalancer;
 import io.kubernetes.client.extended.network.RoundRobinLoadBalanceStrategy;
+import io.kubernetes.client.informer.SharedIndexInformer;
 import io.kubernetes.client.informer.SharedInformerFactory;
 import io.kubernetes.client.informer.cache.Lister;
 import io.kubernetes.client.openapi.models.V1Endpoints;
@@ -48,8 +49,8 @@ public CommandLineRunner loadBalancerCommandLineRunner(
     }
 
     @Bean
-    public MyService myService(Lister<V1Endpoints> lister) {
-      return new MyService(lister);
+    public MyService myService(SharedIndexInformer<V1Endpoints> lister) {
+      return new MyService(new Lister<>(lister.getIndexer()));
     }
   }
 

spring/src/main/java/io/kubernetes/client/spring/extended/controller/KubernetesInformerFactoryProcessor.java

@@ -44,7 +44,11 @@
  * new ApiClient if there's no user-specified one for override. 3. By reading from {@link
  * io.kubernetes.client.spring.extended.controller.annotation.KubernetesInformers}, instantiates and
  * injects informers to spring context with the underlying constructing process hidden from users.
+ *
+ * @deprecated instead of declaring via the annotation create the informers manually as {@link
+ *     org.springframework.context.annotation.Bean @Beans}
  */
+@Deprecated
 public class KubernetesInformerFactoryProcessor
     implements BeanDefinitionRegistryPostProcessor, BeanFactoryAware, Ordered {
 

spring/src/main/java/io/kubernetes/client/spring/extended/controller/KubernetesReconcilerProcessor.java

@@ -31,7 +31,11 @@
  *
  * <p>It will create a {@link io.kubernetes.client.extended.controller.Controller} for every
  * reconciler instances registered in the spring bean-factory.
+ *
+ * @deprecated instead of declaring via the annotation create the controller manually as a {@link
+ *     org.springframework.context.annotation.Bean @Bean}
  */
+@Deprecated
 public class KubernetesReconcilerProcessor implements BeanDefinitionRegistryPostProcessor, Ordered {
 
   public static final String DEFAULT_SHARED_INFORMER_FACTORY_BEAN_NAME = "sharedInformerFactory";

spring/src/main/java/io/kubernetes/client/spring/extended/controller/annotation/AddWatchEventFilter.java

@@ -23,7 +23,11 @@
  * from watches.
  *
  * <p>A add-event filter must have the signature as {@link java.util.function.Predicate<ApiType>}
+ *
+ * @deprecated register the watcher via the {@link
+ *     io.kubernetes.client.extended.controller.builder.ControllerBuilder} API
  */
+@Deprecated
 @Target({ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface AddWatchEventFilter {

spring/src/main/java/io/kubernetes/client/spring/extended/controller/annotation/DeleteWatchEventFilter.java

@@ -26,7 +26,11 @@
  * java.util.function.BiPredicate<ApiType, Boolean>} where the 1st parameter is the
  * "before-deletion" state of the resource and the 2nd indicates whether the cache entry for the
  * resource is stale.
+ *
+ * @deprecated register the watcher via the {@link
+ *     io.kubernetes.client.extended.controller.builder.ControllerBuilder} API
  */
+@Deprecated
 @Target({ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface DeleteWatchEventFilter {

spring/src/main/java/io/kubernetes/client/spring/extended/controller/annotation/GroupVersionResource.java

@@ -17,7 +17,12 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-/** The standard Kubernetes group-version-resource. */
+/**
+ * The standard Kubernetes group-version-resource.
+ *
+ * @deprecated use the {@link io.kubernetes.client.util.generic.GenericKubernetesApi} instead
+ */
+@Deprecated
 @Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface GroupVersionResource {

spring/src/main/java/io/kubernetes/client/spring/extended/controller/annotation/KubernetesInformer.java

@@ -26,7 +26,10 @@
  * The interface Kubernetes informer specifies the arguments for injecting an informer into the
  * informer-factory. The default argument list works for instantiating an informer list-watching
  * namespace resources.
+ *
+ * @deprecated create a {@link io.kubernetes.client.informer.SharedIndexInformer} as a bean instead
  */
+@Deprecated
 @Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface KubernetesInformer {

spring/src/main/java/io/kubernetes/client/spring/extended/controller/annotation/KubernetesInformers.java

@@ -25,7 +25,10 @@
  * <p>This annotation is specifically used for joining a list of {@link
  * io.kubernetes.client.spring.extended.controller.annotation.KubernetesInformer} onto one bean
  * method.
+ *
+ * @deprecated create a {@link io.kubernetes.client.informer.SharedIndexInformer} beans instead
  */
+@Deprecated
 @Target({ElementType.TYPE, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface KubernetesInformers {

spring/src/main/java/io/kubernetes/client/spring/extended/controller/annotation/KubernetesReconciler.java

@@ -26,7 +26,11 @@
  * KubernetesReconciler#value()} specifies.
  *
  * <p>Note that the automatically created controller is not started by default.
+ *
+ * @deprecated create a controller as a bean instead using {@link
+ *     io.kubernetes.client.extended.controller.builder.ControllerBuilder}
  */
+@Deprecated
 @Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface KubernetesReconciler {