underpost 2.89.1 → 2.89.21

package/src/cli/deploy.js

@@ -91,12 +91,25 @@ class UnderpostDeploy {
      * @param {Array<string>} deploymentVersions - List of deployment versions.
      * @returns {string} - YAML service configuration for the specified deployment.
      * @param {string} [serviceId] - Custom service name (optional).
+     * @param {Array} [pathRewritePolicy] - Path rewrite policy (optional).
      * @memberof UnderpostDeploy
      */
-    deploymentYamlServiceFactory({ deployId, path, env, port, deploymentVersions, serviceId }) {
+    deploymentYamlServiceFactory({ deployId, path, env, port, deploymentVersions, serviceId, pathRewritePolicy }) {
       return `
     - conditions:
         - prefix: ${path}
+      ${
+        pathRewritePolicy
+          ? `pathRewritePolicy:
+          replacePrefix:
+          ${pathRewritePolicy.map(
+            (rd) => `- prefix: ${rd.prefix}
+            replacement: ${rd.replacement}
+            `,
+          ).join(`
+`)}`
+          : ''
+      }
       enableWebsockets: true
       services:
     ${deploymentVersions
@@ -121,6 +134,17 @@ class UnderpostDeploy {
      */
     deploymentYamlPartsFactory({ deployId, env, suffix, resources, replicas, image }) {
       const packageJson = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
+      let volumes = [
+        {
+          volumeMountPath: '/etc/config',
+          volumeName: 'config-volume',
+          configMap: 'underpost-config',
+        },
+      ];
+      const confVolume = fs.existsSync(`./engine-private/conf/${deployId}/conf.volume.json`)
+        ? JSON.parse(fs.readFileSync(`./engine-private/conf/${deployId}/conf.volume.json`, 'utf8'))
+        : [];
+      volumes = volumes.concat(confVolume);
       return `apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -155,13 +179,10 @@ spec:
               npm install -g underpost &&
               underpost secret underpost --create-from-file /etc/config/.env.${env} &&
               underpost start --build --run ${deployId} ${env}
-          volumeMounts:
-            - name: config-volume
-              mountPath: /etc/config
-      volumes:
-        - name: config-volume
-          configMap:
-            name: underpost-config
+${UnderpostDeploy.API.volumeFactory(volumes)
+  .render.split(`\n`)
+  .map((l) => '    ' + l)
+  .join(`\n`)}
 ---
 apiVersion: v1
 kind: Service
@@ -230,7 +251,7 @@ ${UnderpostDeploy.API.deploymentYamlPartsFactory({
 
           const pathPortAssignment = pathPortAssignmentData[host];
           // logger.info('', { host, pathPortAssignment });
-          proxyYaml += `
+          let _proxyYaml = `
 ---
 apiVersion: projectcontour.io/v1
 kind: HTTPProxy
@@ -248,32 +269,31 @@ spec:
   routes:`;
           const deploymentVersions =
             options.traffic && typeof options.traffic === 'string' ? options.traffic.split(',') : ['blue'];
-          for (const conditionObj of pathPortAssignment) {
-            const { path, port } = conditionObj;
-            proxyYaml += UnderpostDeploy.API.deploymentYamlServiceFactory({
-              path,
-              deployId,
-              env,
-              port,
-              deploymentVersions,
-            });
-          }
+          let proxyRoutes = '';
+          if (!options.disableDeploymentProxy)
+            for (const conditionObj of pathPortAssignment) {
+              const { path, port } = conditionObj;
+              proxyRoutes += UnderpostDeploy.API.deploymentYamlServiceFactory({
+                path,
+                deployId,
+                env,
+                port,
+                deploymentVersions,
+              });
+            }
           for (const customService of customServices) {
-            const { path: _path, port, serviceId, host: _host } = customService;
+            const { path: _path, port, serviceId, host: _host, pathRewritePolicy } = customService;
             if (host === _host) {
-              switch (serviceId) {
-                case 'mongo-express-service': {
-                  proxyYaml += UnderpostDeploy.API.deploymentYamlServiceFactory({
-                    path: _path,
-                    port,
-                    serviceId,
-                    deploymentVersions,
-                  });
-                  break;
-                }
-              }
+              proxyRoutes += UnderpostDeploy.API.deploymentYamlServiceFactory({
+                path: _path,
+                port,
+                serviceId,
+                deploymentVersions,
+                pathRewritePolicy,
+              });
             }
           }
+          if (proxyRoutes) proxyYaml += _proxyYaml + proxyRoutes;
         }
         const yamlPath = `./engine-private/conf/${deployId}/build/${env}/proxy.yaml`;
         fs.writeFileSync(yamlPath, proxyYaml, 'utf8');
@@ -332,28 +352,31 @@ spec:
 
     /**
      * Callback function for handling deployment options.
-     * @param {string} deployList - List of deployment IDs to include in the manifest.
-     * @param {string} env - Environment for which the manifest is being built.
-     * @param {object} options - Options for the manifest build process.
-     * @param {string} options.remove - Whether to remove the deployment.
-     * @param {string} options.infoRouter - Whether to display router information.
-     * @param {string} options.sync - Whether to synchronize the deployment.
-     * @param {string} options.buildManifest - Whether to build the manifest.
-     * @param {string} options.infoUtil - Whether to display utility information.
-     * @param {string} options.expose - Whether to expose the deployment.
-     * @param {string} options.cert - Whether to create a certificate.
-     * @param {string} options.certHosts - List of hosts for which certificates are being created.
+     * @param {string} deployList - List of deployment IDs to process.
+     * @param {string} env - Environment for which the deployment is being processed.
+     * @param {object} options - Options for the deployment process.
+     * @param {boolean} options.remove - Whether to remove the deployment.
+     * @param {boolean} options.infoRouter - Whether to display router information.
+     * @param {boolean} options.sync - Whether to synchronize deployment configurations.
+     * @param {boolean} options.buildManifest - Whether to build the deployment manifest.
+     * @param {boolean} options.infoUtil - Whether to display utility information.
+     * @param {boolean} options.expose - Whether to expose the deployment.
+     * @param {boolean} options.cert - Whether to create certificates for the deployment.
+     * @param {string} options.certHosts - Comma-separated list of hosts for which to create certificates.
      * @param {string} options.versions - Comma-separated list of versions to deploy.
      * @param {string} options.image - Docker image for the deployment.
-     * @param {string} options.traffic - Current traffic status for the deployment.
+     * @param {string} options.traffic - Traffic status for the deployment.
      * @param {string} options.replicas - Number of replicas for the deployment.
      * @param {string} options.node - Node name for resource allocation.
-     * @param {string} options.restoreHosts - Whether to restore hosts.
-     * @param {string} options.disableUpdateDeployment - Whether to disable updating the deployment.
-     * @param {string} options.disableUpdateProxy - Whether to disable updating the proxy.
-     * @param {string} options.status - Whether to display status host machine server and traffic information.
-     * @param {string} options.etcHosts - Whether to update /etc/hosts.
-     * @returns {Promise<void>} - Promise that resolves when the callback is complete.
+     * @param {boolean} options.restoreHosts - Whether to restore the hosts file.
+     * @param {boolean} options.disableUpdateDeployment - Whether to disable deployment updates.
+     * @param {boolean} options.disableUpdateProxy - Whether to disable proxy updates.
+     * @param {boolean} options.disableDeploymentProxy - Whether to disable deployment proxy.
+     * @param {boolean} options.disableUpdateVolume - Whether to disable volume updates.
+     * @param {boolean} options.status - Whether to display deployment status.
+     * @param {boolean} options.etcHosts - Whether to display the /etc/hosts file.
+     * @param {boolean} options.disableUpdateUnderpostConfig - Whether to disable Underpost config updates.
+     * @returns {Promise<void>} - Promise that resolves when the deployment process is complete.
      * @memberof UnderpostDeploy
      */
     async callback(
@@ -376,8 +399,11 @@ spec:
         restoreHosts: false,
         disableUpdateDeployment: false,
         disableUpdateProxy: false,
+        disableDeploymentProxy: false,
+        disableUpdateVolume: false,
         status: false,
         etcHosts: false,
+        disableUpdateUnderpostConfig: false,
       },
     ) {
       if (options.infoUtil === true)
@@ -473,7 +499,7 @@ EOF`);
         logger.info('router', await UnderpostDeploy.API.routerFactory(deployList, env));
         return;
       }
-      UnderpostDeploy.API.configMap(env);
+      if (!options.disableUpdateUnderpostConfig) UnderpostDeploy.API.configMap(env);
       let renderHosts = '';
       let etcHosts = [];
       if (options.restoreHosts === true) {
@@ -504,6 +530,26 @@ EOF`);
           }
 
         const confServer = JSON.parse(fs.readFileSync(`./engine-private/conf/${deployId}/conf.server.json`, 'utf8'));
+        const confVolume = fs.existsSync(`./engine-private/conf/${deployId}/conf.volume.json`)
+          ? JSON.parse(fs.readFileSync(`./engine-private/conf/${deployId}/conf.volume.json`, 'utf8'))
+          : [];
+
+        if (!options.disableUpdateVolume) {
+          for (const volume of confVolume) {
+            if (options.remove) {
+              shellExec(`kubectl delete pvc ${volume.claimName}`);
+              shellExec(`kubectl delete pv ${volume.claimName.replace('pvc-', 'pv-')}`);
+              continue;
+            }
+            shellExec(`kubectl apply -f - <<EOF
+${UnderpostDeploy.API.persistentVolumeFactory({
+  hostPath: volume.volumeMountPath,
+  pvcId: volume.claimName,
+})}
+EOF
+`);
+          }
+        }
 
         for (const host of Object.keys(confServer)) {
           if (!options.disableUpdateProxy) {
@@ -686,6 +732,78 @@ EOF`);
       );
       shellExec(`sudo kubectl apply -f ./engine-private/conf/${deployId}/build/${env}/proxy.yaml`);
     },
+
+    /**
+     * Creates volume mounts and volumes for a deployment.
+     * @param {Array<volume>} volumes - List of volume configurations.
+     * @param {string} volume.volumeName - Name of the volume.
+     * @param {string} volume.volumeMountPath - Mount path of the volume in the container.
+     * @param {string} volume.volumeHostPath - Host path of the volume.
+     * @param {string} volume.volumeType - Type of the volume (e.g. 'Directory').
+     * @param {string|null} volume.claimName - Name of the persistent volume claim (if applicable).
+     * @param {string|null} volume.configMap - Name of the config map (if applicable).
+     * @returns {object} - Object containing the rendered volume mounts and volumes.
+     * @memberof UnderpostDeploy
+     */
+    volumeFactory(
+      volumes = [
+        {
+          volumeName: 'volume-name',
+          volumeMountPath: '/path/in/container',
+          volumeHostPath: '/path/on/host',
+          volumeType: 'Directory',
+          claimName: null,
+          configMap: null,
+        },
+      ],
+    ) {
+      let _volumeMounts = `
+      volumeMounts:`;
+      let _volumes = `
+  volumes:`;
+      volumes.map((volumeData) => {
+        const { volumeName, volumeMountPath, volumeHostPath, volumeType, claimName, configMap } = volumeData;
+        _volumeMounts += `
+        - name: ${volumeName}
+          mountPath: ${volumeMountPath}
+`;
+
+        _volumes += `
+    - name: ${volumeName}
+ ${
+   configMap
+     ? `     configMap:
+        name: ${configMap}`
+     : claimName
+       ? `     persistentVolumeClaim:
+        claimName: ${claimName}`
+       : `     hostPath:
+        path: ${volumeHostPath}
+        type: ${volumeType}
+`
+ }
+
+  `;
+      });
+      return { render: _volumeMounts + _volumes };
+    },
+
+    /**
+     * Creates a persistent volume and persistent volume claim for a deployment.
+     * @param {object} options - Options for the persistent volume and claim creation.
+     * @param {string} options.hostPath - Host path for the persistent volume.
+     * @param {string} options.pvcId - Persistent volume claim ID.
+     * @returns {string} - YAML configuration for the persistent volume and claim.
+     * @memberof UnderpostDeploy
+     */
+    persistentVolumeFactory({ hostPath, pvcId }) {
+      return fs
+        .readFileSync(`./manifests/pv-pvc-dd.yaml`, 'utf8')
+        .replace('/home/dd', hostPath)
+        .replace('pv-dd', pvcId.replace('pvc-', 'pv-'))
+        .replace('pvc-dd', pvcId);
+    },
+
     /**
      * Creates a hosts file for a deployment.
      * @param {Array<string>} hosts - List of hosts to be added to the hosts file.
@@ -789,37 +907,35 @@ ${renderHosts}`,
           }))
           .filter((o) => o.image);
       }
-      if (node === 'kind-worker') {
-        const raw = shellExec(`docker exec -i ${node} crictl images`, {
-          stdout: true,
-          silent: true,
-        });
+      const raw = shellExec(node === 'kind-worker' ? `docker exec -i ${node} crictl images` : `crictl images`, {
+        stdout: true,
+        silent: true,
+      });
 
-        const heads = raw
-          .split(`\n`)[0]
-          .split(' ')
-          .filter((_r) => _r.trim());
+      const heads = raw
+        .split(`\n`)[0]
+        .split(' ')
+        .filter((_r) => _r.trim());
 
-        const pods = raw
-          .split(`\n`)
-          .filter((r) => !r.match('IMAGE'))
-          .map((r) => r.split(' ').filter((_r) => _r.trim()));
-
-        const result = [];
-
-        for (const row of pods) {
-          if (row.length === 0) continue;
-          const pod = {};
-          let index = -1;
-          for (const head of heads) {
-            if (head in pod) continue;
-            index++;
-            pod[head] = row[index];
-          }
-          result.push(pod);
+      const pods = raw
+        .split(`\n`)
+        .filter((r) => !r.match('IMAGE'))
+        .map((r) => r.split(' ').filter((_r) => _r.trim()));
+
+      const result = [];
+
+      for (const row of pods) {
+        if (row.length === 0) continue;
+        const pod = {};
+        let index = -1;
+        for (const head of heads) {
+          if (head in pod) continue;
+          index++;
+          pod[head] = row[index];
         }
-        return result;
+        result.push(pod);
       }
+      return result;
     },
   };
 }

package/src/cli/index.js

@@ -78,6 +78,8 @@ program
   .option('--msg <msg>', 'Sets a custom commit message.')
   .option('--deploy-id <deploy-id>', 'Sets the deployment configuration ID for the commit context.')
   .option('--cached', 'Commit staged changes only or context.')
+  .option('--hashes <hashes>', 'Comma-separated list of specific file hashes of commits.')
+  .option('--extension <extension>', 'specific file extensions of commits.')
   .description('Manages commits to a GitHub repository, supporting various commit types and options.')
   .action(Underpost.repo.commit);
 
@@ -162,6 +164,8 @@ program
   .option('--worker', 'Sets the context for a worker node.')
   .option('--chown', 'Sets the appropriate ownership for Kubernetes kubeconfig files.')
   .option('--k3s', 'Initializes the cluster using K3s (Lightweight Kubernetes).')
+  .option('--hosts <hosts>', 'A comma-separated list of cluster hostnames or IP addresses.')
+  .option('--remove-volume-host-paths', 'Removes specified volume host paths after execution.')
   .action(Underpost.cluster.init)
   .description('Manages Kubernetes clusters, defaulting to Kind cluster initialization.');
 
@@ -191,6 +195,8 @@ program
   .option('--traffic <traffic-versions>', 'A comma-separated list of custom deployment traffic weights.')
   .option('--disable-update-deployment', 'Disables updates to deployments.')
   .option('--disable-update-proxy', 'Disables updates to proxies.')
+  .option('--disable-deployment-proxy', 'Disables proxies of deployments.')
+  .option('--disable-update-volume', 'Disables updates to volume mounts during deployment.')
   .option(
     '--status',
     'Retrieves current network traffic data from resource deployments and the host machine network configuration.',
@@ -198,6 +204,7 @@ program
   .option('--kubeadm', 'Enables the kubeadm context for deployment operations.')
   .option('--etc-hosts', 'Enables the etc-hosts context for deployment operations.')
   .option('--restore-hosts', 'Restores default `/etc/hosts` entries.')
+  .option('--disable-update-underpost-config', 'Disables updates to Underpost configuration during deployment.')
   .description('Manages application deployments, defaulting to deploying development pods.')
   .action(Underpost.deploy.callback);
 
@@ -379,13 +386,24 @@ program
   .option('--dev', 'Sets the development context environment for the script.')
   .option('--build', 'Set builder context runner')
   .option('--replicas <replicas>', 'Sets a custom number of replicas for deployment.')
-  .option('--pod-name <pod-name>', 'Optional: Specifies the pod name for test execution.')
+  .option('--pod-name <pod-name>', 'Optional: Specifies the pod name for execution.')
+  .option('--node-name <node-name>', 'Optional: Specifies the node name for execution.')
+  .option('--port <port>', 'Optional: Specifies the port for execution.')
+  .option('--etc-hosts', 'Enables etc-hosts context for the runner execution.')
   .option('--volume-host-path <volume-host-path>', 'Optional: Specifies the volume host path for test execution.')
   .option('--volume-mount-path <volume-mount-path>', 'Optional: Specifies the volume mount path for test execution.')
   .option('--volume-type <volume-type>', 'Optional: Specifies the volume type for test execution.')
   .option('--image-name <image-name>', 'Optional: Specifies the image name for test execution.')
   .option('--container-name <container-name>', 'Optional: Specifies the container name for test execution.')
   .option('--namespace <namespace>', 'Optional: Specifies the namespace for test execution.')
+  .option('--tty', 'Enables TTY for the container in deploy-job.')
+  .option('--stdin', 'Keeps STDIN open for the container in deploy-job.')
+  .option('--restart-policy <policy>', 'Sets the restart policy for the job in deploy-job.')
+  .option('--runtime-class-name <name>', 'Sets the runtime class name for the job in deploy-job.')
+  .option('--image-pull-policy <policy>', 'Sets the image pull policy for the job in deploy-job.')
+  .option('--api-version <version>', 'Sets the API version for the job manifest in deploy-job.')
+  .option('--claim-name <name>', 'Optional: Specifies the claim name for volume mounting in deploy-job.')
+  .option('--kind <kind-type>', 'Specifies the kind of Kubernetes resource (e.g., Job, Deployment) for deploy-job.')
   .option('--kubeadm', 'Flag to indicate Kubeadm cluster type context')
   .option('--k3s', 'Flag to indicate K3s cluster type context')
   .option('--force', 'Forces operation, overriding any warnings or conflicts.')
@@ -394,6 +412,7 @@ program
   .option('--terminal', 'Enables terminal mode for interactive script execution.')
   .option('--dev-proxy-port-offset <port-offset>', 'Sets a custom port offset for development proxy.')
   .option('--conf-server-path <conf-server-path>', 'Sets a custom configuration server path.')
+  .option('--underpost-root <underpost-root>', 'Sets a custom Underpost root path.')
   .description('Runs a script from the specified path.')
   .action(UnderpostRun.API.callback);
 

package/src/cli/repository.js

@@ -89,6 +89,8 @@ class UnderpostRepository {
      * @param {boolean} [options.lastMsg=0] - If greater than 0, copies or show the last last single n commit message to clipboard.
      * @param {string} [options.msg=''] - If provided, outputs this message instead of committing.
      * @param {string} [options.deployId=''] - An optional deploy ID to include in the commit message.
+     * @param {string} [options.hashes=''] - If provided with diff option, shows the diff between two hashes.
+     * @param {string} [options.extension=''] - If provided with diff option, filters the diff by this file extension.
      * @memberof UnderpostRepository
      */
     commit(
@@ -107,9 +109,19 @@ class UnderpostRepository {
         log: 0,
         msg: '',
         deployId: '',
+        hashes: '',
+        extension: '',
       },
     ) {
       if (!repoPath) repoPath = '.';
+      if (options.diff && options.hashes) {
+        const hashes = options.hashes.split(',');
+        const cmd = `git --no-pager diff ${hashes[0]} ${hashes[1] ? hashes[1] : 'HEAD'}${options.extension ? ` -- '*.${options.extension}'` : ''}`;
+        if (options.copy) {
+          pbcopy(cmd);
+        } else console.log(cmd);
+        return;
+      }
       if (options.msg) {
         options.msg = options.msg.replaceAll('"', '').replaceAll(`'`, '').replaceAll('`', '');
         let key = Object.keys(commitData).find((k) => k && options.msg.toLocaleLowerCase().slice(0, 16).match(k));