diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..83227ced3a9c232d08cdaf1e990b269a36aeefe3 --- /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. +