underpost 2.8.799 → 2.8.812

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/cli.md CHANGED
@@ -1,4 +1,4 @@
1
- ## underpost ci/cd cli v2.8.799
1
+ ## underpost ci/cd cli v2.8.812
2
2
 
3
3
  ### Usage: `underpost [options] [command]`
4
4
  ```
@@ -7,28 +7,29 @@
7
7
  -h, --help display help for command
8
8
 
9
9
  Commands:
10
- new <app-name> Create a new project
11
- start [options] <deploy-id> [env] Start up server, build pipelines, or services
12
- clone [options] <uri> Clone github repository
13
- pull [options] <path> <uri> Pull github repository
14
- cmt [options] <path> <commit-type> [module-tag] [message] Commit github repository
15
- push [options] <path> <uri> Push github repository
16
- env <deploy-id> [env] Set environment variables files and conf related to <deploy-id>
17
- config <operator> [key] [value] Manage configuration, operators
18
- root Get npm root path
19
- cluster [options] [pod-name] Manage cluster, for default initialization base kind cluster
20
- deploy [options] [deploy-list] [env] Manage deployment, for default deploy development pods
21
- secret [options] <platform> Manage secrets
22
- dockerfile-image-build [options] Build image from Dockerfile
23
- dockerfile-pull-base-images [options] Pull underpost dockerfile images requirements
24
- install Fast import underpost npm dependencies
25
- db [options] <deploy-list> Manage databases
26
- 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
27
- cron [options] [deploy-list] [job-list] Cron jobs management
28
- fs [options] [path] File storage management, for default upload file
29
- test [options] [deploy-list] Manage Test, for default run current underpost default test
30
- monitor [options] <deploy-id> [env] Monitor health server management
31
- lxd [options] Lxd management
10
+ new <app-name> Initializes a new Underpost project with a predefined structure.
11
+ start [options] <deploy-id> [env] Initiates application servers, build pipelines, or other defined services based on the deployment ID.
12
+ clone [options] <uri> Clones a specified GitHub repository into the current directory.
13
+ pull [options] <path> <uri> Pulls the latest changes from a specified GitHub repository.
14
+ cmt [options] <path> <commit-type> [module-tag] [message] Manages commits to a GitHub repository, supporting various commit types and options.
15
+ push [options] <path> <uri> Pushes committed changes from a local repository to a remote GitHub repository.
16
+ env <deploy-id> [env] Sets environment variables and configurations related to a specific deployment ID.
17
+ config [options] <operator> [key] [value] Manages Underpost configurations using various operators.
18
+ root Displays the root path of the npm installation.
19
+ cluster [options] [pod-name] Manages Kubernetes clusters, defaulting to Kind cluster initialization.
20
+ deploy [options] [deploy-list] [env] Manages application deployments, defaulting to deploying development pods.
21
+ secret [options] <platform> Manages secrets for various platforms.
22
+ dockerfile-image-build [options] Builds a Docker image from a specified Dockerfile with various options for naming, saving, and loading.
23
+ dockerfile-pull-base-images [options] Pulls required Underpost Dockerfile base images and optionally loads them into clusters.
24
+ install Quickly imports Underpost npm dependencies by copying them.
25
+ db [options] <deploy-list> Manages database operations, including import, export, and collection management.
26
+ script [options] <operator> <script-name> [script-value] Supports a variety of built-in Underpost global scripts, their preset lifecycle events, and arbitrary custom scripts.
27
+ cron [options] [deploy-list] [job-list] Manages cron jobs, including initialization, execution, and configuration updates.
28
+ fs [options] [path] Manages file storage, defaulting to file upload operations.
29
+ test [options] [deploy-list] Manages and runs tests, defaulting to the current Underpost default test suite.
30
+ monitor [options] <deploy-id> [env] Manages health server monitoring for specified deployments.
31
+ lxd [options] Manages LXD containers and virtual machines.
32
+ baremetal [options] Manages baremetal server operations, including installation, database setup, and user management.
32
33
  help [command] display help for command
33
34
 
34
35
  ```
