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.

827 lines
21 KiB

  1. #+SETUPFILE: /home/vaab/dev/el/org-html-themes/setup/theme-readtheorg.setup
  2. #+PROPERTY: Effort_ALL 0 0:30 1:00 2:00 0.5d 1d 1.5d 2d 3d 4d 5d
  3. #+PROPERTY: Max_effort_ALL 0 0:30 1:00 2:00 0.5d 1d 1.5d 2d 3d 4d 5d
  4. #+PROPERTY: header-args:python :var filename=(buffer-file-name)
  5. #+PROPERTY: header-args:sh :var filename=(buffer-file-name)
  6. #+TODO: TODO WIP BLOCKED POSTPONED | DONE CANCELED
  7. #+LATEX_HEADER: \usepackage[margin=0.5in]{geometry}
  8. #+LaTeX_CLASS: article
  9. #+OPTIONS: H:8 ^:nil prop:("Effort" "Max_effort") tags:not-in-toc
  10. #+COLUMNS: %50ITEM %Effort(Min Effort) %Max_effort(Max Effort)
  11. #+begin_LaTeX
  12. \hypersetup{
  13. linkcolor=blue,
  14. pdfborder={0 0 0 0}
  15. }
  16. #+end_LaTeX
  17. #+TITLE: Architecture 0k.io
  18. #+LATEX: \pagebreak
  19. * Process de déploiement
  20. Description du process de déploiement pour une nouvelle installation
  21. ** Base myc
  22. *** Qu'est ce c'est ?
  23. A partir d'une debian 9, on peut installer la machine pour être prête
  24. à utiliser un déploiement myc.
  25. Une fois executé, la machine aura toute les deps pour lancer une
  26. commande compose qui fera peut-être appel à des registry de
  27. mycéliandre. Un compose de base est aussi proposé.
  28. *** Déploiement
  29. **** Hôte linux base debian 9
  30. #+BEGIN_SRC sh
  31. export WITHOUT_DOCKER_CLEAN=1 ## only if you want to remove docker clean from cron
  32. wget https://justodooit.myceliandre.fr/r/deploy -qO - | bash
  33. #+END_SRC
  34. If you want to setup odoo admin password and domain in one go:
  35. #+BEGIN_SRC sh
  36. export WITHOUT_DOCKER_CLEAN=1 ## only if you want to remove docker clean from cron
  37. export DOMAIN=myhost.com
  38. wget https://justodooit.myceliandre.fr/r/deploy -qO - | bash
  39. #+END_SRC
  40. Considérer la possibilité de mettre en place la clé =0k-admin= pour
  41. accès au compte =root=:
  42. #+begin_src sh
  43. myc-root-allow-0k-admin
  44. #+end_src
  45. **** Hôte macosx
  46. - install bash, docker
  47. - Uncheck "Securely store docker logins in macOS keychain"
  48. *** Ce que cela fait
  49. **** Mettre la machine en état charm-ready
  50. - installation du strict minimu pour lancer les =charms=
  51. - téléchargement de la dernière version des =0k-charms= (collection
  52. de recettes d'installation et de gestion de docker)
  53. **** Mettre la machine en état compose ready (notre docker qui va bien)
  54. via le lancement du charm =docker-host= qui installe:
  55. - docker, docker-compose, compose avec des versions qui vont bien
  56. - paquets maisons (kal-scripts, 0k-manage, 0k-pgm, lxc-scripts, 0k-docker)
  57. - accès pour le repository deb de kalysto.org
  58. - clé SSH pour repos git.kal.fr
  59. - login sur le docker registry docker.0k.io
  60. **** Commandes spécifique à myc
  61. - login sur le registry myc
  62. - téléchargement du compose de base dans =/opt/apps/myc-deploy=
  63. ** Modification du compose
  64. *** Qu'est-ce que c'est ?
  65. Il y a des update client à faire souvent sur le compose. Cette étape
  66. doit être externalisée au plus possible, sont consigné ici ce qu'il
  67. faut encore faire à la main.
  68. *** Commande
  69. **** Création de clé OVH pour letsencrypt/lexicon
  70. Ceci n'est nécessaire qu'en cas d'utilisation de la méthode DNS
  71. pour valider la possession du domaine auprès de letsencrypt.
  72. #+BEGIN_SRC shell
  73. APPLICATION_KEY=XXXXXXXXXXXXXXXXX
  74. REDIR_WEBSITE=https://0k.io
  75. req=$(cat <<EOF
  76. {
  77. "accessRules": [
  78. {
  79. "method": "GET",
  80. "path": "/*"
  81. },
  82. {
  83. "method": "POST",
  84. "path": "/*"
  85. },
  86. {
  87. "method": "PUT",
  88. "path": "/*"
  89. },
  90. {
  91. "method": "DELETE",
  92. "path": "/*"
  93. }
  94. ],
  95. "redirection":"$REDIR_WEBSITE"
  96. }
  97. EOF
  98. )
  99. res=$(curl -X POST \
  100. -H "X-Ovh-Application: ${APPLICATION_KEY}" \
  101. -H "Content-type: application/json" \
  102. https://eu.api.ovh.com/1.0/auth/credential \
  103. -d "$req")
  104. consumer_key=$(echo "$res" | jq -r .consumerKey)
  105. validation_url=$(echo "$res" | jq -r .validationUrl)
  106. echo "Visit: $validation_url"
  107. echo "ConsumerKey: $consumer_key"
  108. #+END_SRC
  109. Il s'agit alors de remplir le compose.yml
  110. #+BEGIN_SRC yaml
  111. ovh:
  112. ## see: https://api.ovh.com/g934.first_step_with_api
  113. entrypoint: ovh-eu
  114. application:
  115. key: XXXXXXXXXXXXXXXX
  116. secret: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
  117. consumer_key: ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
  118. #+END_SRC
  119. Puis de valider que tout est ok:
  120. #+BEGIN_SRC shell
  121. check-compose-ovh-credentials compose.yml
  122. #+END_SRC
  123. ** Lancement/Deploy de service odoo
  124. *** Qu'est ce que c'est ?
  125. A partir d'une base myc, cette commande permet d'envoyer la
  126. construction et l'assemblage de tous les services décrit dans le
  127. =compose.yml= fourni par défaut.
  128. *** commandes
  129. #+BEGIN_SRC sh
  130. cd /opt/apps/myc-deploy
  131. compose --debug up odoo frontend
  132. #+END_SRC
  133. De manière générale:
  134. #+BEGIN_SRC sh
  135. compose [--debug] up [SERVICES...]
  136. #+END_SRC
  137. *** Ce que ça fait
  138. Les charms vont s'occuper de séparer la config des
  139. donnée, de tout stocker dans =/srv/datastore=, il vont
  140. s'occuper de la petite maintenance:
  141. - le charm postgres (qui est une dépendance du service odoo) va créer
  142. un mot de passe et le filer à odoo
  143. - le charm apache (qui implémente le service frontend)
  144. va créer les fichiers de conf apache pour déclarer un virtualhost
  145. et mettre les clés SSL s'il y a lieu.
  146. * Gestion
  147. Description des process de gestion d'une installation existante.
  148. ** Connection aux serveurs
  149. *** installation commande =st=
  150. Le mieux est d'utiliser la commande =st= que l'on peut installer ainsi
  151. sur un poste linux ayant =apt=:
  152. Se mettre en =root=:
  153. #+begin_src sh
  154. cat <<'EOF' > /usr/local/bin/st
  155. #!/bin/bash
  156. echo "Trying mosh to $1"
  157. TERM=xterm-256color mosh "$1" -- bash -c "tmux attach || { tmux; }"
  158. if [ "$?" == "5" ]; then
  159. echo "Fallback to ssh $1"
  160. ssh "$1" -tM "TERM=xterm-256color tmux attach || TERM=xterm-256color tmux"
  161. fi
  162. EOF
  163. chmod +x /usr/local/bin/st
  164. apt install mosh
  165. #+end_src
  166. *** utilisation de la commande =st=
  167. =st= utilise =ssh= ou =mosh= et se met dans un =tmux= sur la destination.
  168. #+begin_src sh
  169. st root@monvps.fr
  170. #+end_src
  171. On note qu'il faut penser à mettre les clé SSH sur la destination.
  172. ** Mise à jour de l'ensemble
  173. Pour mettre à jour un VPS:
  174. #+BEGIN_SRC sh
  175. myc-update
  176. #+END_SRC
  177. Cette commande va ré-appliquer l'installation du charm =docker-host=
  178. qui installe ou met à jour chaque composant.
  179. ** Gestion des dockers
  180. *** Relancement
  181. si on veut relancer parce que le compose a changé :
  182. on fait pareil qu'au lancement : lors du "up", docker-compose se
  183. rend compte que la définition des services a changé et relance les
  184. docker voulu.
  185. *** Arrêt
  186. #+BEGIN_SRC sh
  187. compose --debug down
  188. #+END_SRC
  189. *** Voir les logs
  190. #+BEGIN_SRC sh
  191. cd /opt/apps/myc-deploy
  192. compose --debug logs odoo
  193. #+END_SRC
  194. *** Obtenir les IPs des dockers
  195. #+BEGIN_SRC sh
  196. docker-ip
  197. #+END_SRC
  198. ** Par services
  199. *** odoo
  200. **** Backups
  201. ***** Backuping odoo account (filestore and database)
  202. There are still some quirks, so be sure:
  203. - to change your current directory to =/opt/apps/myc-deploy=
  204. - your odoo instance should be already up.
  205. - to have =admin-password= defined in your =compose.yml=, in your
  206. =odoo= service's =options=.
  207. #+BEGIN_SRC yaml
  208. odoo:
  209. options:
  210. admin-password: XXXXXX
  211. #+END_SRC
  212. #+BEGIN_SRC sh
  213. MYODOOSERVICENAME=odoo
  214. DBNAME="$MYODOOSERVICENAME"
  215. OUTPUTFILE=backup-odoo.zip
  216. cd /opt/apps/myc-deploy &&
  217. compose save "$MYODOOSERVICENAME" "$DBNAME" "$OUTPUT_FILE"
  218. #+END_SRC
  219. The backup file should be in the same directory.
  220. ***** Restoring odoo account (filestore and database)
  221. There are still some quirks, so be sure:
  222. - to change your current directory to =/opt/apps/myc-deploy=
  223. and put your backup file in the same directory
  224. - your odoo instance should be already up.
  225. - to have =admin-password= defined in your =compose.yml=, in your
  226. =odoo= service's =options=.
  227. #+BEGIN_SRC yaml
  228. odoo:
  229. options:
  230. admin-password: XXXXXX
  231. #+END_SRC
  232. *IMPORTANT* you might want to consider the usage of docker-cutoff if
  233. you are restoring a production odoo onto a dev or staging odoo that you
  234. don't want to allow to go mess around with sending mails or fetching mails.
  235. #+BEGIN_SRC yaml
  236. docker-cutoff 25 993 465
  237. #+END_SRC
  238. These are the normal loading instructions:
  239. #+BEGIN_SRC sh
  240. MYODOOSERVICENAME=odoo
  241. DBNAME="$MYODOOSERVICENAME"
  242. SOURCEFILE=backup-odoo.zip
  243. cd /opt/apps/myc-deploy &&
  244. compose load "$MYODOOSERVICENAME" "$SOURCEFIE" "$DBNAME"
  245. #+END_SRC
  246. ***** charger un dump SQL dans odoo
  247. Supporte *.dump ou sql (non compressé), *.gz ou *.bz2:
  248. #+BEGIN_SRC sh
  249. compose load-db odoo MONFICHIER.dump.bz2
  250. #+END_SRC
  251. ***** sauvegarder dump db de odoo
  252. Pour l'instant on passe par pgm
  253. #+BEGIN_SRC sh
  254. compose save-db odoo MONFICHIER.dump.bz2
  255. #+END_SRC
  256. **** Update de modules
  257. #+BEGIN_SRC sh
  258. compose update odoo MABASE [MODULE [MODULE ...]]
  259. #+END_SRC
  260. **** lancement d'une commande odoo
  261. Si l'ensemble n'est pas up:
  262. #+BEGIN_SRC sh
  263. compose --debug run odoo --help
  264. #+END_SRC
  265. **** Mod dev d'odoo
  266. Il est souhaitable de lancer odoo en mode dev avec un terminal prêt à
  267. accueillir un pdb par exemple, et pouvoir changer facilement la ligne de commande.
  268. On peut tout a fait lancer odoo directement, par exempe:
  269. #+BEGIN_SRC sh
  270. compose run --rm --use-aliases odoo --dev=wdb --config=/opt/odoo/auto/odoo.conf
  271. #+END_SRC
  272. On récupère ainsi tous les volumes et autres options (sauf ce qui est
  273. dans =command:=) défini dans =compose.yml=.
  274. Un problème cependant: si on utilise apache comme frontend, celui-ci
  275. ne pourra pas résoudre le nom =odoo= à cause de problèmes autour de
  276. =docker-compose= et/ou =docker network=. En effet, si on fait un =up=
  277. comme d'habitude, et qu'on souhaite simplement arrêter le service
  278. classique pour ensuite le remplacer par la commande au dessus, cela ne
  279. fonctionnera pas. En effet, l'alias réseau =odoo= n'est plus adjoignable
  280. (même avec les commandes =docker network {dis,}connect=), et même si
  281. le container original de odoo est détruit ou éjecté du réseau, ou que l'on
  282. essaye de connecter soi-même le nouveau container.
  283. Un moyen (bancal) de passer outre cependant:
  284. - =down= pour fermer le réseau
  285. - =create= sur le service apache, puis =restart=.
  286. - enfin, le =run= tel que décrit au dessus
  287. Soit:
  288. #+BEGIN_SRC sh
  289. compose down &&
  290. compose create apache &&
  291. compose restart apache &&
  292. compose run --rm --use-aliases odoo --dev=wdb --config=/opt/odoo/auto/odoo.conf
  293. #+END_SRC
  294. Le container odoo crée par la dernière ligne se retirera proprement des tables DNS
  295. interne, et donc peut tout a fait être relancée autant de fois que l'on souhaitera.
  296. *** letsencrypt
  297. Le service letsencrypt fourni des certificat SSL à la demande et les
  298. renouvelle automatiquement.
  299. **** configuration dans compose
  300. ***** Authentification HTTP
  301. Il n'y a besoin d'aucune option dans le service =letsencrypt=.
  302. Le charm =apache= doit trouver un service utilisant le charm =letsencrypt=, cette
  303. connection se fera automatiquement si un servce de type =letsencrypt= est lancé soit
  304. parce que directement mentionné dans la racine ou dans une relation explicite.
  305. La relation construite automatiquement (ou manuellement) d'un service
  306. =apache= vers un service =letsencrypt= s'appelle =cert-provider=.
  307. Une fois que ce service est relié à apache, on peut s'en servir comme clé dans
  308. la configuration =ssl= des relations =*-->web-proxy-->apache=.
  309. Par défaut, =apache= utilisera du ssl pour tout se virtual-host s'il trouve un
  310. =cert-provider= à disposition.
  311. Aussi la configuration suivante est suffisante pour avoir un site publié en SSL:
  312. #+BEGIN_SRC yaml
  313. www.mydomain.org:
  314. charm: odoo
  315. apache:
  316. letsencrypt:
  317. #+END_SRC
  318. Cela équivaut à :
  319. #+BEGIN_SRC yaml
  320. www.mydomain.org:
  321. charm: odoo
  322. relations:
  323. web-proxy:
  324. myapache:
  325. domain: www.mydomain.org
  326. ssl:
  327. myletsencrypt:
  328. challenge-type: http
  329. myapache:
  330. charm: apache
  331. myletsencrypt:
  332. charm: letsencrypt
  333. #+END_SRC
  334. ***** Authentification DNS
  335. ****** créer un nouveau jeu de clé OVH pour l'authentification DNS
  336. When =letsencrypt= is setup and running::
  337. #+BEGIN_SRC sh
  338. compose --debug add letsencrypt DOMAIN [DOMAIN...]
  339. #+END_SRC
  340. Exemple de setup (dans =compose.yml=):
  341. #+BEGIN_SRC yaml
  342. letsencrypt:
  343. options:
  344. email: admin@0k.io
  345. ovh:
  346. entrypoint: ovh-eu
  347. application:
  348. key: ZZZ
  349. secret: XXX
  350. consumer_key: YYYYY
  351. #+END_SRC
  352. Le résultat est dans =/srv/datastore/data/letsencrypt/etc/letsencrypt/live/DOMAIN1=
  353. Il apparaît entre 30sec et 1 minute après la demande.
  354. ****** Vérifier que le jeu de clé ovh est bon
  355. Cette commande prend le compose yml et va vérifier que les accès sont valides:
  356. #+BEGIN_SRC shell
  357. check-compose-ovh-credentials compose.yml
  358. #+END_SRC
  359. **** Utilisation manuelle
  360. On peut utiliser le service =letsencrypt= manuellement
  361. ***** creation d'un certificat http
  362. #+BEGIN_SRC shell
  363. compose crt letsencrypt create DOMAIN [DOMAIN...]
  364. #+END_SRC
  365. Cette action crée un certificat (et force le renouvellement si existant).
  366. On peut y injecter une configuration via =--add-compose-content= si nécessaire::
  367. #+BEGIN_SRC shell
  368. compose --add-compose-content='
  369. letsencrypt:
  370. ovh:
  371. ## see: https://api.ovh.com/g934.first_step_with_api
  372. entrypoint: ovh-eu
  373. application:
  374. key: XXX
  375. secret: YYY
  376. consumer_key: ZZZ
  377. challenge-type: dns
  378. #renew-before-expiry: 30' crt letsencrypt create DOMAIN [DOMAIN...]
  379. #+END_SRC
  380. ***** Renew de tous les certificats
  381. Cela renew uniquement les certificats dont la date de validité est inférieure à 30j
  382. #+BEGIN_SRC shell
  383. compose crt letsencrypt renew
  384. #+END_SRC
  385. ***** Liste des certificats gérés et infos connexes
  386. #+BEGIN_SRC shell
  387. compose run letsencrypt crt list
  388. #+END_SRC
  389. ***** suppression d'un certificat
  390. #+BEGIN_SRC shell
  391. compose run letsencrypt certbot delete --cert-name DOMAIN
  392. #+END_SRC
  393. *** apache
  394. **** Utiliser letsencrypt
  395. Pour ajouter la fonctionalité de génération automatique de certificat
  396. via le service =letsencrypt=, il faut:
  397. - déclarer un service =letsencrypt= si cela n'est pas déjà fait
  398. - le lier au charm apache via une relation =cert-provider=:
  399. #+BEGIN_SRC yaml
  400. frontend:
  401. charm: apache
  402. relations:
  403. cert-provider: letsencrypt
  404. letsencrypt:
  405. ...
  406. #+END_SRC
  407. Et l'on peut alors utiliser la valeur =letsencrypt= (le nom du service qui implémente
  408. qui est en relation =cert-provider= avec apache) dans le champ =ssl=::
  409. #+BEGIN_SRC yaml
  410. web-proxy:
  411. apache:
  412. ...
  413. ssl: letsencrypt
  414. #+END_SRC
  415. **** Changer les clés SSL
  416. Voici un exemple de ce qu'on peut mettre dans les options de la relation apache
  417. pour déclarer le certificat que l'on souhaite:
  418. #+BEGIN_SRC yaml
  419. ssl:
  420. ca-cert:
  421. -----BEGIN CERTIFICATE-----
  422. MIIF6TCCA9GgAwIBAgIQBeTcO5Q4qzuFl8umoZhQ4zANBgkqhkiG9w0BAQwFADCB
  423. iDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCk5ldyBKZXJzZXkxFDASBgNVBAcTC0pl
  424. ...
  425. m9T8bJUox04FB6b9HbwZ4ui3uRGKLXASUoWNjDNKD/yZkuBjcNqllEdjB+dYxzFf
  426. BT02Vf6Dsuimrdfp5gJ0iHRc2jTbkNJtUQoj1iM=
  427. -----END CERTIFICATE-----
  428. -----BEGIN CERTIFICATE-----
  429. MIIFdzCCBF+gAwIBAgIQE+oocFv07O0MNmMJgGFDNjANBgkqhkiG9w0BAQwFADBv
  430. MQswCQYDVQQGEwJTRTEUMBIGA1UEChMLQWRkVHJ1c3QgQUIxJjAkBgNVBAsTHUFk
  431. ...
  432. Le9Gclc1Bb+7RrtubTeZtv8jkpHGbkD4jylW6l/VXxRTrPBPYer3IsynVgviuDQf
  433. Jtl7GQVoP7o81DgGotPmjw7jtHFtQELFhLRAlSv0ZaBIefYdgWOWnU914Ph85I6p
  434. 0fKtirOMxyHNwu8=
  435. -----END CERTIFICATE-----
  436. cert: |
  437. -----BEGIN CERTIFICATE-----
  438. MIIF/TCCBOWgAwIBAgIRALUydpTpCApfYMuJchDJv5AwDQYJKoZIhvcNAQELBQAw
  439. XzELMAkGA1UEBhMCRlIxDjAMBgNVBAgTBVBhcmlzMQ4wDAYDVQQHEwVQYXJpczEO
  440. ...
  441. lIxY9HJanHrWvjiz7+eToxXpZJtAPXTx5hxzcJrtWROlq7IJCMIhzr/EVA37jTCk
  442. Xs5S6mr0T6Dqx6MQkPATSsEEJlLH5wq3DxXQcrMqnM/WHMRYUCkoTl37sXplflHe
  443. jw==
  444. -----END CERTIFICATE-----
  445. key: |
  446. -----BEGIN PRIVATE KEY-----
  447. MIIJRQIBADANBgkqhkiG9w0BAQEFAASCCS8wggkrAgEAAoICAQDONqqTCS4CiSi/
  448. XeNpp2nUsq1299spGc7mlRs+PDrXNHscB5lUB5/yo2yEetYXrJacQ8n4NV9hkID5
  449. ...
  450. 44eHDYsofcnRbidGR+QT8PQgiiDNCkbpi2u4QnLTs0w4oW+53ZTyHYEYF2rcLbIb
  451. vRt4kR4KG6ULXrmsRA4WQjBDJ9vZw2aK+w==
  452. -----END PRIVATE KEY-----
  453. #+END_SRC
  454. **** Ajouter des rêgles particulière de apache
  455. #+BEGIN_SRC yaml
  456. relations:
  457. web-proxy:
  458. apache:
  459. ...
  460. apache-custom-rules: |
  461. RewriteEngine On
  462. RewriteCond %{HTTPS} off
  463. RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [R=302,L,QSA]
  464. #+END_SRC
  465. **** Vérification des derniers logs de renouvellement automatique
  466. #+BEGIN_SRC shell
  467. tail -f /srv/datastore/data/cron/var/log/cron/letsencrypt-renew_script.log -n 200
  468. #+END_SRC
  469. *** postgres
  470. **** utilisation de pgm
  471. récupérer l'IP du docker postgres via =docker-ip=
  472. #+BEGIN_SRC sh
  473. PGHOST=172.19.0.2 PGUSER=postgres pgm ls
  474. #+END_SRC
  475. **** base corrompue, réparation
  476. Il s'agit de lancer un =pg_resetwal=, il faut veiller à plusieurs élément:
  477. - bien arréter tout process utilisant le répertoire de =data= du
  478. postgres en question, généralement un =compose stop postgres=
  479. suffit.
  480. - utiliser l'image du postgres via son nom (habituellement =myc_postgres=).
  481. - monter le répertoire data =directement=
  482. Le tout peut se faire ainsi dans une installation qui fait tourner un postgres
  483. actuellement:
  484. #+begin_src sh
  485. compose stop postgres &&
  486. docker run --rm --entrypoint pg_resetwal \
  487. -u postgres -v /srv/datastore/data/postgres/var/lib/postgresql/data:/var/lib/postgresql/data \
  488. myc_postgres \
  489. /var/lib/postgresql/data &&
  490. docker start myc_postgres_1
  491. #+end_src
  492. *** mysql
  493. **** sur installation mailcow
  494. Le script =mailcow-backup-install= fourni via =myc-manage= s'occupe
  495. de mettre en place le dump de =mysql=, et le système pour envoyer les
  496. backup régulièrement via rsync.
  497. **** docker sans compose
  498. #+begin_src sh
  499. export MYSQL_ROOT_PASSWORD=xxx
  500. export MYSQL_CONTAINER=mailcowdockerized_mysql-mailcow_1
  501. /srv/charm-store/mysql/hooks/install.d/60-backup.sh
  502. #+end_src
  503. *** rsync-backup
  504. **** Installation du backup via compose
  505. A faire depuis le serveur ayant des services géré par =compose= à
  506. backupper.
  507. #+begin_src sh
  508. DOMAIN=xxx.fr
  509. BACKUP_SERVER=core-06.0k.io:10023
  510. ssh-keygen -t rsa -N "" -f /root/.ssh/rsync_rsa -C "rsync@$DOMAIN"
  511. cat <<EOF >> /opt/apps/myc-deploy/compose.yml
  512. rsync-backup:
  513. options:
  514. ident: $DOMAIN
  515. target: $BACKUP_SERVER
  516. private-key: |
  517. $(cat /root/.ssh/rsync_rsa | sed -r 's/^/ /g')
  518. EOF
  519. dest="$BACKUP_SERVER"
  520. dest="${dest%/*}"
  521. dest="${dest%%:*}"
  522. echo "Contacting '$dest' host, to add key in authorized key:"
  523. ssh "root@${dest}" -- compose-add-rsync-key "\"$DOMAIN\"" "\"$(cat /root/.ssh/rsync_rsa.pub)\""
  524. compose build mongo ## force the build of the new mongo image with regular dumps
  525. #+end_src
  526. **** Installation du backup sur une installe mailcow
  527. Le script suivant va s'occuper de tout, il doit être lancé
  528. depuis l'hôte faisant tourner l'installation =mailcow=.
  529. #+begin_src sh
  530. mailcow-backup-install
  531. #+end_src
  532. **** Installation du backup sur un host debian
  533. Cela fonctionnera sur tout host ayant une base debian.
  534. #+begin_src sh
  535. export DOMAIN=mail.myceliandre.fr
  536. export BACKUP_SERVER=core-06.0k.io:10023
  537. /srv/charm-store/rsync-backup/hooks/install.d/60-install.sh
  538. #+end_src
  539. Note, il est possible de spécifier des exclusions pour chaque
  540. répértoire mirroré de telle façon:
  541. #+begin_src sh
  542. cat <<EOF > /etc/mirror-dir/config.yml
  543. /home:
  544. exclude:
  545. - /*/.cache/
  546. - /*/.gvfs/
  547. - /*/.local/share/Trash/files/
  548. - /*/.Trash/
  549. - /*/.mozilla/firefox/*/Cache/
  550. - /*/.mozilla/firefox/*/storage/default/*/cache/
  551. /media/data:
  552. exclude:
  553. - /binary/games/_steam
  554. - /incoming
  555. - /.Trash*
  556. - /lost+found
  557. - /backup/device
  558. EOF
  559. #+end_src
  560. * Interventions avancées
  561. Description des process avancés d'intervention sur une installation existante.
  562. ** Modification du compose
  563. Y a un exemple en commentaire dans le =/opt/apps/myc-deploy/compose.yml=
  564. Petit exemple:
  565. #+BEGIN_SRC yaml
  566. odoo:
  567. ...
  568. docker-compose:
  569. ## Important to keep as a list: otherwise it'll overwrite charm's arguments.
  570. command:
  571. - "--log-level=debug"
  572. environment:
  573. TOTO: TUTU
  574. image: masuperimage
  575. #+END_SRC
  576. ** Troubleshooting
  577. S'il semble qu'il y ait un soucis, tu peux visualiser le =docker-compose.yml= qui est
  578. généré à la fin via l'ajout de =--debug= AVANT la commande:
  579. #+BEGIN_EXAMPLE
  580. compose --debug up odoo frontend
  581. #+END_EXAMPLE
  582. * Comment ça marche
  583. La surcouche =compose= est là pour créer un =docker-compose.yml= et le
  584. lancer tout a fait normalement. Le long du chemin, il peut aussi
  585. préparer des trucs utiles si c'est nécessaire.
  586. Il part du =compose.yml= et accède aux définitions en yaml des charms à déployer
  587. et qui sont dans /srv/charms ... (qui en fait sont dans =/opt/apps/0k-charms=).
  588. Chaque charm possède une définition générale (le =metadata.yml=) qui peut aussi
  589. injecter des trucs dans le =docker-compose.yml= final.
  590. Et puis il y a des =hooks=, qui sont juste des scripts bash qui sont
  591. lancés avec des infos dans des variables d'environment, qui vont généralement
  592. créer des trucs à l'init ou lors de liaison avec d'autres charms.