From a8836c0dabb173caa40533a0346fe11784e14cbb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20-=20Le=20Filament?= <remi@le-filament.com>
Date: Fri, 11 Jun 2021 16:21:50 +0200
Subject: [PATCH] Document role
---
README.md | 27 ++++++++++++++++++++-------
defaults/main.yml | 25 ++++++++++++++++++++++++-
meta/main.yml | 26 ++++++++++++--------------
templates/tuleap.yaml.j2 | 2 +-
4 files changed, 57 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index a3d0bdb..904124e 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,32 @@
-Role Name
-=========
+docker_tuleap
+=============
-A brief description of the role goes here.
+This role deploys Tuleap. This role is not maintained anymore.
Requirements
------------
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+None
Role Variables
--------------
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+Variables from default directory :
+* tuleap_url: URL for accessing Tuleap
+* tuleap_db_root_pass : Root password for MySQL database
+* Backups :
+ * swift parameters for 2 object storage instances where backups should be pushed daily
+ * tuleap_backup_pass : Passphrase for encryption of backups
+
Dependencies
------------
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+This role requires the following Ansible collection :
+* community.docker
+
+This Docker role supposes that Traefik is deployed as an inverseproxy in front of the deployed Dockers.
+The following role is used by Le Filament for deploying Traefik : docker_server (https://sources.le-filament.com/lefilament/ansible-roles/docker_server)
Example Playbook
----------------
@@ -25,7 +35,10 @@ Including an example of how to use your role (for instance, with variables passe
- hosts: servers
roles:
- - { role: username.rolename, x: 42 }
+ - { role: docker_tuleap }
+ vars:
+ - { tuleap_url: "tuleap.example.org" }
+ - { tuleap_db_root_pass: "veryUnsecurePassToBeModified" }
License
-------
diff --git a/defaults/main.yml b/defaults/main.yml
index 9457e0c..01c7ee4 100644
--- a/defaults/main.yml
+++ b/defaults/main.yml
@@ -1,2 +1,25 @@
---
-# defaults file for test
+# Tuleap URL (only sub.domain without https:// in front)
+tuleap_url: "tuleap.example.org"
+# Tuleap DB
+tuleap_db_root_pass: "veryUnsecurePassToBeModified"
+
+# Backups
+# Parameters for pushing backups to Object Storage - Instance 1
+swift_odoo_authurl: https://auth.cloud.ovh.net/v3/
+swift_odoo_authversion: 3
+swift_odoo_tenantid: "132e1fa"
+swift_odoo_tenantname: "12312534534"
+swift_odoo_username: "testuser"
+swift_odoo_password: "testpassword"
+swift_odoo_regionname: "GRA"
+# Parameters for pushing backups to Object Storage - Instance 2
+swift_odoo2_authurl: https://auth.cloud.ovh.net/v3/
+swift_odoo2_authversion: 3
+swift_odoo2_tenantid: "12323534ab"
+swift_odoo2_tenantname: "123124235345"
+swift_odoo2_username: "testuser"
+swift_odoo2_password: "testpassword"
+swift_odoo2_regionname: "DE"
+# Passphrase for backups encryption
+tuleap_backup_pass: notSecureEnoughPasswordToBeModified
diff --git a/meta/main.yml b/meta/main.yml
index 4ed7944..c41f1f0 100644
--- a/meta/main.yml
+++ b/meta/main.yml
@@ -1,20 +1,18 @@
+---
galaxy_info:
author: Rémi
- description: your role description
+ description: Role for deploying Tuleap on Docker. Role not maintained anymore.
company: Le Filament (https://le-filament.com)
-
license: AGPL-3.0-or-later
-
min_ansible_version: 2.1
-
platforms:
- - name: CentOS
- versions:
- - 7
- - name: Ubuntu
- versions:
- - 16.04
- - 18.04
- - 20.04
-
- galaxy_tags: []
+ - name: CentOS
+ versions:
+ - 7
+ - name: Ubuntu
+ versions:
+ - 16.04
+ - 18.04
+ - 20.04
+ galaxy_tags:
+ - tuleap
diff --git a/templates/tuleap.yaml.j2 b/templates/tuleap.yaml.j2
index 2617813..8266878 100644
--- a/templates/tuleap.yaml.j2
+++ b/templates/tuleap.yaml.j2
@@ -1,5 +1,5 @@
version: "2.1"
-
+
services:
tuleap:
image: enalean/tuleap-aio:stable
--
GitLab