You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1622 lines
54 KiB

  1. #!/bin/bash
  2. . /etc/shlib
  3. include common
  4. include parse
  5. include cmdline
  6. include config
  7. [[ "${BASH_SOURCE[0]}" != "${0}" ]] && SOURCED=true
  8. version=0.1
  9. desc='Manage 0k related installs'
  10. help=""
  11. ##
  12. ## Functions
  13. ##
  14. is-port-open() {
  15. local host="$1" port="$2" timeout=5
  16. start="$SECONDS"
  17. debug "Testing if $host's port $2 is open ..."
  18. while true; do
  19. timeout 1 bash -c "</dev/tcp/${host}/${port}" >/dev/null 2>&1 && break
  20. sleep 0.2
  21. if [ "$((SECONDS - start))" -gt "$timeout" ]; then
  22. return 1
  23. fi
  24. done
  25. debug " .. $host's port $2 is open."
  26. return 0
  27. }
  28. resolve() {
  29. local ent hostname="$1"
  30. debug "Resolving $1 ..."
  31. if ent=$(getent ahosts "$hostname"); then
  32. ent=$(echo "$ent" | egrep ^"[0-9]+.[0-9]+.[0-9]+.[0-9]+\s+" | \
  33. head -n 1 | awk '{ print $1 }')
  34. debug " .. resolved $1 to $ent."
  35. echo "$ent"
  36. else
  37. debug " .. couldn't resolve $1."
  38. return 1
  39. fi
  40. }
  41. set_errlvl() { return "${1:-1}"; }
  42. export master_pid=$$
  43. ssh:open() {
  44. local hostname ssh_cmd ssh_options
  45. ssh_cmd=(ssh)
  46. ssh_options=()
  47. while [ "$#" != 0 ]; do
  48. case "$1" in
  49. "--stdin-password")
  50. ssh_cmd=(sshpass "${ssh_cmd[@]}")
  51. ;;
  52. -o)
  53. ssh_options+=("$1" "$2")
  54. shift
  55. ;;
  56. *)
  57. [ -z "$hostname" ] && hostname="$1" || {
  58. err "Surnumerous positional argument '$1'. Expecting only hostname."
  59. return 1
  60. }
  61. ;;
  62. esac
  63. shift
  64. done
  65. full_cmd=(
  66. "${ssh_cmd[@]}"
  67. -o ControlPath=/tmp/ssh-control-master-${master_pid}-$hostname \
  68. -o ControlMaster=auto -o ControlPersist=900 \
  69. -o ConnectTimeout=5 -o StrictHostKeyChecking=no \
  70. "${ssh_options[@]}" \
  71. "$hostname" "$@" -- true)
  72. "${full_cmd[@]}" >/dev/null 2>&1 || {
  73. err "Failed: ${full_cmd[*]}"
  74. return 1
  75. }
  76. trap_add EXIT,INT 'ssh:quit "$hostname"'
  77. }
  78. ssh:rsync() {
  79. local src="$1" dst="$2"
  80. hostname=${src%%:*}
  81. hostname=${hostname#*@}
  82. local rsync_ssh_options=(
  83. -o ControlPath="/tmp/ssh-control-master-${master_pid}-$hostname"
  84. -o ControlMaster=auto
  85. -o ControlPersist=900
  86. -o ConnectTimeout=10
  87. -o StrictHostKeyChecking=no
  88. )
  89. if ! ssh:run "root@$hostname" -- type -p rsync </dev/null >/dev/null; then
  90. info "No 'rsync' available on '$hostname'. Requesting installation..."
  91. ssh:run "root@$hostname" -- apt-get install rsync -y || {
  92. err "Installation of 'rsync' failed on '$hostname'"
  93. return 1
  94. }
  95. fi
  96. local cmd=(
  97. rsync -e "ssh ${rsync_ssh_options[*]}"
  98. -azvArH --delete --delete-excluded
  99. --partial --partial-dir .rsync-partial
  100. "$src" "$dst"
  101. )
  102. "${cmd[@]}"
  103. }
  104. ssh:open-try() {
  105. local opts hostnames
  106. opts=()
  107. hostnames=()
  108. while [ "$#" != 0 ]; do
  109. case "$1" in
  110. -o)
  111. opts+=("$1" "$2")
  112. shift
  113. ;;
  114. *)
  115. hostnames+=("$1")
  116. ;;
  117. esac
  118. shift
  119. done
  120. password=''
  121. for host in "${hostnames[@]}"; do
  122. debug "Trying $host with publickey."
  123. ssh:open -o PreferredAuthentications=publickey \
  124. "${opts[@]}" \
  125. "$host" >/dev/null 2>&1 && {
  126. echo "$host"$'\n'"$password"$'\n'
  127. return 0
  128. }
  129. debug " .. failed connecting to $host with publickey."
  130. done
  131. local times=0 password
  132. while [ "$((++times))" -le 3 ]; do
  133. read -sp "$HOST's password: " password
  134. errlvl="$?"
  135. echo >&2
  136. if [ "$errlvl" -gt 0 ]; then
  137. exit 1
  138. fi
  139. for host in "${hostnames[@]}"; do
  140. debug "Trying $host with password ($times/3)"
  141. echo "$password" | ssh:open -o PreferredAuthentications=password \
  142. --stdin-password \
  143. "${opts[@]}" \
  144. "$host" >/dev/null 2>&1 && {
  145. echo "$host"$'\n'"$password"$'\n'
  146. return 0
  147. }
  148. debug " .. failed connecting to $host with password."
  149. done
  150. err "login failed. Try again... ($((times+1))/3)"
  151. done
  152. return 1
  153. }
  154. ssh:run() {
  155. local hostname="$1" ssh_options cmd
  156. shift
  157. ssh_options=()
  158. cmd=()
  159. while [ "$#" != 0 ]; do
  160. case "$1" in
  161. "--")
  162. shift
  163. cmd+=("$@")
  164. break
  165. ;;
  166. *)
  167. ssh_options+=("$1")
  168. ;;
  169. esac
  170. shift
  171. done
  172. ## XXXvlab: keeping in case we need some debug
  173. # debug "$DARKCYAN$hostname$NORMAL $WHITE\$$NORMAL" "$@"
  174. # debug "Running cmd: ${cmd[*]}"
  175. # for arg in "${cmd[@]}"; do
  176. # debug "$arg"
  177. # done
  178. {
  179. {
  180. ssh -o ControlPath=/tmp/ssh-control-master-${master_pid}-$hostname \
  181. -o ControlMaster=auto -o ControlPersist=900 \
  182. -o "StrictHostKeyChecking=no" \
  183. "${ssh_options[@]}" "$hostname" -- "${cmd[@]}"
  184. } 3>&1 1>&2 2>&3 ## | sed -r "s/^/$DARKCYAN$hostname$NORMAL $DARKRED\!$NORMAL /g"
  185. set_errlvl "${PIPESTATUS[0]}"
  186. } 3>&1 1>&2 2>&3
  187. }
  188. ssh:quit() {
  189. local hostname="$1"
  190. shift
  191. ssh -o ControlPath=/tmp/ssh-control-master-${master_pid} \
  192. -o ControlMaster=auto -o ControlPersist=900 -O exit \
  193. "$hostname" 2>/dev/null
  194. }
  195. is_ovh_domain_name() {
  196. local domain="$1"
  197. [[ "$domain" == *.ovh.net ]] && return 0
  198. [[ "$domain" == "ns"*".ip-"*".eu" ]] && return 0
  199. return 1
  200. }
  201. is_ovh_hostname() {
  202. local domain="$1"
  203. [[ "$domain" =~ ^vps-[0-9a-f]*$ ]] && return 0
  204. [[ "$domain" =~ ^vps[0-9]*$ ]] && return 0
  205. return 1
  206. }
  207. vps_connection_check() {
  208. local vps="$1"
  209. ip=$(resolve "$vps") ||
  210. { echo "${DARKRED}no-resolve${NORMAL}"; return 1; }
  211. is-port-open "$ip" "22" </dev/null ||
  212. { echo "${DARKRED}no-port-22-open${NORMAL}"; return 1; }
  213. ssh:open -o ConnectTimeout=10 -o PreferredAuthentications=publickey \
  214. "root@$vps" >/dev/null 2>&1 ||
  215. { echo "${DARKRED}no-ssh-root-access${NORMAL}"; return 1; }
  216. }
  217. vps_check() {
  218. local vps="$1"
  219. vps_connection_check "$vps" </dev/null || return 1
  220. if size=$(
  221. echo "df /srv -h | tail -n +2 | sed -r 's/ +/ /g' | cut -f 5 -d ' ' | cut -f 1 -d %" |
  222. ssh:run "root@$vps" -- bash); then
  223. if [ "$size" -gt "90" ]; then
  224. echo "${DARKRED}above-90%-disk-usage${NORMAL}"
  225. elif [ "$size" -gt "75" ]; then
  226. echo "${DARKYELLOW}above-75%-disk-usage${NORMAL}"
  227. fi
  228. else
  229. echo "${DARKRED}no-size${NORMAL}"
  230. fi </dev/null
  231. compose_content=$(ssh:run "root@$vps" -- cat /opt/apps/myc-deploy/compose.yml </dev/null) ||
  232. { echo "${DARKRED}no-compose${NORMAL}"; return 1; }
  233. echo "$compose_content" | grep backup >/dev/null 2>&1 ||
  234. { echo "${DARKRED}no-backup${NORMAL}"; return 1; }
  235. }
  236. backup:setup-rsync() {
  237. local admin="$1" vps="$2" server="$3" id="$4"
  238. [ -z "${BACKUP_SSH_SERVER}" ] || {
  239. err "Unexpected error: '\$BACKUP_SSH_SERVER' is already set in '$FUNCNAME'."
  240. return 1
  241. }
  242. BACKUP_SSH_OPTIONS=(-o StrictHostKeyChecking=no)
  243. if [[ "$server" == *":"* ]]; then
  244. BACKUP_SSH_OPTIONS+=(-p "${server#*:}")
  245. BACKUP_SSH_SERVER=${server%%:*}
  246. else
  247. BACKUP_SSH_SERVER="$server"
  248. fi
  249. if ! private_key=$(ssh "${BACKUP_SSH_OPTIONS[@]}" \
  250. "$admin"@"${BACKUP_SSH_SERVER}" request-recovery-key "$id"); then
  251. err "Couldn't request a recovery key for '$id' with account '$admin'."
  252. return 1
  253. fi
  254. if ! VPS_TMP_DIR=$(echo "mktemp -d" | ssh:run "root@$vps" -- bash); then
  255. err "Couldn't create a temporary directory on vps"
  256. return 1
  257. fi
  258. cat <<EOF | ssh:run "root@$vps" -- bash || return 1
  259. touch "$VPS_TMP_DIR/recover_key" &&
  260. chmod go-rwx "$VPS_TMP_DIR/recover_key" &&
  261. printf "%s\n" "$private_key" >> "$VPS_TMP_DIR/recover_key"
  262. EOF
  263. BACKUP_SSH_OPTIONS+=(-i "$VPS_TMP_DIR/recover_key" -l rsync)
  264. BACKUP_VPS_TARGET="$vps"
  265. BACKUP_IDENT="$id"
  266. echo "type -p rsync >/dev/null 2>&1 || apt-get install -y rsync </dev/null" |
  267. ssh:run "root@$vps" -- bash || return 1
  268. }
  269. backup:rsync() {
  270. local ssh_options
  271. [ -n "${BACKUP_SSH_SERVER}" ] || {
  272. err "Unexpected error: '\$BACKUP_SSH_SERVER' is not set in 'rsync_exists'."
  273. return 1
  274. }
  275. rsync_options=()
  276. while [[ "$1" == "-"* ]]; do
  277. rsync_options+=("$1")
  278. shift
  279. done
  280. local src="$1" dst="$2"
  281. cat <<EOF | ssh:run "root@${BACKUP_VPS_TARGET}" -- bash
  282. rsync -e "ssh ${BACKUP_SSH_OPTIONS[*]}" \
  283. -azvArH --delete --delete-excluded \
  284. --partial --partial-dir .rsync-partial \
  285. --numeric-ids ${rsync_options[*]} \
  286. "${BACKUP_SSH_SERVER}":/var/mirror/"${BACKUP_IDENT}${src}" "${dst}"
  287. EOF
  288. }
  289. backup:path_exists() {
  290. local src="$1"
  291. [ -n "${BACKUP_SSH_SERVER}" ] || {
  292. err "Unexpected error: '\$BACKUP_SSH_SERVER' is not set in 'rsync_exists'."
  293. return 1
  294. }
  295. cat <<EOF | ssh:run "root@${BACKUP_VPS_TARGET}" -- bash >/dev/null 2>&1
  296. rsync -e "ssh ${BACKUP_SSH_OPTIONS[*]}" \
  297. -nazvArH --numeric-ids \
  298. "${BACKUP_SSH_SERVER}":/var/mirror/"${BACKUP_IDENT}${src}" "/tmp/dummy"
  299. EOF
  300. }
  301. file:vps_backup_recover() {
  302. local admin="$1" server="$2" id="$3" path="$4" vps="$5" vps_path="$6"
  303. backup:rsync "${path}" "${vps_path}" || return 1
  304. if [[ "$path" == *"/" ]]; then
  305. if [ "$path" == "$vps_path"/ ]; then
  306. msg_target="Directory '$path'"
  307. else
  308. msg_target="Directory '$path' -> '$vps_path'"
  309. fi
  310. else
  311. if [ "$path" == "$vps_path" ]; then
  312. msg_target="File '$path'"
  313. else
  314. msg_target="File '$path' -> '$vps_path'"
  315. fi
  316. fi
  317. info "$msg_target was ${GREEN}successfully${NORMAL} restored on $vps."
  318. }
  319. mailcow:vps_backup_recover() {
  320. local admin="$1" server="$2" id="$3" path="$4" vps="$5" vps_path="$6"
  321. if ! compose_yml_files=$(cat <<EOF | ssh:run "root@$vps" -- bash
  322. urn=com.docker.compose.project
  323. docker ps -f "label=\$urn=mailcowdockerized" \
  324. --format="{{.Label \"\$urn.working_dir\"}}/{{.Label \"\$urn.config_files\"}}" |
  325. uniq
  326. EOF
  327. ); then
  328. err "Couldn't get list of running projects"
  329. return 1
  330. fi
  331. stopped_containers=
  332. if [ -n "$compose_yml_files" ]; then
  333. echo "Found running mailcowdockerized containers" >&2
  334. if [[ "$compose_yml_files" == *$'\n'* ]]; then
  335. err "Running containers are confusing, did not find only one mailcowdockerized project."
  336. return 1
  337. fi
  338. if ! echo "[ -e \"$compose_yml_files\" ]" | ssh:run "root@$vps" -- bash ; then
  339. ## For some reason, sometimes $urn.config_files holds an absolute path
  340. compose_yml_files=/${compose_yml_files#*//}
  341. if ! echo "[ -e \"$compose_yml_files\" ]" | ssh:run "root@$vps" -- bash ; then
  342. err "Running containers are confusing, they don't point to an existing docker-compose.yml."
  343. return 1
  344. fi
  345. fi
  346. echo "Containers where launched from '$compose_yml_files'" >&2
  347. COMPOSE_FILE="$compose_yml_files"
  348. ENV_FILE="${COMPOSE_FILE%/*}/.env"
  349. if ! echo "[ -e \"${ENV_FILE}\" ]" | ssh:run "root@$vps" -- bash ; then
  350. err "Running containers are confusing, docker-compose.yml has no '.env' next to it."
  351. return 1
  352. fi
  353. echo "${WHITE}Bringing mailcowdockerized down${NORMAL}"
  354. echo "docker-compose -f \"${COMPOSE_FILE}\" --env-file \"${ENV_FILE}\" down" |
  355. ssh:run "root@$vps" -- bash
  356. stopped_containers=1
  357. fi
  358. if [[ "$path" == "/"* ]]; then
  359. ##
  360. ## Additional intelligence to simple file copy
  361. ##
  362. if [[ "$path" == "/var/lib/docker/volumes/mailcowdockerized_*-vol-1/_data"* ]]; then
  363. volume_name=${path#/var/lib/docker/volumes/}
  364. volume_name=${volume_name%%/*}
  365. volume_dir=${path%%"$volume_name"*}
  366. ## Create volumes if not existent
  367. if ! ssh:run "root@$vps" -- "
  368. [ -d '${volume_dir}' ] ||
  369. docker run --rm -v ${volume_name}:/tmp/dummy docker.0k.io/alpine:3.9
  370. [ -d '${volume_dir}' ]
  371. "; then
  372. err "Couldn't find nor create '${volume_dir}'."
  373. return 1
  374. fi
  375. fi
  376. echo "${WHITE}Sync from backup ${path} to VPS ${vps_path}${NORMAL}" >&2
  377. backup:rsync "${path}" "${vps_path}" || return 1
  378. if [[ "$path" == *"/" ]]; then
  379. if [ "$path" == "$vps_path"/ ]; then
  380. msg_target="Directory '$path'"
  381. else
  382. msg_target="Directory '$path' -> '$vps_path'"
  383. fi
  384. else
  385. if [ "$path" == "$vps_path" ]; then
  386. msg_target="File '$path'"
  387. else
  388. msg_target="File '$path' -> '$vps_path'"
  389. fi
  390. fi
  391. else
  392. ALL_TARGETS=(mailcow postfix rspamd redis crypt vmail{,-attachments} mysql)
  393. if [[ -n "$path" ]]; then
  394. targets=()
  395. bad_targets=()
  396. for target in ${path//,/ }; do
  397. if [[ " ${ALL_TARGETS[*]} " != *" $target "* ]]; then
  398. bad_targets+=("$target")
  399. fi
  400. targets+=("$target")
  401. done
  402. if [ "${#bad_targets[@]}" -gt 0 ]; then
  403. bad_target_msg=$(printf "%s, " "${bad_targets[@]}")
  404. err "Unknown components: ${bad_target_msg%, }. These are allowed components:"
  405. printf " - %s\n" "${ALL_TARGETS[@]}" >&2
  406. return 1
  407. fi
  408. msg_target="Partial mailcow backup"
  409. else
  410. targets=("${ALL_TARGETS[@]}")
  411. msg_target="Full mailcow backup"
  412. fi
  413. for target in "${targets[@]}"; do
  414. case "$target" in
  415. postfix|rspamd|redis|crypt|vmail|vmail-attachments)
  416. volume_name="mailcowdockerized_${target}-vol-1"
  417. volume_dir="/var/lib/docker/volumes/${volume_name}/_data"
  418. if ! backup:path_exists "${volume_dir}/"; then
  419. warn "No '$volume_name' in backup. This might be expected."
  420. continue
  421. fi
  422. ## Create volumes if not existent
  423. if ! ssh:run "root@$vps" -- "
  424. [ -d '${volume_dir}' ] ||
  425. docker run --rm -v ${volume_name}:/tmp/dummy docker.0k.io/alpine:3.9
  426. [ -d '${volume_dir}' ]
  427. "; then
  428. err "Couldn't find nor create '${volume_dir}'."
  429. return 1
  430. fi
  431. echo "${WHITE}Downloading of $volume_name${NORMAL}"
  432. backup:rsync "${volume_dir}/" "${volume_dir}" || return 1
  433. ;;
  434. mailcow)
  435. ## Mailcow git base
  436. COMPOSE_FILE=
  437. for mailcow_dir in /opt/{apps/,}mailcow-dockerized; do
  438. backup:path_exists "${mailcow_dir}/" || continue
  439. ## this possibly change last value
  440. COMPOSE_FILE="$mailcow_dir/docker-compose.yml"
  441. ENV_FILE="$mailcow_dir/.env"
  442. echo "${WHITE}Download of $mailcow_dir${NORMAL}"
  443. backup:rsync "${mailcow_dir}"/ "${mailcow_dir}" || return 1
  444. break
  445. done
  446. if [ -z "$COMPOSE_FILE" ]; then
  447. err "Can't find mailcow base installation path in backup."
  448. return 1
  449. fi
  450. ;;
  451. mysql)
  452. if [ -z "$COMPOSE_FILE" ]; then
  453. ## Mailcow git base
  454. compose_files=()
  455. for mailcow_dir in /opt/{apps/,}mailcow-dockerized; do
  456. ssh:run "root@$vps" -- "[ -e \"$mailcow_dir/docker-compose.yml\" ]" || continue
  457. ## this possibly change last value
  458. compose_files+=("$mailcow_dir/docker-compose.yml")
  459. done
  460. if [ "${#compose_files[@]}" == 0 ]; then
  461. err "No compose file found for mailcow installation."
  462. return 1
  463. elif [ "${#compose_files[@]}" -gt 1 ]; then
  464. err "Multiple compose files for mailcow found:"
  465. for f in "${compose_files[@]}"; do
  466. echo " - $f" >&2
  467. done
  468. echo "Can't decide which to use for mounting mysql container." >&2
  469. return 1
  470. fi
  471. COMPOSE_FILE="${compose_files[0]}"
  472. ENV_FILE="${COMPOSE_FILE%/*}/.env"
  473. if ! ssh:run "root@$vps" -- "[ -e \"${COMPOSE_FILE%/*}/.env\" ]"; then
  474. err "No env file in '$ENV_FILE' found."
  475. return 1
  476. fi
  477. fi
  478. ## Mysql database
  479. echo "${WHITE}Downloading last backup of mysql backups${NORMAL}"
  480. backup:rsync "/var/backups/mysql/" "/var/backups/mysql" || return 1
  481. if ! env_content=$(echo "cat '$ENV_FILE'" | ssh:run "root@$vps" -- bash); then
  482. err "Can't access env file: '$ENV_FILE'."
  483. return 1
  484. fi
  485. root_password=$(printf "%s\n" "$env_content" | grep ^DBROOT= | cut -f 2 -d =)
  486. echo "${WHITE}Bringing mysql-mailcow up${NORMAL}"
  487. if ! image=$(cat <<EOF | ssh:run "root@$vps" -- bash
  488. shyaml get-value services.mysql-mailcow.image < "${COMPOSE_FILE}"
  489. EOF
  490. ); then
  491. err "Failed to get image name of service 'mysql-mailcow' in 'compose.yml'."
  492. return 1
  493. fi
  494. if [ -z "$(ssh:run "root@$vps" -- docker images -q "$image")" ]; then
  495. info "Image '$image' not available, pull it."
  496. if ! ssh:run "root@$vps" -- \
  497. docker-compose -f "${COMPOSE_FILE}" --env-file "${ENV_FILE}" \
  498. pull mysql-mailcow; then
  499. err "Failed to pull image of service 'mysql-mailcow'."
  500. return 1
  501. fi
  502. fi
  503. if ! container_id=$(cat <<EOF | ssh:run "root@$vps" -- bash
  504. echo "[client]
  505. password=$root_password" > "$VPS_TMP_DIR/my.cnf"
  506. docker-compose -f "${COMPOSE_FILE}" --env-file "${ENV_FILE}" \
  507. run -d \
  508. -v "$VPS_TMP_DIR/my.cnf:/root/.my.cnf:ro" \
  509. mysql-mailcow
  510. EOF
  511. ); then
  512. err "Failed to bring up mysql-mailcow"
  513. return 1
  514. fi
  515. START="$SECONDS"
  516. retries=0
  517. timeout=600
  518. while true; do
  519. ((retries++))
  520. echo " waiting for mysql db..." \
  521. "(retry $retries, $(($SECONDS - $START))s elapsed, timeout is ${timeout}s)" >&2
  522. cat <<EOF | ssh:run "root@$vps" -- bash && break
  523. echo "SELECT 1;" | docker exec -i "$container_id" mysql >/dev/null 2>&1
  524. EOF
  525. if (($SECONDS - $START > $timeout)); then
  526. err "Failed to connect to mysql-mailcow."
  527. echo "docker-compose -f \"${COMPOSE_FILE}\" --env-file \"${ENV_FILE}\" down" |
  528. ssh:run "root@$vps" -- bash
  529. return 1
  530. fi
  531. sleep 0.4
  532. done
  533. DBUSER=$(printf "%s\n" "$env_content" | grep ^DBUSER= | cut -f 2 -d =)
  534. DBPASS=$(printf "%s\n" "$env_content" | grep ^DBPASS= | cut -f 2 -d =)
  535. echo "${WHITE}Uploading mysql dump${NORMAL}"
  536. cat <<EOF | ssh:run "root@$vps" -- bash
  537. echo "
  538. DROP DATABASE IF EXISTS mailcow;
  539. CREATE DATABASE mailcow;
  540. GRANT ALL PRIVILEGES ON mailcow.* TO '$DBUSER'@'%' IDENTIFIED BY '$DBPASS';
  541. " | docker exec -i "$container_id" mysql
  542. zcat /var/backups/mysql/mailcow/*.gz | docker exec -i "$container_id" mysql mailcow
  543. EOF
  544. if [ "$?" != 0 ]; then
  545. err "Failed to load mysql dump."
  546. echo "docker-compose -f \"${COMPOSE_FILE}\" --env-file \"${ENV_FILE}\" down" |
  547. ssh:run "root@$vps" -- bash
  548. return 1
  549. fi
  550. echo "${WHITE}Bringing mysql-mailcow down${NORMAL}"
  551. echo "docker-compose -f \"${COMPOSE_FILE}\" --env-file \"${ENV_FILE}\" down" |
  552. ssh:run "root@$vps" -- bash
  553. ;;
  554. *)
  555. err "Unknown component '$target'. Bailing out."
  556. return 1
  557. esac
  558. done
  559. ssh:run "root@$vps" -- "rm -rf '$VPS_TMP_DIR'"
  560. fi
  561. if [ -n "$stopped_containers" ]; then
  562. echo "${WHITE}Starting mailcow${NORMAL}" >&2
  563. echo "docker-compose -f \"${COMPOSE_FILE}\" --env-file \"${ENV_FILE}\" up -d" |
  564. ssh:run "root@$vps" -- bash
  565. fi
  566. info "$msg_target was ${GREEN}successfully${NORMAL} restored on $vps."
  567. }
  568. vps_backup_recover() {
  569. local vps="$1" admin server id path rtype force type
  570. read-0 admin server id path rtype force
  571. if [[ "$vps" == *":"* ]]; then
  572. vps_path=${vps#*:}
  573. vps=${vps%%:*}
  574. else
  575. vps_path=
  576. fi
  577. vps_connection_check "$vps" </dev/null || {
  578. err "Failed to access '$vps'."
  579. return 1
  580. }
  581. if type=$(ssh:run "root@$vps" -- vps get-type); then
  582. info "VPS $vps seems to be of ${WHITE}$type${NORMAL} type"
  583. else
  584. warn "Couldn't find type of vps '$vps' (command 'vps get-type' failed on vps)."
  585. fi
  586. if [ -z "$path" ]; then
  587. if [ -n "$vps_path" ]; then
  588. err "You can't provide a VPS with path as destination if you don't provide a path in backup source."
  589. return 1
  590. fi
  591. info "No path provided in backup, so we assume you want ${WHITE}full recovery${NORMAL}."
  592. if [ "$rtype" != "$type" ]; then
  593. if [ -n "$force" ]; then
  594. warn "Backup found is of ${rtype:-unknown} type, while vps is of ${type:-unknown} type."
  595. else
  596. err "Backup found is of ${rtype:-unknown} type, while vps is of ${type:-unknown} type. (use \`\`-f\`\` to force)"
  597. return 1
  598. fi
  599. fi
  600. else
  601. if [ "$path" == "/" ]; then
  602. if [ -z "$vps_path" ]; then
  603. err "Recovery of '/' (full backup files) requires that you provide a vps path also."
  604. return 1
  605. fi
  606. if [ "$vps_path" == "/" ]; then
  607. err "Recovery of '/' (full backup files) requires that you provide" \
  608. "a vps path different from '/' also."
  609. return 1
  610. fi
  611. fi
  612. fi
  613. ## Sets VPS and internal global variable to allow rsync to work
  614. ## from vps to backup server.
  615. backup:setup-rsync "$admin" "$vps" "$server" "$id" || return 1
  616. if [[ "$path" == "/"* ]]; then
  617. if ! backup:path_exists "${path}"; then
  618. err "File or directory '$path' not found in backup."
  619. return 1
  620. fi
  621. if [ -z "$vps_path" ]; then
  622. if [[ "$path" != *"/" ]] && backup:path_exists "${path}"/ ; then
  623. path="$path/"
  624. fi
  625. vps_path=${path%/}
  626. vps_path=${vps_path:-/}
  627. fi
  628. fi
  629. case "$rtype-$type" in
  630. mailcow-*)
  631. ## Supports having $path and $vps_path set or unset, with additional behavior
  632. mailcow:vps_backup_recover "$admin" "$server" "$id" "$path" "$vps" "$vps_path"
  633. ;;
  634. *-*)
  635. if [[ "$path" == "/"* ]]; then
  636. ## For now, will require having $path and $vps_path set, no additional behaviors
  637. file:vps_backup_recover "$admin" "$server" "$id" "$path" "$vps" "$vps_path"
  638. else
  639. if [ -n "$path" ]; then
  640. err "Partial component recover of ${rtype:-unknown} backup type on" \
  641. "${type:-unknown} type VPS is not yet implemented."
  642. return 1
  643. else
  644. err "Full recover of ${rtype:-unknown} backup type on" \
  645. "${type:-unknown} type VPS is not yet implemented."
  646. return 1
  647. fi
  648. fi
  649. ;;
  650. esac
  651. }
  652. vps_install_backup() {
  653. local vps="$1" admin server
  654. vps_connection_check "$vps" </dev/null || return 1
  655. read-0 admin server
  656. if ! type=$(ssh:run "root@$vps" -- vps get-type </dev/null); then
  657. err "Could not get type."
  658. return 1
  659. fi
  660. backup_opts=()
  661. local opt
  662. while read-0 opt; do
  663. case "$opt" in
  664. --ignore-domain-check|--ignore-ping-check)
  665. backup_opts+=("$opt")
  666. ;;
  667. *)
  668. err "Unknown option '$opt'."
  669. return 1
  670. ;;
  671. esac
  672. done
  673. if ! out=$(ssh:run "root@$vps" -- vps install backup "$server" "${backup_opts[@]}" 2>&1); then
  674. err "Command 'vps install backup $server ${backup_opts[@]}' on $vps failed:"
  675. echo "$out" | prefix " ${DARKGRAY}|${NORMAL} " >&2
  676. return 1
  677. fi
  678. ## Format of output:
  679. ##
  680. ## II Entry for service rsync-backup is already present in '/opt/apps/myc-deploy/compose.yml'.
  681. ## II You can run this following command from an host having admin access to core-07.0k.io:
  682. ## (Or send it to a backup admin of core-07.0k.io)
  683. ## ssh -p 10023 myadmin@core-07.0k.io ssh-key add 'ssh-rsa AAAAAAAD...QCJ\
  684. ## 8HH6pVgEpu1twyxpr9xTt7eh..WaJdgPoxmiEwGfjMMNGxs39ggOTKUuSFSmOv8TiA1fzY\
  685. ## s85hF...dKP1qByJU1k= compose@odoo.sikle.fr'
  686. key="ssh-rsa ${out##*\'ssh-rsa }" ## remove everything before last "'ssh-rsa"
  687. key="${key%\'*}" ## remove everything after last '
  688. if ! [[ "$key" =~ ^"ssh-rsa "[a-zA-Z0-9/+=]+" "[a-zA-Z0-9._-]+"@"[a-zA-Z0-9._-]+$ ]]; then
  689. err "Unexpected output from 'vps install backup $server'. Can't find key."
  690. echo "$out" | prefix " ${GRAY}|$NORMAL " >&2
  691. echo " Extracted key:" >&2
  692. echo "$key" | prefix " ${GRAY}|$NORMAL " >&2
  693. return 1
  694. fi
  695. if [ "$type" == "compose" ]; then
  696. if ! ssh:run "root@$vps" -- \
  697. docker exec myc_cron_1 \
  698. cat /etc/cron.d/rsync-backup >/dev/null 2>&1; then
  699. ssh:run "root@$vps" -- compose --debug up || {
  700. err "Command 'compose --debug up' failed."
  701. return 1
  702. }
  703. if ! ssh:run "root@$vps" -- \
  704. docker exec myc_cron_1 \
  705. cat /etc/cron.d/rsync-backup >/dev/null 2>&1; then
  706. err "Launched 'compose up' successfully but ${YELLOW}cron${NORMAL} container is not setup as expected."
  707. echo " Was waiting for existence of '/etc/cron.d/rsync-backup' in it." >&2
  708. return 1
  709. fi
  710. fi
  711. fi
  712. dest="$server"
  713. dest="${dest%/*}"
  714. ssh_options=()
  715. if [[ "$dest" == *":"* ]]; then
  716. port="${dest##*:}"
  717. dest="${dest%%:*}"
  718. ssh_options=(-p "$port")
  719. else
  720. port=""
  721. dest="${dest%%:*}"
  722. fi
  723. cmd=(ssh "${ssh_options[@]}" "$admin"@"$dest" ssh-key add "$key")
  724. echo "${WHITE}Launching:${NORMAL} ${cmd[@]}"
  725. "${cmd[@]}" || {
  726. err "Failed add key to backup server '$dest'."
  727. return 1
  728. }
  729. echo "${WHITE}Launching backup${NORMAL} from '$vps'"
  730. ssh:run "root@$vps" -- vps backup || {
  731. err "First backup failed to run."
  732. return 1
  733. }
  734. echo "Backup is ${GREEN}up and running${NORMAL}."
  735. }
  736. vps_update() {
  737. local vps="$1"
  738. vps_connection_check "$vps" || return 1
  739. ssh:run "root@$vps" -- myc-update </dev/null
  740. }
  741. vps_bash() {
  742. local vps="$1"
  743. vps_connection_check "$vps" </dev/null || return 1
  744. ssh:run "root@$vps" -- bash
  745. }
  746. vps_mux() {
  747. local fn="$1" vps_done VPS max_size vps
  748. shift
  749. VPS=($(printf "%s\n" "$@" | sort))
  750. max_size=0
  751. declare -A vps_done;
  752. new_vps=()
  753. for name in "${VPS[@]}"; do
  754. [ -n "${vps_done[$name]}" ] && {
  755. warn "duplicate vps '$name' provided. Ignoring."
  756. continue
  757. }
  758. vps_done["$name"]=1
  759. new_vps+=("$name")
  760. size_name="${#name}"
  761. [ "$max_size" -lt "${size_name}" ] &&
  762. max_size="$size_name"
  763. done
  764. settmpdir "_0KM_TMP_DIR"
  765. cat > "$_0KM_TMP_DIR/code"
  766. for vps in "${new_vps[@]}"; do
  767. label=$(printf "%-${max_size}s" "$vps")
  768. (
  769. {
  770. {
  771. "$fn" "$vps" < "$_0KM_TMP_DIR/code"
  772. } 3>&1 1>&2 2>&3 | sed -r "s/^/$DARKCYAN$label$NORMAL $DARKRED\!$NORMAL /g"
  773. set_errlvl "${PIPESTATUS[0]}"
  774. } 3>&1 1>&2 2>&3 | sed -r "s/^/$DARKCYAN$label$NORMAL $DARKGRAY\|$NORMAL /g"
  775. set_errlvl "${PIPESTATUS[0]}"
  776. ) &
  777. done
  778. wait
  779. }
  780. [ "$SOURCED" ] && return 0
  781. ##
  782. ## Command line processing
  783. ##
  784. cmdline.spec.gnu
  785. cmdline.spec.reporting
  786. cmdline.spec.gnu vps-setup
  787. cmdline.spec::cmd:vps-setup:run() {
  788. : :posarg: HOST 'Target host to check/fix ssh-access'
  789. : :optfla: --force,-f "Will force domain name change, even if
  790. current hostname was not recognized as
  791. an ovh domain name. "
  792. depends sshpass shyaml
  793. KEY_PATH="ssh-access.public-keys"
  794. local keys=$(config get-value -y "ssh-access.public-keys") || true
  795. if [ -z "$keys" ]; then
  796. err "No ssh publickeys configured in config file."
  797. echo " Looking for keys in ${WHITE}${KEY_PATH}${NORMAL}" \
  798. "in config file." >&2
  799. config:exists --message 2>&1 | prefix " "
  800. if [ "${PIPESTATUS[0]}" == "0" ]; then
  801. echo " Config file found in $(config:filename)"
  802. fi
  803. return 1
  804. fi
  805. local tkey=$(e "$keys" | shyaml get-type)
  806. if [ "$tkey" != "sequence" ]; then
  807. err "Value type of ${WHITE}${KEY_PATH}${NORMAL} unexpected (is $tkey, expecting sequence)."
  808. echo " Check content of $(config:filename), and make sure to use a sequence." >&2
  809. return 1
  810. fi
  811. local IP NAME keys host_pass_connected
  812. if ! IP=$(resolve "$HOST"); then
  813. err "'$HOST' name unresolvable."
  814. exit 1
  815. fi
  816. NAME="$HOST"
  817. if [ "$IP" != "$HOST" ]; then
  818. NAME="$HOST ($IP)"
  819. fi
  820. if ! is-port-open "$IP" "22"; then
  821. err "$NAME unreachable or port 22 closed."
  822. exit 1
  823. fi
  824. debug "Host $IP's port 22 is open."
  825. if ! host_pass_connected=$(ssh:open-try \
  826. {root,debian}@"$HOST"); then
  827. err "Could not connect to {root,debian}@$HOST with publickey nor password."
  828. exit 1
  829. fi
  830. read-0a host password <<<"$host_pass_connected"
  831. sudo_if_necessary=
  832. if [ "$password" -o "${host%%@*}" != "root" ]; then
  833. if ! ssh:run "$host" -- sudo -n true >/dev/null 2>&1; then
  834. err "Couldn't do a password-less sudo from $host."
  835. echo " This is not yet supported."
  836. exit 1
  837. else
  838. sudo_if_necessary=sudo
  839. fi
  840. fi
  841. SUPPORTED_KEY_TYPE=(ssh-rsa ssh-ed25519)
  842. Section Checking access
  843. while read-0 key; do
  844. prefix="${key%% *}"
  845. if ! [[ " ${SUPPORTED_KEY_TYPE[*]} " == *" $prefix "* ]]; then
  846. err "Unsupported key:"$'\n'"$key"
  847. echo " Please use only key of the following type:" >&2
  848. printf " - %s\n" "${SUPPORTED_KEY_TYPE[@]}" >&2
  849. return 1
  850. fi
  851. label="${key##* }"
  852. Elt "considering adding key ${DARKYELLOW}$label${NORMAL}"
  853. dest="/root/.ssh/authorized_keys"
  854. if ssh:run "$host" -- $sudo_if_necessary grep "\"$key\"" "$dest" >/dev/null 2>&1 </dev/null; then
  855. print_info "already present"
  856. print_status noop
  857. Feed
  858. else
  859. if echo "$key" | ssh:run "$host" -- $sudo_if_necessary tee -a "$dest" >/dev/null; then
  860. print_info added
  861. else
  862. echo
  863. Feedback failure
  864. return 1
  865. fi
  866. Feedback success
  867. fi
  868. done < <(e "$keys" | shyaml get-values-0)
  869. Section Checking ovh hostname file
  870. Elt "Checking /etc/ovh-hostname"
  871. if ! ssh:run "$host" -- $sudo_if_necessary [ -e "/etc/ovh-hostname" ]; then
  872. print_info "creating"
  873. ssh:run "$host" -- $sudo_if_necessary cp /etc/hostname /etc/ovh-hostname
  874. ovhname=$(ssh:run "$host" -- $sudo_if_necessary cat /etc/ovh-hostname)
  875. Elt "Checking /etc/ovh-hostname: $ovhname"
  876. Feedback || return 1
  877. else
  878. ovhname=$(ssh:run "$host" -- $sudo_if_necessary cat /etc/ovh-hostname)
  879. Elt "Checking /etc/ovh-hostname: $ovhname"
  880. print_info "already present"
  881. print_status noop
  882. Feed
  883. fi
  884. if ! is_ovh_domain_name "$HOST" && ! str_is_ipv4 "$HOST"; then
  885. Section Checking hostname
  886. Elt "Checking /etc/hostname..."
  887. old_etc_hostname="$(ssh:run "$host" -- $sudo_if_necessary cat /etc/hostname)"
  888. if [ "$old_etc_hostname" != "$HOST" ]; then
  889. Elt "/etc/hostname is '$old_etc_hostname'"
  890. if is_ovh_hostname "$old_etc_hostname" || [ -n "$opt_force" ]; then
  891. Elt "Hostname '$old_etc_hostname' --> '$HOST'"
  892. print_info "creating"
  893. echo "$HOST" | ssh:run "$host" -- $sudo_if_necessary tee /etc/hostname >/dev/null &&
  894. ssh:run "$host" -- $sudo_if_necessary hostname "$HOST"
  895. Feedback || return 1
  896. else
  897. Elt "Hostname '$old_etc_hostname' isn't an ovh domain"
  898. print_info "no change"
  899. print_status noop
  900. Feed
  901. warn "Domain name was not changed because it was already set"
  902. echo " (use \`-f\` or \`--force\`) to force domain name change to $HOST." >&2
  903. fi
  904. else
  905. print_info "already set"
  906. print_status noop
  907. Feed
  908. fi
  909. Elt "Checking consistency between /etc/hostname and \`hostname\`..."
  910. etc_hostname="$(ssh:run "$host" -- $sudo_if_necessary cat /etc/hostname)"
  911. transient_hostname="$(ssh:run "$host" -- $sudo_if_necessary hostname)"
  912. if [ "$etc_hostname" != "$transient_hostname" ]; then
  913. print_info "change"
  914. ssh:run "$host" -- $sudo_if_necessary hostname "$etc_hostname"
  915. Feedback || return 1
  916. else
  917. print_info "consistent"
  918. print_status noop
  919. Feed
  920. fi
  921. else
  922. info "Not changing domain as '$HOST' doesn't seem to be final domain."
  923. fi
  924. }
  925. cmdline.spec.gnu vps-check
  926. cmdline.spec::cmd:vps-check:run() {
  927. : :posarg: [VPS...] 'Target host(s) to check'
  928. echo "" |
  929. vps_mux vps_check "${VPS[@]}"
  930. }
  931. cmdline.spec.gnu vps-install
  932. cmdline.spec::cmd:vps-install:run() {
  933. :
  934. }
  935. cmdline.spec.gnu backup
  936. cmdline.spec:vps-install:cmd:backup:run() {
  937. : :posarg: BACKUP_TARGET 'Backup target.
  938. (ie: myadmin@backup.domain.org:10023/256)'
  939. : :optfla: --ignore-domain-check \
  940. "Allow to bypass the domain check in
  941. compose file (only used in compose
  942. installation)."
  943. : :optfla: --ignore-ping-check "Allow to bypass the ping check of host."
  944. : :posarg: [VPS...] 'Target host(s) to check'
  945. if [ "${#VPS[@]}" == 0 ]; then
  946. warn "VPS list provided in command line is empty. Nothing will be done."
  947. return 0
  948. fi
  949. if ! [[ "$BACKUP_TARGET" == *"@"* ]]; then
  950. err "Missing admin account identifier in backup target."
  951. echo " Have you forgottent to specify an account, ie 'myadmin@<MYBACKUP_SERVER>' ?)"
  952. return 1
  953. fi
  954. admin=${BACKUP_TARGET%%@*}
  955. server=${BACKUP_TARGET#*@}
  956. opts=()
  957. [ -n "$opt_ignore_ping_check" ] &&
  958. opts+=("--ignore-ping-check")
  959. [ -n "$opt_ignore_domain_check" ] &&
  960. opts+=("--ignore-domain-check")
  961. p0 "$admin" "$server" "${opts[@]}" |
  962. vps_mux vps_install_backup "${VPS[@]}"
  963. }
  964. cmdline.spec.gnu vps-backup
  965. cmdline.spec::cmd:vps-backup:run() {
  966. :
  967. }
  968. cmdline.spec.gnu ls
  969. cmdline.spec:vps-backup:cmd:ls:run() {
  970. : :posarg: BACKUP_ID 'Backup id.
  971. (ie: myadmin@backup.domain.org:10023)'
  972. if ! [[ "$BACKUP_ID" == *"@"* ]]; then
  973. err "Missing admin account identifier in backup id."
  974. echo " Have you forgottent to specify an admin account ?" \
  975. "ie 'myadmin@<MYBACKUP_SERVER>#<BACKUP_IDENT>' ?)"
  976. return 1
  977. fi
  978. id=${BACKUP_ID##*#}
  979. BACKUP_TARGET=${BACKUP_ID%#*}
  980. admin=${BACKUP_TARGET%%@*}
  981. server=${BACKUP_TARGET#*@}
  982. ## XXXvlab: in this first implementation we expect to have access
  983. ## to the server main ssh port 22, so we won't use the provided port.
  984. ssh_options=()
  985. if [[ "$server" == *":"* ]]; then
  986. ssh_options+=(-p "${server#*:}")
  987. server=${server%%:*}
  988. fi
  989. ssh "${ssh_options[@]}" "$admin"@"$server" ssh-key ls
  990. }
  991. cmdline.spec.gnu recover
  992. cmdline.spec:vps-backup:cmd:recover:run() {
  993. : :posarg: BACKUP_ID 'Backup id.
  994. (ie: myadmin@backup.domain.org:10023#mx.myvps.org
  995. myadmin@ark-01.org#myid:/a/path
  996. admin@ark-02.io#myid:myqsl,mailcow)'
  997. : :posarg: VPS_PATH 'Target host(s) to check.
  998. (ie: myvps.com
  999. myvps.com:/a/path)'
  1000. : :optval: --date,-D '"last", or label of version to recover. (Default: "last").'
  1001. : :optfla: --force,-f 'Will allow you to bypass some checks.'
  1002. if ! [[ "$BACKUP_ID" == *"@"* ]]; then
  1003. err "Missing admin account identifier in backup id."
  1004. echo " Have you forgottent to specify an admin account ?" \
  1005. "ie 'myadmin@<MYBACKUP_SERVER>#<BACKUP_IDENT>' ?)"
  1006. return 1
  1007. fi
  1008. if ! [[ "$BACKUP_ID" == *"@"*"#"* ]]; then
  1009. err "Missing backup label identifier in backup id."
  1010. echo " Have you forgottent to specify a backup label identifier ?" \
  1011. "ie 'myadmin@<MYBACKUP_SERVER>#<BACKUP_IDENT>' ?)"
  1012. return 1
  1013. fi
  1014. id_path=${BACKUP_ID#*#}
  1015. if [[ "$id_path" == *":"* ]]; then
  1016. id=${id_path%%:*}
  1017. path=${id_path#*:}
  1018. else
  1019. id="$id_path"
  1020. path=
  1021. fi
  1022. BACKUP_TARGET=${BACKUP_ID%#*}
  1023. admin=${BACKUP_TARGET%%@*}
  1024. server=${BACKUP_TARGET#*@}
  1025. ssh_options=()
  1026. if [[ "$server" == *":"* ]]; then
  1027. ssh_options+=(-p "${server#*:}")
  1028. ssh_server=${server%%:*}
  1029. fi
  1030. BACKUP_PATH="/srv/datastore/data/rsync-backup-target/var/mirror"
  1031. if ! content=$(ssh:run "$admin"@"${ssh_server}" "${ssh_options[@]}" -- ssh-key ls 2>/dev/null); then
  1032. err "Access denied to '$admin@${server}'."
  1033. return 1
  1034. fi
  1035. idents=$(echo "$content" | sed -r "s/"$'\e'"\[[0-9]+(;[0-9]+)*m//g" | cut -f 2 -d " ")
  1036. if ! [[ $'\n'"$idents"$'\n' == *$'\n'"$id"$'\n'* ]]; then
  1037. err "Given backup id '$id' not found in $admin@${server}'s idents."
  1038. return 1
  1039. fi
  1040. rtype=$(ssh:run "$admin"@"${ssh_server}" "${ssh_options[@]}" -- ssh-key get-type "$id" ) &&
  1041. info "Backup archive matches ${WHITE}${rtype}${NORMAL} type"
  1042. p0 "$admin" "$server" "$id" "$path" "$rtype" "$opt_force" |
  1043. vps_backup_recover "${VPS_PATH}"
  1044. }
  1045. cmdline.spec.gnu vps-update
  1046. cmdline.spec::cmd:vps-update:run() {
  1047. : :posarg: [VPS...] 'Target host to check'
  1048. echo "" |
  1049. vps_mux vps_update "${VPS[@]}"
  1050. }
  1051. cmdline.spec.gnu vps-mux
  1052. cmdline.spec::cmd:vps-mux:run() {
  1053. : :posarg: [VPS...] 'Target host(s) to check'
  1054. cat | vps_mux vps_bash "${VPS[@]}"
  1055. }
  1056. cmdline.spec.gnu vps-space
  1057. cmdline.spec::cmd:vps-space:run() {
  1058. : :posarg: [VPS...] 'Target host(s) to check'
  1059. echo "df /srv -h | tail -n +2 | sed -r 's/ +/ /g' | cut -f 2-5 -d ' '" |
  1060. vps_mux vps_bash "${VPS[@]}"
  1061. }
  1062. cmdline.spec.gnu vps-stats
  1063. cmdline.spec::cmd:vps-stats:run() {
  1064. : :posarg: [VPS...] 'Target host(s) to get stats'
  1065. : :optfla: --follow,-f 'Refresh graph every 2m'
  1066. : :optval: --timespan,-t 'timespan START[..END]'
  1067. : :optval: --resource,-r 'resource(s) separated with a comma'
  1068. : :optval: --interval,-i 'refersh interval (default: 60s)'
  1069. local opts_rrdfetch=( -a )
  1070. if [ -n "${opt_timespan}" ]; then
  1071. start=${opt_timespan%\.\.*}
  1072. opts_rrdfetch+=(-s "$start")
  1073. if [ "$start" != "${opt_timespan}" ]; then
  1074. end=${opt_timespan#*..}
  1075. opts_rrdfetch+=(-e "$end")
  1076. fi
  1077. fi
  1078. local resources=(c.memory c.network load_avg)
  1079. if [ -n "${opt_resource}" ]; then
  1080. resources=(${opt_resource//,/ })
  1081. fi
  1082. local not_found=()
  1083. for resource in "${resources[@]}"; do
  1084. if ! fn.exists "graph:def:$resource"; then
  1085. not_found+=("$resource")
  1086. fi
  1087. done
  1088. if [[ "${#not_found[@]}" -gt 0 ]]; then
  1089. not_found_msg=$(printf "%s, " "${not_found[@]}")
  1090. not_found_msg=${not_found_msg%, }
  1091. err "Unsupported resource(s) provided: ${not_found_msg}"
  1092. echo " resource must be one-of:" >&2
  1093. declare -F | egrep 'graph:def:[a-zA-Z_.]+$' | cut -f 3- -d " " | cut -f 3- -d ":" | prefix " - " >&2
  1094. return 1
  1095. fi
  1096. if [ "${#VPS[@]}" == 0 ]; then
  1097. err "You must provide a VPS list as positional arguments"
  1098. return 1
  1099. fi
  1100. include cache
  1101. if [ -z "$VAR_DIR" ]; then
  1102. err "Unset \$VAR_DIR, can't downlowd rrd graph"
  1103. return 1
  1104. fi
  1105. mkdir -p "$VAR_DIR/rrd"
  1106. if ! [ -d "$VAR_DIR/rrd" ]; then
  1107. err "Invalid \$VAR_DIR: '$VAR_DIR/rrd' is not a directory"
  1108. return 1
  1109. fi
  1110. (
  1111. for vps in "${VPS[@]}"; do
  1112. (
  1113. {
  1114. {
  1115. ssh:open "root@$vps" 2>/dev/null || {
  1116. err "Can't open connection $vps."
  1117. return 1
  1118. }
  1119. while true; do
  1120. if ssh:run "root@$vps" -- "[ -d '/var/lib/vps/rrd' ]"; then
  1121. echo "${WHITE}Collecting stats${NORMAL}..."
  1122. {
  1123. {
  1124. ssh:rsync "root@$vps:/var/lib/vps/rrd/" "${VAR_DIR}/rrd/${vps}"
  1125. } 3>&1 1>&2 2>&3 | prefix " ${DARKRED}\!${NORMAL} "
  1126. set_errlvl "${PIPESTATUS[0]}"
  1127. } 3>&1 1>&2 2>&3 | prefix " ${GRAY}|${NORMAL} "
  1128. echo " ${GRAY}..${NORMAL} ${DARKGREEN}done${NORMAL} collecting stats"
  1129. else
  1130. warn "No stats found. Did you run 'myc-update' on the vps ?."
  1131. fi
  1132. [ -z "$opt_follow" ] && break
  1133. echo "${WHITE}Sleeping ${DARKYELLOW}${opt_interval:-60}${NORMAL}s..."
  1134. sleep "${opt_interval:-60}"
  1135. echo " ${GRAY}..${NORMAL} ${DARKGREEN}done${NORMAL} sleeping"
  1136. done
  1137. } 3>&1 1>&2 2>&3 | prefix " ${DARKRED}\!${GRAY} collect(${DARKCYAN}$vps${GRAY})${NORMAL} "
  1138. set_errlvl "${PIPESTATUS[0]}"
  1139. } 3>&1 1>&2 2>&3 | prefix " ${GRAY}| collect(${DARKCYAN}$vps${GRAY})${NORMAL} " >&2
  1140. ) &
  1141. done
  1142. wait
  1143. ) &
  1144. collect_pid="$!"
  1145. if [ -z "$opt_follow" ]; then
  1146. echo "${WHITE}Fetching last stats${NORMAL}${GRAY}..${NORMAL}" >&2
  1147. wait
  1148. echo " ${GRAY}..${DARKGREEN} done${NORMAL} fetching stats" >&2
  1149. else
  1150. collect_end_msg=" ${GRAY}..${NORMAL} ${DARKGREEN}stop${NORMAL} collecting daemon (pid: ${DARKYELLOW}$collect_pid${NORMAL})"
  1151. trap_add EXIT \
  1152. "printf '%s\n' \"$collect_end_msg\" && kill $collect_pid"
  1153. echo "${WHITE}Start collecting daemon${NORMAL} (pid: ${DARKYELLOW}$collect_pid${NORMAL}) ${GRAY}..${NORMAL}" >&2
  1154. fi
  1155. ( depends gnuplot ) || {
  1156. echo ""
  1157. echo " Gnuplot is required to display graphs..." \
  1158. "You might want to try to install ${WHITE}gnuplot${NORMAL} with:"
  1159. echo ""
  1160. echo " apt install gnuplot"
  1161. echo ""
  1162. return 1
  1163. } >&2
  1164. ( depends rrdtool ) || {
  1165. echo ""
  1166. echo " Rrdtool is required to display graphs..." \
  1167. "You might want to try to install ${WHITE}rrdtool${NORMAL} with:"
  1168. echo ""
  1169. echo " apt install rrdtool"
  1170. echo ""
  1171. return 1
  1172. } >&2
  1173. export GNUTERM=qt
  1174. ## rrdtool fetch will use comma for floating point depending on some locals !
  1175. export LC_ALL=C
  1176. exec {PFD}> >(exec gnuplot 2>/dev/null)
  1177. gnuplot_pid="$!"
  1178. if [ -z "$opt_follow" ]; then
  1179. echo "${WHITE}Draw gnuplot graph${GRAY}..${NORMAL}" >&2
  1180. else
  1181. gnuplot_end_msg=" ${GRAY}..${NORMAL} ${DARKGREEN}stop${NORMAL} gnuplot process (pid: $gnuplot_pid)"
  1182. trap_add EXIT \
  1183. "printf '%s\n' \"$gnuplot_end_msg\" && kill $gnuplot_pid"
  1184. echo "${WHITE}Start gnuplot process${NORMAL} (pid: $gnuplot_pid) ${GRAY}..${NORMAL}" >&2
  1185. fi
  1186. echo "set term qt noraise replotonresize" >&$PFD
  1187. while true; do
  1188. {
  1189. i=0
  1190. data_start_ts=
  1191. data_stop_ts=
  1192. for resource in "${resources[@]}"; do
  1193. for vps in "${VPS[@]}"; do
  1194. ((i++))
  1195. {
  1196. {
  1197. rrd_vps_path="$VAR_DIR/rrd/$vps"
  1198. if [ -d "$rrd_vps_path" ]; then
  1199. graph:def:"${resource}" "$vps" "$i" "${opts_rrdfetch[@]}"
  1200. else
  1201. warn "No data yet, ignoring..."
  1202. fi
  1203. } 3>&1 1>&2 2>&3 | prefix " ${DARKRED}\!${GRAY} graph(${DARKCYAN}$vps${GRAY}:${WHITE}$resource${NORMAL})${NORMAL} "
  1204. set_errlvl "${PIPESTATUS[0]}"
  1205. } 3>&1 1>&2 2>&3 || continue 1
  1206. done
  1207. done
  1208. } >&$PFD
  1209. if [ -z "$opt_follow" ]; then
  1210. echo " ${GRAY}..${DARKGREEN} done${NORMAL} gnuplot graphing" >&2
  1211. break
  1212. else
  1213. {
  1214. echo "${WHITE}Sleeping ${DARKYELLOW}${opt_interval:-60}${NORMAL}s..."
  1215. sleep "${opt_interval:-60}"
  1216. echo " ${GRAY}..${NORMAL} ${DARKGREEN}done${NORMAL} sleeping"
  1217. } | prefix " ${GRAY}| gnuplot:${NORMAL} " >&2
  1218. fi
  1219. done
  1220. if [ -n "$opt_follow" ]; then
  1221. echo "Waiting for child process to finish.." >&2
  1222. wait
  1223. echo " ..done" >&2
  1224. else
  1225. echo "pause mouse close" >&$PFD
  1226. fi
  1227. }
  1228. graph:def:c.memory() {
  1229. local vps="$1" i="$2"
  1230. shift 2
  1231. local opts_rrdfetch=("$@")
  1232. local resource="memory"
  1233. rrd_vps_path="$VAR_DIR/rrd/$vps"
  1234. [ -d "$rrd_vps_path/containers" ] || {
  1235. warn "No containers data yet for vps '$vps'... Ignoring"
  1236. return 0
  1237. }
  1238. containers=(
  1239. $(
  1240. cd "$rrd_vps_path/containers";
  1241. find -maxdepth 3 -mindepth 3 -name "${resource}.rrd" -type f |
  1242. sed -r 's%^./([^/]+/[^/]+)/[^/]+.rrd$%\1%g'
  1243. )
  1244. )
  1245. gnuplot_line_config=(
  1246. "set term qt $i title \"$vps $resource\" replotonresize noraise"
  1247. "set title '$vps'"
  1248. "set xdata time"
  1249. "set timefmt '%s'"
  1250. "set ylabel '$resource Usage'"
  1251. "set format y '%s'"
  1252. "set ytics format ' %g'"
  1253. "set mouse mouseformat 6"
  1254. "set yrange [0:*] "
  1255. "set border behind"
  1256. )
  1257. printf "%s\n" "${gnuplot_line_config[@]}"
  1258. first=1
  1259. for container in "${containers[@]}"; do
  1260. rrdfetch_cmd="'< rrdtool fetch \"$rrd_vps_path/containers/$container/$resource.rrd\""
  1261. rrdfetch_cmd+=" AVERAGE ${opts_rrdfetch[*]} | \\"$'\n'
  1262. rrdfetch_cmd+=" tail -n +2 | \\"$'\n'
  1263. rrdfetch_cmd+=" egrep -v \"^$\" | sed -r \"s/ -?nan/ -/g;s/^([0-9]+): /\\1 /g\"'"
  1264. rrdfetch_cmd_bash=$(eval echo "${rrdfetch_cmd}")
  1265. rrdfetch_cmd_bash=${rrdfetch_cmd_bash#< }
  1266. first_ts=
  1267. first_ts=$(eval "$rrdfetch_cmd_bash" | head -n 1 | cut -f 1 -d " ")
  1268. if [ -z "$first_ts" ]; then
  1269. warn "No data for $container on vps $vps, skipping..."
  1270. continue
  1271. fi
  1272. last_ts=$(eval "$rrdfetch_cmd_bash" | tail -n 1 | cut -f 1 -d " ")
  1273. if [[ -z "$data_start_ts" ]] || [[ "$data_start_ts" > "$first_ts" ]]; then
  1274. data_start_ts="$first_ts"
  1275. fi
  1276. if [[ -z "$data_stop_ts" ]] || [[ "$data_stop_ts" < "$last_ts" ]]; then
  1277. data_stop_ts="$last_ts"
  1278. fi
  1279. if [ -n "$first" ]; then
  1280. first=
  1281. echo "plot \\"
  1282. else
  1283. echo ", \\"
  1284. fi
  1285. container="${container//\'/}"
  1286. container="${container//@/\\@}"
  1287. echo -n " ${rrdfetch_cmd} u 1:((\$3 - \$2)/1000000000) w lines title '${container//_/\\_}'"
  1288. done
  1289. echo
  1290. }
  1291. graph:def:c.network() {
  1292. local vps="$1" i="$2"
  1293. shift 2
  1294. local opts_rrdfetch=("$@")
  1295. local resource="network"
  1296. rrd_vps_path="$VAR_DIR/rrd/$vps"
  1297. [ -d "$rrd_vps_path/containers" ] || {
  1298. warn "No containers data yet for vps '$vps'... Ignoring"
  1299. return 0
  1300. }
  1301. containers=(
  1302. $(
  1303. cd "$rrd_vps_path/containers";
  1304. find -maxdepth 3 -mindepth 3 -name "${resource}.rrd" -type f |
  1305. sed -r 's%^./([^/]+/[^/]+)/[^/]+.rrd$%\1%g'
  1306. )
  1307. )
  1308. gnuplot_line_config=(
  1309. "set term qt $i title \"$vps $resource\" replotonresize noraise"
  1310. "set title '$vps'"
  1311. "set xdata time"
  1312. "set timefmt '%s'"
  1313. "set ylabel '$resource Usage'"
  1314. "set format y '%s'"
  1315. "set ytics format ' %.2f MiB/s'"
  1316. "set mouse mouseformat 6"
  1317. "set yrange [0:*] "
  1318. "set border behind"
  1319. )
  1320. printf "%s\n" "${gnuplot_line_config[@]}"
  1321. first=1
  1322. for container in "${containers[@]}"; do
  1323. rrdfetch_cmd="'< rrdtool fetch \"$rrd_vps_path/containers/$container/$resource.rrd\""
  1324. rrdfetch_cmd+=" AVERAGE ${opts_rrdfetch[*]} | \\"$'\n'
  1325. rrdfetch_cmd+=" tail -n +2 | \\"$'\n'
  1326. rrdfetch_cmd+=" egrep -v \"^$\" | sed -r \"s/ -?nan/ -/g;s/^([0-9]+): /\\1 /g\"'"
  1327. rrdfetch_cmd_bash=$(eval echo "${rrdfetch_cmd}")
  1328. rrdfetch_cmd_bash=${rrdfetch_cmd_bash#< }
  1329. first_ts=
  1330. first_ts=$(eval "$rrdfetch_cmd_bash" | head -n 1 | cut -f 1 -d " ")
  1331. if [ -z "$first_ts" ]; then
  1332. warn "No data for $container on vps $vps, skipping..."
  1333. continue
  1334. fi
  1335. last_ts=$(eval "$rrdfetch_cmd_bash" | tail -n 1 | cut -f 1 -d " ")
  1336. if [[ -z "$data_start_ts" ]] || [[ "$data_start_ts" > "$first_ts" ]]; then
  1337. data_start_ts="$first_ts"
  1338. fi
  1339. if [[ -z "$data_stop_ts" ]] || [[ "$data_stop_ts" < "$last_ts" ]]; then
  1340. data_stop_ts="$last_ts"
  1341. fi
  1342. if [ -n "$first" ]; then
  1343. first=
  1344. echo "plot \\"
  1345. else
  1346. echo ", \\"
  1347. fi
  1348. container="${container//\'/}"
  1349. container="${container//@/\\@}"
  1350. echo -n " ${rrdfetch_cmd} u 1:((\$3 / 1024) / 1024) w lines title '${container//_/\\_}'"
  1351. done
  1352. echo
  1353. }
  1354. graph:def:load_avg() {
  1355. local vps="$1" i="$2"
  1356. shift 2
  1357. local opts_rrdfetch=("$@")
  1358. rrd_vps_path="$VAR_DIR/rrd/$vps"
  1359. [ -f "$rrd_vps_path/$resource.rrd" ] || {
  1360. warn "No containers data yet for vps '$vps'... Ignoring"
  1361. return 0
  1362. }
  1363. gnuplot_line_config=(
  1364. "set term qt $i title \"$vps $resource\" replotonresize noraise"
  1365. "set title '$vps'"
  1366. "set xdata time"
  1367. "set timefmt '%s'"
  1368. "set ylabel '${resource//_/\\_} Usage'"
  1369. "set format y '%s'"
  1370. "set ytics format '%g'"
  1371. "set mouse mouseformat 6"
  1372. "set yrange [0:*] "
  1373. "set border behind"
  1374. )
  1375. printf "%s\n" "${gnuplot_line_config[@]}"
  1376. first=1
  1377. for value in 1m:2 5m:3 15m:4; do
  1378. label="${value%:*}"
  1379. col_num="${value#*:}"
  1380. rrdfetch_cmd="'< rrdtool fetch \"$rrd_vps_path/$resource.rrd\""
  1381. rrdfetch_cmd+=" AVERAGE ${opts_rrdfetch[*]} | \\"$'\n'
  1382. rrdfetch_cmd+=" tail -n +2 | \\"$'\n'
  1383. rrdfetch_cmd+=" egrep -v \"^$\" | sed -r \"s/ -?nan/ -/g;s/^([0-9]+): /\\1 /g\"'"
  1384. rrdfetch_cmd_bash=$(eval echo "${rrdfetch_cmd}")
  1385. rrdfetch_cmd_bash=${rrdfetch_cmd_bash#< }
  1386. first_ts=
  1387. first_ts=$(eval "$rrdfetch_cmd_bash" | head -n 1 | cut -f 1 -d " ")
  1388. if [ -z "$first_ts" ]; then
  1389. warn "No data for $resource on vps $vps, skipping..."
  1390. continue
  1391. fi
  1392. last_ts=$(eval "$rrdfetch_cmd_bash" | tail -n 1 | cut -f 1 -d " ")
  1393. if [[ -z "$data_start_ts" ]] || [[ "$data_start_ts" > "$first_ts" ]]; then
  1394. data_start_ts="$first_ts"
  1395. fi
  1396. if [[ -z "$data_stop_ts" ]] || [[ "$data_stop_ts" < "$last_ts" ]]; then
  1397. data_stop_ts="$last_ts"
  1398. fi
  1399. if [ -n "$first" ]; then
  1400. first=
  1401. echo "plot \\"
  1402. else
  1403. echo ", \\"
  1404. fi
  1405. container="${container//\'/}"
  1406. container="${container//@/\\@}"
  1407. echo -n " ${rrdfetch_cmd} u 1:$col_num w lines title '${label}'"
  1408. done
  1409. echo
  1410. }
  1411. cmdline::parse "$@"