underpost 2.8.884 → 2.8.886

package/src/cli/deploy.js

@@ -1,3 +1,9 @@
+/**
+ * Deploy module for managing the deployment of applications and services.
+ * @module src/cli/deploy.js
+ * @namespace UnderpostDeploy
+ */
+
 import {
   buildKindPorts,
   buildPortProxyRouter,
@@ -14,13 +20,30 @@ import fs from 'fs-extra';
 import dotenv from 'dotenv';
 import UnderpostRootEnv from './env.js';
 import UnderpostCluster from './cluster.js';
-import Underpost from '../index.js';
+import { timer } from '../client/components/core/CommonJs.js';
 
 const logger = loggerFactory(import.meta);
 
+/**
+ * @class UnderpostDeploy
+ * @description Manages the deployment of applications and services.
+ * This class provides a set of static methods to handle the deployment process,
+ * including resource allocation, configuration management, and Kubernetes deployment.
+ * @memberof UnderpostDeploy
+ */
 class UnderpostDeploy {
   static NETWORK = {};
   static API = {
+    /**
+     * Synchronizes deployment configurations for a list of deployments.
+     * @param {string} deployList - List of deployment IDs to synchronize.
+     * @param {object} options - Options for the synchronization process.
+     * @param {string} options.versions - Comma-separated list of versions to deploy.
+     * @param {string} options.replicas - Number of replicas for each deployment.
+     * @param {string} options.node - Node name for resource allocation.
+     * @returns {object} - Deployment data for the specified deployments.
+     * @memberof UnderpostDeploy
+     */
     sync(deployList, { versions, replicas, node }) {
       const deployGroupId = 'dd.router';
       fs.writeFileSync(`./engine-private/deploy/${deployGroupId}`, deployList, 'utf8');
@@ -43,6 +66,13 @@ class UnderpostDeploy {
         deployGroupId,
       });
     },
+    /**
+     * Creates a router configuration for a list of deployments.
+     * @param {string} deployList - List of deployment IDs to include in the router.
+     * @param {string} env - Environment for which the router is being created.
+     * @returns {object} - Router configuration for the specified deployments.
+     * @memberof UnderpostDeploy
+     */
     async routerFactory(deployList, env) {
       const initEnvPath = `./engine-private/conf/${deployList.split(',')[0]}/.env.${env}`;
       const initEnvObj = dotenv.parse(fs.readFileSync(initEnvPath, 'utf8'));
@@ -51,6 +81,15 @@ class UnderpostDeploy {
       await Config.build('proxy', deployList);
       return buildPortProxyRouter(env === 'development' ? 80 : 443, buildProxyRouter());
     },
+    /**
+     * Creates a YAML service configuration for a deployment.
+     * @param {string} deployId - Deployment ID for which the service is being created.
+     * @param {string} env - Environment for which the service is being created.
+     * @param {number} port - Port number for the service.
+     * @param {Array<string>} deploymentVersions - List of deployment versions.
+     * @returns {string} - YAML service configuration for the specified deployment.
+     * @memberof UnderpostDeploy
+     */
     deploymentYamlServiceFactory({ deployId, env, port, deploymentVersions }) {
       return deploymentVersions
         .map(
@@ -61,7 +100,19 @@ class UnderpostDeploy {
         )
         .join('');
     },
+    /**
+     * Creates a YAML deployment configuration for a deployment.
+     * @param {string} deployId - Deployment ID for which the deployment is being created.
+     * @param {string} env - Environment for which the deployment is being created.
+     * @param {string} suffix - Suffix for the deployment.
+     * @param {object} resources - Resource configuration for the deployment.
+     * @param {number} replicas - Number of replicas for the deployment.
+     * @param {string} image - Docker image for the deployment.
+     * @returns {string} - YAML deployment configuration for the specified deployment.
+     * @memberof UnderpostDeploy
+     */
     deploymentYamlPartsFactory({ deployId, env, suffix, resources, replicas, image }) {
+      const packageJson = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
       return `apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -80,7 +131,7 @@ spec:
     spec:
       containers:
         - name: ${deployId}-${env}-${suffix}
-          image: ${image ?? `localhost/rockylinux9-underpost:${Underpost.version}`}
+          image: ${image ?? `localhost/rockylinux9-underpost:v${packageJson.version}`}
 #          resources:
 #            requests:
 #              memory: "${resources.requests.memory}"
@@ -114,6 +165,16 @@ spec:
   ports:
 {{ports}}  type: LoadBalancer`;
     },
+    /**
+     * Builds a manifest for a list of deployments.
+     * @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.replicas - Number of replicas for each deployment.
+     * @param {string} options.image - Docker image for the deployment.
+     * @returns {Promise<void>} - Promise that resolves when the manifest is built.
+     * @memberof UnderpostDeploy
+     */
     async buildManifest(deployList, env, options) {
       const resources = UnderpostDeploy.API.resourcesFactory();
       const replicas = options.replicas;
@@ -124,10 +185,9 @@ spec:
         if (!deployId) continue;
         const confServer = loadReplicas(
           JSON.parse(fs.readFileSync(`./engine-private/conf/${deployId}/conf.server.json`, 'utf8')),
-          'proxy',
         );
         const router = await UnderpostDeploy.API.routerFactory(deployId, env);
-        const pathPortAssignmentData = pathPortAssignmentFactory(router, confServer);
+        const pathPortAssignmentData = await pathPortAssignmentFactory(deployId, router, confServer);
         const { fromPort, toPort } = deployRangePortFactory(router);
         const deploymentVersions = options.versions.split(',');
         fs.mkdirSync(`./engine-private/conf/${deployId}/build/${env}`, { recursive: true });
@@ -208,6 +268,12 @@ spec:
         }
       }
     },
+    /**
+     * Builds a Certificate resource for a host using cert-manager.
+     * @param {string} host - Hostname for which the certificate is being built.
+     * @returns {string} - Certificate resource YAML for the specified host.
+     * @memberof UnderpostDeploy
+     */
     buildCertManagerCertificate({ host }) {
       return `
 ---
@@ -224,6 +290,12 @@ spec:
     kind: ClusterIssuer
   secretName: ${host}`;
     },
+    /**
+     * Retrieves the current traffic status for a deployment.
+     * @param {string} deployId - Deployment ID for which the traffic status is being retrieved.
+     * @returns {string|null} - Current traffic status ('blue' or 'green') or null if not found.
+     * @memberof UnderpostDeploy
+     */
     getCurrentTraffic(deployId) {
       // kubectl get deploy,sts,svc,configmap,secret -n default -o yaml --export > default.yaml
       const hostTest = Object.keys(
@@ -232,6 +304,32 @@ spec:
       const info = shellExec(`sudo kubectl get HTTPProxy/${hostTest} -o yaml`, { silent: true, stdout: true });
       return info.match('blue') ? 'blue' : info.match('green') ? 'green' : null;
     },
+
+    /**
+     * 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} 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.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.infoTraffic - Whether to display traffic information.
+     * @param {string} options.etcHosts - Whether to update /etc/hosts.
+     * @returns {Promise<void>} - Promise that resolves when the callback is complete.
+     * @memberof UnderpostDeploy
+     */
     async callback(
       deployList = '',
       env = 'development',
@@ -399,6 +497,13 @@ EOF`);
 ` + renderHosts,
         );
     },
+    /**
+     * Retrieves information about a deployment.
+     * @param {string} deployId - Deployment ID for which information is being retrieved.
+     * @param {string} kindType - Type of Kubernetes resource to retrieve information for (e.g. 'pods').
+     * @returns {Array<object>} - Array of objects containing information about the deployment.
+     * @memberof UnderpostDeploy
+     */
     get(deployId, kindType = 'pods') {
       const raw = shellExec(`sudo kubectl get ${kindType} --all-namespaces -o wide`, {
         stdout: true,
@@ -430,6 +535,11 @@ EOF`);
 
       return result;
     },
+    /**
+     * Retrieves the resources factory for a deployment.
+     * @returns {object} - Object containing the resources factory for the deployment.
+     * @memberof UnderpostDeploy
+     */
     resourcesFactory() {
       return {
         requests: {
@@ -443,6 +553,14 @@ EOF`);
         totalPods: UnderpostRootEnv.API.get('total-pods'),
       };
     },
+    /**
+     * Checks if a container file exists in a pod.
+     * @param {object} options - Options for the check.
+     * @param {string} options.podName - Name of the pod to check.
+     * @param {string} options.path - Path to the container file to check.
+     * @returns {boolean} - True if the container file exists, false otherwise.
+     * @memberof UnderpostDeploy
+     */
     existsContainerFile({ podName, path }) {
       return JSON.parse(
         shellExec(`kubectl exec ${podName} -- test -f ${path} && echo "true" || echo "false"`, {
@@ -452,6 +570,15 @@ EOF`);
         }).trim(),
       );
     },
+    /**
+     * Checks the status of a deployment.
+     * @param {string} deployId - Deployment ID for which the status is being checked.
+     * @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.
+     * @returns {object} - Object containing the status of the deployment.
+     * @memberof UnderpostDeploy
+     */
     checkDeploymentReadyStatus(deployId, env, traffic, ignoresNames = []) {
       const cmd = `underpost config get container-status`;
       const pods = UnderpostDeploy.API.get(`${deployId}-${env}-${traffic}`);
@@ -476,12 +603,25 @@ EOF`);
         readyPods,
       };
     },
+    /**
+     * Creates a configmap for a deployment.
+     * @param {string} env - Environment for which the configmap is being created.
+     * @memberof UnderpostDeploy
+     */
     configMap(env) {
       shellExec(`kubectl delete configmap underpost-config`);
       shellExec(
         `kubectl create configmap underpost-config --from-file=/home/dd/engine/engine-private/conf/dd-cron/.env.${env}`,
       );
     },
+    /**
+     * Switches the traffic for a deployment.
+     * @param {string} deployId - Deployment ID for which the traffic is being switched.
+     * @param {string} env - Environment for which the traffic is being switched.
+     * @param {string} targetTraffic - Target traffic status for the deployment.
+     * @param {number} replicas - Number of replicas for the deployment.
+     * @memberof UnderpostDeploy
+     */
     switchTraffic(deployId, env, targetTraffic, replicas = 1) {
       UnderpostRootEnv.API.set(`${deployId}-${env}-traffic`, targetTraffic);
       shellExec(
@@ -489,6 +629,11 @@ EOF`);
       );
       shellExec(`sudo kubectl apply -f ./engine-private/conf/${deployId}/build/${env}/proxy.yaml`);
     },
+    /**
+     * Creates a hosts file for a deployment.
+     * @param {Array<string>} hosts - List of hosts to be added to the hosts file.
+     * @memberof UnderpostDeploy
+     */
     etcHostFactory(hosts = []) {
       const renderHosts = `127.0.0.1         ${hosts.join(
         ' ',
@@ -498,10 +643,50 @@ EOF`);
       fs.writeFileSync(`/etc/hosts`, renderHosts, 'utf8');
       return { renderHosts };
     },
+    /**
+     * Checks if a TLS context is valid.
+     * @param {object} options - Options for the check.
+     * @param {string} options.host - Host for which the TLS context is being checked.
+     * @param {string} options.env - Environment for which the TLS context is being checked.
+     * @param {object} options.options - Options for the TLS context check.
+     * @returns {boolean} - True if the TLS context is valid, false otherwise.
+     * @memberof UnderpostDeploy
+     */
     isValidTLSContext: ({ host, env, options }) =>
       env === 'production' &&
       options.cert === true &&
       (!options.certHosts || options.certHosts.split(',').includes(host)),
+
+    /**
+     * Monitors the ready status of a deployment.
+     * @param {string} deployId - Deployment ID for which the ready status is being monitored.
+     * @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.
+     * @memberof UnderpostDeploy
+     */
+    async monitorReadyRunner(deployId, env, targetTraffic, ignorePods = []) {
+      let checkStatusIteration = 0;
+      const checkStatusIterationMsDelay = 1000;
+      const iteratorTag = `[${deployId}-${env}-${targetTraffic}]`;
+      logger.info('Deployment init', { deployId, env, targetTraffic, checkStatusIterationMsDelay });
+      const minReadyOk = 3;
+      let readyOk = 0;
+
+      while (readyOk < minReadyOk) {
+        const ready = UnderpostDeploy.API.checkDeploymentReadyStatus(deployId, env, targetTraffic, ignorePods).ready;
+        if (ready === true) {
+          readyOk++;
+          logger.info(`${iteratorTag} | Deployment ready. Verification number: ${readyOk}`);
+        }
+        await timer(checkStatusIterationMsDelay);
+        checkStatusIteration++;
+        logger.info(
+          `${iteratorTag} | Deployment in progress... | Delay number check iterations: ${checkStatusIteration}`,
+        );
+      }
+      logger.info(`${iteratorTag} | Deployment ready. | Total delay number check iterations: ${checkStatusIteration}`);
+    },
   };
 }
 

package/src/cli/env.js

@@ -1,3 +1,9 @@
+/**
+ * Environment module for managing the environment variables of the underpost root
+ * @module src/cli/env.js
+ * @namespace UnderpostEnv
+ */
+
 import { getNpmRootPath, writeEnv } from '../server/conf.js';
 import fs from 'fs-extra';
 import { loggerFactory } from '../server/logger.js';
@@ -7,8 +13,20 @@ dotenv.config();
 
 const logger = loggerFactory(import.meta);
 
+/**
+ * @class UnderpostEnv
+ * @description Manages the environment variables of the underpost root.
+ * @memberof UnderpostEnv
+ */
 class UnderpostRootEnv {
   static API = {
+    /**
+     * @method set
+     * @description Sets an environment variable in the underpost root environment.
+     * @param {string} key - The key of the environment variable to set.
+     * @param {string} value - The value of the environment variable to set.
+     * @memberof UnderpostEnv
+     */
     set(key, value) {
       const exeRootPath = `${getNpmRootPath()}/underpost`;
       const envPath = `${exeRootPath}/.env`;
@@ -17,6 +35,12 @@ class UnderpostRootEnv {
       env[key] = value;
       writeEnv(envPath, env);
     },
+    /**
+     * @method delete
+     * @description Deletes an environment variable from the underpost root environment.
+     * @param {string} key - The key of the environment variable to delete.
+     * @memberof UnderpostEnv
+     */
     delete(key) {
       const exeRootPath = `${getNpmRootPath()}/underpost`;
       const envPath = `${exeRootPath}/.env`;
@@ -25,6 +49,15 @@ class UnderpostRootEnv {
       delete env[key];
       writeEnv(envPath, env);
     },
+    /**
+     * @method get
+     * @description Gets an environment variable from the underpost root environment.
+     * @param {string} key - The key of the environment variable to get.
+     * @param {string} value - The value of the environment variable to get.
+     * @param {object} options - Options for getting the environment variable.
+     * @param {boolean} [options.plain=false] - If true, returns the environment variable value as a string.
+     * @memberof UnderpostEnv
+     */
     get(key, value, options = { plain: false }) {
       const exeRootPath = `${getNpmRootPath()}/underpost`;
       const envPath = `${exeRootPath}/.env`;
@@ -36,6 +69,11 @@ class UnderpostRootEnv {
       options?.plain === true ? console.log(env[key]) : logger.info(`${key}(${typeof env[key]})`, env[key]);
       return env[key];
     },
+    /**
+     * @method list
+     * @description Lists all environment variables in the underpost root environment.
+     * @memberof UnderpostEnv
+     */
     list() {
       const exeRootPath = `${getNpmRootPath()}/underpost`;
       const envPath = `${exeRootPath}/.env`;
@@ -47,6 +85,11 @@ class UnderpostRootEnv {
       logger.info('underpost root', env);
       return env;
     },
+    /**
+     * @method clean
+     * @description Cleans the underpost root environment by removing the environment file.
+     * @memberof UnderpostEnv
+     */
     clean() {
       const exeRootPath = `${getNpmRootPath()}/underpost`;
       const envPath = `${exeRootPath}/.env`;

package/src/cli/fs.js

@@ -1,18 +1,35 @@
+/**
+ * File storage module for managing file operations using Cloudinary.
+ * @module src/cli/fs.js
+ * @namespace UnderpostFileStorage
+ */
+
 import { v2 as cloudinary } from 'cloudinary';
 import { loggerFactory } from '../server/logger.js';
 import dotenv from 'dotenv';
 import AdmZip from 'adm-zip';
 import * as dir from 'path';
 import fs from 'fs-extra';
-import { Downloader } from '../server/downloader.js';
+import Downloader from '../server/downloader.js';
 import UnderpostRepository from './repository.js';
 import { shellExec } from '../server/process.js';
 dotenv.config();
 
 const logger = loggerFactory(import.meta);
 
+/**
+ * @class UnderpostFileStorage
+ * @description Manages file storage operations using Cloudinary.
+ * This class provides a set of static methods to upload, pull, and delete files
+ * from Cloudinary, as well as manage a local storage configuration file.
+ */
 class UnderpostFileStorage {
   static API = {
+    /**
+     * @method cloudinaryConfig
+     * @description Configures the Cloudinary client with environment variables.
+     * @memberof UnderpostFileStorage
+     */
     cloudinaryConfig() {
       // https://console.cloudinary.com/
       cloudinary.config({
@@ -21,6 +38,15 @@ class UnderpostFileStorage {
         api_secret: process.env.CLOUDINARY_API_SECRET,
       });
     },
+    /**
+     * @method getStorageConf
+     * @description Retrieves the storage configuration for a specific deployment.
+     * @param {object} options - An object containing deployment-specific options.
+     * @param {string} options.deployId - The identifier for the deployment.
+     * @param {string} [options.storageFilePath] - The path to the storage configuration file.
+     * @returns {object} An object containing the storage configuration and storage file path.
+     * @memberof UnderpostFileStorage
+     */
     getStorageConf(options) {
       let storage, storageConf;
       if (options.deployId && typeof options.deployId === 'string') {
@@ -30,9 +56,31 @@ class UnderpostFileStorage {
       }
       return { storage, storageConf };
     },
+    /**
+     * @method writeStorageConf
+     * @description Writes the storage configuration to a file.
+     * @param {object} storage - The storage configuration object.
+     * @param {string} storageConf - The path to the storage configuration file.
+     * @memberof UnderpostFileStorage
+     */
     writeStorageConf(storage, storageConf) {
       if (storage) fs.writeFileSync(storageConf, JSON.stringify(storage, null, 4), 'utf8');
     },
+    /**
+     * @method recursiveCallback
+     * @description Recursively processes files and directories based on the provided options.
+     * @param {string} path - The path to the directory to process.
+     * @param {object} [options] - An object containing options for the recursive callback.
+     * @param {boolean} [options.rm=false] - Flag to remove files and directories.
+     * @param {boolean} [options.recursive=false] - Flag to process directories recursively.
+     * @param {string} [options.deployId=''] - The identifier for the deployment.
+     * @param {boolean} [options.force=false] - Flag to force file operations.
+     * @param {boolean} [options.pull=false] - Flag to pull files from storage.
+     * @param {boolean} [options.git=false] - Flag to use Git for file operations.
+     * @param {string} [options.storageFilePath=''] - The path to the storage configuration file.
+     * @returns {Promise<void>} A promise that resolves when the recursive callback is complete.
+     * @memberof UnderpostFileStorage
+     */
     async recursiveCallback(
       path,
       options = {
@@ -84,6 +132,21 @@ class UnderpostFileStorage {
         shellExec(`underpost cmt ${path} feat`);
       }
     },
+    /**
+     * @method callback
+     * @description Orchestrates file storage operations based on the provided options.
+     * This method handles file uploads, deletions, and recursive processing of directories.
+     * @param {string} path - The path to the file or directory to process.
+     * @param {object} [options] - An object containing options for the callback.
+     * @param {boolean} [options.rm=false] - Flag to remove files and directories.
+     * @param {boolean} [options.recursive=false] - Flag to process directories recursively.
+     * @param {string} [options.deployId=''] - The identifier for the deployment.
+     * @param {boolean} [options.force=false] - Flag to force file operations.
+     * @param {boolean} [options.pull=false] - Flag to pull files from storage.
+     * @param {boolean} [options.git=false] - Flag to use Git for file operations.
+     * @returns {Promise<void>} A promise that resolves when the callback is complete.
+     * @memberof UnderpostFileStorage
+     */
     async callback(
       path,
       options = { rm: false, recursive: false, deployId: '', force: false, pull: false, git: false },
@@ -94,6 +157,16 @@ class UnderpostFileStorage {
       if (options.rm === true) return await UnderpostFileStorage.API.delete(path, options);
       return await UnderpostFileStorage.API.upload(path, options);
     },
+    /**
+     * @method upload
+     * @description Uploads a file to Cloudinary.
+     * @param {string} path - The path to the file to upload.
+     * @param {object} [options] - An object containing options for the upload.
+     * @param {boolean} [options.force=false] - Flag to force file operations.
+     * @param {string} [options.storageFilePath=''] - The path to the storage configuration file.
+     * @returns {Promise<object>} A promise that resolves to the upload result.
+     * @memberof UnderpostFileStorage
+     */
     async upload(
       path,
       options = { rm: false, recursive: false, deployId: '', force: false, pull: false, storageFilePath: '' },
@@ -115,6 +188,13 @@ class UnderpostFileStorage {
       UnderpostFileStorage.API.writeStorageConf(storage, storageConf);
       return uploadResult;
     },
+    /**
+     * @method pull
+     * @description Pulls a file from Cloudinary.
+     * @param {string} path - The path to the file to pull.
+     * @returns {Promise<void>} A promise that resolves when the file is pulled.
+     * @memberof UnderpostFileStorage
+     */
     async pull(path) {
       UnderpostFileStorage.API.cloudinaryConfig();
       const folder = dir.dirname(path);
@@ -124,7 +204,7 @@ class UnderpostFileStorage {
         resource_type: 'raw',
       });
       logger.info('download result', downloadResult);
-      await Downloader(downloadResult, path + '.zip');
+      await Downloader.downloadFile(downloadResult, path + '.zip');
       path = UnderpostFileStorage.API.zip2File(path + '.zip');
       fs.removeSync(path + '.zip');
     },
@@ -138,6 +218,13 @@ class UnderpostFileStorage {
       logger.info('delete result', deleteResult);
       return deleteResult;
     },
+    /**
+     * @method file2Zip
+     * @description Converts a file to a zip file.
+     * @param {string} path - The path to the file to convert.
+     * @returns {string} The path to the zip file.
+     * @memberof UnderpostFileStorage
+     */
     file2Zip(path) {
       const zip = new AdmZip();
       zip.addLocalFile(path, '/');
@@ -145,6 +232,13 @@ class UnderpostFileStorage {
       zip.writeZip(path);
       return path;
     },
+    /**
+     * @method zip2File
+     * @description Converts a zip file to a file.
+     * @param {string} path - The path to the zip file to convert.
+     * @returns {string} The path to the file.
+     * @memberof UnderpostFileStorage
+     */
     zip2File(path) {
       const zip = new AdmZip(path);
       path = path.replaceAll('.zip', '');

package/src/cli/image.js

@@ -1,3 +1,9 @@
+/**
+ * Image management module for pull, build, creation of docker images and loading them into Kubernetes clusters
+ * @module src/cli/image.js
+ * @namespace UnderpostImage
+ */
+
 import fs from 'fs-extra';
 import dotenv from 'dotenv';
 import { loggerFactory } from '../server/logger.js';
@@ -9,6 +15,13 @@ dotenv.config();
 
 const logger = loggerFactory(import.meta);
 
+/**
+ * @class UnderpostImage
+ * @description Manages Docker image operations, including pulling, building, and loading images into Kubernetes clusters.
+ * This class provides a set of static methods to handle image operations, including pulling base images,
+ * building custom images, and loading them into specified Kubernetes clusters (Kind, Kubeadm, or K3s).
+ * @memberof UnderpostImage
+ */
 class UnderpostImage {
   static API = {
     dockerfile: {
@@ -22,6 +35,7 @@ class UnderpostImage {
        * @param {boolean} [options.k3sLoad=false] - If true, load image into K3s cluster.
        * @param {string} [options.path=false] - Path to the Dockerfile context.
        * @param {string} [options.version=''] - Version tag for the image.
+       * @memberof UnderpostImage
        */
       pullBaseImages(
         options = {
@@ -68,6 +82,7 @@ class UnderpostImage {
        * @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.
+       * @memberof UnderpostImage
        */
       build(
         options = {

package/src/cli/index.js

@@ -1,6 +1,6 @@
 import dotenv from 'dotenv';
 import { Command } from 'commander';
-import Underpost from '../index.js';
+import Underpost, { UnderpostRootEnv } from '../index.js';
 import { getNpmRootPath, getUnderpostRootPath, loadConf } from '../server/conf.js';
 import fs from 'fs-extra';
 import { commitData } from '../client/components/core/CommonJs.js';
@@ -26,7 +26,8 @@ program
   .option('--deploy-id', 'Crete deploy ID conf env files')
   .option('--cluster', 'Create deploy ID cluster files and sync to current cluster')
   .option('--dev', 'Sets the development cli context')
-  .description('Initializes a new Underpost project with a predefined structure.')
+  .option('--sub-conf <sub-conf>', 'Create sub conf env files')
+  .description('Initializes a new Underpost project, service, or configuration.')
   .action(Underpost.repo.new);
 
 // 'start' command: Start application servers, build pipelines, or services
@@ -86,10 +87,22 @@ program
 // 'env' command: Manage environment variables
 program
   .command('env')
-  .argument('<deploy-id>', `The deployment configuration ID. Use 'clean' to restore default environment settings.`)
+  .argument(
+    '[deploy-id]',
+    `The deployment configuration ID. Use 'clean' to restore default environment settings. User 'root' to load root env. User 'current' to get plain current deploy Id.`,
+  )
   .argument('[env]', 'Optional: The environment to set (e.g., "production", "development"). Defaults to "production".')
+  .argument('[subConf]', 'Optional: The sub configuration to set.')
   .description('Sets environment variables and configurations related to a specific deployment ID.')
-  .action(loadConf);
+  .action((deployId, env, subConf) => {
+    if (fs.existsSync(`./engine-private/conf/${deployId}/.env.${env}`))
+      dotenv.config({ path: `./engine-private/conf/${deployId}/.env.${env}`, override: true });
+    else if (deployId === 'root') {
+      deployId = UnderpostRootEnv.API.get('DEPLOY_ID');
+    } else dotenv.config({ path: `./.env`, override: true });
+
+    loadConf(deployId, subConf);
+  });
 
 // 'config' command: Manage Underpost configurations
 program