@@ -40,10 +41,10 @@ Commands:
40
41
  ```
41
42
  Usage: underpost new [options] <app-name>
42
43
 
43
- Create a new project
44
+ Initializes a new Underpost project with a predefined structure.
44
45
 
45
46
  Arguments:
46
- app-name Application name
47
+ app-name The name of the application to create.
47
48
 
48
49
  Options:
49
50
  -h, --help display help for command
@@ -55,15 +56,17 @@ Options:
55
56
  ```
56
57
  Usage: underpost start [options] <deploy-id> [env]
57
58
 
58
- Start up server, build pipelines, or services
59
+ Initiates application servers, build pipelines, or other defined services based
60
+ on the deployment ID.
59
61
 
60
62
  Arguments:
61
- deploy-id Deploy configuration id
62
- env Optional environment, for default is development
63
+ deploy-id The unique identifier for the deployment configuration.
64
+ env Optional: The environment to start (e.g., "development",
65
+ "production"). Defaults to "development".
63
66
 
64
67
  Options:
65
- --run Run app servers and monitor health server
66
- --build Build app client
68
+ --run Starts application servers and monitors their health.
69
+ --build Triggers the client-side application build process.
67
70
  -h, --help display help for command
68
71
 
69
72
  ```
@@ -73,14 +76,14 @@ Options:
73
76
  ```
74
77
  Usage: underpost clone [options] <uri>
75
78
 
76
- Clone github repository
79
+ Clones a specified GitHub repository into the current directory.
77
80
 
78
81
  Arguments:
79
- uri e.g. username/repository
82
+ uri The URI of the GitHub repository (e.g., "username/repository").
80
83
 
81
84
  Options:
82
- --bare Clone only .git files
83
- -g8 Use g8 repo extension
85
+ --bare Performs a bare clone, downloading only the .git files.
86
+ -g8 Uses the g8 repository extension for cloning.
84
87
  -h, --help display help for command
85
88
 
86
89
  ```
@@ -90,14 +93,15 @@ Options:
90
93
  ```
91
94
  Usage: underpost pull [options] <path> <uri>
92
95
 
93
- Pull github repository
96
+ Pulls the latest changes from a specified GitHub repository.
94
97
 
95
98
  Arguments:
96
- path Absolute or relative directory
97
- uri e.g. username/repository
99
+ path The absolute or relative directory path where the repository is
100
+ located.
101
+ uri The URI of the GitHub repository (e.g., "username/repository").
98
102
 
99
103
  Options:
100
- -g8 Use g8 repo extension
104
+ -g8 Uses the g8 repository extension for pulling.
101
105
  -h, --help display help for command
102
106
 
103
107
  ```
@@ -107,19 +111,20 @@ Options:
107
111
  ```
108
112
  Usage: underpost cmt [options] <path> <commit-type> [module-tag] [message]
109
113
 
110
- Commit github repository
114
+ Manages commits to a GitHub repository, supporting various commit types and
115
+ options.
111
116
 
112
117
  Arguments:
113
- path Absolute or relative directory
114
- commit-type Options:
115
- feat,fix,docs,style,refactor,perf,cd,test,build,ci,chore,revert,backup
116
- module-tag Optional set module tag
117
- message Optional set additional message
118
+ path The absolute or relative directory path of the repository.
119
+ commit-type The type of commit to perform. Options: feat, fix, docs, style,
120
+ refactor, perf, cd, test, build, ci, chore, revert, backup.
121
+ module-tag Optional: Sets a specific module tag for the commit.
122
+ message Optional: Provides an additional custom message for the commit.
118
123
 
119
124
  Options:
120
- --empty Allow empty files
121
- --copy Copy to clipboard message
122
- --info Info commit types
125
+ --empty Allows committing with empty files.
126
+ --copy Copies the generated commit message to the clipboard.
127
+ --info Displays information about available commit types.
123
128
  -h, --help display help for command
124
129
 
125
130
  ```
@@ -129,15 +134,15 @@ Options:
129
134
  ```
130
135
  Usage: underpost push [options] <path> <uri>
131
136
 
132
- Push github repository
137
+ Pushes committed changes from a local repository to a remote GitHub repository.
133
138
 
134
139
  Arguments:
135
- path Absolute or relative directory
136
- uri e.g. username/repository
140
+ path The absolute or relative directory path of the repository.
141
+ uri The URI of the GitHub repository (e.g., "username/repository").
137
142
 
138
143
  Options:
