underpost 2.92.0 → 2.95.1

package/src/cli/deploy.js

@@ -657,18 +657,28 @@ EOF`);
      * @param {string} env - Environment for which the status is being checked.
      * @param {string} traffic - Current traffic status for the deployment.
      * @param {Array<string>} ignoresNames - List of pod names to ignore.
+     * @param {string} [namespace='default'] - Kubernetes namespace for the deployment.
      * @returns {object} - Object containing the status of the deployment.
      * @memberof UnderpostDeploy
      */
-    checkDeploymentReadyStatus(deployId, env, traffic, ignoresNames = []) {
+    async checkDeploymentReadyStatus(deployId, env, traffic, ignoresNames = [], namespace = 'default') {
       const cmd = `underpost config get container-status`;
-      const pods = UnderpostDeploy.API.get(`${deployId}-${env}-${traffic}`);
+      const pods = UnderpostDeploy.API.get(`${deployId}-${env}-${traffic}`, 'pods', namespace);
       const readyPods = [];
       const notReadyPods = [];
       for (const pod of pods) {
         const { NAME } = pod;
         if (ignoresNames && ignoresNames.find((t) => NAME.trim().toLowerCase().match(t.trim().toLowerCase()))) continue;
-        const out = shellExec(`sudo kubectl exec -i ${NAME} -- sh -c "${cmd}"`, { stdout: true, silent: true });
+        const out = await new Promise((resolve) => {
+          shellExec(`sudo kubectl exec -i ${NAME} -n ${namespace} -- sh -c "${cmd}"`, {
+            silent: true,
+            disableLog: true,
+            callback: function (code, stdout, stderr) {
+              return resolve(JSON.stringify({ code, stdout, stderr }));
+            },
+          });
+        });
+        pod.out = out;
         const ready = out.match(`${deployId}-${env}-running-deployment`);
         ready ? readyPods.push(pod) : notReadyPods.push(pod);
       }
@@ -893,15 +903,18 @@ ${renderHosts}`,
      * @param {string} env - Environment for which the ready status is being monitored.
      * @param {string} targetTraffic - Target traffic status for the deployment.
      * @param {Array<string>} ignorePods - List of pod names to ignore.
+     * @param {string} [namespace='default'] - Kubernetes namespace for the deployment.
+     * @param {string} [outLogType=''] - Type of log output.
      * @returns {object} - Object containing the ready status of the deployment.
      * @memberof UnderpostDeploy
      */
