adding helm timeout field for operator/ingress install/update (#166)

* adding helm timeout field for operator install/update

* adding helm timeout for ingress controller

Author: robertpatrick

electron/app/js/helmUtils.js

@@ -231,12 +231,22 @@ function getHelmEnv(httpsProxyUrl, bypassProxyHosts, helmOptions) {
 function processHelmChartValues(args, helmChartValues) {
   if (helmChartValues) {
     for (const [propertyName, propertyValue] of Object.entries(helmChartValues)) {
-      if (propertyName === 'imagePullSecrets') {
-        args.push(...formatArrayOfObjectsSetArgument(propertyName, propertyValue));
-      } else if (propertyName === 'nodeSelector') {
-        args.push(...formatNodeSelectorSetArgument(propertyValue));
-      } else {
-        args.push('--set', formatSetArgument(propertyName, propertyValue));
+      switch (propertyName) {
+        case 'imagePullSecrets':
+          args.push(...formatArrayOfObjectsSetArgument(propertyName, propertyValue));
+          break;
+
+        case 'nodeSelector':
+          args.push(...formatNodeSelectorSetArgument(propertyValue));
+          break;
+
+        case 'timeout':
+          args.push('--timeout', `${propertyValue}m`);
+          break;
+
+        default:
+          args.push('--set', formatSetArgument(propertyName, propertyValue));
+          break;
       }
     }
   }

electron/app/locales/en/webui.json

@@ -474,6 +474,9 @@
   "wko-design-node-selector-label-value-header": "Label Value",
   "wko-design-node-selector-add-row-tooltip": "Add Node Selector Label",
   "wko-design-node-selector-delete-row-tooltip": "Delete Node Selector Label",
+  "wko-design-helm-settings-title": "Helm Settings",
+  "wko-design-helm-timeout-label": "Helm Timeout in Minutes",
+  "wko-design-helm-timeout-help": "The number of minutes that the Helm command will wait for the WebLogic Kubernetes Operator install or update command to complete.",
 
   "domain-page-hints-deployDomain": "Deploy WebLogic Domain to Kubernetes",
   "domain-page-button-deployDomain": "Deploy Domain",
@@ -697,6 +700,8 @@
   "ingress-design-install-ingress-controller-help": "Whether to install the selected ingress controller.",
   "ingress-design-ingress-name-label": "Helm Release Name to Use",
   "ingress-design-ingress-name-help": "The Helm release name used to install the ingress controller.",
+  "ingress-design-helm-timeout-label": "Helm Timeout in Minutes",
+  "ingress-design-helm-timeout-help": "The number of minutes that the Helm command will wait for the Ingress Controller install command to complete.",
   "ingress-design-ingress-namespace-label": "Ingress Controller Namespace",
   "ingress-design-ingress-namespace-help": "The Kubernetes namespace to use for the ingress controller.",
   "ingress-design-voyager-provider-label": "Kubernetes Cluster Provider for Voyager",

webui/src/js/models/ingress-definition.js

@@ -40,6 +40,8 @@ define(['knockout', 'utils/observable-properties', 'utils/validation-helper'],
         this.specifyDockerRegSecret = props.createProperty(false);
         this.specifyIngressTLSSecret = props.createProperty(false);
 
+        this.helmTimeoutMinutes = props.createProperty(5);
+
         this.ingressRouteKeys = [
           'uid', 'name', 'virtualHost', 'targetServiceNameSpace', 'targetService', 'targetPort',
           'path', 'annotations', 'accessPoint', 'tlsOption', 'markedForDeletion', 'isConsoleService'

webui/src/js/models/wko-definition.js

@@ -68,6 +68,8 @@ define(['utils/observable-properties', 'utils/validation-helper'],
         //
         this.nodeSelector = props.createListProperty(['uid', 'name', 'value']);
 
+        this.helmTimeoutMinutes = props.createProperty(5);
+
         // internal fields that should not be read or written to the project file.
         this.internal = {
           operatorImagePullRegistryAddress: props.createProperty()

webui/src/js/utils/cmd-script-adapter.js

@@ -77,6 +77,19 @@ define(['utils/script-adapter-base'],
         return this.getEnvironmentVariableReference(name);
       }
 
+      addHelmTimeoutCollectArgsBlock(comment, collectVarName, timeoutVarRef) {
+        if (comment) {
+          this.addComment(comment);
+        }
+
+        this._lines.push(
+          `IF DEFINED ${this._getVariableNameFromReference(timeoutVarRef)} (`,
+          `${this.indent(1)}SET "${collectVarName}=${this.getVariableReference(collectVarName)} ${timeoutVarRef}m"`,
+          ')',
+          ''
+        );
+      }
+
       addNotEmptyCollectArgsBlock(collectVarName, varRef, valuePrefix) {
         let value = `"${varRef}"`;
         if (valuePrefix) {
@@ -256,6 +269,12 @@ define(['utils/script-adapter-base'],
           ')'
         ];
 
+        const helmTimeoutLines = [
+          `IF "${helmChartValues.timeout}" NEQ "" (`,
+          `${this.indent(1)}SET "${variableName}=${variableRef} --timeout ${helmChartValues.timeout}m"`,
+          ')',
+        ];
+
         const initialValue = `--set domainNamespaceSelectionStrategy=${helmChartValues.domainNamespaceSelectionStrategy}`;
         this.addVariableDefinition(variableName, initialValue);
         this._lines.push(
@@ -274,6 +293,8 @@ define(['utils/script-adapter-base'],
           ...elkIntegrationLines,
           '',
           ...javaLoggingLines,
+          '',
+          ...helmTimeoutLines,
           ''
         );
       }

webui/src/js/utils/ingress-controller-installer.js

@@ -249,6 +249,10 @@ function(IngressActionsBase, project, wktConsole, k8sHelper, i18n, dialogHelper,
       if (ingressControllerProvider === 'nginx' && this.project.ingress.allowNginxSSLPassThrough) {
         helmChartData['controller.extraArgs.enable-ssl-passthrough'] = true;
       }
+
+      if (this.project.ingress.helmTimeoutMinutes.hasValue()) {
+        helmChartData['timeout'] = this.project.ingress.helmTimeoutMinutes.value;
+      }
       return helmChartData;
     }
   }

webui/src/js/utils/ingress-install-script-generator.js

@@ -62,6 +62,11 @@ define(['models/wkt-project', 'utils/script-generator-base', 'utils/helm-helper'
         this.adapter.addVariableDefinition('DOCKER_HUB_EMAIL', this.project.ingress.dockerRegSecretUserEmail.value);
         this.adapter.addEmptyLine();
 
+        comment = [ 'The number of minutes for the helm command to wait for completion (e.g., 10)' ];
+        this.adapter.addVariableDefinition('HELM_TIMEOUT',
+          this._getOptionalScalarFieldValue(this.project.ingress.helmTimeoutMinutes), comment);
+        this.adapter.addEmptyLine();
+
         this.adapter.addVariableEndBanner();
 
         this.adapter.addKubectlExportAndUseContextBlock();
@@ -98,6 +103,10 @@ define(['models/wkt-project', 'utils/script-generator-base', 'utils/helm-helper'
         this.adapter.addVoyagerHelmChartArgsBlock(comment, ingressControllerType, voyagerProvider,
           voyagerApiEnableHealthCheck, voyagerApiEnableWebhook);
 
+        comment = [ 'The number of minutes for the helm command to wait for completion (e.g., 10)' ];
+        const helmTimeout = this.adapter.getVariableReference('HELM_TIMEOUT');
+        this.adapter.addIngressHelmChartTimeoutArgBlock(comment, helmTimeout);
+
         comment = [ 'Add Docker Hub pull secret, if specified' ];
         this.adapter.addIngressHelmChartPullSecretArgBlock(comment, ingressControllerType, useDockerHubSecret,
           dockerHubSecretName);
@@ -121,6 +130,14 @@ define(['models/wkt-project', 'utils/script-generator-base', 'utils/helm-helper'
         this.adapter.addScriptFooter();
         return this.adapter.getScript();
       }
+
+      _getOptionalScalarFieldValue(property) {
+        let result = '';
+        if (this._isSet(property)) {
+          result = property.value;
+        }
+        return result;
+      }
     }
 
     return IngressInstallScriptGenerator;

webui/src/js/utils/operator-script-generator.js

@@ -125,6 +125,11 @@ define(['models/wkt-project', 'utils/script-generator-base', 'utils/helm-helper'
           this._getOptionalScalarFieldValue(this.project.wko.javaLoggingFileCount), comment);
         this.adapter.addEmptyLine();
 
+        comment = [ 'The number of minutes for the helm command to wait for completion (e.g., 10)' ];
+        this.adapter.addVariableDefinition('HELM_TIMEOUT',
+          this._getOptionalScalarFieldValue(this.project.wko.helmTimeoutMinutes), comment);
+        this.adapter.addEmptyLine();
+
         this.adapter.addVariableEndBanner();
 
         const wkoHelmChartData = helmHelper.getOperatorHelmChartData();
@@ -224,7 +229,8 @@ define(['models/wkt-project', 'utils/script-generator-base', 'utils/helm-helper'
           elasticSearchPort: this.adapter.getVariableReference('WKO_ELASTICSEARCH_PORT'),
           javaLoggingLevel: this.adapter.getVariableReference('WKO_JAVA_LOGGING_LEVEL'),
           javaLoggingFileSizeLimit: this.adapter.getVariableReference('WKO_JAVA_LOGGING_FILE_SIZE_LIMIT'),
-          javaLoggingFileCount: this.adapter.getVariableReference('WKO_JAVA_LOGGING_FILE_COUNT')
+          javaLoggingFileCount: this.adapter.getVariableReference('WKO_JAVA_LOGGING_FILE_COUNT'),
+          timeout: this.adapter.getVariableReference('HELM_TIMEOUT'),
         };
       }
 

webui/src/js/utils/powershell-script-adapter.js

@@ -50,6 +50,19 @@ define(['utils/script-adapter-base'],
         return `$${name}`;
       }
 
+      addHelmTimeoutCollectArgsBlock(comment, collectVarName, timeoutVarRef) {
+        if (comment) {
+          this.addComment(comment);
+        }
+
+        this._lines.push(
+          `if ("${timeoutVarRef}" -ne "") {`,
+          `${this.indent(1)}$${collectVarName} = "${this.getVariableReference(collectVarName)} $(${timeoutVarRef})m"`,
+          '}',
+          ''
+        );
+      }
+
       addNotEmptyCollectArgsBlock(collectVarName, varRef, valuePrefix) {
         let value = `""${varRef}""`;
         if (valuePrefix) {
@@ -204,6 +217,12 @@ define(['utils/script-adapter-base'],
           '}'
         ];
 
+        const helmTimeoutLines = [
+          `if ("${helmChartValues.timeout}" -ne "") {`,
+          `${this.indent(1)}$${variableName}="${variableRef} --timeout $(${helmChartValues.timeout})m"`,
+          '}',
+        ];
+
         const initialValue = `--set domainNamespaceSelectionStrategy=${helmChartValues.domainNamespaceSelectionStrategy}`;
         this.addVariableDefinition(variableName, initialValue);
         this._lines.push(
@@ -222,6 +241,8 @@ define(['utils/script-adapter-base'],
           ...elkIntegrationLines,
           '',
           ...javaLoggingLines,
+          '',
+          ...helmTimeoutLines,
           ''
         );
       }

webui/src/js/utils/script-adapter-base.js

@@ -335,6 +335,10 @@ define([],
         this._lines.push(...this._formatVoyagerHelmChartArgsBlock(comment, 'HELM_CHART_ARGS', ingressType, options), '');
       }
 
+      addIngressHelmChartTimeoutArgBlock(comment, timeoutArg) {
+        this.addHelmTimeoutCollectArgsBlock(comment, 'HELM_CHART_ARGS', timeoutArg);
+      }
+
       addIngressHelmChartPullSecretArgBlock(comment, ingressType, useSecret, secretName) {
         this._lines.push(...this._formatIngressHelmChartPullSecretBlock(comment, 'HELM_CHART_ARGS',
           ingressType, useSecret, secretName), '');
@@ -431,6 +435,11 @@ define([],
         /* subclasses must implement. */
       }
 
+      // eslint-disable-next-line no-unused-vars
+      addHelmTimeoutCollectArgsBlock(comment, collectVarName, timeoutVarRef) {
+        /* subclasses must implement. */
+      }
+
       // eslint-disable-next-line no-unused-vars
       addNotEmptyCollectArgsBlock(collectVarName, varRef, valuePrefix) {
         /* subclasses must implement. */