139
- -f Force push overwriting repository
140
- -g8 Use g8 repo extension
144
+ -f Forces the push, overwriting the remote repository history.
145
+ -g8 Uses the g8 repository extension for pushing.
141
146
  -h, --help display help for command
142
147
 
143
148
  ```
@@ -147,11 +152,14 @@ Options:
147
152
  ```
148
153
  Usage: underpost env [options] <deploy-id> [env]
149
154
 
150
- Set environment variables files and conf related to <deploy-id>
155
+ Sets environment variables and configurations related to a specific deployment
156
+ ID.
151
157
 
152
158
  Arguments:
153
- deploy-id deploy configuration id, if 'clean' restore default
154
- env Optional environment, for default is production
159
+ deploy-id The deployment configuration ID. Use 'clean' to restore default
160
+ environment settings.
161
+ env Optional: The environment to set (e.g., "production",
162
+ "development"). Defaults to "production".
155
163
 
156
164
  Options:
157
165
  -h, --help display help for command
@@ -163,14 +171,16 @@ Options:
163
171
  ```
164
172
  Usage: underpost config [options] <operator> [key] [value]
165
173
 
166
- Manage configuration, operators
174
+ Manages Underpost configurations using various operators.
167
175
 
168
176
  Arguments:
169
- operator Options: set,delete,get,list,clean
170
- key Config key
171
- value Config value
177
+ operator The configuration operation to perform. Options: set, delete,
178
+ get, list, clean.
179
+ key Optional: The specific configuration key to manage.
180
+ value Optional: The value to set for the configuration key.
172
181
 
173
182
  Options:
183
+ --plain Prints the configuration value in plain text.
174
184
  -h, --help display help for command
175
185
 
176
186
  ```
@@ -180,7 +190,7 @@ Options:
180
190
  ```
181
191
  Usage: underpost root [options]
182
192
 
183
- Get npm root path
193
+ Displays the root path of the npm installation.
184
194
 
185
195
  Options:
186
196
  -h, --help display help for command
@@ -192,37 +202,50 @@ Options:
192
202
  ```
193
203
  Usage: underpost cluster [options] [pod-name]
194
204
 
195
- Manage cluster, for default initialization base kind cluster
205
+ Manages Kubernetes clusters, defaulting to Kind cluster initialization.
196
206
 
197
207
  Arguments:
198
- pod-name Optional pod name filter
208
+ pod-name Optional: Filters information by a specific pod name.
199
209
 
200
210
  Options:
201
- --reset Delete all clusters and prune all data and caches
202
- --mariadb Init with mariadb statefulset
203
- --mysql Init with mysql statefulset
204
- --mongodb Init with mongodb statefulset
205
- --postgresql Init with postgresql statefulset
206
- --mongodb4 Init with mongodb 4.4 service
207
- --valkey Init with valkey service
208
- --contour Init with project contour base HTTPProxy and envoy
209
- --cert-manager Init with letsencrypt-prod ClusterIssuer
210
- --dedicated-gpu Init with dedicated gpu base resources env
211
- --info Get all kinds objects deployed
212
- --full Init with all statefulsets and services available
213
- --ns-use <ns-name> Switches current context to namespace
214
- --kubeadm Init with kubeadm controlplane management
215
- --dev init with dev cluster
216
- --list-pods Display list pods information
217
- --info-capacity display current total machine capacity info
218
- --info-capacity-pod display current machine capacity pod info
219
- --pull-image Set optional pull associated image
220
- --init-host Install k8s node necessary cli env: kind, kubeadm,
221
- docker, podman, helm
222
- --config Set k8s base node config
223
- --worker Set worker node context
224
- --chown Set k8s kube chown
225
- --k3s Initialize the cluster using K3s
211
+ --reset Deletes all clusters and prunes all related data and
212
+ caches.
213
+ --mariadb Initializes the cluster with a MariaDB statefulset.
214
+ --mysql Initializes the cluster with a MySQL statefulset.
215
+ --mongodb Initializes the cluster with a MongoDB statefulset.
216
+ --postgresql Initializes the cluster with a PostgreSQL statefulset.
217
+ --mongodb4 Initializes the cluster with a MongoDB 4.4 service.
218
+ --valkey Initializes the cluster with a Valkey service.
219
+ --contour Initializes the cluster with Project Contour base
220
+ HTTPProxy and Envoy.
221
+ --cert-manager Initializes the cluster with a Let's Encrypt production
222
+ ClusterIssuer.
223
+ --dedicated-gpu Initializes the cluster with dedicated GPU base
224
+ resources and environment settings.
225
+ --info Retrieves information about all deployed Kubernetes
226
+ objects.
227
+ --full Initializes the cluster with all available statefulsets
228
+ and services.
229
+ --ns-use <ns-name> Switches the current Kubernetes context to the specified
230
+ namespace.
231
+ --kubeadm Initializes the cluster using kubeadm for control plane
232
+ management.
233
+ --dev Initializes a development-specific cluster
234
+ configuration.
235
+ --list-pods Displays detailed information about all pods.
236
+ --info-capacity Displays the current total machine capacity information.
237
+ --info-capacity-pod Displays the current machine capacity information per
238
+ pod.
239
+ --pull-image Sets an optional associated image to pull during
240
+ initialization.
241
+ --init-host Installs necessary Kubernetes node CLI tools (e.g.,
242
+ kind, kubeadm, docker, podman, helm).
243
+ --config Sets the base Kubernetes node configuration.
244
+ --worker Sets the context for a worker node.
245
+ --chown Sets the appropriate ownership for Kubernetes kubeconfig
246
+ files.
247
+ --k3s Initializes the cluster using K3s (Lightweight
248
+ Kubernetes).
226
249
  -h, --help display help for command
