| Table of Contents |
|---|
Install
| Note |
|---|
All yarnman service install commands need to be run with sudo |
Install
ym-set-static-ip.sh
ym-generate-certs.sh
ym-install.sh
Upgrade
| Note |
|---|
All yarnman upgrade commands need to be run with sudo |
ym-upgrade.sh
| Info |
|---|
This command upgrades yarnman |
...
| Note |
|---|
A reboot may be required to apply OS patches if they are bundled into the update. |
Service Commands
| Note |
|---|
All yarnman service commands need to be run with sudo |
ym-service-commands.sh start
...
Note that the status-pm2 options will change based on the terminal/console width/resolution
ym-service-commands.sh
...
status-
...
docker
| Info |
|---|
This this command shows the scrolling output of yarnman services press CTRL+c to exit |
ym-service-commands.sh couchdb-logs
| Info |
|---|
This command shows the scrolling output of dabase logs press CTRL+c to exit |
docker container processes |
| Code Block |
|---|
sudo ym-service-commands.sh |
...
| Info |
|---|
This command shows the scrolling output of message bus logs press CTRL+c to exit |
ym-service-commands.sh tang-logs
| Info |
|---|
This command shows the scrolling output of NBE logs press CTRL+c to exit |
ym-service-commands.sh tang-thp
| Note |
|---|
Note that this command was previously ym-service-commands.sh tang-adv |
| Info |
|---|
This command shows the tag thp used for setting up configuration encryption |
| Code Block |
|---|
yarnman@ym-ph-test [ ~ ]$ sudo ym-service-commands.sh tang-adv
9_CZiwV9PKBlQfehPKZO7cd5ZpM |
ym-service-commands.sh update-jtapi
| Info |
|---|
This command updates jtapi for test_mate |
| Code Block |
|---|
PENDING |
...
status-docker
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
203da0dedf3b ym-local/ym-yarnman:ym-bbpatch-fcab0f3 "/bin/bash -c 'node …" 7 hours ago Up 7 hours (healthy) 0.0.0.0:80->80/tcp, :::80->80/tcp, 0/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp, 0.0.0.0:6700-6710->6700-6710/udp, :::6700-6710->6700-6710/udp ym-yarnman
edcca82fbcb8 localhost:5000/ym-couchdb:yl-ph-n18-cb516f8c "tini -- /docker-ent…" 7 hours ago Up 7 hours (healthy) 4369/tcp, 5984/tcp, 9100/tcp, 0.0.0.0:6984->6984/tcp, :::6984->6984/tcp ym-couchdb
8aee8553dec6 localhost:5000/ym-tang:yl-ph-n18-cb516f8c "/usr/local/bin/star…" 7 hours ago Up 7 hours (healthy) 6655/tcp, 0.0.0.0:6655->8080/tcp, :::6655->8080/tcp ym-tang
63b6e664ab62 localhost:5000/ym-redis:yl-ph-n18-cb516f8c "docker-entrypoint.s…" 7 hours ago Up 7 hours (healthy) 6379/tcp |
ym-service-commands.sh stats-docker
| Info |
|---|
this command shows the internal docker container resource utilisation |
| Code Block |
|---|
sudo ym-service-commands.sh stats-docker
CONTAINER ID NAME CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O PIDS
203da0dedf3b ym-yarnman 7.84% 1.472GiB / 4GiB 36.79% 112MB / 660MB 11.7MB / 0B 161
edcca82fbcb8 ym-couchdb 4.70% 194.9MiB / 6GiB 3.17% 7.87MB / 29.2MB 17.5MB / 6.46MB 61
8aee8553dec6 ym-tang 3.31% 804KiB / 128MiB 0.61% 2.15kB / 0B 0B / 0B 2
63b6e664ab62 ym-redis 0.56% 11.04MiB / 512MiB 2.16% 157MB / 70.8MB 0B / 0B 5 |
ym-service-commands.sh yarnman-logs
| Info |
|---|
This command shows the scrolling output of yarnman services press CTRL+c to exit |
ym-service-commands.sh couchdb-logs
| Info |
|---|
This command shows the scrolling output of dabase logs press CTRL+c to exit |
ym-service-commands.sh redis-logs
| Info |
|---|
This command shows the scrolling output of message bus logs press CTRL+c to exit |
ym-service-commands.sh tang-logs
| Info |
|---|
This command shows the scrolling output of NBE logs press CTRL+c to exit |
ym-service-commands.sh tang-thp
| Note |
|---|
Note that this command was previously ym-service-commands.sh tang-adv |
| Info |
|---|
This command shows the tag thp used for setting up configuration encryption |
| Code Block |
|---|
yarnman@ym-ph-test [ ~ ]$ sudo ym-service-commands.sh tang-adv
9_CZiwV9PKBlQfehPKZO7cd5ZpM |
ym-service-commands.sh update-jtapi
| Info |
|---|
This command updates jtapi for test_mate |
| Code Block |
|---|
PENDING |
ym-service-commands.sh update-jtapi-local
| Info |
|---|
This command updates jtapi for test_mate locally |
| Code Block |
|---|
PENDING |
ym-service-commands.sh stig-hardening-check
| Code Block |
|---|
PENDING |
ym-service-commands.sh stig-hardening-run
| Code Block |
|---|
PENDING |
ym-service-commands.sh show-tech-support
| Info |
|---|
This command provides an overview of the system for yarnlab tech support |
| Code Block |
|---|
sudo ym-service-commands.sh show-tech-support
YARNMAN SHOW TECH SUPPORT
YARNMAN HOSTNAME
ym-ph4-wxc
!! ommitted |
Edit Configuration Commands
| Note |
|---|
All yarnman edit config commands need to be run with sudo |
ym-edit-config.sh enable-local-admin-access
| Info |
|---|
This command enables local admin access on port 3999 |
| Code Block |
|---|
sudo ym-edit-config.sh enable-local-admin-access |
ym-edit-config.sh disable-local-admin-access
| Info |
|---|
This command disables local admin access on port 3999 |
| Code Block |
|---|
sudo ym-edit-config.sh disable-local-admin-access |
ym-edit-config.sh enable-local-couchdb-access
| Info |
|---|
This command enables couchdb access |
| Code Block |
|---|
sudo ym-edit-config.sh enable-local-couchdb-access |
ym-edit-config.sh disable-local-couchdb-access
| Info |
|---|
This command disables couchdb access |
| Code Block |
|---|
sudo ym-edit-config.sh disable-local-couchdb-access |
ym-edit-config.sh set-local-yarnman-container-name
| Info |
|---|
This command sets the container hostname for clustered systems |
| Code Block |
|---|
sudo ym-edit-config.sh set-local-yarnman-container-name |
ym-edit-config.sh unset-local-yarnman-container-name
| Info |
|---|
This command unsets the container hostname for clustered systems |
| Code Block |
|---|
sudo ym-edit-config.sh unset-local-yarnman-container-name |
ym-edit-config.sh enable-
...
yarnman-
...
logs
| Info |
|---|
This command enables local admin access on port 3999yarnman trace logs |
| Code Block |
|---|
PENDINGsudo ym-edit-config.sh enable-yarnman-logs |
ym-edit-config.sh disable-
...
yarnman-
...
logs
| Info |
|---|
This command disables local admin access on port 3999 |
| Code Block |
| PENDING enables yarnman debug logs (default) |
| Code Block |
|---|
sudo ym-edit-config.sh disable-yarnman-logs |
ym-edit-config.sh
...
set-
...
hw-
...
8vcpu-
...
16gb
| Info |
|---|
This command enables couchdb access |
| Code Block |
| PENDING allocates 8vcpu and 16gb ram which is required for large wrangler_ migrations |
| Code Block |
|---|
sudo ym-edit-config.sh set-hw-8vcpu-16gb |
ym-edit-config.sh
...
set-
...
hw-
...
default
| Info |
|---|
This command disables couchdb access |
| Code Block |
|---|
PENDING |
reverts the changes in ym-edit-config.sh set- |
...
hw- |
...
| Info |
|---|
This command sets the container hostname for clustered systems 8vcpu-16gb |
| Code Block |
|---|
PENDING |
sudo ym-edit-config.sh |
...
set- |
...
| Info |
|---|
This command unsets the container hostname for clustered systems |
| Code Block |
|---|
PENDINGhw-default |
ym-edit-config.sh
...
set-
...
custom-
...
motd
| Info |
|---|
This command enables yarnman trace logssets a custom MOTD |
| Code Block |
|---|
PENDING |
sudo ym-edit-config.sh |
...
set- |
...
| Info |
|---|
This command enables yarnman debug logs (default) |
| Code Block |
|---|
PENDINGcustom-motd |
Backup
ym-backup-setup.sh
Sets up the local backup service account on the yarnman node, and the passphrase used on the backup
...