underpost 2.8.884 → 2.8.885

package/README.md

@@ -16,128 +16,12 @@
 
 <div align="center">
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 <!-- badges -->
 
-
-[![Node.js CI](https://github.com/underpostnet/engine/actions/workflows/docker-image.ci.yml/badge.svg?branch=master)](https://github.com/underpostnet/engine/actions/workflows/docker-image.yml) [![Test](https://github.com/underpostnet/engine/actions/workflows/coverall.ci.yml/badge.svg?branch=master)](https://github.com/underpostnet/engine/actions/workflows/coverall.yml) [![Downloads](https://img.shields.io/npm/dm/underpost.svg)](https://www.npmjs.com/package/underpost) [![Socket Badge](https://socket.dev/api/badge/npm/package/underpost/2.8.884)](https://socket.dev/npm/package/underpost/overview/2.8.884) [![Coverage Status](https://coveralls.io/repos/github/underpostnet/engine/badge.svg?branch=master)](https://coveralls.io/github/underpostnet/engine?branch=master) [![Version](https://img.shields.io/npm/v/underpost.svg)](https://www.npmjs.org/package/underpost) [![License](https://img.shields.io/npm/l/underpost.svg)](https://www.npmjs.com/package/underpost)
-
+[![Node.js CI](https://github.com/underpostnet/engine/actions/workflows/docker-image.ci.yml/badge.svg?branch=master)](https://github.com/underpostnet/engine/actions/workflows/docker-image.yml) [![Test](https://github.com/underpostnet/engine/actions/workflows/coverall.ci.yml/badge.svg?branch=master)](https://github.com/underpostnet/engine/actions/workflows/coverall.yml) [![Downloads](https://img.shields.io/npm/dm/underpost.svg)](https://www.npmjs.com/package/underpost) [![Socket Badge](https://socket.dev/api/badge/npm/package/underpost/2.8.885)](https://socket.dev/npm/package/underpost/overview/2.8.885) [![Coverage Status](https://coveralls.io/repos/github/underpostnet/engine/badge.svg?branch=master)](https://coveralls.io/github/underpostnet/engine?branch=master) [![Version](https://img.shields.io/npm/v/underpost.svg)](https://www.npmjs.org/package/underpost) [![License](https://img.shields.io/npm/l/underpost.svg)](https://www.npmjs.com/package/underpost)
 
 <!-- end-badges -->
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 </div>
 
 <div align="center">
@@ -182,7 +66,7 @@ Run dev client server
 npm run dev
 ```
 <!-- -->
-## underpost ci/cd cli v2.8.884
+## underpost ci/cd cli v2.8.885
 
 ### Usage: `underpost [options] [command]`
   ```
@@ -191,13 +75,13 @@ npm run dev
   -h, --help                                                 display help for command
 
 Commands:
-  new [options] <app-name>                                   Initializes a new Underpost project with a predefined structure.
+  new [options] <app-name>                                   Initializes a new Underpost project, service, or configuration.
   start [options] <deploy-id> [env]                          Initiates application servers, build pipelines, or other defined services based on the deployment ID.
   clone [options] <uri>                                      Clones a specified GitHub repository into the current directory.
   pull [options] <path> <uri>                                Pulls the latest changes from a specified GitHub repository.
   cmt [options] <path> <commit-type> [module-tag] [message]  Manages commits to a GitHub repository, supporting various commit types and options.
   push [options] <path> <uri>                                Pushes committed changes from a local repository to a remote GitHub repository.
-  env <deploy-id> [env]                                      Sets environment variables and configurations related to a specific deployment ID.
+  env [deploy-id] [env] [subConf]                            Sets environment variables and configurations related to a specific deployment ID.
   config [options] <operator> [key] [value]                  Manages Underpost configurations using various operators.
   root                                                       Displays the root path of the npm installation.
   cluster [options] [pod-name]                               Manages Kubernetes clusters, defaulting to Kind cluster initialization.

package/bin/deploy.js

@@ -122,7 +122,12 @@ try {
       }
       break;
     case 'conf': {
-      loadConf(process.argv[3], process.argv[4]);
+      let subConf = process.argv[5] ?? '';
+
+      if (!['current', 'clean'].includes(process.argv[3]))
+        dotenv.config({ path: `./engine-private/conf/${process.argv[3]}/.env.${process.argv[4]}`, override: true });
+
+      loadConf(process.argv[3], subConf);
       break;
     }
 
@@ -194,10 +199,10 @@ try {
       {
         dotenv.config({ override: true });
         if (!process.argv[3]) process.argv[3] = 'dd-default';
-        const { deployId, folder } = loadConf(process.argv[3]);
+        const { deployId } = loadConf(process.argv[3], process.argv[4] ?? '');
 
-        let argHost = process.argv[4] ? process.argv[4].split(',') : [];
-        let argPath = process.argv[5] ? process.argv[5].split(',') : [];
+        let argHost = process.argv[5] ? process.argv[5].split(',') : [];
+        let argPath = process.argv[6] ? process.argv[6].split(',') : [];
         let deployIdSingleReplicas = [];
         const serverConf = deployId
           ? JSON.parse(fs.readFileSync(`./conf/conf.server.json`, 'utf8'))
@@ -209,16 +214,10 @@ try {
             } else {
               serverConf[host][path].liteBuild = process.argv.includes('l') ? true : false;
               serverConf[host][path].minifyBuild = process.env.NODE_ENV === 'production' ? true : false;
-              if (process.env.NODE_ENV === 'development' && process.argv.includes('static')) {
-                serverConf[host][path].apiBaseProxyPath = '/';
-                serverConf[host][path].apiBaseHost = `localhost:${parseInt(process.env.PORT) + 1}`;
-              }
               if (serverConf[host][path].singleReplica && serverConf[host][path].replicas) {
                 deployIdSingleReplicas = deployIdSingleReplicas.concat(
                   serverConf[host][path].replicas.map((replica) => buildReplicaId({ deployId, replica })),
                 );
-
-                // shellExec(Cmd.replica(deployId, host, path));
               }
             }
           }

package/bin/file.js

@@ -112,6 +112,8 @@ try {
           `./.github/workflows/ghpkg.ci.yml`,
           `./.github/workflows/publish.ci.yml`,
           `./.github/workflows/release.cd.yml`,
+          './src/ws/IoInterface.js',
+          './src/ws/IoServer.js',
         ])
           fs.copyFileSync(_path, `../pwa-microservices-template/${_path}`);
 
@@ -165,13 +167,9 @@ try {
 
         originMd =
           originMd.split(`<!-- badges -->`)[0] +
-          `
-<!-- badges -->
-` +
+          `<!-- badges -->` +
           badges +
-          `
-<!-- end-badges -->
-` +
+          `<!-- end-badges -->` +
           originMd.split(`<!-- end-badges -->`)[1];
 
         const splitKeyword = '## underpost ci/cd cli';

package/cli.md

@@ -1,4 +1,4 @@
-## underpost ci/cd cli v2.8.884
+## underpost ci/cd cli v2.8.885
 
 ### Usage: `underpost [options] [command]`
   ```
@@ -7,13 +7,13 @@
   -h, --help                                                 display help for command
 
 Commands:
-  new [options] <app-name>                                   Initializes a new Underpost project with a predefined structure.
+  new [options] <app-name>                                   Initializes a new Underpost project, service, or configuration.
   start [options] <deploy-id> [env]                          Initiates application servers, build pipelines, or other defined services based on the deployment ID.
   clone [options] <uri>                                      Clones a specified GitHub repository into the current directory.
   pull [options] <path> <uri>                                Pulls the latest changes from a specified GitHub repository.
   cmt [options] <path> <commit-type> [module-tag] [message]  Manages commits to a GitHub repository, supporting various commit types and options.
   push [options] <path> <uri>                                Pushes committed changes from a local repository to a remote GitHub repository.
-  env <deploy-id> [env]                                      Sets environment variables and configurations related to a specific deployment ID.
+  env [deploy-id] [env] [subConf]                            Sets environment variables and configurations related to a specific deployment ID.
   config [options] <operator> [key] [value]                  Manages Underpost configurations using various operators.
   root                                                       Displays the root path of the npm installation.
   cluster [options] [pod-name]                               Manages Kubernetes clusters, defaulting to Kind cluster initialization.
@@ -44,16 +44,18 @@ Commands:
 ```
  Usage: underpost new [options] <app-name>
 
-Initializes a new Underpost project with a predefined structure.
+Initializes a new Underpost project, service, or configuration.
 
 Arguments:
-  app-name     The name or deploy-id of the application to create.
+  app-name               The name or deploy-id of the application to create.
 
 Options:
-  --deploy-id  Crete deploy ID conf env files
-  --cluster    Create deploy ID cluster files and sync to current cluster
-  --dev        Sets the development cli context
-  -h, --help   display help for command
+  --deploy-id            Crete deploy ID conf env files
+  --cluster              Create deploy ID cluster files and sync to current
+                         cluster
+  --dev                  Sets the development cli context
+  --sub-conf <sub-conf>  Create sub conf env files
+  -h, --help             display help for command
  
 ```
   
@@ -157,16 +159,18 @@ Options:
 
 ### `env` :
 ```
- Usage: underpost env [options] <deploy-id> [env]
+ Usage: underpost env [options] [deploy-id] [env] [subConf]
 
 Sets environment variables and configurations related to a specific deployment
 ID.
 
 Arguments:
   deploy-id   The deployment configuration ID. Use 'clean' to restore default
-              environment settings.
+              environment settings. User 'root' to load root env. User
+              'current' to get plain current deploy Id.
   env         Optional: The environment to set (e.g., "production",
               "development"). Defaults to "production".
+  subConf     Optional: The sub configuration to set.
 
 Options:
   -h, --help  display help for command

package/manifests/deployment/dd-default-development/deployment.yaml

@@ -17,7 +17,7 @@ spec:
     spec:
       containers:
         - name: dd-default-development-blue
-          image: localhost/rockylinux9-underpost:v2.8.884
+          image: localhost/rockylinux9-underpost:v2.8.885
           #          resources:
           #            requests:
           #              memory: "124Ki"
@@ -100,7 +100,7 @@ spec:
     spec:
       containers:
         - name: dd-default-development-green
-          image: localhost/rockylinux9-underpost:v2.8.884
+          image: localhost/rockylinux9-underpost:v2.8.885
           #          resources:
           #            requests:
           #              memory: "124Ki"

package/manifests/deployment/dd-test-development/deployment.yaml

@@ -17,7 +17,7 @@ spec:
     spec:
       containers:
         - name: dd-test-development-blue
-          image: localhost/rockylinux9-underpost:v2.8.884
+          image: localhost/rockylinux9-underpost:v2.8.885
 #          resources:
 #            requests:
 #              memory: "96294Ki"
@@ -104,7 +104,7 @@ spec:
     spec:
       containers:
         - name: dd-test-development-green
-          image: localhost/rockylinux9-underpost:v2.8.884
+          image: localhost/rockylinux9-underpost:v2.8.885
 #          resources:
 #            requests:
 #              memory: "96294Ki"

package/package.json

@@ -2,7 +2,7 @@
     "type": "module",
     "main": "src/index.js",
     "name": "underpost",
-    "version": "2.8.884",
+    "version": "2.8.885",
     "description": "pwa api rest template",
     "scripts": {
         "start": "env-cmd -f .env.production node --max-old-space-size=8192 src/server",

package/src/cli/cluster.js

@@ -1,3 +1,9 @@
+/**
+ * Cluster module for managing Kubernetes cluster initialization, configuration, and component deployment.
+ * @module src/cli/cluster.js
+ * @namespace UnderpostCluster
+ */
+
 import { getNpmRootPath } from '../server/conf.js';
 import { loggerFactory } from '../server/logger.js';
 import { shellExec } from '../server/process.js';
@@ -45,6 +51,7 @@ class UnderpostCluster {
      * @param {boolean} [options.config=false] - Apply general host configuration (SELinux, containerd, sysctl, firewalld).
      * @param {boolean} [options.worker=false] - Configure as a worker node (for Kubeadm or K3s join).
      * @param {boolean} [options.chown=false] - Set up kubectl configuration for the current user.
+     * @memberof UnderpostCluster
      */
     async init(
       podName,
@@ -460,6 +467,7 @@ EOF
      * are applied for a healthy Kubernetes environment. It explicitly avoids
      * iptables flushing commands to prevent conflicts with Kubernetes' own network management.
      * @param {string} underpostRoot - The root directory of the underpost project.
+     * @memberof UnderpostCluster
      */
     config(options = { underpostRoot: '.' }) {
       const { underpostRoot } = options;
@@ -523,6 +531,7 @@ net.ipv4.ip_forward = 1' | sudo tee ${iptableConfPath}`,
      * @method chown
      * @description Sets up kubectl configuration for the current user based on the cluster type.
      * @param {string} clusterType - The type of Kubernetes cluster ('kubeadm', 'k3s', or 'kind').
+     * @memberof UnderpostCluster
      */
     chown(clusterType) {
       console.log(`Setting up kubectl configuration for ${clusterType} cluster...`);
@@ -559,6 +568,7 @@ net.ipv4.ip_forward = 1' | sudo tee ${iptableConfPath}`,
      * in coredns) by restoring SELinux security contexts and safely cleaning up cluster artifacts.
      * @param {object} [options] - Configuration options for the reset.
      * @param {string} [options.underpostRoot] - The root path of the underpost project.
+     * @memberof UnderpostCluster
      */
     async safeReset(options = { underpostRoot: '.' }) {
       logger.info('Starting a safe and comprehensive reset of Kubernetes and container environments...');
@@ -672,6 +682,13 @@ net.ipv4.ip_forward = 1' | sudo tee ${iptableConfPath}`,
       }
     },
 
+    /**
+     * @method getResourcesCapacity
+     * @description Retrieves the capacity of resources (CPU and memory) for a specific node in the cluster.
+     * @param {string} [node=os.hostname()] - The node to query. Defaults to the current host.
+     * @returns {object} An object containing the CPU and memory capacity of the node.
+     * @memberof UnderpostCluster
+     */
     getResourcesCapacity(node) {
       const resources = {};
       const nodeName = node ?? os.hostname();
@@ -698,9 +715,11 @@ net.ipv4.ip_forward = 1' | sudo tee ${iptableConfPath}`,
 
       return resources;
     },
+
     /**
      * @method initHost
      * @description Installs essential host-level prerequisites for Kubernetes (Docker, Podman, Kind, Kubeadm, Helm).
+     * @memberof UnderpostCluster
      */
     initHost() {
       const archData = UnderpostBaremetal.API.getHostArch();
@@ -738,10 +757,12 @@ EOF`);
       shellExec(`sudo rm -rf get_helm.sh`);
       console.log('Host prerequisites installed successfully.');
     },
+
     /**
      * @method uninstallHost
      * @description Uninstalls all host components installed by initHost.
      * This includes Docker, Podman, Kind, Kubeadm, Kubelet, Kubectl, and Helm.
+     * @memberof UnderpostCluster
      */
     uninstallHost() {
       console.log('Uninstalling host components: Docker, Podman, Kind, Kubeadm, Kubelet, Kubectl, Helm.');

package/src/cli/cron.js

@@ -71,6 +71,14 @@ class UnderpostCron {
         if (UnderpostCron.JOB[jobId]) await UnderpostCron.JOB[jobId].callback(deployList, options);
       }
     },
+
+    /**
+     * Get the related deploy id for the given job id
+     * @static
+     * @param {String} jobId - The job id
+     * @return {String} The related deploy id
+     * @memberof UnderpostCron
+     */
     getRelatedDeployId(jobId) {
       switch (jobId) {
         case 'dns':

package/src/cli/db.js

@@ -1,3 +1,9 @@
+/**
+ * UnderpostDB CLI index module
+ * @module src/cli/db.js
+ * @namespace UnderpostDB
+ */
+
 import { mergeFile, splitFileFactory } from '../server/conf.js';
 import { loggerFactory } from '../server/logger.js';
 import { shellExec } from '../server/process.js';
@@ -9,8 +15,36 @@ import { loadReplicas, pathPortAssignmentFactory } from '../server/conf.js';
 
 const logger = loggerFactory(import.meta);
 
+/**
+ * @class UnderpostDB
+ * @description Manages database operations and backups.
+ * This class provides a set of static methods to handle database operations,
+ * including importing and exporting data, managing database backups, and
+ * handling database connections for different providers (e.g., MariaDB, MongoDB).
+ * @memberof UnderpostDB
+ */
 class UnderpostDB {
   static API = {
+    /**
+     * @method callback
+     * @description Initiates a database backup workflow based on the provided options.
+     * This method orchestrates the backup process for multiple deployments, handling
+     * database connections, backup storage, and optional Git integration for version control.
+     * @param {string} [deployList='default'] - List of deployment IDs to include in the backup.
+     * @param {object} [options] - An object containing boolean flags for various operations.
+     * @param {boolean} [options.import=false] - Flag to import data from a backup.
+     * @param {boolean} [options.export=false] - Flag to export data to a backup.
+     * @param {string} [options.podName=false] - The name of the Kubernetes pod to use for database operations.
+     * @param {string} [options.ns=false] - The namespace to use for database operations.
+     * @param {string} [options.collections=''] - Comma-separated list of collections to include in the backup.
+     * @param {string} [options.outPath=''] - Output path for the backup file.
+     * @param {boolean} [options.drop=false] - Flag to drop the database before importing.
+     * @param {boolean} [options.preserveUUID=false] - Flag to preserve UUIDs during import.
+     * @param {boolean} [options.git=false] - Flag to enable Git integration for version control.
+     * @param {string} [options.hosts=''] - Comma-separated list of hosts to include in the backup.
+     * @param {string} [options.paths=''] - Comma-separated list of paths to include in the backup.
+     * @memberof UnderpostDB
+     */
     async callback(
       deployList = 'default',
       options = {
@@ -200,6 +234,17 @@ class UnderpostDB {
         }
       }
     },
+
+    /**
+     * @method clusterMetadataFactory
+     * @description Creates a cluster metadata object for the specified deployment.
+     * This method loads database configuration and initializes a cluster metadata object
+     * using the provided deployment ID, host, and path.
+     * @param {string} [deployId=process.env.DEFAULT_DEPLOY_ID] - The deployment ID to use.
+     * @param {string} [host=process.env.DEFAULT_DEPLOY_HOST] - The host to use.
+     * @param {string} [path=process.env.DEFAULT_DEPLOY_PATH] - The path to use.
+     * @memberof UnderpostDB
+     */
     async clusterMetadataFactory(
       deployId = process.env.DEFAULT_DEPLOY_ID,
       host = process.env.DEFAULT_DEPLOY_HOST,
@@ -227,7 +272,6 @@ class UnderpostDB {
           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);
@@ -298,6 +342,24 @@ class UnderpostDB {
       }
       await DataBaseProvider.instance[`${host}${path}`].mongoose.close();
     },
+
+    /**
+     * @method clusterMetadataBackupCallback
+     * @description Handles the backup of cluster metadata for the specified deployment.
+     * This method orchestrates the backup process for cluster metadata, including
+     * instances and crons, and handles optional Git integration for version control.
+     * @param {string} [deployId=process.env.DEFAULT_DEPLOY_ID] - The deployment ID to use.
+     * @param {string} [host=process.env.DEFAULT_DEPLOY_HOST] - The host to use.
+     * @param {string} [path=process.env.DEFAULT_DEPLOY_PATH] - The path to use.
+     * @param {object} [options] - An object containing boolean flags for various operations.
+     * @param {boolean} [options.generate=false] - Flag to generate cluster metadata.
+     * @param {boolean} [options.itc=false] - Flag to enable Git integration for version control.
+     * @param {boolean} [options.import=false] - Flag to import data from a backup.
+     * @param {boolean} [options.export=false] - Flag to export data to a backup.
+     * @param {boolean} [options.instances=false] - Flag to backup instances.
+     * @param {boolean} [options.crons=false] - Flag to backup crons.
+     * @memberof UnderpostDB
+     */
     clusterMetadataBackupCallback(
       deployId = process.env.DEFAULT_DEPLOY_ID,
       host = process.env.DEFAULT_DEPLOY_HOST,