underpost 2.8.641 → 2.8.651

package/cli.md

@@ -0,0 +1,439 @@
+## underpost ci/cd cli v2.8.651
+
+### Usage: `underpost [options] [command]`
+  ```
+ Options:
+  -V, --version                                              output the version number
+  -h, --help                                                 display help for command
+
+Commands:
+  new <app-name>                                             Create a new project
+  start [options] <deploy-id> [env]                          Start up server, build pipelines, or services
+  clone [options] <uri>                                      Clone github repository
+  pull <path> <uri>                                          Pull github repository
+  cmt [options] <path> <commit-type> [module-tag] [message]  Commit github repository
+  push [options] <path> <uri>                                Push github repository
+  env <deploy-id> [env]                                      Set environment variables files and conf related to <deploy-id>
+  config <operator> [key] [value]                            Manage configuration, operators
+  root                                                       Get npm root path
+  cluster [options] [pod-name]                               Manage cluster, for default initialization base kind cluster
+  deploy [options] <deploy-list> [env]                       Manage deployment, for default deploy development pods
+  secret [options] <platform>                                Manage secrets
+  dockerfile-image-build [options]                           Build image from Dockerfile
+  dockerfile-pull-base-images                                Pull underpost dockerfile images requirements
+  install                                                    Fast import underpost npm dependencies
+  db [options] <deploy-list>                                 Manage databases
+  script [options] <operator> <script-name> [script-value]   Supports a number of built-in underpost global scripts and their preset life cycle events as well as arbitrary scripts
+  cron [options] [deploy-list] [job-list]                    Cron jobs management
+  fs [options] [path]                                        File storage management, for default upload file
+  test [options] [deploy-list]                               Manage Test, for default run current underpost default test
+  monitor [options] <deploy-id> [env]                        Monitor health server management
+  help [command]                                             display help for command
+ 
+```
+
+## Commands:
+    
+
+### `new` :
+```
+ Usage: underpost new [options] <app-name>
+
+Create a new project
+
+Arguments:
+  app-name    Application name
+
+Options:
+  -h, --help  display help for command
+ 
+```
+  
+
+### `start` :
+```
+ Usage: underpost start [options] <deploy-id> [env]
+
+Start up server, build pipelines, or services
+
+Arguments:
+  deploy-id   Deploy configuration id
+  env         Optional environment, for default is development
+
+Options:
+  --run       Run app servers and monitor health server
+  --build     Build app client
+  -h, --help  display help for command
+ 
+```
+  
+
+### `clone` :
+```
+ Usage: underpost clone [options] <uri>
+
+Clone github repository
+
+Arguments:
+  uri         e.g. username/repository
+
+Options:
+  --bare      Clone only .git files
+  -h, --help  display help for command
+ 
+```
+  
+
+### `pull` :
+```
+ Usage: underpost pull [options] <path> <uri>
+
+Pull github repository
+
+Arguments:
+  path        Absolute or relative directory
+  uri         e.g. username/repository
+
+Options:
+  -h, --help  display help for command
+ 
+```
+  
+
+### `cmt` :
+```
+ Usage: underpost cmt [options] <path> <commit-type> [module-tag] [message]
+
+Commit github repository
+
+Arguments:
+  path         Absolute or relative directory
+  commit-type  Options:
+               feat,fix,docs,style,refactor,perf,cd,test,build,ci,chore,revert,backup
+  module-tag   Optional set module tag
+  message      Optional set additional message
+
+Options:
+  --empty      Allow empty files
+  --copy       Copy to clipboard message
+  --info       Info commit types
+  -h, --help   display help for command
+ 
+```
+  
+
+### `push` :
+```
+ Usage: underpost push [options] <path> <uri>
+
+Push github repository
+
+Arguments:
+  path        Absolute or relative directory
+  uri         e.g. username/repository
+
+Options:
+  -f          Force push overwriting repository
+  -h, --help  display help for command
+ 
+```
+  
+
+### `env` :
+```
+ Usage: underpost env [options] <deploy-id> [env]
+
+Set environment variables files and conf related to <deploy-id>
+
+Arguments:
+  deploy-id   deploy configuration id, if 'clean' restore default
+  env         Optional environment, for default is production
+
+Options:
+  -h, --help  display help for command
+ 
+```
+  
+
+### `config` :
+```
+ Usage: underpost config [options] <operator> [key] [value]
+
+Manage configuration, operators
+
+Arguments:
+  operator    Options: set,delete,get,list,clean
+  key         Config key
+  value       Config value
+
+Options:
+  -h, --help  display help for command
+ 
+```
+  
+
+### `root` :
+```
+ Usage: underpost root [options]
+
+Get npm root path
+
+Options:
+  -h, --help  display help for command
+ 
+```
+  
+
+### `cluster` :
+```
+ Usage: underpost cluster [options] [pod-name]
+
+Manage cluster, for default initialization base kind cluster
+
+Arguments:
+  pod-name             Optional pod name filter
+
+Options:
+  --reset              Delete all clusters and prune all data and caches
+  --mariadb            Init with mariadb statefulset
+  --mongodb            Init with mongodb statefulset
+  --mongodb4           Init with mongodb 4.4 service
+  --valkey             Init with valkey service
+  --contour            Init with project contour base HTTPProxy and envoy
+  --cert-manager       Init with letsencrypt-prod ClusterIssuer
+  --info               Get all kinds objects deployed
+  --full               Init with all statefulsets and services available
+  --ns-use <ns-name>   Switches current context to namespace
+  --dev                init with dev cluster
+  --list-pods          Display list pods information
+  --info-capacity      display current total machine capacity info
+  --info-capacity-pod  display current machine capacity pod info
+  -h, --help           display help for command
+ 
+```
+  
+
+### `deploy` :
+```
+ Usage: underpost deploy [options] <deploy-list> [env]
+
+Manage deployment, for default deploy development pods
+
+Arguments:
+  deploy-list                       Deploy id list, e.g. default-a,default-b
+  env                               Optional environment, for default is
+                                    development
+
+Options:
+  --remove                          Delete deployments and services
+  --sync                            Sync deployments env, ports, and replicas
+  --info-router                     Display router structure
+  --expose                          Expose service match deploy-list
+  --info-util                       Display kubectl util management commands
+  --cert                            Reset tls/ssl certificate secrets
+  --build-manifest                  Build kind yaml manifests: deployments,
+                                    services, proxy and secrets
+  --dashboard-update                Update dashboard instance data with current
+                                    router config
+  --replicas <replicas>             Set custom number of replicas
+  --versions <deployment-versions>  Comma separated custom deployment versions
+  --traffic <traffic-versions>      Comma separated custom deployment traffic
+  -h, --help                        display help for command
+ 
+```
+  
+
+### `secret` :
+```
+ Usage: underpost secret [options] <platform>
+
+Manage secrets
+
+Arguments:
+  platform                            Options: docker,underpost
+
+Options:
+  --init                              Init secrets platform environment
+  --create-from-file <path-env-file>  Create secret from env file
+  --list                              Lists secrets
+  -h, --help                          display help for command
+ 
+```
+  
+
+### `dockerfile-image-build` :
+```
+ Usage: underpost dockerfile-image-build [options]
+
+Build image from Dockerfile
+
+Options:
+  --path [path]                        Dockerfile path
+  --image-name [image-name]            Set image name
+  --image-path [image-path]            Set tar image path
+  --dockerfile-name [dockerfile-name]  set Dockerfile name
+  --podman-save                        Export tar file from podman
+  --kind-load                          Import tar image to Kind cluster
+  --secrets                            Dockerfile env secrets
+  --secrets-path [secrets-path]        Dockerfile custom path env secrets
+  --no-cache                           Build without using cache
+  -h, --help                           display help for command
+ 
+```
+  
+
+### `dockerfile-pull-base-images` :
+```
+ Usage: underpost dockerfile-pull-base-images [options]
+
+Pull underpost dockerfile images requirements
+
+Options:
+  -h, --help  display help for command
+ 
+```
+  
+
+### `install` :
+```
+ Usage: underpost install [options]
+
+Fast import underpost npm dependencies
+
+Options:
+  -h, --help  display help for command
+ 
+```
+  
+
+### `db` :
+```
+ Usage: underpost db [options] <deploy-list>
+
+Manage databases
+
+Arguments:
+  deploy-list                  Deploy id list, e.g. default-a,default-b
+
+Options:
+  --import                     Import container backups from repositories
+  --export                     Export container backups to repositories
+  --pod-name <pod-name>        Optional pod context
+  --collections <collections>  Comma separated collections
+  --out-path <out-path>        Custom out path backup
+  --drop                       Drop databases
+  --preserveUUID               Preserve Ids
+  --git                        Upload to github
+  --hosts <hosts>              Comma separated hosts
+  --paths <paths>              Comma separated paths
+  --ns <ns-name>               Optional name space context
+  -h, --help                   display help for command
+ 
+```
+  
+
+### `script` :
+```
+ Usage: underpost script [options] <operator> <script-name> [script-value]
+
+Supports a number of built-in underpost global scripts and their preset life
+cycle events as well as arbitrary scripts
+
+Arguments:
+  operator               Options: set,run,get
+  script-name            Script name
+  script-value           Literal command, or path
+
+Options:
+  --itc                  Inside container execution context
+  --itc-path             Inside container path options
+  --ns <ns-name>         Options name space context
+  --pod-name <pod-name>
+  -h, --help             display help for command
+ 
+```
+  
+
+### `cron` :
+```
+ Usage: underpost cron [options] [deploy-list] [job-list]
+
+Cron jobs management
+
+Arguments:
+  deploy-list         Deploy id list, e.g. default-a,default-b
+  job-list            Deploy id list, e.g. callback,updateDashboardData, for
+                      default all available jobs
+
+Options:
+  --itc               Inside container execution context
+  --init              Init cron jobs for cron job default deploy id
+  --git               Upload to github
+  --dashboard-update  Update dashboard cron data with current jobs config
+  -h, --help          display help for command
+ 
+```
+  
+
+### `fs` :
+```
+ Usage: underpost fs [options] [path]
+
+File storage management, for default upload file
+
+Arguments:
+  path                     Absolute or relative directory
+
+Options:
+  --rm                     Remove file
+  --git                    Current git changes
+  --recursive              Upload files recursively
+  --deploy-id <deploy-id>  Deploy configuration id
+  --pull                   Download file
+  --force                  Force action
+  -h, --help               display help for command
+ 
+```
+  
+
+### `test` :
+```
+ Usage: underpost test [options] [deploy-list]
+
+Manage Test, for default run current underpost default test
+
+Arguments:
+  deploy-list                Deploy id list, e.g. default-a,default-b
+
+Options:
+  --itc                      Inside container execution context
+  --sh                       Copy to clipboard, container entrypoint shell
+                             command
+  --logs                     Display container logs
+  --pod-name <pod-name>
+  --pod-status <pod-status>
+  --kind-type <kind-type>
+  -h, --help                 display help for command
+ 
+```
+  
+
+### `monitor` :
+```
+ Usage: underpost monitor [options] <deploy-id> [env]
+
+Monitor health server management
+
+Arguments:
+  deploy-id                    Deploy configuration id
+  env                          Optional environment, for default is development
+
+Options:
+  --ms-interval <ms-interval>  Custom ms interval delta time
+  --now                        Exec immediately monitor script
+  --single                     Disable recurrence
+  --type <type>                Set custom monitor type
+  -h, --help                   display help for command
+ 
+```
+  