-    async monitorReadyRunner(deployId, env, targetTraffic, ignorePods = []) {
+    async monitorReadyRunner(deployId, env, targetTraffic, ignorePods = [], namespace = 'default', outLogType = '') {
       let checkStatusIteration = 0;
       const checkStatusIterationMsDelay = 1000;
       const maxIterations = 500;
-      const iteratorTag = `[${deployId}-${env}-${targetTraffic}]`;
-      logger.info('Deployment init', { deployId, env, targetTraffic, checkStatusIterationMsDelay });
+      const deploymentId = `${deployId}-${env}-${targetTraffic}`;
+      const iteratorTag = `[${deploymentId}]`;
+      logger.info('Deployment init', { deployId, env, targetTraffic, checkStatusIterationMsDelay, namespace });
       const minReadyOk = 3;
       let readyOk = 0;
       let result = {
@@ -909,7 +922,7 @@ ${renderHosts}`,
         notReadyPods: [],
         readyPods: [],
       };
-
+      let lastMsg = {};
       while (readyOk < minReadyOk) {
         if (checkStatusIteration >= maxIterations) {
           logger.error(
@@ -917,30 +930,81 @@ ${renderHosts}`,
           );
           break;
         }
-        result = UnderpostDeploy.API.checkDeploymentReadyStatus(deployId, env, targetTraffic, ignorePods);
+        result = await UnderpostDeploy.API.checkDeploymentReadyStatus(
+          deployId,
+          env,
+          targetTraffic,
+          ignorePods,
+          namespace,
+        );
         if (result.ready === true) {
           readyOk++;
           logger.info(`${iteratorTag} | Deployment ready. Verification number: ${readyOk}`);
+          for (const pod of result.readyPods) {
+            const { NAME } = pod;
+            lastMsg[NAME] = 'Deployment ready';
+            console.log(
+              'Target pod:',
+              NAME[NAME.match('green') ? 'bgGreen' : 'bgBlue'].bold.black,
+              '| Status:',
+              lastMsg[NAME].bold.magenta,
+            );
+          }
+        }
+
+        switch (outLogType) {
+          case 'underpost': {
+            let indexOf = -1;
+            for (const pod of result.notReadyPods) {
+              indexOf++;
+              const { NAME, out } = pod;
+
+              if (out.match('not') && out.match('found') && checkStatusIteration <= 20 && out.match(deploymentId))
+                lastMsg[NAME] = 'Starting deployment';
+              else if (out.match('not') && out.match('found') && checkStatusIteration <= 20 && out.match('underpost'))
+                lastMsg[NAME] = 'Installing underpost cli';
+              else if (out.match('not') && out.match('found') && checkStatusIteration <= 20 && out.match('task'))
+                lastMsg[NAME] = 'Initializing setup task';
+              else if (out.match('Empty environment variables')) lastMsg[NAME] = 'Setup environment';
+              else if (out.match(`${deployId}-${env}-build-deployment`)) lastMsg[NAME] = 'Building apps/services';
+              else if (out.match(`${deployId}-${env}-initializing-deployment`))
+                lastMsg[NAME] = 'Initializing apps/services';
+              else if (!lastMsg[NAME]) lastMsg[NAME] = `Waiting for status`;
+
+              console.log(
+                'Target pod:',
+                NAME[NAME.match('green') ? 'bgGreen' : 'bgBlue'].bold.black,
+                '| Status:',
+                lastMsg[NAME].bold.magenta,
+              );
+            }
+          }
         }
         await timer(checkStatusIterationMsDelay);
         checkStatusIteration++;
         logger.info(
-          `${iteratorTag} | Deployment in progress... | Delay number check iterations: ${checkStatusIteration}`,
+          `${iteratorTag} | Deployment in progress... | Delay number monitor iterations: ${checkStatusIteration}`,
         );
       }
-      logger.info(`${iteratorTag} | Deployment ready. | Total delay number check iterations: ${checkStatusIteration}`);
+      logger.info(
+        `${iteratorTag} | Deployment ready. | Total delay number monitor iterations: ${checkStatusIteration}`,
+      );
       return result;
     },
 
     /**
      * Retrieves the currently loaded images in the Kubernetes cluster.
+     * @param {string} [node='kind-worker'] - Node name to check for loaded images.
+     * @param {object} options - Options for the image retrieval.
+     * @param {boolean} options.spec - Whether to retrieve images from the pod specifications.
+     * @param {string} options.namespace - Kubernetes namespace to filter pods.
      * @returns {Array<object>} - Array of objects containing pod names and their corresponding images.
      * @memberof UnderpostDeploy
      */
