From c9090d4eeebc5f2bc6c1700082da7d78a2cb31ec Mon Sep 17 00:00:00 2001
From: Arthur BOUDREAULT <arthur@lydra.fr>
Date: Thu, 15 Sep 2022 11:37:19 +0200
Subject: [PATCH] docs: update README for Docker Compose
---
roles/ynh_apps/README-FR.md | 47 ++++++++++++++++++++++++++++++++++++
roles/ynh_apps/README.md | 48 +++++++++++++++++++++++++++++++++++++
2 files changed, 95 insertions(+)
diff --git a/roles/ynh_apps/README-FR.md b/roles/ynh_apps/README-FR.md
index d128676..36b60b1 100644
--- a/roles/ynh_apps/README-FR.md
+++ b/roles/ynh_apps/README-FR.md
@@ -70,6 +70,53 @@ Cette tâche utilisant le module template, vous pouvez tout à fait utiliser vos
Pour `owner` et `group`, par défaut le fichier va prendre comme utilisateur propriétaire le nom de l'application et comme groupe propriétaire www-data (groupe NGINX). Vous pouvez les changer en précisant des valeurs différentes.
+### Gestion des conteneurs Docker
+Par défaut, les applications de YunoHost sont prépackagées par les membres de la communauté. Nous avons décidé d'aller plus loin, en ajoutant simplement la possibilité de déployer des conteneurs Docker à l'aide de Docker Compose et de les intégrer au panel d'applications YunoHost. Nous utilisons pour cela [l'application YunoHost redirect](https://github.com/YunoHost-Apps/redirect_ynh/).
+
+### 1ere étape : Installation et lancement des conteneurs Docker
+
+```yml
+enable_ynh_docker: true
+geerlingguy_docker_version: 5.2.1
+docker_compose_src_template: templates/compose.yml.j2
+docker_compose_dest_template: /tmp/compose.yml
+docker_compose_version: 3.9
+docker_compose_apps:
+ - name: app1
+ image: "recordsansible/ara-api:latest"
+ ports:
+ - "8000:8000"
+ volumes:
+ - "/home/{{ ynh_admin }}/.ara/server:/opt/ara"
+ environment: null
+```
+
+- `enable_ynh_docker` : Active / désactive la fonctionnalité d'installation et de lancement des services Docker Compose.
+- `geerlingguy_docker_version`: Vous permet de spécifier la version du rôle Ansible Docker que vous souhaitez utiliser. La version par défaut du rôle est 5.2.1, mais vous pouvez vérifier les versions du rôle [ici](https://github.com/geerlingguy/ansible-role-docker/tags).
+- `docker_compose_src_template`: Chemin où se trouve le fichier de template Docker Compose à utiliser. Par défaut, nous fournissons un fichier de template mais vous pouvez aussi fournir votre fichier Docker Compose personnalisé.
+- `docker_compose_dest_template` : Chemin où va être le fichier Docker Compose sur la machine distante.
+- `docker_compose_version` : Version de Docker Compose utilisée pour le fichier. Valeur par défaut: `3.9`.
+- `docker_compose_apps` : Dictionnaires d'un ou plusieurs services Docker Compose. Dans chaque dictionnaire vous pourrez définir : name (obligatoire), image (obligatoire), ports (optionnel), volumes (optionnel) et environment (optionnel, variables d'environnement). Si vous ne définissez pas un des clés optionnelles, il vous faudra ne pas remplir de valeur ou la mettre à "null". Supprimer une clé du dictionnaire fera faire une erreur à Ansible.
+
+### 2eme étape : Installation des applications Yunohost redirect
+
+Si vous voulez intégrer des applications conteneurisées à l'interface utilisateur YunoHost ou facilement gérer une redirection à l'aide de Nginx, il existe [l'application YunoHost redirect](https://github.com/YunoHost-Apps/redirect_ynh/).
+
+```yml
+ynh_apps:
+ - label: "Redirection de l'application ara"
+ link: "redirect"
+ args:
+ domain: "ara.exemple.com"
+ path: "/"
+ redirect_path: "http://0.0.0.0:8000"
+ redirect_type: "public_proxy"
+```
+
+Dans l'exemple ci-dessus. On va rediriger l'application disponible sur le port 8000 de la machine pour qu'il soit exposé sur internet depuis l'url "ara.exemple.com".
+
+- `redirect_type` : Il existe 4 types de redirections gérées par Nginx. [Pour en savoir plus](https://github.com/YunoHost-Apps/redirect_ynh/blob/62718ad5c42705c92752908f3e062d086b87a251/manifest.json#L57).
+
## Dépendances
Aucune.
diff --git a/roles/ynh_apps/README.md b/roles/ynh_apps/README.md
index 44bc735..fd76913 100644
--- a/roles/ynh_apps/README.md
+++ b/roles/ynh_apps/README.md
@@ -70,6 +70,54 @@ Because this task uses the template module, you can use your own variables and c
For `owner` and `group`, by default the file will take as owner the name of the application and as owner www-data(NGINX group). You can change them by specifying different values.
+### Docker container management
+
+By default, YunoHost applications are pre-packaged by community members. We decided to go further, by simply adding the ability to deploy Docker containers using Docker Compose and integrate them into the YunoHost application panel.
+
+### Step 1: Install and launch Docker containers
+
+```yml
+enable_ynh_docker: true
+geerlingguy_docker_version: 5.2.1
+docker_compose_src_template: templates/compose.yml.j2
+docker_compose_dest_template: /tmp/compose.yml
+docker_compose_version: 3.9
+docker_compose_apps:
+ - name: app1
+ image: "recordsansible/ara-api:latest"
+ ports:
+ - "8000:8000"
+ volumes:
+ - "/home/{{ ynh_admin }}/.ara/server:/opt/ara"
+ environment: null
+```
+
+- `enable_ynh_docker`: Enables / disables the feature to install and launch Docker Compose services.
+- `geerlingguy_docker_version`: Allows you to specify the version of the Ansible Docker role you wish to use. The default version of the role is 5.2.1, but you can check the role versions [here](https://github.com/geerlingguy/ansible-role-docker/tags).
+- `docker_compose_src_template`: Path where the Docker Compose template file is located. By default a template file is provided by us but you can also provide your custom Docker Compose file.
+- docker_compose_dest_template`: Path where the Docker Compose file will be on the remote machine.
+- docker_compose_version`: Version of Docker Compose used for the file.
+- docker_compose_apps`: Dictionaries of one or more Docker Compose services. In each dictionary you will be able to define: name (required), image (required), ports (optional), volumes (optional) and environment (optional, environment variables). If you don't define one of the optional keys, you will have to leave the value blank or set it to "null". Removing a key from the dictionary will make Ansible make an error.
+
+### Step 2: Installing Yunohost redirect applications
+
+If you want to integrate containerized applications with the YunoHost UI or easily manage a redirect using Nginx, there is [the YunoHost redirect application](https://github.com/YunoHost-Apps/redirect_ynh/).
+
+```yml
+ynh_apps:
+ - label: "ara application redirect"
+ link: "redirect"
+ args:
+ domain: "ara.example.com"
+ path: "/"
+ redirect_path: "http://0.0.0.0:8000"
+ redirect_type: "public_proxy"
+```
+
+In the example above. We will redirect the application available on port 8000 of the machine to be exposed on the internet from the url "ara.example.com".
+
+- `redirect_type` : There are 4 types of redirects managed by Nginx. [For more information](https://github.com/YunoHost-Apps/redirect_ynh/blob/62718ad5c42705c92752908f3e062d086b87a251/manifest.json#L57).
+
## Dependencies
None.
--
GitLab