From 417540209ac92abbcfa104f0745ed896aea13606 Mon Sep 17 00:00:00 2001 From: spmfox Date: Sat, 2 Sep 2023 23:03:55 -0400 Subject: initial --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index ab329b0..25399ad 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,24 @@ By default it will create systemd service files and is compatible with or withou - ```ansible-playbook host.yml``` - ```ansible-galaxy install -r collections/requirements.yml``` - ```ansible-playbook containers.yml -e @docs/sample-environment/wordpress.yml``` + +## Features +- Declare container environment using Ansible variables file +- Rebuild, stop, start, enable systemd service, disable + remove systemd files +- One command for re-build image, re-generate systemd unit files +- Utilizes rootless Podman + +## Sample Environment +A fully working pod with Wordpress and a MariaDB database are in the ```docs/sample-environment``` directory. + +## Requirements +- Ansible +- Ansible collections + - ```ansible-galaxy install -r collections/requirements.yml``` +- Podman +- User with ```sudo``` rights + +## Assumptions +- Rootless mode is being used, so tasks are written to use systemd user scope + - Tasks would need to be tweaked for using the root user +- ```containers``` user is automatically created during the ```host.yml``` play -- cgit