Rhctl

rhctl

Script root

SCRIPT_ROOT = C:/Users/saidake/Desktop/DevProjects/rhctl/scripts

Absolute path to the repo’s scripts/ tree. Canonical scripts live only under $SCRIPT_ROOT. Do not copy them into this skill — always read the live file header before invoking or editing.

Put script path + args in one quoted --script value. Use --use-sudo when the script needs root/postgres. Prefer --identity when available; --password also covers sudo.

Commands

rhctl execute

Runs local Bash scripts and/or remote shell commands on a host.

rhctl execute \
  --host <host> \
  --user <user> \
  [--ssh-port <port>] \
  [--password <pass>] \
  [--identity <key>] \
  [--certificate <cert>] \
  [--script <script-or-cmdline> ...] \
  [--cmd <remote-command> ...] \
  [--env-extract-regex <regex> --env-name <KEY> --env-write-file <path>] \
  [--work-path <path>] \
  [--mode sync|async] \
  [--use-sudo] \
  [options]

Example (script with args + save DATABASE_URL):

rhctl execute \
  --host 192.168.75.129 \
  --user test99 \
  --password testpwd \
  --script "$SCRIPT_ROOT/postgresql/db.sh --action create --port 5432" \
  --env-extract-regex '\[INFO\][[:space:]]+DATABASE_URL=(.*)' \
  --env-name DB_URL \
  --env-write-file /etc/myapp/.env \
  --use-sudo

Example (direct command):

rhctl execute \
  --host 192.168.75.129 \
  --user root \
  --cmd "systemctl status nats" \
  --use-sudo

Required Parameters:

• --host, --user
• At least one of --script or --cmd

Optional Parameters:

• --cmd <command>: Remote shell command (no upload); repeatable
• --env-extract-regex + --env-name + --env-write-file: All three required together (no default env file); regexes/names pair by order with the same count. Last capture-group match on clean lines (skip \r) → upsert each key into --env-write-file (chmod 600; missing parent dirs created 700). Path must be absolute or ~/... (relative paths and critical system paths rejected); supports ${VAR}.
• --mode <sync|async>: sync (sequential) or async (concurrent) for scripts
• --work-path <path>: Remote working directory (default: ~)
• --password <password>: SSH password (also sudo / key passphrase fallback)
• --identity <path>: SSH private key (preferred over password)
• --certificate <path>: OpenSSH certificate (requires --identity)
• --ssh-port <port>: SSH port (default: 22)
• --use-sudo: Run with sudo (default: false)
• --use-rsync: Prefer rsync over scp (default: false)
• --silent: Auto-confirm overwrite/delete prompts (default: false)
• --connect-timeout <duration>: e.g. 20s, 5m, 1h
• --max-sessions-per-server <num> / --max-channels-per-session <num>
• --session-acquire-timeout <duration> / --max-session-lifetime <duration>
• --debug: Enable debug logging (default: info)

Path placeholders ${NAME} expand from the process environment.

rhctl upload

Upload files/directories via --transfer / --transfer-file, and/or merge .env files via --patch-env.

rhctl upload \
  --host <host> \
  --user <user> \
  [--transfer <local=remote-dir> ...] \
  [--transfer-file <file>] \
  [--patch-env <local=.env=remote-.env> ...] \
  [options]

Transfer format: <local-path>=<remote-directory> (RHS is a directory; created if missing).
Patch-env format: <local-.env>=<remote-.env> — local keys overwrite; remote-only keys kept; chmod 600.

At least one of --transfer / --transfer-file / --patch-env required.

rhctl upload \
  --host 192.168.75.128 \
  --user root \
  --patch-env /local/app.env=/etc/rhctl/.env \
  --use-sudo

Required Parameters:

• --host, --user
• At least one of --transfer, --transfer-file, or --patch-env

Optional Parameters: Same SSH / sudo / rsync / silent / timeout / session / --debug options as execute.

rhctl patch

Upload a local file, backup the remote target, then overwrite (or --recover from backup).