-    getCurrentLoadedImages(node = 'kind-worker', specContainers = false) {
-      if (specContainers) {
+    getCurrentLoadedImages(node = 'kind-worker', options = { spec: false, namespace: '' }) {
+      if (options.spec) {
         const raw = shellExec(
-          `kubectl get pods --all-namespaces -o=jsonpath='{range .items[*]}{"\\n"}{.metadata.namespace}{"/"}{.metadata.name}{":\\t"}{range .spec.containers[*]}{.image}{", "}{end}{end}'`,
+          `kubectl get pods ${options.namespace ? `--namespace ${options.namespace}` : `--all-namespaces`} -o=jsonpath='{range .items[*]}{"\\n"}{.metadata.namespace}{"/"}{.metadata.name}{":\\t"}{range .spec.containers[*]}{.image}{", "}{end}{end}'`,
           {
             stdout: true,
             silent: true,

package/src/cli/image.js

@@ -24,143 +24,208 @@ const logger = loggerFactory(import.meta);
  */
 class UnderpostImage {
   static API = {
-    dockerfile: {
-      /**
-       * @method pullBaseImages
-       * @description Pulls base images and builds a 'rockylinux9-underpost' image,
-       * then loads it into the specified Kubernetes cluster type (Kind, Kubeadm, or K3s).
-       * @param {object} options - Options for pulling and loading images.
-       * @param {boolean} [options.kindLoad=false] - If true, load image into Kind cluster.
-       * @param {boolean} [options.kubeadmLoad=false] - If true, load image into Kubeadm cluster.
-       * @param {boolean} [options.k3sLoad=false] - If true, load image into K3s cluster.
-       * @param {string} [options.path=false] - Path to the Dockerfile context.
-       * @param {boolean} [options.dev=false] - If true, use development mode.
-       * @param {string} [options.version=''] - Version tag for the image.
-       * @memberof UnderpostImage
-       */
-      pullBaseImages(
-        options = {
-          kindLoad: false,
-          kubeadmLoad: false,
-          k3sLoad: false,
-          path: false,
-          dev: false,
-          version: '',
-        },
-      ) {
-        // shellExec(`sudo podman pull docker.io/library/debian:buster`);
-        shellExec(`sudo podman pull docker.io/library/rockylinux:9`);
-        const baseCommand = options.dev ? 'node bin' : 'underpost';
-        const baseCommandOption = options.dev ? ' --dev' : '';
-        const IMAGE_NAME = `rockylinux9-underpost`;
-        const IMAGE_NAME_FULL = `${IMAGE_NAME}:${options.version ? options.version : Underpost.version}`;
-        let LOAD_TYPE = '';
-        if (options.kindLoad === true) {
-          LOAD_TYPE = `--kind-load`;
-        } else if (options.kubeadmLoad === true) {
-          LOAD_TYPE = `--kubeadm-load`;
-        } else if (options.k3sLoad === true) {
-          // Handle K3s load type
-          LOAD_TYPE = `--k3s-load`;
+    /**
+     * @method pullBaseImages
+     * @description Pulls base images and builds a 'rockylinux9-underpost' image,
+     * then loads it into the specified Kubernetes cluster type (Kind, Kubeadm, or K3s).
+     * @param {object} options - Options for pulling and loading images.
+     * @param {boolean} [options.kind=false] - If true, load image into Kind cluster.
+     * @param {boolean} [options.kubeadm=false] - If true, load image into Kubeadm cluster.
+     * @param {boolean} [options.k3s=false] - If true, load image into K3s cluster.
+     * @param {string} [options.path=false] - Path to the Dockerfile context.
+     * @param {boolean} [options.dev=false] - If true, use development mode.
+     * @param {string} [options.version=''] - Version tag for the image.
+     * @param {string} [options.imageName=''] - Custom name for the image.
+     * @memberof UnderpostImage
+     */
+    pullBaseImages(
+      options = {
+        kind: false,
+        kubeadm: false,
+        k3s: false,
+        path: false,
+        dev: false,
+        version: '',
+        imageName: '',
+      },
+    ) {
+      shellExec(`sudo podman pull docker.io/library/rockylinux:9`);
+      const baseCommand = options.dev ? 'node bin' : 'underpost';
+      const baseCommandOption = options.dev ? ' --dev' : '';
+      const IMAGE_NAME = options.imageName
+        ? `options.imageName${options.version ? `:${options.version}` : ''}`
+        : `rockylinux9-underpost:${options.version ? options.version : Underpost.version}`;
+      let LOAD_TYPE = '';
+      if (options.kind === true) LOAD_TYPE = `--kind`;
+      else if (options.kubeadm === true) LOAD_TYPE = `--kubeadm`;
+      else if (options.k3s === true) LOAD_TYPE = `--k3s`;
+      shellExec(
+        `${baseCommand} image${baseCommandOption} --build --podman-save --reset --image-path=. --path ${
+          options.path ? options.path : getUnderpostRootPath()
+        } --image-name=${IMAGE_NAME} ${LOAD_TYPE}`,
+      );
+    },
+    /**
+     * @method build
+     * @description Builds a Docker image using Podman, optionally saves it as a tar archive,
+     * and loads it into a specified Kubernetes cluster (Kind, Kubeadm, or K3s).
+     * @param {object} options - Options for building and loading images.
+     * @param {string} [options.path=''] - The path to the directory containing the Dockerfile.
+     * @param {string} [options.imageName=''] - The name and tag for the image (e.g., 'my-app:latest').
+     * @param {string} [options.version=''] - Version tag for the image.
+     * @param {string} [options.imagePath=''] - Directory to save the image tar file.
+     * @param {string} [options.dockerfileName=''] - Name of the Dockerfile (defaults to 'Dockerfile').
+     * @param {boolean} [options.podmanSave=false] - If true, save the image as a tar archive using Podman.
+     * @param {boolean} [options.kind=false] - If true, load the image archive into a Kind cluster.
+     * @param {boolean} [options.kubeadm=false] - If true, load the image archive into a Kubeadm cluster (uses 'ctr').
+     * @param {boolean} [options.k3s=false] - If true, load the image archive into a K3s cluster (uses 'k3s ctr').
+     * @param {boolean} [options.secrets=false] - If true, load secrets from the .env file for the build.
+     * @param {string} [options.secretsPath=''] - Custom path to the .env file for secrets.
+     * @param {boolean} [options.reset=false] - If true, perform a no-cache build.
+     * @param {boolean} [options.dev=false] - If true, use development mode.
+     * @memberof UnderpostImage
+     */
+    build(
+      options = {
+        path: '',
+        imageName: '',
+        version: '',
+        imagePath: '',
+        dockerfileName: '',
+        podmanSave: false,
+        kind: false,
+        kubeadm: false,
+        k3s: false,
+        secrets: false,
+        secretsPath: '',
+        reset: false,
+        dev: false,
+      },
+    ) {
+      let {
+        path,
+        imageName,
+        version,
+        imagePath,
+        dockerfileName,
+        podmanSave,
+        secrets,
+        secretsPath,
+        kind,
+        kubeadm,
+        k3s,
+        reset,
+        dev,
+      } = options;
+      if (!path) path = '.';
+      if (!imageName) imageName = `rockylinux9-underpost:${Underpost.version}`;
+      if (!version) version = 'latest';
+      version = imageName && imageName.match(':') ? '' : `:${version}`;
+      const podManImg = `localhost/${imageName}${version}`;
+      if (imagePath && typeof imagePath === 'string' && !fs.existsSync(imagePath))
+        fs.mkdirSync(imagePath, { recursive: true });
+      const tarFile = `${imagePath}/${imageName.replace(':', '_')}.tar`;
+      let secretsInput = ' ';
+      let secretDockerInput = '';
+      let cache = '';
+      if (secrets === true) {
+        const envObj = dotenv.parse(
+          fs.readFileSync(
+            secretsPath && typeof secretsPath === 'string' ? secretsPath : `${getNpmRootPath()}/underpost/.env`,
+            'utf8',
+          ),
+        );
+        for (const key of Object.keys(envObj)) {
+          secretsInput += ` && export ${key}="${envObj[key]}" `; // Example: $(cat gitlab-token.txt)
+          secretDockerInput += ` --secret id=${key},env=${key} \ `;
         }
-
+      }
+      if (reset === true) cache += ' --rm --no-cache';
+      if (path && typeof path === 'string')
         shellExec(
-          `${baseCommand} dockerfile-image-build${baseCommandOption} --podman-save --reset --image-path=. --path ${
-            options.path ?? getUnderpostRootPath()
-          } --image-name=${IMAGE_NAME_FULL} ${LOAD_TYPE}`,
+          `cd ${path}${secretsInput}&& sudo podman build -f ./${
+            dockerfileName && typeof dockerfileName === 'string' ? dockerfileName : 'Dockerfile'
+          } -t ${imageName} --pull=never --cap-add=CAP_AUDIT_WRITE${cache}${secretDockerInput} --network host`,
         );
-      },
-      /**
-       * @method build
-       * @description Builds a Docker image using Podman, optionally saves it as a tar archive,
-       * and loads it into a specified Kubernetes cluster (Kind, Kubeadm, or K3s).
-       * @param {object} options - Options for building and loading images.
-       * @param {string} [options.path=''] - The path to the directory containing the Dockerfile.
-       * @param {string} [options.imageName=''] - The name and tag for the image (e.g., 'my-app:latest').
-       * @param {string} [options.imagePath=''] - Directory to save the image tar file.
-       * @param {string} [options.dockerfileName=''] - Name of the Dockerfile (defaults to 'Dockerfile').
-       * @param {boolean} [options.podmanSave=false] - If true, save the image as a tar archive using Podman.
-       * @param {boolean} [options.kindLoad=false] - If true, load the image archive into a Kind cluster.
-       * @param {boolean} [options.kubeadmLoad=false] - If true, load the image archive into a Kubeadm cluster (uses 'ctr').
-       * @param {boolean} [options.k3sLoad=false] - If true, load the image archive into a K3s cluster (uses 'k3s ctr').
-       * @param {boolean} [options.secrets=false] - If true, load secrets from the .env file for the build.
-       * @param {string} [options.secretsPath=''] - Custom path to the .env file for secrets.
-       * @param {boolean} [options.reset=false] - If true, perform a no-cache build.
-       * @param {boolean} [options.dev=false] - If true, use development mode.
-       * @memberof UnderpostImage
-       */
-      build(
-        options = {
-          path: '',
-          imageName: '',
-          imagePath: '',
-          dockerfileName: '',
-          podmanSave: false,
-          kindLoad: false,
-          kubeadmLoad: false,
-          k3sLoad: false,
-          secrets: false,
-          secretsPath: '',
-          reset: false,
-          dev: false,
-        },
-      ) {
-        let {
-          path,
-          imageName,
-          imagePath,
-          dockerfileName,
-          podmanSave,
-          secrets,
-          secretsPath,
-          kindLoad,
-          kubeadmLoad,
-          k3sLoad,
-          reset,
-          dev,
-        } = options;
-        if (!path) path = '.';
-        const podManImg = `localhost/${imageName}`;
-        if (imagePath && typeof imagePath === 'string' && !fs.existsSync(imagePath))
-          fs.mkdirSync(imagePath, { recursive: true });
-        const tarFile = `${imagePath}/${imageName.replace(':', '_')}.tar`;
-        let secretsInput = ' ';
-        let secretDockerInput = '';
-        let cache = '';
-        if (secrets === true) {
-          const envObj = dotenv.parse(
-            fs.readFileSync(
-              secretsPath && typeof secretsPath === 'string' ? secretsPath : `${getNpmRootPath()}/underpost/.env`,
-              'utf8',
-            ),
-          );
-          for (const key of Object.keys(envObj)) {
-            secretsInput += ` && export ${key}="${envObj[key]}" `; // Example: $(cat gitlab-token.txt)
-            secretDockerInput += ` --secret id=${key},env=${key} \ `;
-          }
-        }
-        if (reset === true) cache += ' --rm --no-cache';
-        if (path && typeof path === 'string')
-          shellExec(
-            `cd ${path}${secretsInput}&& sudo podman build -f ./${
-              dockerfileName && typeof dockerfileName === 'string' ? dockerfileName : 'Dockerfile'
-            } -t ${imageName} --pull=never --cap-add=CAP_AUDIT_WRITE${cache}${secretDockerInput} --network host`,
-          );
 
-        if (podmanSave === true) {
-          if (fs.existsSync(tarFile)) fs.removeSync(tarFile);
-          shellExec(`podman save -o ${tarFile} ${podManImg}`);
-        }
-        if (kindLoad === true) shellExec(`sudo kind load image-archive ${tarFile}`);
-        if (kubeadmLoad === true) {
-          // Use 'ctr' for Kubeadm
-          shellExec(`sudo ctr -n k8s.io images import ${tarFile}`);
-        }
-        if (k3sLoad === true) {
-          // Use 'k3s ctr' for K3s
-          shellExec(`sudo k3s ctr images import ${tarFile}`);
-        }
-      },
+      if (podmanSave === true) {
+        if (fs.existsSync(tarFile)) fs.removeSync(tarFile);
+        shellExec(`podman save -o ${tarFile} ${podManImg}`);
+      }
+      if (kind === true) shellExec(`sudo kind load image-archive ${tarFile}`);
+      else if (kubeadm === true) shellExec(`sudo ctr -n k8s.io images import ${tarFile}`);
+      else if (k3s === true) shellExec(`sudo k3s ctr images import ${tarFile}`);
+    },
+    /**
+     * @method list
+     * @description Lists currently loaded Docker images in the specified Kubernetes cluster node.
+     * @param {object} options - Options for listing loaded images.
+     * @param {string} [options.nodeName='kind-worker'] - The name of the node to query.
+     * @param {string} [options.namespace=''] - The namespace to filter images (if applicable).
+     * @param {boolean} [options.spec=false] - If true, include detailed specifications of each image.
+     * @param {boolean} [options.log=false] - If true, log the list of images to the console.
+     * @param {boolean} [options.k3s=false] - If true, list images from a K3s cluster.
+     * @param {boolean} [options.kubeadm=false] - If true, list images from a Kubeadm cluster.
+     * @param {boolean} [options.kind=false] - If true, list images from a Kind cluster.
+     * @returns {Array} - An array of loaded images information.
+     * @memberof UnderpostImage
+     */
+    list(options = { nodeName: '', namespace: '', spec: false, log: false, k3s: false, kubeadm: false, kind: false }) {
+      if ((options.kubeadm === true || options.k3s === true) && !options.nodeName)
+        options.nodeName = shellExec('echo $HOSTNAME', { stdout: true, silent: true }).trim();
+      const list = Underpost.deploy.getCurrentLoadedImages(
+        options.nodeName ? options.nodeName : 'kind-worker',
+        options,
+      );
+      if (options.log) console.table(list);
+      return list;
+    },
+    /**
+     * @method rm
+     * @description Removes a specified Docker image from the specified Kubernetes cluster type (Kind, Kubeadm, or K3s).
+     * @param {object} options - Options for removing the image.
+     * @param {string} [options.imageName=''] - The name and tag of the image to be removed.
+     * @param {boolean} [options.k3s=false] - If true, remove the image from a K3s cluster.
+     * @param {boolean} [options.kubeadm=false] - If true, remove the image from a Kubeadm cluster.
+     * @param {boolean} [options.kind=false] - If true, remove the image from a Kind cluster.
+     * @memberof UnderpostImage
+     */
+    rm(options = { imageName: '', k3s: false, kubeadm: false, kind: false }) {
+      let { imageName, k3s, kubeadm, kind } = options;
+      if (kind === true) {
+        shellExec(`docker exec -i kind-control-plane crictl rmi ${imageName}`);
+        shellExec(`docker exec -i kind-worker crictl rmi ${imageName}`);
+      } else if (kubeadm === true) {
+        shellExec(`crictl rmi ${imageName}`);
+      } else if (k3s === true) {
+        shellExec(`sudo k3s ctr images rm ${imageName}`);
+      }
+    },
+    /**
+     * @method pullDockerHubImage
+     * @description Pulls a Docker image from Docker Hub and loads it into the specified Kubernetes cluster type (Kind, Kubeadm, or K3s).
+     * @param {object} options - Options for pulling and loading the image.
+     * @param {boolean} [options.k3s=false] - If true, load the image into a K3s cluster.
+     * @param {boolean} [options.kubeadm=false] - If true, load the image into a Kubeadm cluster.
+     * @param {boolean} [options.kind=false] - If true, load the image into a Kind cluster.
+     * @param {string} [options.dockerhubImage=''] - The name of the Docker Hub image to be pulled.
+     * @param {string} [options.version=''] - The version tag of the image to be pulled.
+     * @memberof UnderpostImage
+     */
+    pullDockerHubImage(options = { k3s: false, kubeadm: false, kind: false, dockerhubImage: '', version: '' }) {
+      if (options.dockerhubImage === 'underpost') {
+        options.dockerhubImage = 'underpost/underpost-engine';
+        if (!options.version) options.version = Underpost.version;
+      }
+      if (!options.version) options.version = 'latest';
+      const version = options.dockerhubImage && options.dockerhubImage.match(':') ? '' : `:${options.version}`;
+      const image = `${options.dockerhubImage}${version}`;
+      if (options.kind === true) {
+        shellExec(`docker pull ${image}`);
+        shellExec(`sudo kind load docker-image ${image}`);
+      } else {
+        shellExec(`sudo crictl pull ${image}`);
+      }
     },
   };
 }