Merge pull request #664 from spolti/BXMSDOC-7448

[BXMSDOC-7448] - Improve jdbc extension image fields description
kiegroup · Jul 5, 2021 · 44cc6bf · 44cc6bf
2 parents 5d68b3d + 5c593c9
commit 44cc6bf
Show file tree

Hide file tree

Showing 10 changed files with 40 additions and 32 deletions.
diff --git a/deploy/crds/kieapp.crd.yaml b/deploy/crds/kieapp.crd.yaml
@@ -1309,7 +1309,8 @@ spec:
                             extensionImageInstallDir:
                               description: Full path to the directory within the extensions
                                 image where the extensions are located (e.g. install.sh,
-                                modules/, etc.).
+                                modules/, etc.).  Defaults to '/extension'. Do not
+                                change it unless it is necessary.
                               type: string
                             extensionImageStreamTag:
                               description: ImageStreamTag definition for the image
@@ -3625,7 +3626,8 @@ spec:
                                 extensionImageInstallDir:
                                   description: Full path to the directory within the
                                     extensions image where the extensions are located
-                                    (e.g. install.sh, modules/, etc.).
+                                    (e.g. install.sh, modules/, etc.).  Defaults to
+                                    '/extension'. Do not change it unless it is necessary.
                                   type: string
                                 extensionImageStreamTag:
                                   description: ImageStreamTag definition for the image

diff --git a/...olm-catalog/dev/7.11.1-1/manifests/businessautomation-operator.clusterserviceversion.yaml b/...olm-catalog/dev/7.11.1-1/manifests/businessautomation-operator.clusterserviceversion.yaml
@@ -7,7 +7,7 @@ metadata:
     categories: Integration & Delivery
     certified: "false"
     containerImage: quay.io/kiegroup/kie-cloud-operator:7.11.1
-    createdAt: "2021-04-05 15:01:30"
+    createdAt: "2021-06-30 18:10:56"
     description: Deploys and manages Red Hat Process Automation Manager and Red Hat Decision Manager environments.
     operators.openshift.io/infrastructure-features: '["Disconnected"]'
     repository: https://github.com/kiegroup/kie-cloud-operator
@@ -17,7 +17,7 @@ metadata:
     operator-businessautomation: "true"
     operatorframework.io/arch.amd64: supported
     operatorframework.io/os.linux: supported
-  name: businessautomation-operator.7.11.1-1-dev-q6b728t6nn
+  name: businessautomation-operator.7.11.1-1-dev-d7trg6kkfh
   namespace: placeholder
 spec:
   apiservicedefinitions: {}
@@ -401,7 +401,7 @@ spec:
   - operator
   labels:
     alm-owner-businessautomation: businessautomation-operator
-    operated-by: businessautomation-operator.7.11.1-1-dev-q6b728t6nn
+    operated-by: businessautomation-operator.7.11.1-1-dev-d7trg6kkfh
   links:
   - name: Product Page
     url: https://access.redhat.com/products/red-hat-process-automation-manager
@@ -413,9 +413,9 @@ spec:
   maturity: dev
   provider:
     name: Red Hat
-  replaces: businessautomation-operator.7.11.0-1
+  replaces: businessautomation-operator.7.11.0-2
   selector:
     matchLabels:
       alm-owner-businessautomation: businessautomation-operator
-      operated-by: businessautomation-operator.7.11.1-1-dev-q6b728t6nn
-  version: 7.11.1-1+q6b728t6nn
+      operated-by: businessautomation-operator.7.11.1-1-dev-d7trg6kkfh
+  version: 7.11.1-1+d7trg6kkfh
diff --git a/deploy/olm-catalog/dev/7.11.1-1/manifests/kieapp.crd.yaml b/deploy/olm-catalog/dev/7.11.1-1/manifests/kieapp.crd.yaml
@@ -1309,7 +1309,8 @@ spec:
                             extensionImageInstallDir:
                               description: Full path to the directory within the extensions
                                 image where the extensions are located (e.g. install.sh,
-                                modules/, etc.).
+                                modules/, etc.).  Defaults to '/extension'. Do not
+                                change it unless it is necessary.
                               type: string
                             extensionImageStreamTag:
                               description: ImageStreamTag definition for the image
@@ -3625,7 +3626,8 @@ spec:
                                 extensionImageInstallDir:
                                   description: Full path to the directory within the
                                     extensions image where the extensions are located
-                                    (e.g. install.sh, modules/, etc.).
+                                    (e.g. install.sh, modules/, etc.).  Defaults to
+                                    '/extension'. Do not change it unless it is necessary.
                                   type: string
                                 extensionImageStreamTag:
                                   description: ImageStreamTag definition for the image

