Ensure that Carvel deployment uses default image tags from values file when provided. (#5699)

Author: Corneil du Plessis

spring-cloud-dataflow-docs/src/main/asciidoc/configuration-carvel.adoc

@@ -116,6 +116,7 @@ Where:
 * `scdf-type` One of oss or pro. oss is the default.
 * `release|snapshot` and `scdf-type` will determine the value of `PACKAGE_VERSION`.
 
+_*The best option to ensure using the type and version of package intended is to modify `deploy/versions.yaml`*_
 
 The environmental variables can also be configured manually to override the values.
 
@@ -131,6 +132,10 @@ The environmental variables can also be configured manually to override the valu
 |Version of Spring Cloud Data Flow
 |2.11.2
 
+|DATAFLOW_PRO_VERSION
+|Version of Spring Cloud Data Flow Pro
+|1.6.1
+
 |SKIPPER_VERSION
 |Version of Spring Cloud Skipper
 |2.11.2
@@ -157,6 +162,8 @@ The environmental variables can also be configured manually to override the valu
 
 |===
 
+NOTE: The above environmental variables should only be provided if different from the default in `deploy/versions.yaml`
+
 ==== Prepare Configuration file
 
 Create a file name `scdf-values.yml` by executing:

src/deploy/carvel/deploy-scdf.sh

@@ -52,14 +52,53 @@ if [ "$1" != "" ]; then
     APP_NAME="$1"
 fi
 echo "Deploying scdf-$SCDF_TYPE $PACKAGE_NAME:$PACKAGE_VERSION as $APP_NAME"
+SERVER_TAG=$(yq '.scdf.server.image.tag' ./scdf-values.yml)
 if [ "$DATAFLOW_VERSION" != "" ]; then
-    yq ".scdf.server.image.tag=\"$DATAFLOW_VERSION\"" -i ./scdf-values.yml
-    yq ".scdf.ctr.image.tag=\"$DATAFLOW_VERSION\"" -i ./scdf-values.yml
-    echo "Overriding Data Flow version=$DATAFLOW_VERSION"
+    if [ "$SCDF_TYPE" == "oss" ]; then
+        if [ "$SERVER_TAG" == "null" ] || [ "$SERVER_TAG" == "" ]; then
+            yq ".scdf.server.image.tag=\"$DATAFLOW_VERSION\"" -i ./scdf-values.yml
+            echo "Overriding Data Flow version=$DATAFLOW_VERSION"
+        else
+            echo "Using Data Flow version=$SERVER_TAG"
+        fi
+    fi
+    CTR_TAG=$(yq '.scdf.ctr.image.tag' ./scdf-values.yml)
+    if [ "$CTR_TAG" == "null" ] || [ "$CTR_TAG" == "" ]; then
+        yq ".scdf.ctr.image.tag=\"$DATAFLOW_VERSION\"" -i ./scdf-values.yml
+        echo "Overriding Composed Task Runner version=$DATAFLOW_VERSION"
+    else
+        echo "Using Composed Task Runner version=$CTR_TAG"
+    fi
+else
+    if [ "$SCDF_TYPE" == "oss" ] && [ "$SERVER_TAG" != "null" ] && [ "$SERVER_TAG" != "" ]; then
+        echo "Using Data Flow version=$SERVER_TAG"
+    fi
+fi
+SERVER_TAG=$(yq '.scdf.server.image.tag' ./scdf-values.yml)
+if [ "$DATAFLOW_PRO_VERSION" != "" ] && [ "$SCDF_TYPE" == "pro" ]; then
+    if [ "$SERVER_TAG" == "null" ] || [ "$SERVER_TAG" == "" ]; then
+        yq ".scdf.server.image.tag=\"$DATAFLOW_PRO_VERSION\"" -i ./scdf-values.yml
+        echo "Overriding Data Flow Pro version=$DATAFLOW_PRO_VERSION"
+    else
+        echo "Using Data Flow Pro version=$SERVER_TAG"
+    fi
+else
+    if [ "$SERVER_TAG" != "null" ] && [ "$SERVER_TAG" != "" ]; then
+        echo "Using Data Flow Pro version=$SERVER_TAG"
+    fi
 fi
+SKIPPER_TAG=$(yq '.scdf.skipper.image.tag' ./scdf-values.yml)
 if [ "$SKIPPER_VERSION" != "" ]; then
-    yq ".scdf.skipper.image.tag=\"$SKIPPER_VERSION\"" -i ./scdf-values.yml
-    echo "Overriding Skipper version=$SKIPPER_VERSION"
+    if [ "$SKIPPER_TAG" == "null" ] || [ "$SKIPPER_TAG" == "" ]; then
+        yq ".scdf.skipper.image.tag=\"$SKIPPER_VERSION\"" -i ./scdf-values.yml
+        echo "Overriding Skipper version=$SKIPPER_VERSION"
+    else
+        echo "Using Skipper version=$SKIPPER_TAG"
+    fi
+else
+    if [ "$SKIPPER_TAG" != "null" ] && [ "$SKIPPER_TAG" != "" ]; then
+        echo "Using Skipper version=$SKIPPER_TAG"
+    fi
 fi
 
 "$SCDIR/carvel-import-secret.sh" "scdfmetadata" "$NS"

src/deploy/carvel/scdf-oss-values.yml

@@ -2,6 +2,8 @@ scdf:
   binder:
     type: rabbit
   server:
+#    image: # uncomment to use a different tag
+#      tag: 2.11.2
     service:
       type: LoadBalancer
     env:
@@ -11,6 +13,12 @@ scdf:
         value: "true"
       - name: SPRING_CLOUD_DATAFLOW_FEATURES_SCHEDULES_ENABLED
         value: "true"
+#  skipper:
+#    image: # uncomment to use a different tag
+#      tag: 2.11.2
+#  ctr:
+#    image: # uncomment to use a different tag
+#      tag: 2.11.2
   registry:
     secret:
       ref: "reg-creds-dockerhub"

src/deploy/carvel/scdf-pro-values.yml

@@ -2,9 +2,8 @@ scdf:
   binder:
     type: rabbit
   server:
-    image:
-      repository: dev.registry.tanzu.vmware.com/p-scdf-for-kubernetes/scdf-pro-server
-      tag: 1.6.0
+#    image: # uncomment to use a different tag
+#      tag: 1.6.1
     service:
       type: LoadBalancer
     env:
@@ -14,10 +13,12 @@ scdf:
         value: "true"
       - name: SPRING_CLOUD_DATAFLOW_FEATURES_SCHEDULES_ENABLED
         value: "true"
-  skipper:
-    image:
-      repository: springcloud/spring-cloud-skipper-server
-      tag: 2.11.2
+#  skipper:
+#    image: # pro uses a skipper image from registry.tanzu.vmware.com that is tagged with package version
+#      tag: 1.6.1
+#  ctr:
+#    image: # uncomment to use a different tag
+#      tag: 2.11.2
   registry:
     secret:
       ref: "reg-creds-dev-registry"

src/deploy/versions.yaml

@@ -10,5 +10,5 @@ scdf-type:
     maintenance-snapshot: '1.5.4-SNAPSHOT'
 default:
   scdf-type: 'oss'
-  version: 'release'
-  package-version: '2.11.2'
+  version: 'snapshot'
+  package-version: '2.11.3-SNAPSHOT'