underpost 2.8.1 → 2.8.7

package/cli.md

@@ -0,0 +1,451 @@
+## underpost ci/cd cli v2.8.7
+
+### 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
+  --postgresql         Init with postgresql statefulset
+  --mongodb4           Init with mongodb 4.4 service
+  --istio              Init base istio cluster
+  --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
+  --pull-image         Set optional pull associated image
+  -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
+  --disable-update-deployment       Disable update deployments
+  --info-traffic                    get traffic conf form current resources
+                                    deployments
+  --rebuild-clients-bundle          Inside container, rebuild clients bundle,
+                                    only static public or storage client files
+  -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
+  --storage-file-path <storage-file-path>  custom file storage path
+  -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
+  --replicas <replicas>        Set custom number of replicas
+  --type <type>                Set custom monitor type
+  --sync                       Sync with current proxy deployments proxy
+                               traffic
+  -h, --help                   display help for command
+ 
+```
+  

package/conf.js

@@ -1,4 +1,8 @@
-const DefaultConf = {
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+const DefaultConf = /**/ {
   client: {
     default: {
       metadata: {
@@ -75,58 +79,16 @@ const DefaultConf = {
         ],
       },
       views: [
-        {
-          path: '/',
-          title: 'Home',
-          client: 'Default',
-          ssr: 'Default',
-        },
-        {
-          path: '/home',
-          title: 'Home',
-          client: 'Default',
-          ssr: 'Default',
-        },
-        {
-          path: '/settings',
-          client: 'Default',
-          ssr: 'Default',
-        },
-        {
-          path: '/log-in',
-          client: 'Default',
-          ssr: 'Default',
-        },
-        {
-          path: '/sign-up',
-          client: 'Default',
-          ssr: 'Default',
-        },
-        {
-          path: '/log-out',
-          client: 'Default',
-          ssr: 'Default',
-        },
-        {
-          path: '/account',
-          client: 'Default',
-          ssr: 'Default',
-        },
-        {
-          path: '/docs',
-          client: 'Default',
-          ssr: 'Default',
-        },
-        {
-          path: '/recover',
-          client: 'Default',
-          ssr: 'Default',
-        },
-        {
-          path: '/default-management',
-          client: 'Default',
-          ssr: 'Default',
-        },
+        { path: '/', title: 'Home', client: 'Default', ssr: 'Default' },
+        { path: '/home', title: 'Home', client: 'Default', ssr: 'Default' },
+        { path: '/settings', client: 'Default', ssr: 'Default' },
+        { path: '/log-in', client: 'Default', ssr: 'Default' },
+        { path: '/sign-up', client: 'Default', ssr: 'Default' },
+        { path: '/log-out', client: 'Default', ssr: 'Default' },
+        { path: '/account', client: 'Default', ssr: 'Default' },
+        { path: '/docs', client: 'Default', ssr: 'Default' },
+        { path: '/recover', client: 'Default', ssr: 'Default' },
+        { path: '/default-management', client: 'Default', ssr: 'Default' },
         { client: 'Default', ssr: 'Default', path: '/404', title: '404 Not Found' },
         { client: 'Default', ssr: 'Default', path: '/500', title: '500 Server Error' },
       ],
@@ -137,24 +99,15 @@ const DefaultConf = {
           import_name: '@neodrag/vanilla',
           import_name_build: '/dist/@neodrag-vanilla/index.js',
         },
-        {
-          folder: './node_modules/@fortawesome/fontawesome-free',
-          public_folder: '/dist/fontawesome',
-        },
+        { folder: './node_modules/@fortawesome/fontawesome-free', public_folder: '/dist/fontawesome' },
         {
           folder: './node_modules/sortablejs/modular',
           public_folder: '/dist/sortablejs',
           import_name: 'sortablejs',
           import_name_build: '/dist/sortablejs/sortable.complete.esm.js',
         },
-        {
-          folder: './node_modules/validator',
-          public_folder: '/dist/validator',
-        },
-        {
-          folder: './node_modules/@loadingio/css-spinner/entries',
-          public_folder: '/dist/loadingio',
-        },
+        { folder: './node_modules/validator', public_folder: '/dist/validator' },
+        { folder: './node_modules/@loadingio/css-spinner/entries', public_folder: '/dist/loadingio' },
         {
           import_name: 'ag-grid-community',
           import_name_build: '/dist/ag-grid-community/ag-grid-community.auto.complete.esm.min.js',
@@ -169,10 +122,7 @@ const DefaultConf = {
           import_name: 'socket.io/client-dist/socket.io.esm.min.js',
           import_name_build: '/dist/socket.io/socket.io.esm.min.js',
         },
-        {
-          folder: './node_modules/peerjs/dist',
-          public_folder: '/dist/peerjs',
-        },
+        { folder: './node_modules/peerjs/dist', public_folder: '/dist/peerjs' },
       ],
       services: ['default', 'core', 'user', 'test', 'file'],
     },
@@ -181,35 +131,12 @@ const DefaultConf = {
     Default: {
       head: ['Seo', 'Pwa', 'Css', 'DefaultScripts', 'Production'],
       body: ['CacheControl', 'DefaultSplashScreen', '404', '500'],
-      mailer: {
-        userVerifyEmail: 'DefaultVerifyEmail',
-        userRecoverEmail: 'DefaultRecoverEmail',
-      },
+      mailer: { userVerifyEmail: 'DefaultVerifyEmail', userRecoverEmail: 'DefaultRecoverEmail' },
       offline: [
-        {
-          path: '/offline',
-          title: 'No Network Connection',
-          client: 'NoNetworkConnection',
-          head: [],
-          body: [],
-        },
-        {
-          path: '/maintenance',
-          title: 'Server Maintenance',
-          client: 'Maintenance',
-          head: [],
-          body: [],
-        },
-      ],
-      pages: [
-        {
-          path: '/test',
-          title: 'Test',
-          client: 'Test',
-          head: [],
-          body: [],
-        },
+        { path: '/offline', title: 'No Network Connection', client: 'NoNetworkConnection', head: [], body: [] },
+        { path: '/maintenance', title: 'Server Maintenance', client: 'Maintenance', head: [], body: [] },
       ],
+      pages: [{ path: '/test', title: 'Test', client: 'Test', head: [], body: [] }],
     },
   },
   server: {
@@ -227,24 +154,14 @@ const DefaultConf = {
         ws: 'core',
         peer: true,
         proxy: [80, 443],
-        db: {
-          provider: 'mongoose',
-          host: 'mongodb://127.0.0.1:27017',
-          name: 'default',
-        },
+        db: { provider: 'mongoose', host: 'mongodb://127.0.0.1:27017', name: 'default' },
         mailer: {
-          sender: {
-            email: 'noreply@default.net',
-            name: 'Default',
-          },
+          sender: { email: 'noreply@default.net', name: 'Default' },
           transport: {
             host: 'smtp.default.com',
             port: 465,
             secure: true,
-            auth: {
-              user: 'noreply@default.net',
-              pass: '',
-            },
+            auth: { user: 'noreply@default.net', pass: '' },
           },
         },
       },
@@ -262,35 +179,9 @@ const DefaultConf = {
     },
   },
   cron: {
-    ipDaemon: {
-      ip: null,
-    },
-    records: {
-      A: [
-        {
-          host: 'example.com',
-          dns: 'dondominio',
-          api_key: '???',
-          user: '???',
-        },
-      ],
-    },
-    backups: [
-      {
-        deployGroupId: 'default-group',
-      },
-    ],
-    jobs: {
-      dns: {
-        expression: '* * * * *',
-        enabled: true,
-      },
-      backups: {
-        expression: '0 1 * * *',
-        enabled: true,
-      },
-    },
+    records: { A: [{ host: 'example.com', dns: 'dondominio', api_key: '???', user: '???' }] },
+    jobs: { dns: { expression: '* * * * *', enabled: true }, backups: { expression: '0 1 * * *', enabled: true } },
   },
-};
+}; /**/
 
 export { DefaultConf };

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.1'
+      engine.version: '2.8.7'
     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,