Operator prod updates

operator/Makefile

@@ -288,16 +288,19 @@ dist: dist-install-file ## TODO
 	$(call target_dir,$(DIST_TARGET_DIR))
 	cp -rt $(DIST_TARGET_DIR) controller/src/main/deploy/dist-template/*
 	# Licenses
-	cp -t $(DIST_TARGET_DIR) target/generated-resources/licenses.xml
-	sed -i '\|^.*<file>.*</file>.*$$|d' $(DIST_TARGET_DIR)/licenses.xml
+	cp -t $(DIST_TARGET_DIR) $(CURRENT_DIR)/../LICENSE
+	mkdir -p $(DIST_TARGET_DIR)/licenses
+	cp -t $(DIST_TARGET_DIR)/licenses target/generated-resources/licenses.xml
+	sed -i '\|^.*<file>.*</file>.*$$|d' $(DIST_TARGET_DIR)/licenses/licenses.xml
 	# Examples
 	mkdir -p $(DIST_TARGET_DIR)/examples
 	cp -t $(DIST_TARGET_DIR)/examples controller/src/main/deploy/examples/*
 	rm $(DIST_TARGET_DIR)/examples/kustomization.yaml
 	cp -rt $(DIST_TARGET_DIR)/examples controller/src/main/resources/k8s/examples/*
 	cp -rt $(DIST_TARGET_DIR)/examples controller/src/test/resources/k8s/examples/*
 	# Install
-	cp $(INSTALL_FILE) $(DIST_TARGET_DIR)/install.yaml
+	mkdir -p $(DIST_TARGET_DIR)/install
+	cp $(INSTALL_FILE) $(DIST_TARGET_DIR)/install/install.yaml
 	# Archive
 	cd $(DIST_TARGET_DIR) && tar -zcf ../apicurio-registry-operator-$(VERSION).tar.gz *
 

operator/controller/src/main/deploy/dist-template/README.adoc

@@ -1,33 +1,40 @@
-= Apicurio Registry Operator Distribution Bundle
+= Apicurio Registry Installation and Example Files
 
 This directory contains installation files for the Apicurio Registry Operator, with example `ApicurioRegistry3` custom resource files.
 Docker images for the operator and the operand are distributed using a public registry.
 
-== Installation
+== How to Install the Operator
 
 .Procedure
-. Choose a namespace where the operator will be deployed:
+. Choose a namespace where the Operator will be deployed:
 +
 [source,bash]
 ----
 export NAMESPACE=apicurio-registry
 kubectl create namespace $NAMESPACE
 ----
 
-. Kubernetes resources required for the installation are present inside `install.yaml` file.
+. Kubernetes resources required for the installation are present inside `install/install.yaml` file.
 Apply the installation file:
 +
 [source,bash]
 ----
-cat install.yaml | sed "s/PLACEHOLDER_NAMESPACE/$NAMESPACE/g" | kubectl -n $NAMESPACE apply -f -
+cat install/install.yaml | sed "s/PLACEHOLDER_NAMESPACE/$NAMESPACE/g" | kubectl -n $NAMESPACE apply -f -
 ----
 
-== Deploy Apicurio Registry
+== How to Install the Registry
 
 After the Apicurio Registry Operator has been deployed, it can deploy an Apicurio Registry instance.
 
-To create a new Apicurio Registry deployment, the fastest way is to use one of the example `ApicurioRegistry3` custom resources:
+The Registry supports the following persistence options:
 
+* Kafka
+* PostgreSQL
+* MySQL
+* SQL Server
+* in-memory
+
+Examples of `ApicurioRegistry3` custom resources configured for different persistence solutions can be found in the `examples/` folder. Review and apply one of them:
 [source,bash]
 ----
 kubectl -n $NAMESPACE apply -f examples/simple.apicurioregistry3.yaml

operator/controller/src/main/deploy/operator/kustomization.yaml

@@ -28,11 +28,6 @@ patches:
         # Workaround for https://github.com/operator-framework/operator-lifecycle-manager/issues/1608
         # See https://github.com/operator-framework/operator-lifecycle-manager/issues/952#issuecomment-639657949
         value: apicurio-registry-operator-v${PLACEHOLDER_LC_VERSION}
-      - op: add
-        path: /spec/template/spec/containers/0/env/-
-        value:
-          name: REGISTRY_VERSION
-          value: ${PLACEHOLDER_VERSION}
       - op: add
         path: /spec/template/spec/containers/0/env/-
         value:

operator/controller/src/main/java/io/apicurio/registry/operator/Configuration.java

@@ -1,26 +1,43 @@
 package io.apicurio.registry.operator;
 
+import org.eclipse.microprofile.config.Config;
 import org.eclipse.microprofile.config.ConfigProvider;
 
 public class Configuration {
 
+    private static final Config config = ConfigProvider.getConfig();
+
     private Configuration() {
     }
 
     public static String getAppImage() {
-        return ConfigProvider.getConfig().getOptionalValue("registry.app.image", String.class)
-                .orElseThrow(() -> new OperatorException(
-                        "Required configuration option 'registry.app.image' is not set."));
+        // spotless:off
+        return config.getOptionalValue("registry.app.image", String.class)
+                .or(() -> config.getOptionalValue("related.image.registry.app.image", String.class))
+                .orElseThrow(() -> new OperatorException("Required configuration option 'registry.app.image' is not set."));
+        // spotless:on
     }
 
     public static String getUIImage() {
-        return ConfigProvider.getConfig().getOptionalValue("registry.ui.image", String.class).orElseThrow(
-                () -> new OperatorException("Required configuration option 'registry.ui.image' is not set."));
+        // spotless:off
+        return config.getOptionalValue("registry.ui.image", String.class)
+                .or(() -> config.getOptionalValue("related.image.registry.ui.image", String.class))
+                .orElseThrow(() -> new OperatorException("Required configuration option 'registry.ui.image' is not set."));
+        // spotless:on
+    }
+
+    public static String getRegistryVersion() {
+        // spotless:off
+        return config.getOptionalValue("registry.version", String.class)
+                .orElseThrow(() -> new OperatorException("Required configuration option 'registry.version' is not set."));
+        // spotless:on
     }
 
     public static String getDefaultBaseHost() {
-        return ConfigProvider.getConfig()
-                .getOptionalValue("apicurio.operator.default-base-host", String.class).map(v -> "." + v)
+        // spotless:off
+        return config.getOptionalValue("apicurio.operator.default-base-host", String.class)
+                .map(v -> "." + v)
                 .orElse("");
+        // spotless:on
     }
 }

operator/controller/src/main/java/io/apicurio/registry/operator/resource/ResourceFactory.java

@@ -205,7 +205,7 @@ private void addDefaultLabels(Map<String, String> labels, ApicurioRegistry3 prim
                 "app.kubernetes.io/name", "apicurio-registry",
                 "app.kubernetes.io/component", component,
                 "app.kubernetes.io/instance", primary.getMetadata().getName(),
-                "app.kubernetes.io/version", "1.0.0", // TODO
+                "app.kubernetes.io/version", Configuration.getRegistryVersion(),
                 "app.kubernetes.io/part-of", "apicurio-registry",
                 "app.kubernetes.io/managed-by", "apicurio-registry-operator"
         ));

operator/controller/src/main/resources/application.properties

@@ -43,17 +43,18 @@ quarkus.operator-sdk.controllers."ApicurioRegistry3Reconciler".namespaces=${apic
 
 quarkus.vertx.max-event-loop-execute-time=8s
 
+# Maven property
+registry.version=${project.version}
+
+# Test & dev only =====
+
 %test.quarkus.operator-sdk.start-operator=false
 
 %test.registry.app.image=quay.io/apicurio/apicurio-registry:latest-snapshot
 %dev.registry.app.image=quay.io/apicurio/apicurio-registry:latest-snapshot
 %test.registry.ui.image=quay.io/apicurio/apicurio-registry-ui:latest-snapshot
 %dev.registry.ui.image=quay.io/apicurio/apicurio-registry-ui:latest-snapshot
 
-# Test Only =====
-
-# Maven property
-%test.test.operator.project-version=${project.version}
 # Maven property
 %test.test.operator.project-root=${projectRoot}
 

operator/controller/src/test/java/io/apicurio/registry/operator/unit/PodTemplateSpecTest.java

@@ -8,6 +8,8 @@
 import io.apicurio.registry.operator.resource.ResourceFactory;
 import io.apicurio.registry.operator.unit.PodTemplateSpecArgumentProviders.*;
 import io.fabric8.kubernetes.api.model.ObjectMeta;
+import io.fabric8.kubernetes.api.model.PodTemplateSpec;
+import org.eclipse.microprofile.config.ConfigProvider;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ArgumentsSource;
 import org.slf4j.Logger;
@@ -27,6 +29,7 @@ void testAppPositive(TestCase testCase) {
         var primary = getPrimary();
         primary.getSpec().getApp().setPodTemplateSpec(testCase.getSpec());
         var expected = ResourceFactory.INSTANCE.getDefaultAppDeployment(primary).getSpec().getTemplate();
+        preprocessTestCaseExpected(testCase.getExpected());
         // spotless:off
         assertThat(expected)
                 .usingRecursiveComparison()
@@ -57,6 +60,7 @@ void testUIPositive(TestCase testCase) {
         var primary = getPrimary();
         primary.getSpec().getUi().setPodTemplateSpec(testCase.getSpec());
         var expected = ResourceFactory.INSTANCE.getDefaultUIDeployment(primary).getSpec().getTemplate();
+        preprocessTestCaseExpected(testCase.getExpected());
         // spotless:off
         assertThat(expected)
                 .usingRecursiveComparison()
@@ -90,4 +94,9 @@ private static ApicurioRegistry3 getPrimary() {
         primary.getSpec().setUi(new ApicurioRegistry3SpecUI());
         return primary;
     }
+
+    private static void preprocessTestCaseExpected(PodTemplateSpec expected) {
+        expected.getMetadata().getLabels().computeIfPresent("app.kubernetes.io/version",
+                (k, v) -> ConfigProvider.getConfig().getValue("registry.version", String.class));
+    }
 }

operator/controller/src/test/resources/podtemplatespec-test-cases-app-positive.yaml

@@ -6,7 +6,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app
@@ -50,7 +50,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app
@@ -95,7 +95,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app
@@ -137,7 +137,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app
@@ -184,7 +184,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app
@@ -234,7 +234,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app
@@ -279,7 +279,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app
@@ -328,7 +328,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app
@@ -382,7 +382,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app
@@ -432,7 +432,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app
@@ -476,7 +476,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app
@@ -514,7 +514,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app
@@ -554,7 +554,7 @@ cases:
       metadata:
         labels:
           app.kubernetes.io/name: apicurio-registry
-          app.kubernetes.io/version: 1.0.0
+          app.kubernetes.io/version: placeholder
           app.kubernetes.io/instance: test
           app.kubernetes.io/part-of: apicurio-registry
           app.kubernetes.io/component: app