diff --git a/...lm-catalog/prod/7.11.1-1/manifests/businessautomation-operator.clusterserviceversion.yaml b/...lm-catalog/prod/7.11.1-1/manifests/businessautomation-operator.clusterserviceversion.yaml
@@ -7,7 +7,7 @@ metadata:
     categories: Integration & Delivery
     certified: "true"
     containerImage: registry.stage.redhat.io/rhpam-7/rhpam-rhel8-operator:7.11.1
-    createdAt: "2021-04-05 15:01:30"
+    createdAt: "2021-06-30 18:10:56"
     description: Deploys and manages Red Hat Process Automation Manager and Red Hat Decision Manager environments.
     operators.openshift.io/infrastructure-features: '["Disconnected"]'
     repository: https://github.com/kiegroup/kie-cloud-operator
@@ -413,7 +413,7 @@ spec:
   maturity: stable
   provider:
     name: Red Hat
-  replaces: businessautomation-operator.7.11.0-1
+  replaces: businessautomation-operator.7.11.0-2
   selector:
     matchLabels:
       alm-owner-businessautomation: businessautomation-operator

diff --git a/deploy/olm-catalog/prod/7.11.1-1/manifests/kieapp.crd.yaml b/deploy/olm-catalog/prod/7.11.1-1/manifests/kieapp.crd.yaml
@@ -1309,7 +1309,8 @@ spec:
                             extensionImageInstallDir:
                               description: Full path to the directory within the extensions
                                 image where the extensions are located (e.g. install.sh,
-                                modules/, etc.).
+                                modules/, etc.).  Defaults to '/extension'. Do not
+                                change it unless it is necessary.
                               type: string
                             extensionImageStreamTag:
                               description: ImageStreamTag definition for the image
@@ -3625,7 +3626,8 @@ spec:
                                 extensionImageInstallDir:
                                   description: Full path to the directory within the
                                     extensions image where the extensions are located
-                                    (e.g. install.sh, modules/, etc.).
+                                    (e.g. install.sh, modules/, etc.).  Defaults to
+                                    '/extension'. Do not change it unless it is necessary.
                                   type: string
                                 extensionImageStreamTag:
                                   description: ImageStreamTag definition for the image

diff --git a/...lm-catalog/test/7.11.1-1/manifests/businessautomation-operator.clusterserviceversion.yaml b/...lm-catalog/test/7.11.1-1/manifests/businessautomation-operator.clusterserviceversion.yaml
@@ -7,7 +7,7 @@ metadata:
     categories: Integration & Delivery
     certified: "true"
     containerImage: registry-proxy.engineering.redhat.com/rh-osbs/rhpam-7-rhpam-rhel8-operator:7.11.1
-    createdAt: "2021-04-05 15:01:30"
+    createdAt: "2021-06-30 18:10:56"
     description: Deploys and manages Red Hat Process Automation Manager and Red Hat Decision Manager environments.
     operators.openshift.io/infrastructure-features: '["Disconnected"]'
     repository: https://github.com/kiegroup/kie-cloud-operator
@@ -17,7 +17,7 @@ metadata:
     operator-businessautomation: "true"
     operatorframework.io/arch.amd64: supported
     operatorframework.io/os.linux: supported
-  name: businessautomation-operator.7.11.1-1-dev-gpss689sbc
+  name: businessautomation-operator.7.11.1-1-dev-xsrr8dpnmj
   namespace: placeholder
 spec:
   apiservicedefinitions: {}
@@ -401,7 +401,7 @@ spec:
   - operator
   labels:
     alm-owner-businessautomation: businessautomation-operator
-    operated-by: businessautomation-operator.7.11.1-1-dev-gpss689sbc
+    operated-by: businessautomation-operator.7.11.1-1-dev-xsrr8dpnmj
   links:
   - name: Product Page
     url: https://access.redhat.com/products/red-hat-process-automation-manager
@@ -413,9 +413,9 @@ spec:
   maturity: test
   provider:
     name: Red Hat
-  replaces: businessautomation-operator.7.11.0-1
+  replaces: businessautomation-operator.7.11.0-2
   selector:
     matchLabels:
       alm-owner-businessautomation: businessautomation-operator
-      operated-by: businessautomation-operator.7.11.1-1-dev-gpss689sbc
-  version: 7.11.1-1+gpss689sbc
+      operated-by: businessautomation-operator.7.11.1-1-dev-xsrr8dpnmj
+  version: 7.11.1-1+xsrr8dpnmj
diff --git a/deploy/olm-catalog/test/7.11.1-1/manifests/kieapp.crd.yaml b/deploy/olm-catalog/test/7.11.1-1/manifests/kieapp.crd.yaml
@@ -1309,7 +1309,8 @@ spec:
                             extensionImageInstallDir:
                               description: Full path to the directory within the extensions
                                 image where the extensions are located (e.g. install.sh,
-                                modules/, etc.).
+                                modules/, etc.).  Defaults to '/extension'. Do not
+                                change it unless it is necessary.
                               type: string
                             extensionImageStreamTag:
                               description: ImageStreamTag definition for the image