package/docker-compose.yml

@@ -58,7 +58,7 @@ services:
           cpus: '0.25'
           memory: 20M
     labels: # labels in Compose file instead of Dockerfile
-      engine.version: '2.8.641'
+      engine.version: '2.8.651'
     networks:
       - load-balancer
 

package/jsdoc.json

@@ -23,7 +23,7 @@
       "homepageTitle": "Docs",
       "favicon": "./public/www.nexodev.org/"
     },
-    "tutorials": "./public/www.nexodev.org/docs/learn"
+    "tutorials": "./public/www.nexodev.org/docs/references"
   },
   "markdown": {
     "hardwrap": false,

package/package.json

@@ -2,7 +2,7 @@
     "type": "module",
     "main": "src/index.js",
     "name": "underpost",
-    "version": "2.8.641",
+    "version": "2.8.651",
     "description": "pwa api rest template",
     "scripts": {
         "start": "env-cmd -f .env.production node --max-old-space-size=8192 src/server",
@@ -118,12 +118,7 @@
         "vanilla-jsoneditor": "^2.3.2",
         "winston": "^3.11.0"
     },
-    "devDependencies": {
-        "clean-jsdoc-theme": "^4.3.0",
-        "mocha": "^10.8.2",
-        "plantuml": "^0.0.2",
-        "swagger-autogen": "^2.23.7"
-    },
+    "devDependencies": {},
     "publishConfig": {
         "provenance": true,
         "access": "public",

package/src/api/user/user.service.js

@@ -225,8 +225,8 @@ const UserService = {
         } else throw new Error('invalid email or password');
 
       case 'guest': {
-        const user = await ValkeyAPI.valkeyObjectFactory('user', options);
-        await ValkeyAPI.setValkeyObject(user.email, user);
+        const user = await ValkeyAPI.valkeyObjectFactory(options, 'user');
+        await ValkeyAPI.setValkeyObject(options, user.email, user);
         return {
           token: hashJWT({ user: UserDto.auth.payload(user) }),
           user: selectDtoFactory(user, UserDto.select.get()),
@@ -325,15 +325,18 @@ const UserService = {
         return await User.find().select(UserDto.select.getAll());
 
       case 'auth': {
-        const user = (await ValkeyAPI.getValkeyObject(req.auth.user.email))
-          ? await ValkeyAPI.getValkeyObject(req.auth.user.email)
-          : await User.findOne({
-              _id: req.auth.user._id,
-            });
+        let user;
+        if (req.auth.user._id.match('guest')) {
+          user = await ValkeyAPI.getValkeyObject(options, req.auth.user.email);
+          if (!user) throw new Error('guest user expired');
+        } else
+          user = await User.findOne({
+            _id: req.auth.user._id,
+          });
 
         const file = await File.findOne({ _id: user.profileImageId });
 
-        if (!file && !(await ValkeyAPI.getValkeyObject(req.auth.user.email))) {
+        if (!file && !(await ValkeyAPI.getValkeyObject(options, req.auth.user.email))) {
           await User.findByIdAndUpdate(
             user._id,
             { profileImageId: await getDefaultProfileImageId(File) },
@@ -342,8 +345,8 @@ const UserService = {
             },
           );
         }
-        return (await ValkeyAPI.getValkeyObject(req.auth.user.email))
-          ? selectDtoFactory(await ValkeyAPI.getValkeyObject(req.auth.user.email), UserDto.select.get())
+        return (await ValkeyAPI.getValkeyObject(options, req.auth.user.email))
+          ? selectDtoFactory(await ValkeyAPI.getValkeyObject(options, req.auth.user.email), UserDto.select.get())
           : await User.findOne({
               _id: req.auth.user._id,
             }).select(UserDto.select.get());

package/src/cli/cluster.js

@@ -1,5 +1,4 @@
-import { timer } from '../client/components/core/CommonJs.js';
-import { cliSpinner, getNpmRootPath } from '../server/conf.js';
+import { getNpmRootPath } from '../server/conf.js';
 import { loggerFactory } from '../server/logger.js';
 import { shellExec } from '../server/process.js';
 import UnderpostDeploy from './deploy.js';
@@ -23,10 +22,14 @@ class UnderpostCluster {
         reset: false,
         dev: false,
         nsUse: '',
+        infoCapacity: false,
+        infoCapacityPod: false,
       },
     ) {
       const npmRoot = getNpmRootPath();
       const underpostRoot = options?.dev === true ? '.' : `${npmRoot}/underpost`;
+      if (options.infoCapacityPod === true) return logger.info('', UnderpostDeploy.API.resourcesFactory());
+      if (options.infoCapacity === true) return logger.info('', UnderpostCluster.API.getResourcesCapacity());
       if (options.reset === true) return await UnderpostCluster.API.reset();
       if (options.listPods === true) return console.table(UnderpostDeploy.API.get(podName ?? undefined));
 
@@ -197,6 +200,46 @@ class UnderpostCluster {
       );
       shellExec(`sudo podman system reset -f`);
     },
+    getResourcesCapacity() {
+      const resources = {};
+      const info = false
+        ? `Capacity:
+  cpu:                8
+  ephemeral-storage:  153131976Ki
+  hugepages-1Gi:      0
+  hugepages-2Mi:      0
+  memory:             11914720Ki
+  pods:               110
+Allocatable:
+  cpu:                8
+  ephemeral-storage:  153131976Ki
+  hugepages-1Gi:      0
+  hugepages-2Mi:      0
+  memory:             11914720Ki
+  pods: `
+        : shellExec(`kubectl describe node kind-worker | grep -E '(Allocatable:|Capacity:)' -A 6`, {
+            stdout: true,
+            silent: true,
+          });
+      info
+        .split('Allocatable:')[1]
+        .split('\n')
+        .filter((row) => row.match('cpu') || row.match('memory'))
+        .map((row) => {
+          if (row.match('cpu'))
+            resources.cpu = {
+              value: parseInt(row.split(':')[1].trim()) * 1000,
+              unit: 'm',
+            };
+          if (row.match('memory'))
+            resources.memory = {
+              value: parseInt(row.split(':')[1].split('Ki')[0].trim()),
+              unit: 'Ki',
+            };
+        });
+
+      return resources;
+    },
   };
 }
 export default UnderpostCluster;

package/src/cli/db.js

@@ -15,11 +15,13 @@ class UnderpostDB {
         export: false,
         podName: false,
         ns: false,
-        collection: '',
+        collections: '',
         outPath: '',
         drop: false,
         preserveUUID: false,
         git: false,
+        hosts: '',
+        paths: '',
       },
     ) {
       const newBackupTimestamp = new Date().getTime();
@@ -39,20 +41,28 @@ class UnderpostDB {
               if (!dbs[provider]) dbs[provider] = {};
 
               if (!(name in dbs[provider]))
-                dbs[provider][name] = { user, password, hostFolder: host + path.replaceAll('/', '-') };
+                dbs[provider][name] = { user, password, hostFolder: host + path.replaceAll('/', '-'), host, path };
             }
           }
         }
 
-        if (!fs.existsSync(`../${repoName}`)) {
-          shellExec(`cd .. && underpost clone ${process.env.GITHUB_USERNAME}/${repoName}`);
-        } else {
-          shellExec(`cd ../${repoName} && underpost pull . ${process.env.GITHUB_USERNAME}/${repoName}`);
+        if (options.git === true) {
+          if (!fs.existsSync(`../${repoName}`)) {
+            shellExec(`cd .. && underpost clone ${process.env.GITHUB_USERNAME}/${repoName}`);
+          } else {
+            shellExec(`cd ../${repoName} && git checkout . && git clean -f -d`);
+            shellExec(`cd ../${repoName} && underpost pull . ${process.env.GITHUB_USERNAME}/${repoName}`);
+          }
         }
 
         for (const provider of Object.keys(dbs)) {
           for (const dbName of Object.keys(dbs[provider])) {
-            const { hostFolder, user, password } = dbs[provider][dbName];
+            const { hostFolder, user, password, host, path } = dbs[provider][dbName];
+            if (
+              (options.hosts && !options.hosts.split(',').includes(host)) ||
+              (options.paths && !options.paths.split(',').includes(path))
+            )
+              continue;
             if (hostFolder) {
               logger.info('', { hostFolder, provider, dbName });
 
@@ -153,7 +163,7 @@ class UnderpostDB {
                       const podName = podNameData.NAME;
                       shellExec(`sudo kubectl exec -i ${podName} -- sh -c "rm -rf /${dbName}"`);
                       if (options.collections)
-                        for (const collection of options.collections)
+                        for (const collection of options.collections.split(','))
                           shellExec(
                             `sudo kubectl exec -i ${podName} -- sh -c "mongodump -d ${dbName} --collection ${collection} -o /"`,
                           );