227
250
 
228
251
  ```
@@ -232,34 +255,48 @@ Options:
232
255
  ```
233
256
  Usage: underpost deploy [options] [deploy-list] [env]
234
257
 
235
- Manage deployment, for default deploy development pods
258
+ Manages application deployments, defaulting to deploying development pods.
236
259
 
237
260
  Arguments:
238
- deploy-list Deploy id list, e.g. default-a,default-b
239
- env Optional environment, for default is
240
- development
261
+ deploy-list A comma-separated list of deployment IDs
262
+ (e.g., "default-a,default-b").
263
+ env Optional: The environment for deployment
264
+ (e.g., "development", "production").
265
+ Defaults to "development".
241
266
 
242
267
  Options:
243
- --remove Delete deployments and services
244
- --sync Sync deployments env, ports, and replicas
245
- --info-router Display router structure
246
- --expose Expose service match deploy-list
247
- --info-util Display kubectl util management commands
248
- --cert Reset tls/ssl certificate secrets
249
- --build-manifest Build kind yaml manifests: deployments,
250
- services, proxy and secrets
251
- --dashboard-update Update dashboard instance data with current
252
- router config
253
- --replicas <replicas> Set custom number of replicas
254
- --versions <deployment-versions> Comma separated custom deployment versions
255
- --traffic <traffic-versions> Comma separated custom deployment traffic
256
- --disable-update-deployment Disable update deployments
257
- --info-traffic get traffic conf form current resources
258
- deployments
259
- --kubeadm Enable kubeadm context
260
- --restore-hosts Restore defautl etc hosts
261
- --rebuild-clients-bundle Inside container, rebuild clients bundle,
262
- only static public or storage client files
268
+ --remove Deletes specified deployments and their
269
+ associated services.
270
+ --sync Synchronizes deployment environment
271
+ variables, ports, and replica counts.
272
+ --info-router Displays the current router structure and
273
+ configuration.
274
+ --expose Exposes services matching the provided
275
+ deployment ID list.
276
+ --info-util Displays useful `kubectl` utility
277
+ management commands.
278
+ --cert Resets TLS/SSL certificate secrets for
279
+ deployments.
280
+ --build-manifest Builds Kubernetes YAML manifests, including
281
+ deployments, services, proxies, and
282
+ secrets.
283
+ --dashboard-update Updates dashboard instance data with the
284
+ current router configuration.
285
+ --replicas <replicas> Sets a custom number of replicas for
286
+ deployments.
287
+ --versions <deployment-versions> A comma-separated list of custom deployment
288
+ versions.
289
+ --traffic <traffic-versions> A comma-separated list of custom deployment
290
+ traffic weights.
291
+ --disable-update-deployment Disables updates to deployments.
292
+ --info-traffic Retrieves traffic configuration from
293
+ current resource deployments.
294
+ --kubeadm Enables the kubeadm context for deployment
295
+ operations.
296
+ --restore-hosts Restores default `/etc/hosts` entries.
297
+ --rebuild-clients-bundle Inside the container, rebuilds client
298
+ bundles (only static public or storage
299
+ client files).
263
300
  -h, --help display help for command
