Operations Overview
What Are You Trying to Do
| Task | Read |
|---|---|
| Turn on/off · Restart | Startup · Shutdown · Restart |
| Check status · Monitor | Monitoring |
| Backup · Recovery | Backup |
| Change password · key | Credentials |
| Diagnose when it doesn't work | Diagnostics |
| Handling by situation | Operational Scenarios |
| Manage containers directly | Container Operations |
| Tables · Schema | Database Model |
| High Availability | HA |
| Upgrade version | Upgrade |
| Disk cleanup | Cleanup |
This is a collection of operational scripts executed by the administrator (root) who accesses the gateway server via SSH. For general users, the web UI is sufficient, but operational tasks such as start / stop / backup / upgrade / fault diagnosis are performed using these scripts.
If systemctl is-active plantpulse-edge.service is active, it's container mode.
Instead of the native scripts on this page (bin/start.sh, etc.), use the Container Mode Operations page's
/opt/kopens/install/bin/*.sh commands. This page is for native deployment boxes only.
Installation path (native):
PE_HOME=/opt/kopens/plantpulse-edge
cd $PE_HOME/bin
ls *.sh # 어떤 스크립트가 있는지 확인
At a Glance
| Category | Script | Brief Description | Duration |
|---|---|---|---|
| Start | start.sh | Boots the gateway full stack | ~90–120 sec |
start-daemon.sh | start.sh as nohup background | Immediate | |
| Stop | stop.sh | Graceful stop per module (max 20 sec per component, incl. Cassandra drain) | ~60–90 sec |
| Restart | restart.sh | stop.sh + start.sh as a single process — full stack | ~150–210 sec |
restart-app.sh | Restart Tomcat (app) only — the "App Restart" button is this | 30–90 sec | |
reboot.sh | OS reboot | — | |
| Backup | backup.sh | Back up settings + DB snapshot + tool data all at once | Minutes |
| Upgrade | upgrade.sh | Backup → download/install new version | 5–15 min |
firmware.sh | OS package update (dnf update) | Minutes | |
| Diagnostics | log-viewer.sh | Integrated tail -f of 7 component logs | Indefinite |
ps.sh | Live plantpulse processes | Immediate | |
node-info.sh | nodetool info (Cassandra status) | Immediate | |
node-cql.sh | Cassandra cqlsh interactive | — | |
network-speed-test.sh | External network speed test | Minutes | |
| Cleanup | clean.sh | Bulk deletion of logs / temp files | Immediate |
node-cleanup.sh | Cassandra disk reclamation | Minutes | |
| Scenarios | — | New version deployment / fault diagnosis / disk full / regular backup / disaster recovery runbook | — |
In the development/deployment cycle, the one used nearly every time is restart-app.sh (app only, 30–90 sec). start.sh is used once after an OS reboot, and stop.sh is used only right before an inspection or backup.
Sub-Component's Own start.sh / stop.sh
The overall scripts (start.sh, stop.sh) only coordinate the sequence, and the internal implementation is handled by component-specific scripts. Call these directly when you want to restart just one:
| Component | Start | Stop |
|---|---|---|
| Redis (cache) | $PE_HOME/cache/bin/start.sh | $PE_HOME/cache/bin/stop.sh |
| Cassandra (DB) | $PE_HOME/db/bin/start.sh | $PE_HOME/db/bin/stop.sh |
| HiveMQ (MQTT) | $PE_HOME/mqtt/bin/start.sh | $PE_HOME/mqtt/bin/stop.sh |
| timeseries-engine | $PE_HOME/timeseries/engine/bin/start.sh | $PE_HOME/timeseries/engine/bin/stop.sh |
| timeseries-dashboard | $PE_HOME/timeseries/dashboard/bin/start.sh | $PE_HOME/timeseries/dashboard/bin/stop.sh |
| Tomcat (server) | $PE_HOME/server/bin/start.sh | $PE_HOME/server/bin/stop.sh |
| Node-RED | $PE_HOME/node/bin/start.sh | $PE_HOME/node/bin/stop.sh |
Example — restart Node-RED only:
$PE_HOME/node/bin/stop.sh
$PE_HOME/node/bin/start.sh
Permissions / Location Reference
- All scripts require root privileges (port 80/443 binding, systemctl, /opt/ writes).
- Directories:
| Purpose | Path |
|---|---|
| Gateway code / artifacts | /opt/kopens/plantpulse-edge/ |
| User data (sparkplug bdSeq, grafana, node-red, hivemq, apm) | /data1/pp-data/ |
| Backup artifacts | /data1/pp-backup/ |
| Tomcat logs | $PE_HOME/server/logs/catalina.out |
| Cassandra logs | $PE_HOME/db/logs/system.log |
| HiveMQ logs | $PE_HOME/mqtt/log/hivemq.log |
| Node-RED logs | $PE_HOME/node/log/node-red.log |
- Note: It is recommended to place
/opt/kopens/and/data1/pp-data/on separate disks. Separating code updates and data preservation reduces the risk of data loss during upgrade.
Learn More
- For detailed procedures in each category, see the Start / Stop / Restart / Backup / Upgrade / Diagnostics / Cleanup / Scenarios pages in the left menu.
- For usage of each script, refer to
--helpor the comments at the top of the script.