Operations Guide (`__PACKAGE_ARCH__`)

Install

./scripts/install.sh

The installer is idempotent:

existing .env is kept;
existing Docker/Compose installation is reused;
repeated loading of packaged runtime, metrics, Prometheus and Grafana images for the package architecture is safe;
existing data directory is reused;
matching host/package architecture is required by default.

Start

./scripts/start.sh

Start without waiting for the first snapshot:

./scripts/start.sh --no-wait-first-run

If you intentionally want to run this package on a different host architecture through QEMU/binfmt, first set:

ALLOW_CROSS_ARCH=1

Then rerun ./scripts/install.sh or ./scripts/self-check.sh, and only then will the scripts attempt to enable the matching binfmt handler.

Stop and Restart

./scripts/stop.sh
./scripts/restart.sh

Status Checks

./scripts/status.sh
./scripts/self-check.sh

Important checks:

Docker/Compose availability;
runtime, metrics, Prometheus and Grafana images exist;
HOST_DATA_DIR is writable;
Compose config is valid;
latest run status;
metrics, Prometheus and Grafana endpoints;
whether host_arch, package_arch, and arch_mode match expectations.

status.sh also prints:

package_arch
package_platform
runtime_image
metrics_image
allow_cross_arch
periodic_snapshot_reset
periodic_snapshot_max_deltas
rtr_report_dir
rtr_report_container_dir

To verify RTR report ingestion:

./scripts/register_rtr_monitor.sh --report-dir /root/rpki/report --dry-run
./scripts/register_rtr_monitor.sh --report-dir /root/rpki/report
./scripts/status.sh
curl -s "http://127.0.0.1:${METRICS_PORT:-9556}/metrics" | grep '^ours_rp_rtr_' | head

Registration accepts only an absolute directory on the same host. The command retains a timestamped .env backup and updates only the metrics, Prometheus, and Grafana sidecars; the ours-rp-soak container ID must remain unchanged.

Upgrade

Extract the new package into a new directory and explicitly reuse the existing .env through the upgrade script:

./scripts/upgrade.sh --reuse-env-from /path/to/old-installer/.env

If the new package directory already has a .env, the upgrade script keeps it.

If an older .env does not contain METRICS_IMAGE or METRICS_PLATFORM, the install/upgrade flow backfills package-matched defaults automatically.

Upgrade does not delete:

runs/
logs/
state/rsync-mirror
runtime configuration referenced by .env
Prometheus / Grafana data

To validate periodic forced snapshot behavior, temporarily set:

PERIODIC_SNAPSHOT_RESET=1
PERIODIC_SNAPSHOT_MAX_DELTAS=2

Then confirm the latest run-meta.json contains:

snapshot_reason=periodic_snapshot_delta_limit

And inspect the independent lifecycle state:

jq '{last_run,last_success_snapshot,successful_deltas_since_snapshot,state_health}' \
  "${HOST_DATA_DIR}/state/run-lifecycle-state.json"

After validation, restore:

PERIODIC_SNAPSHOT_MAX_DELTAS=100

Cleanup

./scripts/cleanup.sh --keep-runs 100
./scripts/cleanup.sh --keep-runs 100 --execute

Cleanup is dry-run by default. Add --execute after reviewing the output.

3.3 KiB Raw Blame History

Operations Guide (__PACKAGE_ARCH__)