@underpostnet/underpost 2.99.6 → 2.99.7

package/src/server/backup.js

@@ -8,6 +8,7 @@ import fs from 'fs-extra';
 import { loggerFactory } from './logger.js';
 import { shellExec } from './process.js';
 import dotenv from 'dotenv';
+import Underpost from '../index.js';
 
 dotenv.config();
 
@@ -28,6 +29,7 @@ class BackUp {
    * @param {boolean} [options.k3s] - Use k3s cluster context.
    * @param {boolean} [options.kind] - Use kind cluster context.
    * @param {boolean} [options.kubeadm] - Use kubeadm cluster context.
+   * @param {boolean} [options.ssh] - Execute backup commands via SSH on the remote node.
    * @memberof UnderpostBakcUp
    */
   static callback = async function (deployList, options = { git: false }) {
@@ -43,10 +45,19 @@ class BackUp {
       const deployId = _deployId.trim();
       if (!deployId) continue;
 
-      logger.info('Executing database export for', deployId);
-      shellExec(
-        `node bin db ${options.git ? '--git --force-clone ' : ''}--export --primary-pod${clusterFlag} ${deployId}`,
-      );
+      const command = `node bin db ${options.git ? '--git --force-clone ' : ''}--export --primary-pod${clusterFlag} ${deployId}`;
+
+      if (options.ssh) {
+        logger.info('Executing database export via SSH for', deployId);
+        await Underpost.ssh.sshRemoteRunner(command, {
+          remote: true,
+          useSudo: true,
+          cd: '/home/dd/engine',
+        });
+      } else {
+        logger.info('Executing database export for', deployId);
+        shellExec(command);
+      }
     }
   };
 }

package/src/server/client-build-docs.js

@@ -1,5 +1,11 @@
 'use strict';
 
+/**
+ * Module for building project documentation (JSDoc, Swagger, Coverage).
+ * @module src/server/client-build-docs.js
+ * @namespace clientBuildDocs
+ */
+
 import fs from 'fs-extra';
 import swaggerAutoGen from 'swagger-autogen';
 import { shellExec } from './process.js';
@@ -8,6 +14,8 @@ import { JSONweb } from './client-formatted.js';
 
 /**
  * Builds API documentation using Swagger
+ * @function buildApiDocs
+ * @memberof clientBuildDocs
  * @param {Object} options - Documentation build options
  * @param {string} options.host - The hostname for the API
  * @param {string} options.path - The base path for the API
@@ -126,12 +134,15 @@ const buildApiDocs = async ({
 
 /**
  * Builds JSDoc documentation
+ * @function buildJsDocs
+ * @memberof clientBuildDocs
  * @param {Object} options - JSDoc build options
  * @param {string} options.host - The hostname for the documentation
  * @param {string} options.path - The base path for the documentation
  * @param {Object} options.metadata - Metadata for the documentation
+ * @param {string} options.publicClientId - Client ID used to resolve the tutorials/references directory
  */
