refactor: move CSV-related annotation & interface to annotations modu…

…le (#705)

Fixes #700

annotations/src/main/java/io/quarkiverse/operatorsdk/annotations/CSVMetadata.java

@@ -0,0 +1,121 @@
+package io.quarkiverse.operatorsdk.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE })
+@SuppressWarnings("unused")
+public @interface CSVMetadata {
+    String name() default "";
+
+    Annotations annotations() default @Annotations;
+
+    String description() default "";
+
+    String displayName() default "";
+
+    Icon[] icon() default {};
+
+    String[] keywords() default "";
+
+    String maturity() default "";
+
+    String version() default "";
+
+    String replaces() default "";
+
+    Maintainer[] maintainers() default {};
+
+    Provider provider() default @Provider;
+
+    InstallMode[] installModes() default {};
+
+    PermissionRule[] permissionRules() default {};
+
+    RequiredCRD[] requiredCRDs() default {};
+
+    String minKubeVersion() default "";
+
+    Link[] links() default {};
+
+    @interface Annotations {
+        String containerImage() default "";
+
+        String repository() default "";
+
+        String capabilities() default "";
+
+        String categories() default "";
+
+        boolean certified() default false;
+
+        String almExamples() default "";
+
+        String skipRange() default "";
+
+        Annotation[] others() default {};
+
+        @interface Annotation {
+            String name();
+
+            String value();
+        }
+    }
+
+    @interface Icon {
+        String DEFAULT_MEDIA_TYPE = "image/svg+xml";
+
+        String fileName();
+
+        String mediatype() default DEFAULT_MEDIA_TYPE;
+    }
+
+    @interface Maintainer {
+        String email() default "";
+
+        String name() default "";
+    }
+
+    @interface Provider {
+        String name() default "";
+
+        String url() default "";
+    }
+
+    @interface InstallMode {
+        String type();
+
+        boolean supported() default true;
+    }
+
+    @interface PermissionRule {
+        String[] apiGroups();
+
+        String[] resources();
+
+        String[] verbs() default { "get", "list", "watch", "create", "delete", "patch", "update" };
+
+        /**
+         * @return the service account name for the permission rule. If not provided, it will use the default service account
+         *         name.
+         */
+        String serviceAccountName() default "";
+    }
+
+    @interface RequiredCRD {
+        String kind();
+
+        String name();
+
+        String version();
+    }
+
+    @interface Link {
+        String url();
+
+        String name();
+    }
+}

annotations/src/main/java/io/quarkiverse/operatorsdk/annotations/SharedCSVMetadata.java

@@ -0,0 +1,4 @@
+package io.quarkiverse.operatorsdk.annotations;
+
+public interface SharedCSVMetadata {
+}

bundle-generator/deployment/pom.xml

@@ -37,6 +37,10 @@
             <artifactId>quarkus-junit5-internal</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>io.quarkiverse.operatorsdk</groupId>
+            <artifactId>quarkus-operator-sdk-annotations</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

bundle-generator/deployment/src/main/java/io/quarkiverse/operatorsdk/bundle/deployment/BundleProcessor.java

@@ -27,11 +27,10 @@
 import io.fabric8.kubernetes.api.model.rbac.ClusterRoleBinding;
 import io.fabric8.kubernetes.api.model.rbac.Role;
 import io.fabric8.kubernetes.api.model.rbac.RoleBinding;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.SharedCSVMetadata;
 import io.quarkiverse.operatorsdk.bundle.runtime.BundleGenerationConfiguration;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata.Icon;
 import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadataHolder;
-import io.quarkiverse.operatorsdk.bundle.runtime.SharedCSVMetadata;
 import io.quarkiverse.operatorsdk.common.*;
 import io.quarkiverse.operatorsdk.deployment.GeneratedCRDInfoBuildItem;
 import io.quarkiverse.operatorsdk.deployment.VersionBuildItem;
