underpost 2.90.1 → 2.92.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/release.cd.yml +7 -7
- package/README.md +6 -6
- package/bin/deploy.js +16 -127
- package/cli.md +123 -30
- package/examples/QUICK-REFERENCE.md +499 -0
- package/examples/README.md +447 -0
- package/examples/STATIC-GENERATOR-GUIDE.md +807 -0
- package/examples/ssr-components/CustomPage.js +579 -0
- package/examples/static-config-example.json +183 -0
- package/examples/static-config-simple.json +57 -0
- package/manifests/deployment/dd-default-development/deployment.yaml +2 -2
- package/manifests/deployment/dd-test-development/deployment.yaml +2 -2
- package/package.json +1 -1
- package/scripts/rocky-setup.sh +1 -0
- package/src/api/document/document.model.js +7 -0
- package/src/api/document/document.service.js +4 -1
- package/src/cli/db.js +1148 -197
- package/src/cli/deploy.js +17 -12
- package/src/cli/env.js +2 -2
- package/src/cli/index.js +191 -15
- package/src/cli/repository.js +127 -3
- package/src/cli/run.js +41 -12
- package/src/cli/ssh.js +424 -13
- package/src/cli/static.js +785 -49
- package/src/client/components/core/CommonJs.js +0 -1
- package/src/client/components/core/Input.js +6 -4
- package/src/client/components/core/Modal.js +13 -18
- package/src/client/components/core/Panel.js +26 -6
- package/src/client/components/core/PanelForm.js +67 -52
- package/src/db/mongo/MongooseDB.js +5 -1
- package/src/index.js +1 -1
- package/src/server/dns.js +154 -0
- package/src/server/start.js +2 -0
|
@@ -30,11 +30,11 @@ jobs:
|
|
|
30
30
|
script: |
|
|
31
31
|
set -e
|
|
32
32
|
echo "Starting remote release deploy"
|
|
33
|
-
underpost run pull
|
|
34
|
-
underpost run secret
|
|
35
|
-
npm install -g underpost
|
|
36
33
|
cd /home/dd/engine
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
34
|
+
sudo -n -- /bin/bash -lc "node bin run pull"
|
|
35
|
+
sudo -n -- /bin/bash -lc "underpost run secret"
|
|
36
|
+
sudo -n -- /bin/bash -lc "npm install -g underpost"
|
|
37
|
+
sudo -n -- /bin/bash -lc "underpost run secret"
|
|
38
|
+
sudo -n -- /bin/bash -lc "node bin run --dev git-conf"
|
|
39
|
+
sudo -n -- /bin/bash -lc "node bin run --dev template-deploy-image"
|
|
40
|
+
sudo -n -- /bin/bash -lc "node bin run --dev ssh-deploy sync-engine-test"
|
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
|
|
19
19
|
<!-- badges -->
|
|
20
20
|
|
|
21
|
-
[](https://github.com/underpostnet/engine/actions/workflows/docker-image.yml) [](https://github.com/underpostnet/engine/actions/workflows/coverall.ci.yml) [](https://www.npmjs.com/package/underpost) [](https://github.com/underpostnet/engine/actions/workflows/docker-image.yml) [](https://github.com/underpostnet/engine/actions/workflows/coverall.ci.yml) [](https://www.npmjs.com/package/underpost) [](https://socket.dev/npm/package/underpost/overview/2.92.0) [](https://coveralls.io/github/underpostnet/engine?branch=master) [](https://www.npmjs.org/package/underpost) [](https://www.npmjs.com/package/underpost)
|
|
22
22
|
|
|
23
23
|
<!-- end-badges -->
|
|
24
24
|
|
|
@@ -66,7 +66,7 @@ Run dev client server
|
|
|
66
66
|
npm run dev
|
|
67
67
|
```
|
|
68
68
|
<!-- -->
|
|
69
|
-
## underpost ci/cd cli v2.
|
|
69
|
+
## underpost ci/cd cli v2.92.0
|
|
70
70
|
|
|
71
71
|
### Usage: `underpost [options] [command]`
|
|
72
72
|
```
|
|
@@ -82,24 +82,24 @@ Commands:
|
|
|
82
82
|
cmt [options] [path] [commit-type] [module-tag] [message] Manages commits to a GitHub repository, supporting various commit types and options.
|
|
83
83
|
push [options] <path> <uri> Pushes committed changes from a local repository to a remote GitHub repository.
|
|
84
84
|
env [deploy-id] [env] [subConf] Sets environment variables and configurations related to a specific deployment ID.
|
|
85
|
-
static [options] Manages static build of page, bundles, and documentation.
|
|
85
|
+
static [options] Manages static build of page, bundles, and documentation with comprehensive customization options.
|
|
86
86
|
config [options] <operator> [key] [value] Manages Underpost configurations using various operators.
|
|
87
87
|
root Displays the root path of the npm installation.
|
|
88
|
-
ip [options]
|
|
88
|
+
ip [options] [ips] Displays the current public machine IP addresses.
|
|
89
89
|
cluster [options] [pod-name] Manages Kubernetes clusters, defaulting to Kind cluster initialization.
|
|
90
90
|
deploy [options] [deploy-list] [env] Manages application deployments, defaulting to deploying development pods.
|
|
91
91
|
secret [options] <platform> Manages secrets for various platforms.
|
|
92
92
|
dockerfile-image-build [options] Builds a Docker image from a specified Dockerfile with various options for naming, saving, and loading.
|
|
93
93
|
dockerfile-pull-base-images [options] Pulls required Underpost Dockerfile base images and optionally loads them into clusters.
|
|
94
94
|
install Quickly imports Underpost npm dependencies by copying them.
|
|
95
|
-
db [options] <deploy-list> Manages database operations, including import,
|
|
95
|
+
db [options] <deploy-list> Manages database operations with support for MariaDB and MongoDB, including import/export, multi-pod targeting, and Git integration.
|
|
96
96
|
metadata [options] [deploy-id] [host] [path] Manages cluster metadata operations, including import and export.
|
|
97
97
|
script [options] <operator> <script-name> [script-value] Supports a variety of built-in Underpost global scripts, their preset lifecycle events, and arbitrary custom scripts.
|
|
98
98
|
cron [options] [deploy-list] [job-list] Manages cron jobs, including initialization, execution, and configuration updates.
|
|
99
99
|
fs [options] [path] Manages file storage, defaulting to file upload operations.
|
|
100
100
|
test [options] [deploy-list] Manages and runs tests, defaulting to the current Underpost default test suite.
|
|
101
101
|
monitor [options] <deploy-id> [env] Manages health server monitoring for specified deployments.
|
|
102
|
-
ssh [options]
|
|
102
|
+
ssh [options]
|
|
103
103
|
run [options] <runner-id> [path] Runs a script from the specified path.
|
|
104
104
|
lxd [options] Manages LXD containers and virtual machines.
|
|
105
105
|
baremetal [options] [workflow-id] [hostname] [ip-address] Manages baremetal server operations, including installation, database setup, commissioning, and user management.
|
package/bin/deploy.js
CHANGED
|
@@ -663,133 +663,6 @@ ${shellExec(`git log | grep Author: | sort -u`, { stdout: true }).split(`\n`).jo
|
|
|
663
663
|
break;
|
|
664
664
|
}
|
|
665
665
|
|
|
666
|
-
case 'ssh': {
|
|
667
|
-
// only import + start
|
|
668
|
-
// node bin/deploy ssh root@<host> <password> import
|
|
669
|
-
|
|
670
|
-
// generate + import + start
|
|
671
|
-
// node bin/deploy ssh root@<host> <password>
|
|
672
|
-
|
|
673
|
-
const host = process.argv[3] ?? `root@${await Dns.getPublicIp()}`;
|
|
674
|
-
const domain = host.split('@')[1];
|
|
675
|
-
const user = 'root'; // host.split('@')[0];
|
|
676
|
-
const password = process.argv[4] ?? '';
|
|
677
|
-
const port = 22;
|
|
678
|
-
|
|
679
|
-
const setUpSSH = () => {
|
|
680
|
-
// Required port forwarding mapping
|
|
681
|
-
// ssh TCP 2222 22 <local-server-ip>
|
|
682
|
-
// ssh UDP 2222 22 <local-server-ip>
|
|
683
|
-
|
|
684
|
-
// Remote connect via public key
|
|
685
|
-
// ssh -i <key-path> <user>@<host>:2222
|
|
686
|
-
|
|
687
|
-
shellExec(`cat ./engine-private/deploy/id_rsa.pub > ~/.ssh/authorized_keys`);
|
|
688
|
-
|
|
689
|
-
// local trust on first use validator
|
|
690
|
-
// check ~/.ssh/known_hosts
|
|
691
|
-
|
|
692
|
-
// shellExec(`sudo sed -i -e "s@#PasswordAuthentication yes@PasswordAuthentication no@g" /etc/ssh/sshd_config`);
|
|
693
|
-
// shellExec(`sudo sed -i -e "s@#UsePAM no@UsePAM yes@g" /etc/ssh/sshd_config`);
|
|
694
|
-
|
|
695
|
-
// Include /etc/ssh/sshd_config.d/*.conf
|
|
696
|
-
// sudo tee /etc/ssh/sshd_config.d/99-custom.conf
|
|
697
|
-
shellExec(`sudo tee /etc/ssh/sshd_config <<EOF
|
|
698
|
-
PasswordAuthentication no
|
|
699
|
-
ChallengeResponseAuthentication yes
|
|
700
|
-
UsePAM yes
|
|
701
|
-
PubkeyAuthentication Yes
|
|
702
|
-
RSAAuthentication Yes
|
|
703
|
-
PermitRootLogin Yes
|
|
704
|
-
X11Forwarding yes
|
|
705
|
-
X11DisplayOffset 10
|
|
706
|
-
LoginGraceTime 120
|
|
707
|
-
StrictModes yes
|
|
708
|
-
SyslogFacility AUTH
|
|
709
|
-
LogLevel INFO
|
|
710
|
-
#HostKey /etc/ssh/ssh_host_ecdsa_key
|
|
711
|
-
HostKey /etc/ssh/ssh_host_ed25519_key
|
|
712
|
-
#HostKey /etc/ssh/ssh_host_rsa_key
|
|
713
|
-
AuthorizedKeysFile ~/.ssh/authorized_keys
|
|
714
|
-
Subsystem sftp /usr/libexec/openssh/sftp-server
|
|
715
|
-
ListenAddress 0.0.0.0
|
|
716
|
-
ListenAddress ::
|
|
717
|
-
ListenAddress ${domain}
|
|
718
|
-
ListenAddress ${domain}:22
|
|
719
|
-
EOF`);
|
|
720
|
-
|
|
721
|
-
shellExec(`sudo chmod 700 ~/.ssh/`);
|
|
722
|
-
shellExec(`sudo chmod 600 ~/.ssh/authorized_keys`);
|
|
723
|
-
shellExec(`sudo chmod 644 ~/.ssh/known_hosts`);
|
|
724
|
-
shellExec(`sudo chmod 600 ~/.ssh/id_rsa`);
|
|
725
|
-
shellExec(`sudo chmod 600 /etc/ssh/ssh_host_ed25519_key`);
|
|
726
|
-
shellExec(`chown -R ${user}:${user} ~/.ssh`);
|
|
727
|
-
|
|
728
|
-
shellExec(`ufw allow ${port}/tcp`);
|
|
729
|
-
shellExec(`ufw allow ${port}/udp`);
|
|
730
|
-
shellExec(`ufw allow ssh`);
|
|
731
|
-
shellExec(`ufw allow from 192.168.0.0/16 to any port 22`);
|
|
732
|
-
|
|
733
|
-
// active ssh-agent
|
|
734
|
-
shellExec('eval `ssh-agent -s`' + ` && ssh-add ~/.ssh/id_rsa` + ` && ssh-add -l`);
|
|
735
|
-
// remove all
|
|
736
|
-
// shellExec(`ssh-add -D`);
|
|
737
|
-
// remove single
|
|
738
|
-
// shellExec(`ssh-add -d ~/.ssh/id_rsa`);
|
|
739
|
-
|
|
740
|
-
// shellExec(`echo "@${host.split(`@`)[1]} * $(cat ~/.ssh/id_rsa.pub)" > ~/.ssh/known_hosts`);
|
|
741
|
-
shellExec('eval `ssh-agent -s`' + `&& ssh-keyscan -H -t ed25519 ${host.split(`@`)[1]} > ~/.ssh/known_hosts`);
|
|
742
|
-
// shellExec(`sudo echo "" > ~/.ssh/known_hosts`);
|
|
743
|
-
|
|
744
|
-
// ssh-copy-id -i ~/.ssh/id_rsa.pub -p <port_number> <username>@<host>
|
|
745
|
-
// shellExec(`ssh-copy-id -i ~/.ssh/id_rsa.pub -p ${port} ${host}`);
|
|
746
|
-
// debug:
|
|
747
|
-
// shellExec(`ssh -vvv ${host}`);
|
|
748
|
-
|
|
749
|
-
shellExec(`sudo cp ./engine-private/deploy/id_rsa ~/.ssh/id_rsa`);
|
|
750
|
-
shellExec(`sudo cp ./engine-private/deploy/id_rsa.pub ~/.ssh/id_rsa.pub`);
|
|
751
|
-
|
|
752
|
-
shellExec(`sudo echo "" > /etc/ssh/ssh_host_ecdsa_key`);
|
|
753
|
-
shellExec(`sudo cp ./engine-private/deploy/id_rsa /etc/ssh/ssh_host_ed25519_key`);
|
|
754
|
-
shellExec(`sudo echo "" > /etc/ssh/ssh_host_rsa_key`);
|
|
755
|
-
|
|
756
|
-
shellExec(`sudo echo "" > /etc/ssh/ssh_host_ecdsa_key.pub`);
|
|
757
|
-
shellExec(`sudo cp ./engine-private/deploy/id_rsa.pub /etc/ssh/ssh_host_ed25519_key.pub`);
|
|
758
|
-
shellExec(`sudo echo "" > /etc/ssh/ssh_host_rsa_key.pub`);
|
|
759
|
-
|
|
760
|
-
shellExec(`sudo systemctl enable sshd`);
|
|
761
|
-
shellExec(`sudo systemctl restart sshd`);
|
|
762
|
-
|
|
763
|
-
const status = shellExec(`sudo systemctl status sshd`, { silent: true, stdout: true });
|
|
764
|
-
console.log(
|
|
765
|
-
status.match('running') ? status.replaceAll(`running`, `running`.green) : `ssh service not running`.red,
|
|
766
|
-
);
|
|
767
|
-
};
|
|
768
|
-
|
|
769
|
-
if (process.argv.includes('import')) {
|
|
770
|
-
setUpSSH();
|
|
771
|
-
break;
|
|
772
|
-
}
|
|
773
|
-
|
|
774
|
-
shellExec(`sudo rm -rf ./id_rsa`);
|
|
775
|
-
shellExec(`sudo rm -rf ./id_rsa.pub`);
|
|
776
|
-
|
|
777
|
-
if (process.argv.includes('legacy'))
|
|
778
|
-
shellExec(`ssh-keygen -t rsa -b 4096 -f id_rsa -N "${password}" -q -C "${host}"`);
|
|
779
|
-
else shellExec(`ssh-keygen -t ed25519 -f id_rsa -N "${password}" -q -C "${host}"`);
|
|
780
|
-
|
|
781
|
-
shellExec(`sudo cp ./id_rsa ~/.ssh/id_rsa`);
|
|
782
|
-
shellExec(`sudo cp ./id_rsa.pub ~/.ssh/id_rsa.pub`);
|
|
783
|
-
|
|
784
|
-
shellExec(`sudo cp ./id_rsa ./engine-private/deploy/id_rsa`);
|
|
785
|
-
shellExec(`sudo cp ./id_rsa.pub ./engine-private/deploy/id_rsa.pub`);
|
|
786
|
-
|
|
787
|
-
shellExec(`sudo rm -rf ./id_rsa`);
|
|
788
|
-
shellExec(`sudo rm -rf ./id_rsa.pub`);
|
|
789
|
-
setUpSSH();
|
|
790
|
-
break;
|
|
791
|
-
}
|
|
792
|
-
|
|
793
666
|
case 'maas-db': {
|
|
794
667
|
// DROP, ALTER, CREATE, WITH ENCRYPTED
|
|
795
668
|
// sudo -u <user> -h <host> psql <db-name>
|
|
@@ -1237,6 +1110,22 @@ nvidia/gpu-operator \
|
|
|
1237
1110
|
break;
|
|
1238
1111
|
}
|
|
1239
1112
|
|
|
1113
|
+
case 'update-static-guide': {
|
|
1114
|
+
fs.writeFileSync(
|
|
1115
|
+
`src/client/public/nexodev/docs/references/Static Site Generator Quick Reference.md`,
|
|
1116
|
+
fs.readFileSync(`examples/QUICK-REFERENCE.md`, 'utf8'),
|
|
1117
|
+
);
|
|
1118
|
+
fs.writeFileSync(
|
|
1119
|
+
`src/client/public/nexodev/docs/references/Static Site Generator Examples.md`,
|
|
1120
|
+
fs.readFileSync(`examples/README.md`, 'utf8'),
|
|
1121
|
+
);
|
|
1122
|
+
fs.writeFileSync(
|
|
1123
|
+
`src/client/public/nexodev/docs/references/Static Generator Guide.md`,
|
|
1124
|
+
fs.readFileSync(`examples/STATIC-GENERATOR-GUIDE.md`, 'utf8'),
|
|
1125
|
+
);
|
|
1126
|
+
break;
|
|
1127
|
+
}
|
|
1128
|
+
|
|
1240
1129
|
case 'udpate-version-files': {
|
|
1241
1130
|
const oldNpmVersion = process.argv[3];
|
|
1242
1131
|
const oldNodeVersion = process.argv[4];
|
package/cli.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## underpost ci/cd cli v2.
|
|
1
|
+
## underpost ci/cd cli v2.92.0
|
|
2
2
|
|
|
3
3
|
### Usage: `underpost [options] [command]`
|
|
4
4
|
```
|
|
@@ -14,24 +14,24 @@ Commands:
|
|
|
14
14
|
cmt [options] [path] [commit-type] [module-tag] [message] Manages commits to a GitHub repository, supporting various commit types and options.
|
|
15
15
|
push [options] <path> <uri> Pushes committed changes from a local repository to a remote GitHub repository.
|
|
16
16
|
env [deploy-id] [env] [subConf] Sets environment variables and configurations related to a specific deployment ID.
|
|
17
|
-
static [options] Manages static build of page, bundles, and documentation.
|
|
17
|
+
static [options] Manages static build of page, bundles, and documentation with comprehensive customization options.
|
|
18
18
|
config [options] <operator> [key] [value] Manages Underpost configurations using various operators.
|
|
19
19
|
root Displays the root path of the npm installation.
|
|
20
|
-
ip [options]
|
|
20
|
+
ip [options] [ips] Displays the current public machine IP addresses.
|
|
21
21
|
cluster [options] [pod-name] Manages Kubernetes clusters, defaulting to Kind cluster initialization.
|
|
22
22
|
deploy [options] [deploy-list] [env] Manages application deployments, defaulting to deploying development pods.
|
|
23
23
|
secret [options] <platform> Manages secrets for various platforms.
|
|
24
24
|
dockerfile-image-build [options] Builds a Docker image from a specified Dockerfile with various options for naming, saving, and loading.
|
|
25
25
|
dockerfile-pull-base-images [options] Pulls required Underpost Dockerfile base images and optionally loads them into clusters.
|
|
26
26
|
install Quickly imports Underpost npm dependencies by copying them.
|
|
27
|
-
db [options] <deploy-list> Manages database operations, including import,
|
|
27
|
+
db [options] <deploy-list> Manages database operations with support for MariaDB and MongoDB, including import/export, multi-pod targeting, and Git integration.
|
|
28
28
|
metadata [options] [deploy-id] [host] [path] Manages cluster metadata operations, including import and export.
|
|
29
29
|
script [options] <operator> <script-name> [script-value] Supports a variety of built-in Underpost global scripts, their preset lifecycle events, and arbitrary custom scripts.
|
|
30
30
|
cron [options] [deploy-list] [job-list] Manages cron jobs, including initialization, execution, and configuration updates.
|
|
31
31
|
fs [options] [path] Manages file storage, defaulting to file upload operations.
|
|
32
32
|
test [options] [deploy-list] Manages and runs tests, defaulting to the current Underpost default test suite.
|
|
33
33
|
monitor [options] <deploy-id> [env] Manages health server monitoring for specified deployments.
|
|
34
|
-
ssh [options]
|
|
34
|
+
ssh [options]
|
|
35
35
|
run [options] <runner-id> [path] Runs a script from the specified path.
|
|
36
36
|
lxd [options] Manages LXD containers and virtual machines.
|
|
37
37
|
baremetal [options] [workflow-id] [hostname] [ip-address] Manages baremetal server operations, including installation, database setup, commissioning, and user management.
|
|
@@ -56,6 +56,15 @@ Options:
|
|
|
56
56
|
--sub-conf <sub-conf> Create sub conf env files
|
|
57
57
|
--cluster Create deploy ID cluster files and sync to current
|
|
58
58
|
cluster
|
|
59
|
+
--build-repos Create deploy ID repositories
|
|
60
|
+
--build Build the deployment to pwa-microservices-template
|
|
61
|
+
(requires --deploy-id)
|
|
62
|
+
--clean-template Clean the build directory
|
|
63
|
+
(pwa-microservices-template)
|
|
64
|
+
--sync-conf Sync configuration to private repositories (requires
|
|
65
|
+
--deploy-id)
|
|
66
|
+
--purge Remove deploy ID conf and all related repositories
|
|
67
|
+
(requires --deploy-id)
|
|
59
68
|
--dev Sets the development cli context
|
|
60
69
|
-h, --help display help for command
|
|
61
70
|
|
|
@@ -199,13 +208,33 @@ Options:
|
|
|
199
208
|
```
|
|
200
209
|
Usage: underpost static [options]
|
|
201
210
|
|
|
202
|
-
Manages static build of page, bundles, and documentation
|
|
211
|
+
Manages static build of page, bundles, and documentation with comprehensive
|
|
212
|
+
customization options.
|
|
203
213
|
|
|
204
214
|
Options:
|
|
205
215
|
--page <ssr-component-path> Build custom static pages.
|
|
206
|
-
--title <title> Sets a custom title for the static page
|
|
216
|
+
--title <title> Sets a custom title for the static page
|
|
217
|
+
(deprecated: use --config-file).
|
|
207
218
|
--output-path <output-path> Sets the output path for the generated static
|
|
208
219
|
page.
|
|
220
|
+
--description <description> Page description for SEO.
|
|
221
|
+
--keywords <keywords> Comma-separated keywords for SEO.
|
|
222
|
+
--author <author> Page author.
|
|
223
|
+
--theme-color <color> Theme color for mobile browsers.
|
|
224
|
+
--canonical-url <url> Canonical URL for SEO.
|
|
225
|
+
--thumbnail <url> Open Graph thumbnail image URL.
|
|
226
|
+
--locale <locale> Page locale (default: en-US).
|
|
227
|
+
--site-name <name> Site name for Open Graph.
|
|
228
|
+
--head-scripts <paths> Comma-separated paths to scripts for head
|
|
229
|
+
section.
|
|
230
|
+
--body-scripts <paths> Comma-separated paths to scripts for body
|
|
231
|
+
section.
|
|
232
|
+
--styles <paths> Comma-separated paths to stylesheets.
|
|
233
|
+
--favicon <path> Favicon path.
|
|
234
|
+
--apple-touch-icon <path> Apple touch icon path.
|
|
235
|
+
--manifest <path> Web manifest path.
|
|
236
|
+
--head-components <paths> Comma-separated SSR head component paths.
|
|
237
|
+
--body-components <paths> Comma-separated SSR body component paths.
|
|
209
238
|
--deploy-id <deploy-id> Build static assets for a specific deployment
|
|
210
239
|
ID.
|
|
211
240
|
--build Triggers the static build process for the
|
|
@@ -216,6 +245,13 @@ Options:
|
|
|
216
245
|
assets.
|
|
217
246
|
--env <env> Sets the environment for the static build (e.g.,
|
|
218
247
|
"development", "production").
|
|
248
|
+
--minify Minify HTML output (default: true for
|
|
249
|
+
production).
|
|
250
|
+
--no-minify Disable HTML minification.
|
|
251
|
+
--config-file <path> Path to JSON configuration file.
|
|
252
|
+
--generate-config [path] Generate a template configuration file.
|
|
253
|
+
--lang <lang> HTML lang attribute (default: en).
|
|
254
|
+
--dir <dir> HTML dir attribute (default: ltr).
|
|
219
255
|
--dev Sets the development cli context
|
|
220
256
|
-h, --help display help for command
|
|
221
257
|
|
|
@@ -255,13 +291,28 @@ Options:
|
|
|
255
291
|
|
|
256
292
|
### `ip` :
|
|
257
293
|
```
|
|
258
|
-
Usage: underpost ip [options]
|
|
294
|
+
Usage: underpost ip [options] [ips]
|
|
259
295
|
|
|
260
296
|
Displays the current public machine IP addresses.
|
|
261
297
|
|
|
298
|
+
Arguments:
|
|
299
|
+
ips Optional args comma-separated list of IP to process.
|
|
300
|
+
|
|
262
301
|
Options:
|
|
263
|
-
--copy
|
|
264
|
-
-
|
|
302
|
+
--copy Copies the IP addresses to the clipboard.
|
|
303
|
+
--ban-ingress-add Adds IP addresses to banned ingress list.
|
|
304
|
+
--ban-ingress-remove Removes IP addresses from banned ingress list.
|
|
305
|
+
--ban-ingress-list Lists all banned ingress IP addresses.
|
|
306
|
+
--ban-ingress-clear Clears all banned ingress IP addresses.
|
|
307
|
+
--ban-egress-add Adds IP addresses to banned egress list.
|
|
308
|
+
--ban-egress-remove Removes IP addresses from banned egress list.
|
|
309
|
+
--ban-egress-list Lists all banned egress IP addresses.
|
|
310
|
+
--ban-egress-clear Clears all banned egress IP addresses.
|
|
311
|
+
--ban-both-add Adds IP addresses to both banned ingress and egress
|
|
312
|
+
lists.
|
|
313
|
+
--ban-both-remove Removes IP addresses from both banned ingress and
|
|
314
|
+
egress lists.
|
|
315
|
+
-h, --help display help for command
|
|
265
316
|
|
|
266
317
|
```
|
|
267
318
|
|
|
@@ -401,6 +452,10 @@ Options:
|
|
|
401
452
|
configuration during deployment.
|
|
402
453
|
--namespace <namespace> Kubernetes namespace for deployment
|
|
403
454
|
operations (defaults to "default").
|
|
455
|
+
--kind-type <kind-type> Specifies the Kind cluster type for
|
|
456
|
+
deployment operations.
|
|
457
|
+
--port <port> Sets up port forwarding from local to
|
|
458
|
+
remote ports.
|
|
404
459
|
-h, --help display help for command
|
|
405
460
|
|
|
406
461
|
```
|
|
@@ -495,8 +550,8 @@ Options:
|
|
|
495
550
|
```
|
|
496
551
|
Usage: underpost db [options] <deploy-list>
|
|
497
552
|
|
|
498
|
-
Manages database operations
|
|
499
|
-
|
|
553
|
+
Manages database operations with support for MariaDB and MongoDB, including
|
|
554
|
+
import/export, multi-pod targeting, and Git integration.
|
|
500
555
|
|
|
501
556
|
Arguments:
|
|
502
557
|
deploy-list A comma-separated list of deployment IDs (e.g.,
|
|
@@ -507,19 +562,35 @@ Options:
|
|
|
507
562
|
repositories.
|
|
508
563
|
--export Exports container backups to specified
|
|
509
564
|
repositories.
|
|
510
|
-
--pod-name <pod-name>
|
|
511
|
-
|
|
512
|
-
--
|
|
513
|
-
|
|
565
|
+
--pod-name <pod-name> Comma-separated list of pod names or patterns
|
|
566
|
+
(supports wildcards like "mariadb-*").
|
|
567
|
+
--node-name <node-name> Comma-separated list of node names to filter
|
|
568
|
+
pods by their node placement.
|
|
569
|
+
--label-selector <selector> Kubernetes label selector for filtering pods
|
|
570
|
+
(e.g., "app=mariadb").
|
|
571
|
+
--all-pods Target all matching pods instead of just the
|
|
572
|
+
first one.
|
|
573
|
+
--primary-pod Automatically detect and use MongoDB primary pod
|
|
574
|
+
(MongoDB only).
|
|
575
|
+
--stats Display database statistics (collection/table
|
|
576
|
+
names with document/row counts).
|
|
577
|
+
--collections <collections> Comma-separated list of database collections to
|
|
578
|
+
operate on.
|
|
514
579
|
--out-path <out-path> Specifies a custom output path for backups.
|
|
515
|
-
--drop Drops the specified databases or collections
|
|
516
|
-
|
|
517
|
-
--
|
|
518
|
-
|
|
519
|
-
--
|
|
520
|
-
|
|
521
|
-
--
|
|
522
|
-
|
|
580
|
+
--drop Drops the specified databases or collections
|
|
581
|
+
before importing.
|
|
582
|
+
--preserveUUID Preserves UUIDs during database import
|
|
583
|
+
operations.
|
|
584
|
+
--git Enables Git integration for backup version
|
|
585
|
+
control (clone, pull, commit, push to GitHub).
|
|
586
|
+
--hosts <hosts> Comma-separated list of database hosts to filter
|
|
587
|
+
operations.
|
|
588
|
+
--paths <paths> Comma-separated list of paths to filter database
|
|
589
|
+
operations.
|
|
590
|
+
--ns <ns-name> Kubernetes namespace context for database
|
|
591
|
+
operations (defaults to "default").
|
|
592
|
+
--dry-run Simulates operations without executing them
|
|
593
|
+
(useful for testing).
|
|
523
594
|
-h, --help display help for command
|
|
524
595
|
|
|
525
596
|
```
|
|
@@ -675,12 +746,35 @@ Options:
|
|
|
675
746
|
```
|
|
676
747
|
Usage: underpost ssh [options]
|
|
677
748
|
|
|
678
|
-
Import and start ssh server and client based on current default deployment ID.
|
|
679
|
-
|
|
680
749
|
Options:
|
|
681
|
-
--
|
|
682
|
-
|
|
683
|
-
|
|
750
|
+
--deploy-id <deploy-id> Sets deploy id context for ssh operations.
|
|
751
|
+
--generate Generates new ssh credential and stores it in
|
|
752
|
+
current private keys file storage.
|
|
753
|
+
--user <user> Sets custom ssh user
|
|
754
|
+
--password <password> Sets custom ssh password
|
|
755
|
+
--host <host> Sets custom ssh host
|
|
756
|
+
--port <port> Sets custom ssh port
|
|
757
|
+
--filter <filter> Filters ssh user credentials from current private
|
|
758
|
+
keys file storage.
|
|
759
|
+
--groups <groups> Sets comma-separated ssh user groups for the ssh
|
|
760
|
+
user credential.
|
|
761
|
+
--user-add Adds a new ssh user credential to current private
|
|
762
|
+
keys file storage.
|
|
763
|
+
--user-remove Removes an existing ssh user credential from current
|
|
764
|
+
private keys file storage.
|
|
765
|
+
--user-ls Lists all ssh user credentials from current private
|
|
766
|
+
keys file storage.
|
|
767
|
+
--start Starts an SSH session with the specified
|
|
768
|
+
credentials.
|
|
769
|
+
--reset Resets ssh configuration and deletes all stored
|
|
770
|
+
credentials.
|
|
771
|
+
--keys-list Lists all ssh keys from current private keys file
|
|
772
|
+
storage.
|
|
773
|
+
--hosts-list Lists all ssh hosts from current private keys file
|
|
774
|
+
storage.
|
|
775
|
+
--disable-password Disables password authentication for the SSH
|
|
776
|
+
session.
|
|
777
|
+
-h, --help display help for command
|
|
684
778
|
|
|
685
779
|
```
|
|
686
780
|
|
|
@@ -733,7 +827,6 @@ Options:
|
|
|
733
827
|
--limits-memory <limits-memory> Sets memory limit for the runner execution.
|
|
734
828
|
--limits-cpu <limits-cpu> Sets CPU limit for the runner execution.
|
|
735
829
|
--resource-template-id <resource-template-id > Specifies a resource template ID for the runner execution.
|
|
736
|
-
--etcHosts Enables /etc/hosts management for the runner execution.
|
|
737
830
|
--expose Enables service exposure for the runner execution.
|
|
738
831
|
--conf-server-path <conf-server-path> Sets a custom configuration server path.
|
|
739
832
|
--underpost-root <underpost-root> Sets a custom Underpost root path.
|