From 3c8ba1d94ddd40b4eaaa20d32321b51fee749f7c 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

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

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.