fixing Verrazzano app/component deployment issues (#187)

* fixing app/component deployment issues

* Show placeholder text for ingress paths as gray; show path type label

Co-authored-by: Richard Killen <[email protected]>

Author: robertpatrick

electron/app/js/ipcRendererPreload.js

@@ -233,6 +233,7 @@ contextBridge.exposeInMainWorld(
           'get-verrazzano-secret-names',
           'get-verrazzano-cluster-names',
           'get-verrazzano-deployment-names-all-namespaces',
+          'verify-verrazzano-components-exist',
           'deploy-verrazzano-project',
           'deploy-verrazzano-application',
           'undeploy-verrazzano-application',

electron/app/js/kubectlUtils.js

@@ -688,7 +688,7 @@ async function apply(kubectlExe, fileData, options) {
     fsUtils.writeTempFile(fileData, { baseName: 'k8sApplyData', extension: '.yaml' }).then(fileName => {
       const args = [ 'apply', '-f', fileName ];
       executeFileCommand(kubectlExe, args, env).then(stdout => {
-        console.log('kubectl apply returned: %s', stdout);
+        getLogger().debug('kubectl apply returned: %s', stdout);
         fsUtils.recursivelyRemoveTemporaryFileDirectory(fileName).then(() => resolve(result)).catch(err => {
           getLogger().warn('kubectlUtils.apply() failed to remove temporary file %s: %s', fileName, err);
           resolve(result);
@@ -860,7 +860,12 @@ async function isVerrazzanoInstalled(kubectlExe, options) {
         const vzObject = vzObjectList[0];
         result.isInstalled = true;
         result.name = vzObject.metadata?.name;
-        result.version = vzObject.status?.version;
+
+        let statusVersion = vzObject.status?.version;
+        if (statusVersion && statusVersion.startsWith('v')) {
+          statusVersion = statusVersion.slice(1);
+        }
+        result.version = statusVersion;
       }
       resolve(result);
     }).catch(err => {
@@ -972,6 +977,36 @@ async function getKubernetesObjectsFromAllNamespaces(kubectlExe, kubectlOptions,
   });
 }
 
+async function verifyVerrazzanoComponentsDeployed(kubectlExe, componentNames, namespace, kubectlOptions) {
+  const httpsProxyUrl = getHttpsProxyUrl();
+  const bypassProxyHosts = getBypassProxyHosts();
+
+  const env = getKubectlEnvironment(kubectlOptions, httpsProxyUrl, bypassProxyHosts);
+
+  const result = {
+    isSuccess: true
+  };
+
+  const missingComponentNames = [];
+  for (const componentName of componentNames) {
+    const args = [ 'get', 'Component', componentName, '-n', namespace ];
+    try {
+      const stdout = await executeFileCommand(kubectlExe, args, env);
+      getLogger().debug('Found component %s in namespace %s: %s', componentName, namespace, stdout);
+    } catch (err) {
+      getLogger().warn('Error getting component %s in namespace %s: %s', componentName, namespace, getErrorMessage(err));
+      missingComponentNames.push(componentName);
+    }
+  }
+
+  if (missingComponentNames.length > 0) {
+    result.isSuccess = false;
+    result.reason = i18n.t('kubectl-verify-vz-components-deployed-error-message',
+      { namespace: namespace, missingComponents: missingComponentNames.join(', ')});
+  }
+  return Promise.resolve(result);
+}
+
 async function doCreateSecret(kubectlExe, createArgs, env, namespace, secret, resolve, results, key) {
   executeFileCommand(kubectlExe, createArgs, env, true).then(() => {
     resolve(results);
@@ -1063,5 +1098,6 @@ module.exports = {
   validateDomainExist,
   validateApplicationExist,
   verifyClusterConnectivity,
+  verifyVerrazzanoComponentsDeployed,
   verifyVerrazzanoPlatformOperatorRollout,
 };

electron/app/locales/en/electron.json

@@ -321,6 +321,7 @@
   "kubectl-get-named-vz-install-error-message": "Unable to get Verrazzano installation with name {{name}}: {{error}}",
   "kubectl-get-vz-application-status-error-message": "Unable to get Verrazzano application status: {{error}}",
   "kubectl-get-operator-version-not-found-error-message": "Failed to find the operator version from its log entries",
+  "kubectl-verify-vz-components-deployed-error-message": "Unable to find one or more components in namespace {{namespace}}: {{missingComponents}}",
 
   "helm-not-specified-error-message": "Helm executable path was not provided",
   "helm-not-exists-error-message": "Helm executable {{filePath}} does not exist",

electron/app/locales/en/webui.json

@@ -1328,6 +1328,7 @@
   "flow-getting-vz-application-status-in-progress": "Getting Application Status",
   "flow-checking-operator-version-in-progress": "Checking operator version",
   "flow-checking-vz-already-installed-in-progress": "Checking if Verrazzano is already installed.",
+  "flow-checking-vz-app-components-deployed-in-progress": "Checking if Verrazzano application's components are deployed.",
   "flow-install-verrazzano-name": "Install Verrazzano",
   "flow-verrazzano-install-status-check-name": "Check Verrazzano Install Status",
   "flow-verrazzano-get-install-version-name": "Get Verrazzano Installed Version",
@@ -1568,8 +1569,11 @@
   "vz-application-design-project-name-label": "Verrazzano Project Name",
   "vz-application-design-project-name-help": "The name to use when creating the new Verrazzano project for this multicluster application.",
   "vz-application-design-components-title": "Components",
+  "vz-application-design-components-label": "Components",
   "vz-application-design-component-name-label": "Component Name",
   "vz-application-design-component-name-help": "The name of the Verrazzano component used by this application.",
+  "vz-application-design-delete-component-button-label": "Delete Component",
+  "vz-application-design-delete-component-button-help": "Delete the component reference from the application.",
   "vz-application-design-add-component-button-label": "Add Component",
   "vz-application.design-add-component-flow-nane": "Add Component",
   "vz-application-design-add-component-validation-error-title": "Add Component to Application Aborted",
@@ -1666,11 +1670,13 @@
   "vz-application-design-ingress-trait-rule-edit-paths-table-aria-label": "Paths table",
   "vz-application-design-ingress-trait-rule-edit-path-label": "Path",
   "vz-application-design-ingress-trait-rule-edit-path-help": "The path value to match using the specified Path Type value.",
+  "vz-application-design-ingress-trait-rule-edit-path-placeholder": "Enter Path Value",
   "vz-application-design-ingress-trait-rule-edit-path-type-label": "Path Type",
   "vz-application-design-ingress-trait-rule-edit-path-type-prefix-label": "Prefix",
   "vz-application-design-ingress-trait-rule-edit-path-type-exact-label": "Exact",
   "vz-application-design-ingress-trait-rule-edit-path-type-regex-label": "Regular Expression",
   "vz-application-design-ingress-trait-rule-edit-path-type-help": "The expression type to use to process the Path value.",
+  "vz-application-design-ingress-trait-rule-edit-path-type-placeholder": "Select Path Type",
   "vz-application-design-ingress-trait-rule-edit-path-add-row-tooltip": "Add Path",
   "vz-application-design-ingress-trait-rule-edit-path-delete-row-tooltip": "Delete Path",
   "vz-application-design-ingress-trait-rule-editASdd-destination-title": "Destination",
@@ -1695,6 +1701,7 @@
   "vz-application-deployer-set-context-error-message": "Unable to deploy Verrazzano application because setting the Kubernetes client cluster context failed: {{error}}.",
   "vz-application-deployer-install-check-failed-error-message": "Unable to deploy Verrazzano application because checking to see if Verrazzano is installed failed: {{error}}.",
   "vz-application-deployer-not-installed-error-message": "Unable to deploy Verrazzano application because Verrazzano is not installed.",
+  "vz-application-deployer-verify-components-error-message": "Unable to deploy Verrazzano application because one or more referenced components are not deployed in the Kubernetes namespace {{namespace}}: {{error}}.",
   "vz-application-deployer-deploy-project-in-progress": "Deploying Verrazzano Project",
   "vz-application-deployer-deploy-project-error-message": "Unable to deploy Verrazzano application because an error occurred while deploying the Verrazzano project {{projectName}}: {{error}}.",
   "vz-application-deployer-deploy-application-in-progress": "Deploying Application",

electron/app/main.js

@@ -1064,6 +1064,11 @@ class Main {
     ipcMain.handle('deploy-verrazzano-project', async (event, kubectlExe, project, kubectlOptions) => {
       return deployProject(kubectlExe, project, kubectlOptions);
     });
+
+    // eslint-disable-next-line no-unused-vars
+    ipcMain.handle('verify-verrazzano-components-exist',async (event, kubectlExe, componentNames, namespace, kubectlOptions) => {
+      return kubectlUtils.verifyVerrazzanoComponentsDeployed(kubectlExe, componentNames, namespace, kubectlOptions);
+    });
   }
 
   async getLatestWdtInstaller(targetWindow) {

webui/src/css/app.css

@@ -756,3 +756,7 @@ h6.wkt-panel-heading {
   color: red;
   font-weight: bold;
 }
+
+.wkt-placeholder-text {
+  color: var(--oj-label-inside-edge-color);
+}

webui/src/js/models/k8s-domain-definition.js

@@ -113,17 +113,6 @@ define(['knockout', 'utils/observable-properties', 'utils/common-utilities', 'ut
           this.updateSecrets();
         });
 
-        this.configMapIsEmpty = () => {
-          let result = true;
-          for (const entry of wdtModel.getMergedPropertiesContent().observable()) {
-            if (entry.Override) {
-              result = false;
-              break;
-            }
-          }
-          return result;
-        };
-
         this.readFrom = (json) => {
           props.createGroup(name, this).readFrom(json);
         };

webui/src/js/models/vz-component-definition.js

@@ -17,10 +17,6 @@ define(['utils/observable-properties', 'utils/validation-helper'],
         this.componentName = props.createProperty('${1}', k8sDomain.uid.observable);
         this.componentName.addValidator(...validationHelper.getK8sNameValidators());
 
-        this.configMapIsEmpty = () => {
-          return k8sDomain.configMapIsEmpty();
-        };
-
         this.readFrom = (json) => {
           props.createGroup(name, this).readFrom(json);
         };

webui/src/js/utils/k8s-domain-configmap-generator.js

@@ -13,7 +13,7 @@ define(['models/wkt-project', 'js-yaml'],
       }
 
       shouldCreateConfigMap() {
-        return this.project.settings.targetDomainLocation.value === 'mii' && !this.project.k8sDomain.configMapIsEmpty();
+        return this.project.settings.targetDomainLocation.value === 'mii';
       }
 
       generate(generateYaml = true) {

webui/src/js/utils/k8s-domain-deployer.js

@@ -247,26 +247,24 @@ function (K8sDomainActionsBase, project, wktConsole, i18n, projectIo, dialogHelp
           {domainName: domainUid, domainNamespace: domainNamespace});
         dialogHelper.updateBusyDialog(busyDialogMessage, 12 / totalSteps);
         if (this.project.settings.targetDomainLocation.value === 'mii') {
-          if (!this.project.k8sDomain.configMapIsEmpty()) {
-            const configMapData = this.k8sDomainConfigMapGenerator.generate().join('\n');
-            wktLogger.debug(configMapData);
-            const mapResults = await (window.api.ipc.invoke('k8s-apply', kubectlExe, configMapData, kubectlOptions));
-            if (!mapResults.isSuccess) {
-              const configMapName = this.project.k8sDomain.modelConfigMapName.value;
-              const errMessage = i18n.t('k8s-domain-deployer-create-config-map-failed-error-message',
-                {configMapName: configMapName, domainNamespace: domainNamespace, error: mapResults.reason});
-              dialogHelper.closeBusyDialog();
-              await window.api.ipc.invoke('show-error-message', errTitle, errMessage);
-              return Promise.resolve(false);
-            }
+          const configMapData = this.k8sDomainConfigMapGenerator.generate().join('\n');
+          wktLogger.debug(configMapData);
+          const mapResults = await (window.api.ipc.invoke('k8s-apply', kubectlExe, configMapData, kubectlOptions));
+          if (!mapResults.isSuccess) {
+            const configMapName = this.project.k8sDomain.modelConfigMapName.value;
+            const errMessage = i18n.t('k8s-domain-deployer-create-config-map-failed-error-message',
+              {configMapName: configMapName, domainNamespace: domainNamespace, error: mapResults.reason});
+            dialogHelper.closeBusyDialog();
+            await window.api.ipc.invoke('show-error-message', errTitle, errMessage);
+            return Promise.resolve(false);
           }
         }
 
         // Deploy domain
         busyDialogMessage = i18n.t('k8s-domain-deployer-deploy-in-progress',
           {domainName: domainUid, domainNamespace: domainNamespace});
         dialogHelper.updateBusyDialog(busyDialogMessage, 13 / totalSteps);
-        const domainSpecData = this.k8sDomainResourceGenerator.generate().join('\n');
+        const domainSpecData = new K8sDomainResourceGenerator(this.project.wko.installedVersion.value).generate().join('\n');
         const domainResult = await (window.api.ipc.invoke('k8s-apply', kubectlExe, domainSpecData, kubectlOptions));
         dialogHelper.closeBusyDialog();
         if (domainResult.isSuccess) {
@@ -415,10 +413,9 @@ function (K8sDomainActionsBase, project, wktConsole, i18n, projectIo, dialogHelp
         }
       }
 
-      if (!this.project.k8sDomain.configMapIsEmpty()) {
+      if (this.project.settings.targetDomainLocation.value === 'mii') {
         validationObject.addField('domain-design-configmap-label',
           this.project.k8sDomain.modelConfigMapName.validate(true), domainFormConfig);
-        // The fields in the table should not require validation since no empty override values should be in this computed table.
       }
 
       return validationObject;