264
301
 
265
302
  ```
@@ -269,15 +306,19 @@ Options:
269
306
  ```
270
307
  Usage: underpost secret [options] <platform>
271
308
 
272
- Manage secrets
309
+ Manages secrets for various platforms.
273
310
 
274
311
  Arguments:
275
- platform Options: docker,underpost
312
+ platform The secret management platform. Options:
313
+ docker, underpost.
276
314
 
277
315
  Options:
278
- --init Init secrets platform environment
279
- --create-from-file <path-env-file> Create secret from env file
280
- --list Lists secrets
316
+ --init Initializes the secrets platform
317
+ environment.
318
+ --create-from-file <path-env-file> Creates secrets from a specified
319
+ environment file.
320
+ --list Lists all available secrets for the
321
+ platform.
281
322
  -h, --help display help for command
282
323
 
283
324
  ```
@@ -287,20 +328,28 @@ Options:
287
328
  ```
288
329
  Usage: underpost dockerfile-image-build [options]
289
330
 
290
- Build image from Dockerfile
331
+ Builds a Docker image from a specified Dockerfile with various options for
332
+ naming, saving, and loading.
291
333
 
292
334
  Options:
293
- --path [path] Dockerfile path
294
- --image-name [image-name] Set image name
295
- --image-path [image-path] Set tar image path
296
- --dockerfile-name [dockerfile-name] set Dockerfile name
297
- --podman-save Export tar file from podman
298
- --kind-load Import tar image to Kind cluster
299
- --kubeadm-load Import tar image to Kubeadm cluster
300
- --secrets Dockerfile env secrets
301
- --secrets-path [secrets-path] Dockerfile custom path env secrets
302
- --reset Build without using cache
303
- --k3s-load Load image into K3s cluster.
335
+ --path [path] The path to the Dockerfile directory.
336
+ --image-name [image-name] Sets a custom name for the Docker image.
337
+ --image-path [image-path] Sets the output path for the tar image
338
+ archive.
339
+ --dockerfile-name [dockerfile-name] Sets a custom name for the Dockerfile.
340
+ --podman-save Exports the built image as a tar file
341
+ using Podman.
342
+ --kind-load Imports the tar image into a Kind
343
+ cluster.
344
+ --kubeadm-load Imports the tar image into a Kubeadm
345
+ cluster.
346
+ --secrets Includes Dockerfile environment secrets
347
+ during the build.
348
+ --secrets-path [secrets-path] Specifies a custom path for Dockerfile
349
+ environment secrets.
350
+ --reset Performs a build without using the
351
+ cache.
352
+ --k3s-load Loads the image into a K3s cluster.
304
353
  -h, --help display help for command
305
354
 
306
355
  ```
@@ -310,14 +359,15 @@ Options:
310
359
  ```
311
360
  Usage: underpost dockerfile-pull-base-images [options]
312
361
 
313
- Pull underpost dockerfile images requirements
362
+ Pulls required Underpost Dockerfile base images and optionally loads them into
363
+ clusters.
314
364
 
315
365
  Options:
316
- --path [path] Dockerfile path
317
- --kind-load Import tar image to Kind cluster
318
- --kubeadm-load Import tar image to Kubeadm cluster
319
- --version Set custom version
320
- --k3s-load Load image into K3s cluster.
366
+ --path [path] The path to the Dockerfile directory.
367
+ --kind-load Imports the pulled image into a Kind cluster.
368
+ --kubeadm-load Imports the pulled image into a Kubeadm cluster.
369
+ --version Sets a custom version for the base images.
370
+ --k3s-load Loads the image into a K3s cluster.
321
371
  -h, --help display help for command
322
372
 
323
373
  ```
@@ -327,7 +377,7 @@ Options:
327
377
  ```
328
378
  Usage: underpost install [options]
329
379
 
330
- Fast import underpost npm dependencies
380
+ Quickly imports Underpost npm dependencies by copying them.
331
381
 