@@ -3625,7 +3626,8 @@ spec:
                                 extensionImageInstallDir:
                                   description: Full path to the directory within the
                                     extensions image where the extensions are located
-                                    (e.g. install.sh, modules/, etc.).
+                                    (e.g. install.sh, modules/, etc.).  Defaults to
+                                    '/extension'. Do not change it unless it is necessary.
                                   type: string
                                 extensionImageStreamTag:
                                   description: ImageStreamTag definition for the image

diff --git a/deploy/ui/form.json b/deploy/ui/form.json
@@ -1662,41 +1662,41 @@
                           "visible": false,
                           "fields": [
                             {
-                              "label": "Enable Extension image stream",
+                              "label": "Use JDBC Extension Image",
                               "type": "checkbox",
                               "required": false,
-                              "description": "When set to true will configure the KIE Server with Extension Image Stream.",
+                              "description": "When set to true will configure the KIE Server with JDBC Extension Image.",
                               "jsonPath": "$.spec.objects.servers[*].database.externalConfig.extensionImage",
                               "originalJsonPath": "$.spec.objects.servers[*].database.externalConfig.extensionImage",
                               "fields": [
                                 {
-                                  "label": "Enable Extension image stream",
+                                  "label": "Use JDBC Extension Image",
                                   "type": "fieldGroup",
                                   "jsonPath": "$.spec.objects.servers[*].build",
                                   "originalJsonPath": "$.spec.objects.servers[*].build",
                                   "displayWhen": "true",
                                   "visible": false,
                                   "fields": [
                                     {
-                                      "label": "Extension image stream tag",
+                                      "label": "JDBC Extension Image imagestream tag",
                                       "type": "text",
                                       "required": true,
                                       "jsonPath": "$.spec.objects.servers[*].build.extensionImageStreamTag",
                                       "description": "ImageStreamTag definition for the image containing the drivers and configuration. For example, custom-driver-image:7.7.0."
                                     },
                                     {
-                                      "label": "Extension image stream namespace",
+                                      "label": "JDBC Extension Image imagestream namespace",
                                       "type": "text",
                                       "required": false,
                                       "jsonPath": "$.spec.objects.servers[*].build.extensionImageStreamTagNamespace",
-                                      "description": "Namespace within which the ImageStream definition for the image containing the drivers and configuration is located. Defaults to openshift namespace."
+                                      "description": "Namespace within which the ImageStream definition for the image containing the drivers and configuration is located. Defaults to 'openshift' namespace."
                                     },
                                     {
-                                      "label": "Extension image install directory",
+                                      "label": "JDBC Extension Image install directory",
                                       "type": "text",
                                       "required": false,
                                       "jsonPath": "$.spec.objects.servers[*].build.extensionImageInstallDir",
-                                      "description": "Full path to the directory within the extensions image where the extensions are located (e.g. install.sh, modules/, etc.)."
+                                      "description": "Full path to the directory within the extensions image where the extensions are located (e.g. install.sh, modules/, etc.). Defaults to '/extension'. Do not change it unless it is necessary."
                                     }
                                   ]
                                 }

diff --git a/pkg/apis/app/v2/kieapp_types.go b/pkg/apis/app/v2/kieapp_types.go
@@ -289,7 +289,7 @@ type KieAppBuildObject struct {
 	ExtensionImageStreamTag string `json:"extensionImageStreamTag,omitempty"`
 	// Namespace within which the ImageStream definition for the image containing the drivers and configuration is located. Defaults to openshift namespace.
 	ExtensionImageStreamTagNamespace string `json:"extensionImageStreamTagNamespace,omitempty"`
-	// Full path to the directory within the extensions image where the extensions are located (e.g. install.sh, modules/, etc.).
+	// Full path to the directory within the extensions image where the extensions are located (e.g. install.sh, modules/, etc.).  Defaults to '/extension'. Do not change it unless it is necessary.
 	ExtensionImageInstallDir string `json:"extensionImageInstallDir,omitempty"`
 }
 

diff --git a/pkg/controller/kieapp/defaults/defaults.go b/pkg/controller/kieapp/defaults/defaults.go
@@ -907,7 +907,7 @@ func getBuildConfig(product string, cr *api.KieApp, serverSet *api.KieServerSet)
 		if serverSet.Build.ExtensionImageInstallDir == "" {
 			serverSet.Build.ExtensionImageInstallDir = constants.DefaultExtensionImageInstallDir
 		} else {
-			log.Debugf("Extension Image Install Dir set to %s, be cautions when updating this parameter.", serverSet.Build.ExtensionImageInstallDir)
+			log.Debugf("Extension Image Install Dir set to %s, be cautious when updating this parameter.", serverSet.Build.ExtensionImageInstallDir)
 		}
 		// JDBC extension image build template
 		buildTemplate = api.BuildTemplate{