From f9bbcd6c71ea96a7a52b3c2e00956c875cd02448 Mon Sep 17 00:00:00 2001
From: Johanna Dorothea Reichmann <transcaffeine@finally.coffee>
Date: Wed, 26 Jul 2023 20:04:50 +0200
Subject: [PATCH] chore(mariadb): add role-README, update collection README

---
 README.md               |  1 +
 roles/mariadb/README.md | 19 +++++++++++++++++++
 2 files changed, 20 insertions(+)
 create mode 100644 roles/mariadb/README.md

diff --git a/README.md b/README.md
index a6dabf4..f3aa7ef 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@ and configuring basic system utilities like gnupg, ssh etc
 
 - [`git`](roles/git/README.md): configures git on the target system
 - [`gnupg`](roles/gnupg/README.md): configures gnupg on the target system
+- [`mariadb`](roles/mariadb/README.md): runs [MariaDB Server](https://mariadb.org/), one of the world's most popular open source relational database
 - [`nginx`](roles/nginx/README.md): [nginx](https://www.nginx.com/),
   an advanced load balancer, webserver and reverse proxy.
 
diff --git a/roles/mariadb/README.md b/roles/mariadb/README.md
new file mode 100644
index 0000000..c74769c
--- /dev/null
+++ b/roles/mariadb/README.md
@@ -0,0 +1,19 @@
+# `finallycoffee.base.mariadb` ansible role
+
+This role deploys a MariaDB instance in a docker container.
+
+## Usage
+
+The role expects the following variables to be populated with values and/or secrets:
+
+```yaml
+mariadb_root_password: #mariadb root password
+mariadb_database: # name of the database to create
+mariadb_username: # name of a user to auto-create and assign permission on the mariadb_database
+mariadb_password: # password of the user in mariadb_username
+```
+
+## Requirements
+
+- Docker installed
+- python-docker present on target system for ansible to be able to talk with the docker API.