332
382
  Options:
333
383
  -h, --help display help for command
@@ -339,23 +389,31 @@ Options:
339
389
  ```
340
390
  Usage: underpost db [options] <deploy-list>
341
391
 
342
- Manage databases
392
+ Manages database operations, including import, export, and collection
393
+ management.
343
394
 
344
395
  Arguments:
345
- deploy-list Deploy id list, e.g. default-a,default-b
396
+ deploy-list A comma-separated list of deployment IDs (e.g.,
397
+ "default-a,default-b").
346
398
 
347
399
  Options:
348
- --import Import container backups from repositories
349
- --export Export container backups to repositories
350
- --pod-name <pod-name> Optional pod context
351
- --collections <collections> Comma separated collections
352
- --out-path <out-path> Custom out path backup
353
- --drop Drop databases
354
- --preserveUUID Preserve Ids
355
- --git Upload to github
356
- --hosts <hosts> Comma separated hosts
357
- --paths <paths> Comma separated paths
358
- --ns <ns-name> Optional name space context
400
+ --import Imports container backups from specified
401
+ repositories.
402
+ --export Exports container backups to specified
403
+ repositories.
404
+ --pod-name <pod-name> Optional: Specifies the pod context for database
405
+ operations.
406
+ --collections <collections> A comma-separated list of database collections
407
+ to operate on.
408
+ --out-path <out-path> Specifies a custom output path for backups.
409
+ --drop Drops the specified databases or collections.
410
+ --preserveUUID Preserves UUIDs during database operations.
411
+ --git Uploads database backups to GitHub.
412
+ --hosts <hosts> A comma-separated list of database hosts.
413
+ --paths <paths> A comma-separated list of paths for database
414
+ files.
415
+ --ns <ns-name> Optional: Specifies the namespace context for
416
+ database operations.
359
417
  -h, --help display help for command
360
418
 
361
419
  ```
@@ -365,19 +423,23 @@ Options:
365
423
  ```
366
424
  Usage: underpost script [options] <operator> <script-name> [script-value]
367
425
 
368
- Supports a number of built-in underpost global scripts and their preset life
369
- cycle events as well as arbitrary scripts
426
+ Supports a variety of built-in Underpost global scripts, their preset lifecycle
427
+ events, and arbitrary custom scripts.
370
428
 
371
429
  Arguments:
372
- operator Options: set,run,get
373
- script-name Script name
374
- script-value Literal command, or path
430
+ operator The script operation to perform. Options: set, run,
431
+ get.
432
+ script-name The name of the script to execute.
433
+ script-value Optional: A literal command or a path to a script
434
+ file.
375
435
 
376
436
  Options:
377
- --itc Inside container execution context
378
- --itc-path Inside container path options
379
- --ns <ns-name> Options name space context
380
- --pod-name <pod-name>
437
+ --itc Executes the script within the container execution
438
+ context.
439
+ --itc-path Specifies container path options for script execution.
440
+ --ns <ns-name> Optional: Specifies the namespace context for script
441
+ execution.
442
+ --pod-name <pod-name> Optional: Specifies the pod name for script execution.
381
443
  -h, --help display help for command
382
444
 
383
445
  ```
@@ -387,18 +449,22 @@ Options:
387
449
  ```
388
450
  Usage: underpost cron [options] [deploy-list] [job-list]
389
451
 
390
- Cron jobs management
452
+ Manages cron jobs, including initialization, execution, and configuration
453
+ updates.
391
454
 
392
455
  Arguments:
393
- deploy-list Deploy id list, e.g. default-a,default-b
394
- job-list Deploy id list, e.g. callback,updateDashboardData, for
395
- default all available jobs
456
+ deploy-list A comma-separated list of deployment IDs (e.g.,
457
+ "default-a,default-b").
458
+ job-list A comma-separated list of job IDs. Options: callback,
459
+ updateDashboardData. Defaults to all available jobs.
396
460
 
397
461
  Options:
398
- --itc Inside container execution context
399
- --init Init cron jobs for cron job default deploy id
400
- --git Upload to github
401
- --dashboard-update Update dashboard cron data with current jobs config
462
+ --itc Executes cron jobs within the container execution
463
+ context.
464
+ --init Initializes cron jobs for the default deployment ID.
465
+ --git Uploads cron job configurations to GitHub.
466
+ --dashboard-update Updates dashboard cron data with the current job
467
+ configurations.
402
468
  -h, --help display help for command
403
469
 
404
470
  ```