@@ -367,7 +366,7 @@ private CSVMetadataHolder createMetadataHolder(AnnotationInstance csvMetadata, C
                         ConfigurationUtils.annotationValueOrDefault(iconAnn[i], "fileName",
                                 AnnotationValue::asString, () -> null),
                         ConfigurationUtils.annotationValueOrDefault(iconAnn[i], "mediatype",
-                                AnnotationValue::asString, () -> Icon.DEFAULT_MEDIA_TYPE));
+                                AnnotationValue::asString, () -> CSVMetadata.Icon.DEFAULT_MEDIA_TYPE));
             }
         } else {
             icon = mh.icon;

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/AReconciler.java

@@ -4,8 +4,8 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
-import io.quarkiverse.operatorsdk.bundle.runtime.SharedCSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.SharedCSVMetadata;
 
 @CSVMetadata(name = "shared", version = "0.0.1")
 public class AReconciler implements Reconciler<ConfigMap>, SharedCSVMetadata {

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/BReconciler.java

@@ -4,7 +4,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
 
 @CSVMetadata(name = "shared", version = "0.0.2")
 public class BReconciler implements Reconciler<Service> {

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/DuplicatedBundleNameWithoutSharedCSVMetadata1.java

@@ -4,7 +4,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
 
 @CSVMetadata(name = "illegal")
 public class DuplicatedBundleNameWithoutSharedCSVMetadata1 implements Reconciler<Role> {

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/DuplicatedBundleNameWithoutSharedCSVMetadata2.java

@@ -4,7 +4,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
 
 @CSVMetadata(name = "illegal")
 public class DuplicatedBundleNameWithoutSharedCSVMetadata2 implements Reconciler<RoleBinding> {

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/External.java

@@ -3,7 +3,7 @@
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.model.annotation.Group;
 import io.fabric8.kubernetes.model.annotation.Version;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
 
 @Group("halkyon.io")
 @Version("v1alpha1")

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/FirstReconciler.java

@@ -3,7 +3,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
 
 @CSVMetadata(name = "first-operator", version = FirstReconciler.VERSION)
 public class FirstReconciler implements Reconciler<First> {

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/SecondReconciler.java

@@ -3,7 +3,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
 
 @CSVMetadata(name = "second-operator")
 public class SecondReconciler implements Reconciler<Second> {

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/Third.java

@@ -4,7 +4,7 @@
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.model.annotation.Group;
 import io.fabric8.kubernetes.model.annotation.Version;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
 
 @Group("samples.javaoperatorsdk.io")
 @Version("v1alpha1")

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/ThirdReconciler.java

@@ -5,10 +5,10 @@
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Dependent;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata.Annotations;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata.Annotations.Annotation;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata.RequiredCRD;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata.Annotations;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata.Annotations.Annotation;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata.RequiredCRD;
 
 @CSVMetadata(name = "third-operator", requiredCRDs = @RequiredCRD(kind = SecondExternal.KIND, name = "externalagains."
         + SecondExternal.GROUP, version = SecondExternal.VERSION), replaces = "1.0.0", annotations = @Annotations(skipRange = ">=1.0.0 <1.0.3", capabilities = "Test", others = @Annotation(name = "foo", value = "bar")))

bundle-generator/runtime/pom.xml

@@ -24,6 +24,10 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-kubernetes</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkiverse.operatorsdk</groupId>
+            <artifactId>quarkus-operator-sdk-annotations</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

bundle-generator/runtime/src/main/java/io/quarkiverse/operatorsdk/bundle/runtime/CSVMetadata.java

@@ -8,6 +8,10 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ ElementType.TYPE })
 @SuppressWarnings("unused")
+@Deprecated(since = "6.3.1", forRemoval = true)
+/**
+ * @deprecated Use {@link io.quarkiverse.operatorsdk.annotations.CSVMetadata} instead
+ */
 public @interface CSVMetadata {
     String name() default "";
 

bundle-generator/runtime/src/main/java/io/quarkiverse/operatorsdk/bundle/runtime/SharedCSVMetadata.java

@@ -1,4 +1,9 @@
 package io.quarkiverse.operatorsdk.bundle.runtime;
 
+@SuppressWarnings("unused")
+@Deprecated(since = "6.3.1", forRemoval = true)
+/**
+ * @deprecated Use {@link io.quarkiverse.operatorsdk.annotations.CSVMetadata} instead
+ */
 public interface SharedCSVMetadata {
 }

samples/joke/pom.xml

@@ -24,6 +24,10 @@
       <groupId>io.quarkiverse.operatorsdk</groupId>
       <artifactId>quarkus-operator-sdk-bundle-generator</artifactId>
     </dependency>
+    <dependency>
+      <groupId>io.quarkiverse.operatorsdk</groupId>
+      <artifactId>quarkus-operator-sdk-annotations</artifactId>
+    </dependency>
     <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-resteasy-reactive-jackson</artifactId>

samples/joke/src/main/java/io/quarkiverse/operatorsdk/samples/joke/JokeRequestReconciler.java

@@ -28,8 +28,8 @@
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata.Icon;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata.Icon;
 import io.quarkiverse.operatorsdk.samples.joke.JokeRequestSpec.ExcludedTopic;
 import io.quarkiverse.operatorsdk.samples.joke.JokeRequestStatus.State;
 

samples/pingpong/src/main/java/io/quarkiverse/operatorsdk/samples/pingpong/PingPongOperatorCSVMetadata.java

@@ -1,7 +1,7 @@
 package io.quarkiverse.operatorsdk.samples.pingpong;
 
-import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
-import io.quarkiverse.operatorsdk.bundle.runtime.SharedCSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
+import io.quarkiverse.operatorsdk.annotations.SharedCSVMetadata;
 
 @CSVMetadata(name = "pingpong-operator")
 public class PingPongOperatorCSVMetadata implements SharedCSVMetadata {