rhctl patch \
  --host <host> \
  --user <user> \
  --local-path <path> \
  --remote-upload <path> \
  --remote-path <path> \
  --remote-backup <path> \
  [--recover] \
  [options]

Required Parameters:

• --host, --user
• --local-path <path>: Local source file
• --remote-upload <path>: Remote upload destination
• --remote-path <path>: Remote target to patch
• --remote-backup <path>: Backup path before patch

Optional Parameters:

• --recover: Restore remote-path from remote-backup
• Same SSH / sudo / rsync / silent / timeout / session / --debug options as execute

rhctl run

Batch pipeline from YAML. Steps under runs: run in order; servers within a step run in parallel. A failed step aborts the rest.

rhctl run --config <yml-file-path> --config-name <name>

Required Parameters:

• --config <yml-file-path>
• --config-name <name>

Config shape: config-level target-servers / var-map, ordered runs: with type: transfer|execute|patch. Transfer accepts transfers / transfer-file / patch-envs. Execute accepts work-path (alias remote-path) and env-extract-regex + env-name + env-write-file (all three required together; no default env file).

For full YAML field details, read README.md (rhctl run section).

Scripts

$SCRIPT_ROOT/postgresql/install.sh

Install PostgreSQL (latest from PGDG) and ensure the service is running. Default port: 5432. If exists, skip.

rhctl execute \
  --host 192.168.75.128 \
  --user test99 \
  --password testpwd \
  --script "$SCRIPT_ROOT/postgresql/install.sh" \
  --use-sudo

Required Parameters: (none)
Optional Parameters: (none)
Override Parameters: (none)

$SCRIPT_ROOT/postgresql/configure.sh

Configure installed PostgreSQL for remote access (listen, port, pg_hba, firewall). Does not create DBs/roles — use db.sh --action create. If exists, overwrite.

rhctl execute \
  --host 192.168.75.128 \
  --user test99 \
  --password testpwd \
  --script "$SCRIPT_ROOT/postgresql/configure.sh --port 5432" \
  --use-sudo

Required Parameters: (none)

Optional Parameters:

• --port <port>: Listen port (default: 5432). Example: 5432, 5433, 48985
• --auth-method <method>: pg_hba auth (default: md5). Example: md5, scram-sha-256, password
• --allowed-ips <ip>[,<ip>...]: Remote allow-list; re-runs overwrite. When omitted, remote rules are cleared (local 127.0.0.1 / ::1 only). Example: 192.168.1.100, 10.0.0.5, 192.168.1.0/24, 0.0.0.0/0, ::/0

Override Parameters:

• RHCTL_PG_PORT, RHCTL_PG_AUTH_METHOD, RHCTL_PG_ALLOW_IPS — same as the flags above

$SCRIPT_ROOT/postgresql/db.sh

Manage databases and roles on an already-configured server.

• create — mint random DB + role + password; write state file; print URL
• list — list non-template databases and owners
• delete — drop a database and optionally its owner role

rhctl execute \
  --host 192.168.75.128 \
  --user test99 \
  --password testpwd \
  --script "$SCRIPT_ROOT/postgresql/db.sh --action create --port 5432" \
  --use-sudo

Parameters (common):

• --action <action>: create | list | delete | clear
• --port <port>: PostgreSQL port (default: 5432)

Parameters (create):

• --max-length: Use maximum lengths (DB/user name 63; password 72). Default: random length in range.
• Mints random DB/role/password with dense charsets within PostgreSQL limits. DATABASE_URL uses <host> as a placeholder.

Parameters (list):

• (none beyond common)

Parameters (delete):

• --db-name <name>: Database name (required)
• --user-name <name>: Role to drop (default: database owner)

Parameters (clear):

• (none beyond common) — drops all non-system DBs/roles; keeps postgres / template* / pg_*

Override Parameters:

• RHCTL_PG_PORT, RHCTL_PG_STATE_FILE, RHCTL_PG_MAX_LENGTH