@@ -408,19 +474,19 @@ Options:
408
474
  ```
409
475
  Usage: underpost fs [options] [path]
410
476
 
411
- File storage management, for default upload file
477
+ Manages file storage, defaulting to file upload operations.
412
478
 
413
479
  Arguments:
414
- path Absolute or relative directory
480
+ path The absolute or relative directory path for file operations.
415
481
 
416
482
  Options:
417
- --rm Remove file
418
- --git Current git changes
419
- --recursive Upload files recursively
420
- --deploy-id <deploy-id> Deploy configuration id
421
- --pull Download file
422
- --force Force action
423
- --storage-file-path <storage-file-path> custom file storage path
483
+ --rm Removes the specified file.
484
+ --git Displays current Git changes related to file storage.
485
+ --recursive Uploads files recursively from the specified path.
486
+ --deploy-id <deploy-id> Specifies the deployment configuration ID for file operations.
487
+ --pull Downloads the specified file.
488
+ --force Forces the action, overriding any warnings or conflicts.
489
+ --storage-file-path <storage-file-path> Specifies a custom file storage path.
424
490
  -h, --help display help for command
425
491
 
426
492
  ```
@@ -430,19 +496,23 @@ Options:
430
496
  ```
431
497
  Usage: underpost test [options] [deploy-list]
432
498
 
433
- Manage Test, for default run current underpost default test
499
+ Manages and runs tests, defaulting to the current Underpost default test suite.
434
500
 
435
501
  Arguments:
436
- deploy-list Deploy id list, e.g. default-a,default-b
502
+ deploy-list A comma-separated list of deployment IDs (e.g.,
503
+ "default-a,default-b").
437
504
 
438
505
  Options:
439
- --itc Inside container execution context
440
- --sh Copy to clipboard, container entrypoint shell
441
- command
442
- --logs Display container logs
443
- --pod-name <pod-name>
444
- --pod-status <pod-status>
445
- --kind-type <kind-type>
506
+ --itc Executes tests within the container execution
507
+ context.
508
+ --sh Copies the container entrypoint shell command to
509
+ the clipboard.
510
+ --logs Displays container logs for test debugging.
511
+ --pod-name <pod-name> Optional: Specifies the pod name for test
512
+ execution.
513
+ --pod-status <pod-status> Optional: Filters tests by pod status.
514
+ --kind-type <kind-type> Optional: Specifies the Kind cluster type for
515
+ tests.
446
516
  -h, --help display help for command
447
517
 
448
518
  ```
@@ -452,20 +522,24 @@ Options:
452
522
  ```
453
523
  Usage: underpost monitor [options] <deploy-id> [env]
454
524
 
455
- Monitor health server management
525
+ Manages health server monitoring for specified deployments.
456
526
 
457
527
  Arguments:
458
- deploy-id Deploy configuration id
459
- env Optional environment, for default is development
528
+ deploy-id The deployment configuration ID to monitor.
529
+ env Optional: The environment to monitor (e.g.,
530
+ "development", "production"). Defaults to
531
+ "development".
460
532
 
461
533
  Options:
462
- --ms-interval <ms-interval> Custom ms interval delta time
463
- --now Exec immediately monitor script
464
- --single Disable recurrence
465
- --replicas <replicas> Set custom number of replicas
466
- --type <type> Set custom monitor type
467
- --sync Sync with current proxy deployments proxy
468
- traffic
534
+ --ms-interval <ms-interval> Sets a custom millisecond interval for
535
+ monitoring checks.
536
+ --now Executes the monitor script immediately.
537
+ --single Disables recurrence, running the monitor script
538
+ only once.
539
+ --replicas <replicas> Sets a custom number of replicas for monitoring.
540
+ --type <type> Sets a custom monitor type.
541
+ --sync Synchronizes with current proxy deployments and
542
+ traffic configurations.
469
543
  -h, --help display help for command
470
544
 
471
545
  ```
