From 4f6478be557c28ca60fd780d1a1fc731306f80ae Mon Sep 17 00:00:00 2001
From: Lars Beckers <lars.beckers@rwth-aachen.de>
Date: Thu, 6 Apr 2017 17:27:26 +0200
Subject: [PATCH] add readme

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..83227ce
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Tivoli Storage Manager aka IBM Spectrum Protect -- RWTH Edition
+
+Deployment of TSM software and configuration, adhering to the specifics at RWTH Aachen.
+
+## Roles
+
+- `tsm-archive`, configures the software for archival purposes
+- `tsm-backup`, configure the software for backup purposes
+- `tsm-client`, installs software and ensures a compatible environment
+
+`tsm-client` is a dependency of the other roles and does not need manual inclusion in playbooks.
+
+*Note:* The backup and archive functionality are mutual exclusive.
+
+## Variables
+
+- `tsm_name`, name of backup/archive node
+- `tsm_node`, number of tsm server
+- `tsm_port`, optional (dervied from server number)
+- `tsm_repo`, repository containing tsm packages
+- `tsm_repo_pubkey`, the repository's public key
+- `tsm_backup_domains`, adds directories to backup
+- `tsm_backup_virtual`, must include all domains which are NOT mountpoints
+- `tsm_backup_includes`, include additional files
+- `tsm_backup_excludes`, exclude files
+- `tsm_backup_include_dirs`, include addtional directories
+- `tsm_backup_exclude_dirs`, exclude directories
+
+`tsm_backup_*` have defaults.
+
-- 
GitLab