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.

570 lines
15 KiB

  1. #!/bin/bash
  2. . /etc/shlib
  3. include common
  4. include parse
  5. include cmdline
  6. include config
  7. include cache
  8. include fn
  9. [[ "${BASH_SOURCE[0]}" != "${0}" ]] && SOURCED=true
  10. version=0.1
  11. desc='Install backup'
  12. help=""
  13. docker:running-container-projects() {
  14. :cache: scope=session
  15. docker ps --format '{{.Label "com.docker.compose.project"}}' | sort | uniq
  16. }
  17. decorator._mangle_fn docker:running-container-projects
  18. ssh:mk-private-key() {
  19. local host="$1" service_name="$2"
  20. (
  21. settmpdir VPS_TMPDIR
  22. ssh-keygen -t rsa -N "" -f "$VPS_TMPDIR/rsync_rsa" -C "$service_name@$host" >/dev/null
  23. cat "$VPS_TMPDIR/rsync_rsa"
  24. )
  25. }
  26. mailcow:has-images-running() {
  27. local images
  28. images=$(docker ps --format '{{.Image}}' | sort | uniq)
  29. [[ $'\n'"$images" == *$'\n'"mailcow/"* ]]
  30. }
  31. mailcow:has-container-project-mentionning-mailcow() {
  32. local projects
  33. projects=$(docker:running-container-projects) || return 1
  34. [[ $'\n'"$projects"$'\n' == *mailcow* ]]
  35. }
  36. mailcow:has-running-containers() {
  37. mailcow:has-images-running ||
  38. mailcow:has-container-project-mentionning-mailcow
  39. }
  40. mailcow:get-root() {
  41. :cache: scope=session
  42. local dir
  43. for dir in {/opt{,/apps},/root}/mailcow-dockerized; do
  44. [ -d "$dir" ] || continue
  45. [ -r "$dir/mailcow.conf" ] || continue
  46. echo "$dir"
  47. return 0
  48. done
  49. return 1
  50. }
  51. decorator._mangle_fn mailcow:get-root
  52. compose:get-compose-yml() {
  53. :cache: scope=session
  54. local path
  55. [ -e "/etc/compose/local.conf" ] && . "/etc/compose/local.conf"
  56. path=${DEFAULT_COMPOSE_FILE:-/etc/compose/compose.yml}
  57. [ -e "$path" ] || return 1
  58. echo "$path"
  59. }
  60. decorator._mangle_fn compose:get-compose-yml
  61. compose:has-container-project-myc() {
  62. local projects
  63. projects=$(docker:running-container-projects) || return 1
  64. [[ $'\n'"$projects"$'\n' == *$'\n'"myc"$'\n'* ]]
  65. }
  66. type:is-mailcow() {
  67. mailcow:get-root >/dev/null ||
  68. mailcow:has-running-containers
  69. }
  70. type:is-compose() {
  71. compose:get-compose-yml >/dev/null &&
  72. compose:has-container-project-myc
  73. }
  74. vps:get-type() {
  75. local fn
  76. for fn in $(declare -F | cut -f 3 -d " " | egrep "^type:is-"); do
  77. "$fn" && {
  78. echo "${fn#type:is-}"
  79. return 0
  80. }
  81. done
  82. return 1
  83. }
  84. mirror-dir:sources() {
  85. :cache: scope=session
  86. if ! shyaml get-values default.sources < /etc/mirror-dir/config.yml; then
  87. err "Couldn't query 'default.sources' in '/etc/mirror-dir/config.yml'."
  88. return 1
  89. fi
  90. }
  91. decorator._mangle_fn mirror-dir:sources
  92. mirror-dir:check-add() {
  93. local elt="$1" sources
  94. sources=$(mirror-dir:sources) || return 1
  95. if [[ $'\n'"$sources"$'\n' == *$'\n'"$elt"$'\n'* ]]; then
  96. info "Volume $elt already in sources"
  97. else
  98. Elt "Adding directory $elt"
  99. sed -i "/sources:/a\ - \"${elt}\"" \
  100. /etc/mirror-dir/config.yml
  101. Feedback || return 1
  102. fi
  103. }
  104. mirror-dir:check-add-vol() {
  105. local elt="$1"
  106. mirror-dir:check-add "/var/lib/docker/volumes/*_${elt}-*/_data"
  107. }
  108. ## The first colon is to prevent auto-export of function from shlib
  109. : ; bash-bug-5() { { cat; } < <(e) >/dev/null; ! cat "$1"; } && bash-bug-5 <(e) 2>/dev/null &&
  110. export BASH_BUG_5=1 && unset -f bash_bug_5
  111. wrap() {
  112. local label="$1" code="$2"
  113. shift 2
  114. export VERBOSE=1
  115. interpreter=/bin/bash
  116. if [ -n "$BASH_BUG_5" ]; then
  117. (
  118. settmpdir tmpdir
  119. fname=${label##*/}
  120. e "$code" > "$tmpdir/$fname" &&
  121. chmod +x "$tmpdir/$fname" &&
  122. Wrap -vsd "$label" -- "$interpreter" "$tmpdir/$fname" "$@"
  123. )
  124. else
  125. Wrap -vsd "$label" -- "$interpreter" <(e "$code") "$@"
  126. fi
  127. }
  128. mailcow:install-backup() {
  129. local BACKUP_SERVER="$1" mailcow_root DOMAIN
  130. ## find installation
  131. mailcow_root=$(mailcow:get-root) || {
  132. err "Couldn't find a valid mailcow root directory."
  133. return 1
  134. }
  135. ## check ok
  136. DOMAIN=$(cat "$mailcow_root/.env" | grep ^MAILCOW_HOSTNAME= | cut -f 2 -d =) || {
  137. err "Couldn't find MAILCOW_HOSTNAME in file \"$mailcow_root/.env\"."
  138. return 1
  139. }
  140. MYSQL_ROOT_PASSWORD=$(cat "$mailcow_root/.env" | grep ^DBROOT= | cut -f 2 -d =) || {
  141. err "Couldn't find DBROOT in file \"$mailcow_root/.env\"."
  142. return 1
  143. }
  144. MYSQL_CONTAINER=${MYSQL_CONTAINER:-mailcowdockerized_mysql-mailcow_1}
  145. container_id=$(docker ps -f name="$MYSQL_CONTAINER" --format "{{.ID}}")
  146. if [ -z "$container_id" ]; then
  147. err "Couldn't find docker container named '$MYSQL_CONTAINER'."
  148. return 1
  149. fi
  150. export MYSQL_ROOT_PASSWORD
  151. export MYSQL_CONTAINER
  152. export BACKUP_SERVER
  153. export DOMAIN
  154. wrap "Install rsync-backup on host" "
  155. cd /srv/charm-store/rsync-backup
  156. bash ./hooks/install.d/60-install.sh
  157. " || return 1
  158. wrap "Mysql dump install" "
  159. cd /srv/charm-store/mariadb
  160. bash ./hooks/install.d/60-backup.sh
  161. " || return 1
  162. ## Using https://github.com/mailcow/mailcow-dockerized/blob/master/helper-scripts/backup_and_restore.sh
  163. for elt in "vmail{,-attachments-vol}" crypt redis rspamd postfix; do
  164. mirror-dir:check-add-vol "$elt" || return 1
  165. done
  166. mirror-dir:check-add "$mailcow_root" || return 1
  167. mirror-dir:check-add "/var/backups/mysql" || return 1
  168. mirror-dir:check-add "/etc" || return 1
  169. dest="$BACKUP_SERVER"
  170. dest="${dest%/*}"
  171. ssh_options=()
  172. if [[ "$dest" == *":"* ]]; then
  173. port="${dest##*:}"
  174. dest="${dest%%:*}"
  175. ssh_options=(-p "$port")
  176. else
  177. port=""
  178. dest="${dest%%:*}"
  179. fi
  180. info "You can run this following from an host having admin access to $dest:"
  181. echo "ssh ${ssh_options[@]} myadmin@$dest ssh-key add '$(cat /var/lib/rsync/.ssh/id_rsa.pub)'"
  182. }
  183. compose:has_domain() {
  184. local compose_file="$1" host="$2" name conf relation relation_value domain server_aliases
  185. while read-0 name conf ; do
  186. name=$(e "$name" | shyaml get-value)
  187. if [[ "$name" =~ ^[a-zA-Z0-9-]+\.[a-zA-Z0-9-]+ ]]; then
  188. [ "$host" == "$name" ] && return 0
  189. fi
  190. rel=$(e "$conf" | shyaml -y get-value relations 2>/dev/null) || continue
  191. for relation in web-proxy publish-dir; do
  192. relation_value=$(e "$rel" | shyaml -y get-value "$relation" 2>/dev/null) || continue
  193. while read-0 label conf_relation; do
  194. domain=$(e "$conf_relation" | shyaml get-value "domain" 2>/dev/null) && {
  195. [ "$host" == "$domain" ] && return 0
  196. }
  197. server_aliases=$(e "$conf_relation" | shyaml get-values "server-aliases" 2>/dev/null) && {
  198. [[ $'\n'"$server_aliases" == *$'\n'"$host"$'\n'* ]] && return 0
  199. }
  200. done < <(e "$relation_value" | shyaml -y key-values-0)
  201. done
  202. done < <(shyaml -y key-values-0 < "$compose_file")
  203. return 1
  204. }
  205. compose:install-backup() {
  206. local BACKUP_SERVER="$1" service_name="$2" compose_file="$3" ignore_ping_check="$4" ignore_domain_check="$5"
  207. ## XXXvlab: far from perfect as it mimics and depends internal
  208. ## logic of current default way to get a domain in compose-core
  209. host=$(hostname)
  210. if ! compose:has_domain "$compose_file" "$host"; then
  211. if [ -n "$ignore_domain_check" ]; then
  212. warn "domain of '$host' not found in compose file '$compose_file'. Ignoring due to ``--ignore-domain-check`` option."
  213. else
  214. err "domain of '$host' not found in compose file '$compose_file'. Use ``--ignore-domain-check`` to ignore check."
  215. return 1
  216. fi
  217. fi
  218. ip=$(getent ahosts "$host" | egrep "^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+\s+" |
  219. head -n 1 | cut -f 1 -d " ") || return 1
  220. my_ip=$(curl -s myip.kal.fr)
  221. if [ "$ip" != "$my_ip" ]; then
  222. if [ -n "$ignore_ping_check" ]; then
  223. warn "IP of '$host' ($ip) doesn't match mine ($my_ip). Ignoring due to ``--ignore-ping-check`` option."
  224. else
  225. err "IP of '$host' ($ip) doesn't match mine ($my_ip). Use ``--ignore-ping-check`` to ignore check."
  226. return 1
  227. fi
  228. fi
  229. if [ -e "/root/.ssh/rsync_rsa" ]; then
  230. warn "deleting private key in /root/.ssh/rsync_rsa, has we are not using it anymore."
  231. rm -fv /root/.ssh/rsync_rsa
  232. fi
  233. if [ -e "/root/.ssh/rsync_rsa.pub" ]; then
  234. warn "deleting public key in /root/.ssh/rsync_rsa.pub, has we are not using it anymore."
  235. rm -fv /root/.ssh/rsync_rsa.pub
  236. fi
  237. if service_cfg=$(cat "$compose_file" |
  238. shyaml get-value -y "$service_name" 2>/dev/null); then
  239. info "Entry for service ${DARKYELLOW}$service_name${NORMAL}" \
  240. "is already present in '$compose_file'."
  241. cfg=$(e "$service_cfg" | shyaml get-value -y options) || {
  242. err "No ${WHITE}options${NORMAL} in ${DARKYELLOW}$service_name${NORMAL}'s" \
  243. "entry in '$compose_file'."
  244. return 1
  245. }
  246. private_key=$(e "$cfg" | shyaml get-value private-key)
  247. target=$(e "$cfg" | shyaml get-value target)
  248. if [ "$target" != "$BACKUP_SERVER" ]; then
  249. err "Existing backup target '$target' is different" \
  250. "from specified '$BACKUP_SERVER'"
  251. return 1
  252. fi
  253. else
  254. private_key=$(ssh:mk-private-key "$host" "$service_name")
  255. cat <<EOF >> "$compose_file"
  256. $service_name:
  257. options:
  258. ident: $host
  259. target: $BACKUP_SERVER
  260. private-key: |
  261. $(e "$private_key" | sed -r 's/^/ /g')
  262. EOF
  263. fi
  264. dest="$BACKUP_SERVER"
  265. dest="${dest%/*}"
  266. ssh_options=()
  267. if [[ "$dest" == *":"* ]]; then
  268. port="${dest##*:}"
  269. dest="${dest%%:*}"
  270. ssh_options=(-p "$port")
  271. else
  272. port=""
  273. dest="${dest%%:*}"
  274. fi
  275. info "You can run this following from an host having admin access to $dest:"
  276. public_key=$(ssh-keygen -y -f <(e "$private_key"$'\n'))
  277. echo "ssh ${ssh_options[@]} myadmin@$dest ssh-key add '$public_key ${service_name}@$host'"
  278. }
  279. [ "$SOURCED" ] && return 0
  280. ##
  281. ## Command line processing
  282. ##
  283. cmdline.spec.gnu
  284. cmdline.spec.reporting
  285. cmdline.spec.gnu install
  286. cmdline.spec::cmd:install:run() {
  287. :
  288. }
  289. cmdline.spec.gnu get-type
  290. cmdline.spec::cmd:get-type:run() {
  291. vps:get-type
  292. }
  293. cmdline.spec:install:cmd:backup:run() {
  294. : :posarg: BACKUP_SERVER 'Target backup server'
  295. local vps_type
  296. vps_type=$(vps:get-type) || {
  297. err "Failed to get type of installation."
  298. return 1
  299. }
  300. if ! fn.exists "${vps_type}:install-backup"; then
  301. err "type '${vps_type}' has no backup installation implemented yet."
  302. return 1
  303. fi
  304. "cmdline.spec:install:cmd:$vps_type-backup:run" "$BACKUP_SERVER"
  305. }
  306. DEFAULT_BACKUP_SERVICE_NAME=rsync-backup
  307. cmdline.spec.gnu compose-backup
  308. cmdline.spec:install:cmd:compose-backup:run() {
  309. : :posarg: BACKUP_SERVER 'Target backup server'
  310. : :optval: --service-name,-s "YAML service name in compose
  311. file to check for existence of key.
  312. Defaults to '$DEFAULT_BACKUP_SERVICE_NAME'"
  313. : :optval: --compose-file,-f "Compose file location. Defaults to
  314. the value of '\$DEFAULT_COMPOSE_FILE'"
  315. : :optfla: --ignore-domain-check \
  316. "Allow to bypass the domain check in
  317. compose file."
  318. : :optfla: --ignore-ping-check "Allow to bypass the ping check of host."
  319. local service_name compose_file
  320. [ -e "/etc/compose/local.conf" ] && source /etc/compose/local.conf
  321. compose_file=${opt_compose_file:-$DEFAULT_COMPOSE_FILE}
  322. service_name=${opt_service_name:-$DEFAULT_BACKUP_SERVICE_NAME}
  323. if ! [ -e "$compose_file" ]; then
  324. err "Compose file not found in '$compose_file'."
  325. return 1
  326. fi
  327. compose:install-backup "$BACKUP_SERVER" "$service_name" "$compose_file" \
  328. "$opt_ignore_ping_check" "$opt_ignore_domain_check"
  329. }
  330. cmdline.spec:install:cmd:mailcow-backup:run() {
  331. : :posarg: BACKUP_SERVER 'Target backup server'
  332. "mailcow:install-backup" "$BACKUP_SERVER"
  333. }
  334. cmdline.spec.gnu backup
  335. cmdline.spec::cmd:backup:run() {
  336. local vps_type
  337. vps_type=$(vps:get-type) || {
  338. err "Failed to get type of installation."
  339. return 1
  340. }
  341. if ! fn.exists "cmdline.spec:backup:cmd:${vps_type}:run"; then
  342. err "type '${vps_type}' has no backup process implemented yet."
  343. return 1
  344. fi
  345. "cmdline.spec:backup:cmd:${vps_type}:run"
  346. }
  347. cmdline.spec:backup:cmd:mailcow:run() {
  348. local cmd_line cron_line cmd
  349. for f in mysql-backup mirror-dir; do
  350. [ -e "/etc/cron.d/$f" ] || {
  351. err "Can't find '/etc/cron.d/$f'."
  352. echo " Have you forgotten to run 'vps install backup BACKUP_HOST' ?" >&2
  353. return 1
  354. }
  355. if ! cron_line=$(cat "/etc/cron.d/$f" |
  356. grep -v "^#" | grep "\* \* \*"); then
  357. err "Can't find cron_line in '/etc/cron.d/$f'." \
  358. "Have you modified it ?"
  359. return 1
  360. fi
  361. cron_line=${cron_line%|*}
  362. cmd_line=(${cron_line#*root})
  363. if [ "$f" == "mirror-dir" ]; then
  364. cmd=()
  365. for arg in "${cmd_line[@]}"; do
  366. [ "$arg" != "-q" ] && cmd+=("$arg")
  367. done
  368. else
  369. cmd=("${cmd_line[@]}")
  370. fi
  371. code="${cmd[*]}"
  372. echo "${WHITE}Launching:${NORMAL} ${code}"
  373. {
  374. {
  375. (
  376. ## Some commands are using colors that are already
  377. ## set by this current program and will trickle
  378. ## down unwantedly
  379. ansi_color no
  380. eval "${code}"
  381. ) | sed -r "s/^/ ${GRAY}|${NORMAL} /g"
  382. set_errlvl "${PIPESTATUS[0]}"
  383. } 3>&1 1>&2 2>&3 | sed -r "s/^/ $DARKRED\!$NORMAL /g"
  384. set_errlvl "${PIPESTATUS[0]}"
  385. } 3>&1 1>&2 2>&3
  386. if [ "$?" != "0" ]; then
  387. err "Failed."
  388. return 1
  389. fi
  390. done
  391. info "Mysql backup and subsequent mirror-dir ${DARKGREEN}succeeded${NORMAL}."
  392. }
  393. set_errlvl() { return "${1:-1}"; }
  394. cmdline.spec:backup:cmd:compose:run() {
  395. local cron_line args
  396. if ! cron_line=$(docker exec myc_cron_1 cat /etc/cron.d/rsync-backup | grep "\* \* \*"); then
  397. err "Can't find cron_line in cron container."
  398. echo " Have you forgotten to run 'compose up' ?" >&2
  399. exit 1
  400. fi
  401. cron_line=${cron_line%|*}
  402. cron_line=${cron_line%"2>&1"*}
  403. cmd_line="${cron_line#*root}"
  404. eval "args=($cmd_line)"
  405. ## should be last argument
  406. docker_cmd=$(echo ${args[@]: -1})
  407. if ! [[ "$docker_cmd" == "docker run --rm -e "* ]]; then
  408. echo "docker command found should start with 'docker run'." >&2
  409. echo "Here's command:" >&2
  410. echo " $docker_cmd" >&2
  411. exit 1
  412. fi
  413. echo "${WHITE}Launching:${NORMAL} docker exec -i myc_cron_1 $docker_cmd"
  414. {
  415. {
  416. eval "docker exec -i myc_cron_1 $docker_cmd" | sed -r "s/^/ ${GRAY}|${NORMAL} /g"
  417. set_errlvl "${PIPESTATUS[0]}"
  418. } 3>&1 1>&2 2>&3 | sed -r "s/^/ $DARKRED\!$NORMAL /g"
  419. set_errlvl "${PIPESTATUS[0]}"
  420. } 3>&1 1>&2 2>&3
  421. if [ "$?" != "0" ]; then
  422. err "Failed."
  423. return 1
  424. fi
  425. info "mirror-dir ${DARKGREEN}succeeded${NORMAL}."
  426. }
  427. cmdline::parse "$@"