@@ -475,35 +549,73 @@ Options:
475
549
  ```
476
550
  Usage: underpost lxd [options]
477
551
 
478
- Lxd management
552
+ Manages LXD containers and virtual machines.
479
553
 
480
554
  Options:
481
- --init Init lxd
482
- --reset Reset lxd on current machine
483
- --install Install lxd on current machine
484
- --dev Set dev context env
485
- --create-virtual-network Create lxd virtual network bridge
486
- --create-admin-profile Create admin profile for lxd management
487
- --control set control node vm context
488
- --worker set worker node context
489
- --create-vm <vm-id> Create default virtual machines
490
- --init-vm <vm-id> Get init vm underpost script
491
- --info-vm <vm-id> Get all info vm
492
- --test <vm-id> Test health, status and network connectivity
493
- for a VM
494
- --root-size <gb-size> Set root size vm
495
- --k3s Flag to indicate K3s cluster type for VM
496
- initialization
497
- --join-node <nodes> Comma separated worker and control node e.
498
- g. k8s-worker-1,k8s-control
499
- --expose <vm-name-ports> Vm name and : separated with Comma separated
500
- vm port to expose e. g. k8s-control:80,443
501
- --delete-expose <vm-name-ports> Vm name and : separated with Comma separated
502
- vm port to remove expose e. g.
503
- k8s-control:80,443
504
- --auto-expose-k8s-ports <vm-id> Automatically expose common Kubernetes ports
505
- for the VM.
555
+ --init Initializes LXD on the current machine.
556
+ --reset Resets LXD on the current machine, deleting
557
+ all configurations.
558
+ --install Installs LXD on the current machine.
559
+ --dev Sets the development context environment for
560
+ LXD.
561
+ --create-virtual-network Creates an LXD virtual network bridge.
562
+ --create-admin-profile Creates an admin profile for LXD management.
563
+ --control Sets the context for a control node VM.
564
+ --worker Sets the context for a worker node VM.
565
+ --create-vm <vm-id> Creates default virtual machines with the
566
+ specified ID.
567
+ --init-vm <vm-id> Retrieves the Underpost initialization
568
+ script for the specified VM.
569
+ --info-vm <vm-id> Retrieves all information about the
570
+ specified VM.
571
+ --test <vm-id> Tests the health, status, and network
572
+ connectivity for a VM.
573
+ --root-size <gb-size> Sets the root partition size (in GB) for the
574
+ VM.
575
+ --k3s Flag to indicate that the VM initialization
576
+ is for a K3s cluster type.
577
+ --join-node <nodes> A comma-separated list of worker and control
578
+ nodes to join (e.g.,
579
+ "k8s-worker-1,k8s-control").
580
+ --expose <vm-name-ports> Exposes specified ports on a VM (e.g.,
581
+ "k8s-control:80,443"). Multiple VM-port
582
+ pairs can be comma-separated.
583
+ --delete-expose <vm-name-ports> Removes exposed ports on a VM (e.g.,
584
+ "k8s-control:80,443"). Multiple VM-port
585
+ pairs can be comma-separated.
586
+ --auto-expose-k8s-ports <vm-id> Automatically exposes common Kubernetes
587
+ ports for the specified VM.
506
588
  -h, --help display help for command
507
589
 
508
590
  ```
591
+
592
+
593
+ ### `baremetal` :
594
+ ```
595
+ Usage: underpost baremetal [options]
596
+
597
+ Manages baremetal server operations, including installation, database setup,
598
+ and user management.
599
+
600
+ Options:
601
+ --control-server-install Installs the baremetal control server.
602
+ --control-server-db-init Sets up the database for the baremetal control
603
+ server.
604
+ --control-server-db-uninstall Uninstalls the database for the baremetal
605
+ control server.
606
+ --control-server-init Initializes the baremetal control server.
607
+ --control-server-login Logs in as an administrator to the control
608
+ server.
609
+ --control-server-uninstall Uninstalls the baremetal control server.
610
+ --control-server-stop Stops the baremetal control server.
611
+ --control-server-start Starts the baremetal control server.
612
+ --get-users Retrieves a list of users from the control
613
+ server.
614
+ --new-api-key Generates a new API key for the control
615
+ server.
616
+ --dev Sets the development context environment for
617
+ baremetal operations.
618
+ -h, --help display help for command
619
+
620
+ ```
509
621