-const buildJsDocs = async ({ host, path, metadata = {} }) => {
+const buildJsDocs = async ({ host, path, metadata = {}, publicClientId }) => {
   const logger = loggerFactory(import.meta);
   const jsDocsConfig = JSON.parse(fs.readFileSync(`./jsdoc.json`, 'utf8'));
 
@@ -139,6 +150,17 @@ const buildJsDocs = async ({ host, path, metadata = {} }) => {
   jsDocsConfig.opts.theme_opts.title = metadata?.title ? metadata.title : undefined;
   jsDocsConfig.opts.theme_opts.favicon = `./public/${host}${path === '/' ? '/' : `${path}/`}favicon.ico`;
 
+  const tutorialsPath = `./src/client/public/${publicClientId}/docs/references`;
+  if (fs.existsSync(tutorialsPath)) {
+    jsDocsConfig.opts.tutorials = tutorialsPath;
+    if (jsDocsConfig.opts.theme_opts.sections && !jsDocsConfig.opts.theme_opts.sections.includes('Tutorials')) {
+      jsDocsConfig.opts.theme_opts.sections.push('Tutorials');
+    }
+    logger.info('build jsdoc tutorials', tutorialsPath);
+  } else {
+    delete jsDocsConfig.opts.tutorials;
+  }
+
   fs.writeFileSync(`./jsdoc.json`, JSON.stringify(jsDocsConfig, null, 4), 'utf8');
   logger.warn('build jsdoc view', jsDocsConfig.opts.destination);
 
@@ -147,6 +169,8 @@ const buildJsDocs = async ({ host, path, metadata = {} }) => {
 
 /**
  * Builds test coverage documentation
+ * @function buildCoverage
+ * @memberof clientBuildDocs
  * @param {Object} options - Coverage build options
  * @param {string} options.host - The hostname for the coverage
  * @param {string} options.path - The base path for the coverage
@@ -168,6 +192,8 @@ const buildCoverage = async ({ host, path }) => {
 
 /**
  * Main function to build all documentation
+ * @function buildDocs
+ * @memberof clientBuildDocs
  * @param {Object} options - Documentation build options
  * @param {string} options.host - The hostname
  * @param {string} options.path - The base path
@@ -188,7 +214,7 @@ const buildDocs = async ({
   rootClientPath,
   packageData,
 }) => {
-  await buildJsDocs({ host, path, metadata });
+  await buildJsDocs({ host, path, metadata, publicClientId });
   await buildCoverage({ host, path });
   await buildApiDocs({
     host,

package/src/server/conf.js

@@ -1167,9 +1167,10 @@ const getPathsSSR = (conf) => {
 };
 
 /**
- * @method Cmd
+ * @method CmdUnderpost
  * @description The command factory.
  * @memberof ServerConfBuilder
+ * @namespace CmdUnderpost
  */
 const Cmd = {
   /**
@@ -1184,7 +1185,7 @@ const Cmd = {
    * @description Builds the deploy.
    * @param {string} deployId - The deploy ID.
    * @returns {string} - The build command.
-   * @memberof Cmd
+   * @memberof CmdUnderpost
    */
   build: (deployId) => `node bin/deploy build-full-client ${deployId}`,
   /**
@@ -1193,7 +1194,7 @@ const Cmd = {
    * @param {string} deployId - The deploy ID.
    * @param {string} env - The environment.
    * @returns {string} - The conf command.
-   * @memberof Cmd
+   * @memberof CmdUnderpost
    */
   conf: (deployId, env) => `node bin/deploy conf ${deployId} ${env ? env : 'production'}`,
   /**
@@ -1203,14 +1204,14 @@ const Cmd = {
    * @param {string} host - The host.
    * @param {string} path - The path.
    * @returns {string} - The replica command.
-   * @memberof Cmd
+   * @memberof CmdUnderpost
    */
   replica: (deployId, host, path) => `node bin/deploy build-single-replica ${deployId} ${host} ${path}`,
   /**
    * @method syncPorts
    * @description Syncs the ports.
    * @returns {string} - The sync ports command.
-   * @memberof Cmd
+   * @memberof CmdUnderpost
    */
   syncPorts: () => `node bin/deploy sync-env-port`,
 };

package/src/server/cron.js

@@ -8,12 +8,15 @@ import { loggerFactory } from './logger.js';
 import { shellExec } from './process.js';
 import fs from 'fs-extra';
 import Underpost from '../index.js';
+import { getUnderpostRootPath } from './conf.js';
 
 const logger = loggerFactory(import.meta);
 
 const volumeHostPath = '/home/dd';
 const enginePath = '/home/dd/engine';
 const cronVolumeName = 'underpost-cron-container-volume';
+const shareEnvVolumeName = 'underpost-share-env';
+const underpostContainerEnvPath = '/usr/lib/node_modules/underpost/.env';
 
 /**
  * Generates a Kubernetes CronJob YAML manifest string.
@@ -30,6 +33,7 @@ const cronVolumeName = 'underpost-cron-container-volume';
  * @param {string} [params.cmd] - Optional pre-script commands to run before cron execution
  * @param {boolean} [params.suspend=false] - Whether the CronJob is suspended
  * @param {boolean} [params.dryRun=false] - Pass --dry-run flag to the cron command inside the container
+ * @param {boolean} [params.ssh=false] - Execute backup commands via SSH on the remote node
  * @returns {string} Kubernetes CronJob YAML manifest
  * @memberof UnderpostCron
  */
@@ -45,6 +49,7 @@ const cronJobYamlFactory = ({
   cmd,
   suspend = false,
   dryRun = false,
+  ssh = false,
 }) => {
   const containerImage = image || `underpost/underpost-engine:${Underpost.version}`;
 
@@ -57,7 +62,7 @@ const cronJobYamlFactory = ({
 
   const cmdPart = cmd ? `${cmd} && ` : '';
   const cronBin = dev ? 'node bin' : 'underpost';
-  const flags = `${git ? '--git ' : ''}${dev ? '--dev ' : ''}${dryRun ? '--dry-run ' : ''}`;
+  const flags = `${git ? '--git ' : ''}${dev ? '--dev ' : ''}${dryRun ? '--dry-run ' : ''}${ssh ? '--ssh ' : ''}`;
   const cronCommand = `${cmdPart}${cronBin} cron ${flags}${deployList} ${jobList}`;
 
   return `apiVersion: batch/v1
@@ -94,11 +99,18 @@ spec:
               volumeMounts:
                 - mountPath: ${enginePath}
                   name: ${cronVolumeName}
+                - mountPath: ${underpostContainerEnvPath}
+                  name: ${shareEnvVolumeName}
+                  subPath: .env
           volumes:
             - hostPath:
                 path: ${enginePath}
                 type: Directory
               name: ${cronVolumeName}
+            - hostPath:
+                path: ${getUnderpostRootPath()}
+                type: DirectoryOrCreate
+              name: ${shareEnvVolumeName}
           restartPolicy: OnFailure
 `;
 };
@@ -171,6 +183,7 @@ class UnderpostCron {
      * @param {boolean} [options.kubeadm] - Use kubeadm cluster context (apply directly on host)
      * @param {boolean} [options.dryRun] - Preview cron jobs without executing them
      * @param {boolean} [options.createJobNow] - After applying, immediately create a Job from each CronJob (requires --apply)
+     * @param {boolean} [options.ssh] - Execute backup commands via SSH on the remote node
      * @memberof UnderpostCron
      */
     callback: async function (
@@ -178,15 +191,9 @@ class UnderpostCron {
       jobList = Object.keys(Underpost.cron.JOB).join(','),
       options = {},
     ) {
-      if (options.setupStart) {
-        await Underpost.cron.setupDeployStart(options.setupStart, options);
-        return;
-      }
+      if (options.setupStart) return await Underpost.cron.setupDeployStart(options.setupStart, options);
 
-      if (options.generateK8sCronjobs) {
-        await Underpost.cron.generateK8sCronJobs(options);
-        return;
-      }
+      if (options.generateK8sCronjobs) return await Underpost.cron.generateK8sCronJobs(options);
 
       for (const _jobId of jobList.split(',')) {
         const jobId = _jobId.trim();
@@ -219,6 +226,7 @@ class UnderpostCron {
      * @param {boolean} [options.k3s] - k3s cluster context (apply directly on host)
      * @param {boolean} [options.kind] - kind cluster context (apply via kind-worker container)
      * @param {boolean} [options.kubeadm] - kubeadm cluster context (apply directly on host)
+     * @param {boolean} [options.ssh] - Execute backup commands via SSH on the remote node
      * @memberof UnderpostCron
      */
     setupDeployStart: async function (deployId, options = {}) {
@@ -263,17 +271,18 @@ class UnderpostCron {
       // Generate and apply cron job manifests for this deploy-id
       await Underpost.cron.generateK8sCronJobs({
         deployId,
-        apply: options.apply,
-        git: !!options.git,
-        dev: !!options.dev,
-        cmd: options.cmd,
         namespace: options.namespace,
         image: options.image,
-        k3s: !!options.k3s,
-        kind: !!options.kind,
-        kubeadm: !!options.kubeadm,
-        createJobNow: !!options.createJobNow,
-        dryRun: !!options.dryRun,
+        apply: options.apply,
+        createJobNow: options.createJobNow,
+        git: true,
+        dev: true,
+        kubeadm: true,
+        ssh: true,
+        cmd: ` cd ${enginePath} && node bin env ${deployId} production`,
+        k3s: false,
+        kind: false,
+        dryRun: false,
       });
     },
 
@@ -295,6 +304,7 @@ class UnderpostCron {
      * @param {boolean} [options.kubeadm=false] - kubeadm cluster context (apply directly on host)
      * @param {boolean} [options.createJobNow=false] - After applying, create a Job from each CronJob immediately
      * @param {boolean} [options.dryRun=false] - Pass --dry-run=client to kubectl commands
+     * @param {boolean} [options.ssh=false] - Execute backup commands via SSH on the remote node
      * @memberof UnderpostCron
      */
     generateK8sCronJobs: async function (options = {}) {
@@ -351,6 +361,7 @@ class UnderpostCron {
           cmd: options.cmd,
           suspend: false,
           dryRun: !!options.dryRun,
+          ssh: !!options.ssh,
         });
 
         const yamlFilePath = `${outputDir}/${cronJobName}.yaml`;
@@ -389,29 +400,28 @@ class UnderpostCron {
           shellExec(`kubectl apply -f ${yamlFile}`);
         }
         logger.info('All CronJob manifests applied');
-
-        // Create an immediate Job from each CronJob if requested
-        if (options.createJobNow) {
-          for (const job of Object.keys(confCronConfig.jobs)) {
-            const jobConfig = confCronConfig.jobs[job];
-            if (jobConfig.enabled === false) continue;
-
-            const cronJobName = `${jobDeployId}-${job}`
-              .toLowerCase()
-              .replace(/[^a-z0-9-]/g, '-')
-              .replace(/--+/g, '-')
-              .replace(/^-|-$/g, '')
-              .substring(0, 52);
-
-            const immediateJobName = `${cronJobName}-now-${Date.now()}`.substring(0, 63);
-            logger.info(`Creating immediate Job from CronJob: ${cronJobName}`, { jobName: immediateJobName });
-            shellExec(`kubectl create job ${immediateJobName} --from=cronjob/${cronJobName} -n ${namespace}`);
-          }
-          logger.info('All immediate Jobs created');
-        }
       } else {
         logger.info(`Manifests generated in ${outputDir}. Use --apply to deploy to the cluster.`);
       }
+      // Create an immediate Job from each CronJob if requested
+      if (options.createJobNow) {
+        for (const job of Object.keys(confCronConfig.jobs)) {
+          const jobConfig = confCronConfig.jobs[job];
+          if (jobConfig.enabled === false) continue;
+
+          const cronJobName = `${jobDeployId}-${job}`
+            .toLowerCase()
+            .replace(/[^a-z0-9-]/g, '-')
+            .replace(/--+/g, '-')
+            .replace(/^-|-$/g, '')
+            .substring(0, 52);
+
+          const immediateJobName = `${cronJobName}-now-${Date.now()}`.substring(0, 63);
+          logger.info(`Creating immediate Job from CronJob: ${cronJobName}`, { jobName: immediateJobName });
+          shellExec(`kubectl create job ${immediateJobName} --from=cronjob/${cronJobName} -n ${namespace}`);
+        }
+        logger.info('All immediate Jobs created');
+      }
     },
 
     /**

package/src/server/dns.js

@@ -330,14 +330,6 @@ class Dns {
             logger.info('IP updated successfully and verified', testIp);
             Underpost.env.set('ip', testIp);
             Underpost.env.delete('monitor-input');
-            {
-              const deployId = resolveDeployId();
-              const envs = dotenv.parse(
-                fs.readFileSync(`./engine-private/conf/${deployId}/.env.${process.env.NODE_ENV}`, 'utf8'),
-              );
-              envs.ip = testIp;
-              writeEnv(`./engine-private/conf/${deployId}/.env.${process.env.NODE_ENV}`, envs);
-            }
           } else {
             logger.error('IP not updated or verification failed', { expected: testIp, received: verifyIp });
           }