initial commit

.gitattributes

+# CRLF vs. LF:
+* text=auto
+
+# make 'git diff' use ansible-vault for vault files, so you can see decrypted
+# content if you have the password
+*.vault diff=ansible-vault merge=binary

.githooks/pre-commit

+#!/usr/bin/env bash
+#
+# An example hook script to verify what is about to be committed.
+# Called by "git commit" with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message if
+# it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-commit".
+
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+	against=HEAD
+else
+	# Initial commit: diff against an empty tree object
+	against=$(git hash-object -t tree /dev/null)
+fi
+
+# If you want to allow non-ASCII filenames set this variable to true.
+allownonascii=$(git config --bool hooks.allownonascii)
+
+# Redirect output to stderr.
+exec 1>&2
+
+# Cross platform projects tend to avoid non-ASCII filenames; prevent
+# them from being added to the repository. We exploit the fact that the
+# printable range starts at the space character and ends with tilde.
+if [ "$allownonascii" != "true" ] &&
+	# Note that the use of brackets around a tr range is ok here, (it's
+	# even required, for portability to Solaris 10's /usr/bin/tr), since
+	# the square bracket bytes happen to fall in the designated range.
+	test $(git diff --cached --name-only --diff-filter=A -z $against |
+	  LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
+then
+	cat <<\EOF
+Error: Attempt to add a non-ASCII file name.
+
+This can cause problems if you want to work with people on other platforms.
+
+To be portable it is advisable to rename the file.
+
+If you know what you are doing you can disable this check using:
+
+  git config hooks.allownonascii true
+EOF
+	exit 1
+fi
+
+# If there are whitespace errors, print the offending file names and fail.
+# exec git diff-index --check --cached $against --
+
+
+
+################################################################################
+## Everything below this is customized, everything above is from the example. ##
+################################################################################
+
+### PREPARE
+
+# Expand aliases and make alias command work in the bash script.
+shopt -s expand_aliases
+
+REPOPATH="$(git rev-parse --show-toplevel)"
+GREP_CMD='grep -Rn --color'
+GREP_EXCLUDES="--exclude-dir=\.git --exclude-dir=\.githooks --exclude=*\.example"
+
+### YAMLLINT stage
+STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM)
+YAML_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep ".yml$")
+if [[ ${YAML_FILES} != "" ]]; then
+	for file in ${YAML_FILES}; do
+		yamllint "${file}"
+		if [[ ${?} -ne 0 ]]; then
+			exit 1
+		fi
+	done
+fi && echo "SUCCESS: Yamllint stage."
+
+### VAULT detection stage
+VAULT_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep ".vault$")
+if [[ ${VAULT_FILES} != "" ]]; then
+	echo "ERROR: Vaultfiles found:"
+	for file in ${VAULT_FILES}; do
+		echo "- ${file}"
+	done
+	exit 1
+fi
+# https://docs.ansible.com/ansible/latest/user_guide/vault.html#vault-format
+if [[ ${STAGED_FILES} != "" ]]; then
+	for file in ${STAGED_FILES}; do
+		grep -e "\$ANSIBLE_VAULT;[[:digit:]]\.[[:digit:]];AES256" "${file}"
+		[[ ${?} -eq 0 ]] && echo "ERROR: Ansible-Vault in String found in file '${file}'." && exit 1
+	done
+fi
+echo "SUCCESS: Vault detection stage."
+
+### URL detection stage
+${GREP_CMD} ${GREP_EXCLUDES} -e "http[s]*.*git.*SLUB" -e "http[s]*.*git.*slub" -e "git@" "${REPOPATH}"
+if [[ ${?} -eq 0 ]]; then
+	echo "ERROR: found internal URLs."
+	exit 1;
+fi
+echo "SUCCESS: URL detection stage."
+
+### IP address detection stage
+# This is pretty basic regex matching, but it's a start.
+IP_REGEX='[^a-zA-ZäöÜÄÖÜß/\\\-][0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\}'
+${GREP_CMD} ${GREP_EXCLUDES} -e "${IP_REGEX}" "${REPOPATH}" | grep -v "127.0.0"
+if [[ ${?} -eq 0 ]]; then
+	echo "ERROR: found IP address."
+	exit 1;
+fi
+echo "SUCCESS: IP address detection stage."
+
+### SSH-Key detection stage
+${GREP_CMD} ${GREP_EXCLUDES} -e "ssh-[dr]sa " "${REPOPATH}"
+if [[ ${?} -eq 0 ]]; then
+	echo "ERROR: found SSH key."
+	exit 1;
+fi
+echo "SUCCESS: SSH Key detection stage."
+
+
+
+
+### DONE
+# Return explicit 0.
+exit 0;

.gitignore

+# Compiled source #
+###################
+*.bin
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+*.pyc
+__pycache__
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+*.tar.gz
+*.tgz
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Linux packages #
+##################
+*.deb
+*.rpm
+
+# Ansible specific files #
+##########################
+
+*.retry
+*.vault
+
+# Vim #
+#######
+
+# swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-v][a-z]
+[._]sw[a-p]
+ # session
+Session.vim
+# temporary
+.netrwhist
+# auto-generated tag files
+tags
+
+# Vagrant #
+###########
+
+.vagrant/
+*.box
+
+# Temporary/Build/Backup #
+##########################
+
+backups/
+build/
+
+# CONFIDENTIAL #
+################
+
+ssh_host_*
+

.travis.yml

+---
+language: python
+python: "2.7"
+
+# Use the new container infrastructure
+sudo: false
+
+# Install ansible
+addons:
+  apt:
+    packages:
+    - python-pip
+
+install:
+  # Install ansible
+  - pip install ansible
+
+  # Check ansible version
+  - ansible --version
+
+  # Create ansible.cfg with correct roles_path
+  - printf '[defaults]\nroles_path=../' >ansible.cfg
+
+script:
+  # Basic role syntax check
+  - ansible-playbook tests/test.yml -i tests/inventory --syntax-check
+
+notifications:
+  webhooks: https://galaxy.ansible.com/api/v1/notifications/
\ No newline at end of file

.yamllint

+---
+# Based on ansible-lint config
+extends: default
+
+rules:
+  braces:
+    max-spaces-inside: 1
+    level: error
+  brackets:
+    max-spaces-inside: 1
+    level: error
+  colons:
+    max-spaces-after: -1
+    level: error
+  commas:
+    max-spaces-after: -1
+    level: error
+  comments: disable
+  comments-indentation: disable
+  document-start: disable
+  empty-lines:
+    max: 3
+    level: error
+  hyphens:
+    level: error
+  indentation: disable
+  key-duplicates: enable
+  line-length: disable
+  new-line-at-end-of-file: disable
+  new-lines:
+    type: unix
+  trailing-spaces: disable
+  truthy: disable

README.md

-# Ansible LZA Backup Proxy
+# Ansible-Role "ansible_lza_backup_proxy"
 
+## Description
+
+This role provides all necessary post-install tasks to setup an IBM Spectrum Protect proxy server to delegate NFS share backup tasks.
+
+## Prerequisites
+
+To use this role, the following software must be installed on your workstation:
+* ansible
+
+To deploy this role to a managed host, the following software must be installed on the target:
+* Python3
+* SSHd
+
+It is recommended to use Debian VMs as deployed by SLUB's UDA tool with this role. Otherwise you will not have access to the software packages that are located in SLUB's private Debian package repository.
+
+## Quick Start
+
+```
+	ansible-playbook site.yml [-i <INVENTORY_FILE>] [--limit <HOSTNAME>] [-u <USERNAME>] [-b]
+```
+
+## General Ansible usage
+
+Most options already have sensible defaults in `ansible.cfg`. However, you can override these defaults using CLI options/flags if you want to.
+
+To simply run the playbook, just call the `site.yml` playbook like this:
+```
+	ansible-playbook site.yml -u <username>
+```
+
+If you want to limit the execution to a subset of all hosts that are listed in the inventory, use the `-l` or `--limit` option like this:
+```
+	ansible-playbook site.yml -l <hostna*>
+	ansible-playbook site.yml -l <hostname>
+	ansible-playbook site.yml -l <hostname1>:<hostname2>:...
+	ansible-playbook site.yml -l <inventory_group>
+	ansible-playbook site.yml --limit=<hostna*>
+```
+
+If you do not have Vault password files in the directory above the role direcory, you have to give the Vault password before execution:
+```
+	ansible-playbook site.yml --ask-vault-pass
+```
+
+You can use your own inventory file by adding the `-i` or `--inventory=INVENTORY` option:
+```
+	ansible-playbook site.yml -i inventory.yml
+	ansible-playbook site.yml --inventory=inventory.yml
+```
+
+Tasks in this role have been tagged to enable users to only run subsets of tasks. This can be leveraged to decrease run times or run only certain tasks after small changes.
+To list all available tags, use:
+```
+	ansible-playbook site.yml --list-tags
+```
+You can then run only certain tagged tasks by using the `--tags` option:
+```
+	ansible-playbook site.yml -t tag1,tag2,...,tagN
+	ansible-playbook site.yml --tags=tag1,tag2,...,tagN
+```
+
+For more help with ansible-playbook, use the `--help` flag.
+
+## Testing the role
+
+Tests have been implemented using the Molecule framework. The details on using the test suite are described below `molecule/`.
+
+## Variables
+
+Many variables have been "hidden" in encrypted Ansible Vaults. For security reasons, these Vaults are maintained in a separate private internal repository of SLUB's Git. However, in order to better understand the data within the vaults, you can find `\*.vault.example` files below the `vars/` directory.
+
+If you work outside of SLUBArchive and have no access to the vault repository, make sure to put the necessary vaults in the expected paths at `../ansible_vaults/<ROLENAME>/`.
+
+## git configuration
+
+Just run the `setup_gitconfig.sh` script that comes with the repo to correctly setup all necessary local Git configurations.
+
+## Author Information
+
+If you have any comments or find bugs, please contact langzeitarchiv@slub-dresden.de or issue a pull request.

ansible.cfg

+[defaults]
+# If set, configures the path to the Vault password file as an alternative to
+# specifying --vault-password-file on the command line.
+vault_identity_list = ../lza_install_common.pass, ../lza_server_hardening.pass, ../slub_osquery.pass, ../lza_backup_proxy.pass
+
+# Path to default inventory file
+# Administrators can override this by using the "-i <inventoryfile>" CLI
+# argument.
+inventory           = ../ansible_vaults/inventory.yml
+
+# Remote user name
+# We DELIBERATELY set this to an non-existent non-root username to make sure
+# the role can only be run if an Administrator knows the correct remote_user
+# name and passes it as a CLI argument.
+remote_user         = non-root-user
+
+# By default, ansible will use the 'linear' strategy but you may want to try
+# another one
+strategy            = free
+
+# Don't like cows?  that's unfortunate.
+# Set to 1 if you don't want cowsay support or export ANSIBLE_NOCOWS=1
+nocows = 1
+
+# Custom role path that guarantees roles are always found, no matter where a
+# user checks them out.
+roles_path = ../:~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles
+
+[inventory]
+# Ignore these extensions when parsing a directory as inventory source.
+ignore_extensions = .pyc, .pyo, .swp, .bak, ~, .rpm, .md, .txt, ~, .orig, .ini, .cfg, .retry
+
+[ssh_connection]
+# Enabling pipelining reduces the number of SSH operations required to
+# execute a module on the remote server. This can result in a significant
+# performance improvement when enabled, however when using "sudo:" you must
+# first disable 'requiretty' in /etc/sudoers
+# By default, this option is disabled to preserve compatibility with
+# sudoers configurations that have requiretty (the default on many distros).
+pipelining = True

defaults/main.yml

+---
+# defaults file for ansible_lza_backup_proxy

handlers/main.yml

+---
+- name: restart dsmcad
+  systemd:
+    name: "dsmcad.service"
+    state: restarted

meta/main.yml

+galaxy_info:
+  author: Jörg Sachse
+  description: IT administrator
+  company: SLUBArchiv.digital
+
+  # If the issue tracker for your role is not on github, uncomment the
+  # next line and provide a value
+  # issue_tracker_url: http://example.com/issue/tracker
+
+  # Choose a valid license ID from https://spdx.org - some suggested licenses:
+  # - BSD-3-Clause (default)
+  # - MIT
+  # - GPL-2.0-or-later
+  # - GPL-3.0-only
+  # - Apache-2.0
+  # - CC-BY-4.0
+  license: license (GPL-2.0-or-later, MIT, etc)
+
+  min_ansible_version: 2.2
+
+  # If this a Container Enabled role, provide the minimum Ansible Container version.
+  # min_ansible_container_version:
+
+  #
+  # Provide a list of supported platforms, and for each platform a list of versions.
+  # If you don't wish to enumerate all versions for a particular platform, use 'all'.
+  # To view available platforms and versions (or releases), visit:
+  # https://galaxy.ansible.com/api/v1/platforms/
+  #
+  # platforms:
+  # - name: Fedora
+  #   versions:
+  #   - all
+  #   - 25
+  # - name: SomePlatform
+  #   versions:
+  #   - all
+  #   - 1.0
+  #   - 7
+  #   - 99.99
+  platforms:
+  - name: Debian
+    versions:
+    - 10
+    - 11
+
+  galaxy_tags: []
+    # List tags for your role here, one per line. A tag is a keyword that describes
+    # and categorizes the role. Users find roles by searching for tags. Be sure to
+    # remove the '[]' above, if you add tags to this list.
+    #
+    # NOTE: A tag is limited to a single word comprised of alphanumeric characters.
+    #       Maximum 20 tags per role.
+
+dependencies: []
+  # List your role dependencies here, one per line. Be sure to remove the '[]' above,
+  # if you add dependencies to this list.

molecule/default/INSTALL.rst

+*********************************
+Vagrant driver installation guide
+*********************************
+
+Requirements
+============
+
+* Vagrant
+* Virtualbox, Parallels, VMware Fusion, VMware Workstation or VMware Desktop
+
+Install
+=======
+
+Please refer to the `Virtual environment`_ documentation for installation best
+practices. If not using a virtual environment, please consider passing the
+widely recommended `'--user' flag`_ when invoking ``pip``.
+
+.. _Virtual environment: https://virtualenv.pypa.io/en/latest/
+.. _'--user' flag: https://packaging.python.org/tutorials/installing-packages/#installing-to-the-user-site
+
+.. code-block:: bash
+
+    $ pip install 'molecule_vagrant'

molecule/default/converge.yml

+---
+- name: Converge
+  hosts: all
+  tasks:
+    - name: "Include ansible_lza_backup_proxy"
+      include_role:
+        name: "ansible_lza_backup_proxy"

molecule/default/molecule.yml

+---
+dependency:
+  name: galaxy
+driver:
+  name: vagrant
+platforms:
+  - name: instance
+provisioner:
+  name: ansible
+verifier:
+  name: ansible

molecule/default/verify.yml

+---
+# This is an example playbook to execute Ansible tests.
+
+- name: Verify
+  hosts: all
+  gather_facts: false
+  tasks:
+  - name: Example assertion
+    assert:
+      that: true

setup_gitconfig.sh

+#!/usr/bin/env bash
+set -ex
+
+# Change the path that Git expects the hooks to be in, so we can track the hooks
+# within the repository (as the default `.git/` directory is not tracked).
+git config --local core.hooksPath .githooks/
+
+# To be able to run `git diff` on Ansible Vault files, please set you local
+# `git/config` files as described in (https://stackoverflow.com/a/52863794) for
+# the `~/.gitconfig` file or just blindly follow the instructions there to set
+# it for you Git installation as a whole.
+git config --local core.attributesfile "../.gitattributes"
+git config --local diff.ansible-vault.textconv "ansible-vault view"

site.yml

+---
+- hosts: "*"
+  pre_tasks:
+    - name: Verify that the installed version of Ansible meets this playbook's version requirements.
+      assert:
+        that: "ansible_version.full is version_compare('2.2', '>=')"
+        msg: >
+          "You must update Ansible to at least 2.2 to use this playbook."
+  # Collect facts from remote system? Possible values: true, false
+  gather_facts: true
+  # Gather only certain subsects of facts. Ansible supports network, hardware, virtual, facter, ohai as subset.
+  #gather_subset:
+  #  - network
+  #  - virtual
+  #  - hardware
+  # any_error_fatal will mark all the hosts as failed if fails and immediately abort the playbook execution. Possible values: true, false
+  any_errors_fatal: false
+  # max_fail_percentage allows you to abort the play if certain threshold of failures have been reached.
+  max_fail_percentage: 30
+  serial: 30
+  # hide sensitive information in verbose/debugging output from others. Possible values: true, false
+  no_log: false
+  # execution strategy, possible values: debug, linear, serial, free (https://docs.ansible.com/ansible/latest/user_guide/playbooks_strategies.html)
+  strategy: linear
+
+  roles:
+    #- { role: ansible_lza_install_common, become: true }
+    #- { role: ansible_lza_server_hardening, become: true }
+    #- { role: ansible_slub_osquery, become: true }
+    - { role: ansible_lza_backup_proxy, become: true }

tasks/configure_nfs_mounts.yml

+---
+- name: Mounts für SubApp-Shares & Logs
+  mount:
+    path: "{{ item.path }}"
+    src: "{{ item.src }}"
+    state: "{{ item.state | default('mounted') }}"
+    fstype: "nfs"
+    opts: "ro,{{ item.opts | default( nfs_opts.v3 ) }}"
+  loop: "{{ nfs_shares }}"
+  tags: [notest]

tasks/configure_ssh_keys.yml

+---
+- name: copy deploykey files to managed servers
+  copy:
+    src: "{{ role_path }}/../ansible_vaults/{{ role_name }}/{{ item }}"
+    dest: "~/.ssh/{{ item }}"
+    owner: "root"
+    group: "root"
+    mode: 0400
+  loop:
+    - "id_ed25519_deploykey"
+    - "id_ed25519_deploykey.pub"

tasks/install_ibmsp_client.yml

+---
+- name: IBMSP-Client Pakete installieren
+  apt:
+    name: [
+      # GSKit Packages
+      'gskcrypt64',
+      'gskssl64',
+      # TSM API
+      'tivsm-api64',
+      # TSM API CIT (Common Inventory Technology, für die Berechnung der PVUs notwendig)
+      'tivsm-apicit',
+      # TSM Backup-Client
+      'tivsm-ba',
+      # TSM Backup-Client CIT (Common Inventory Technology)
+      'tivsm-bacit',
+      # TSM ONTAP Bibliothek (Support für NetApp Speicher)
+      'tivsm-bahdw',
+      #'tivsm-jbb',
+    ]
+    state: latest
+
+- name: link IBMSP Client kernel modules
+  file:
+    src: "/usr/local/ibm/gsk8_64/lib64/{{ item }}"
+    path: "/usr/lib/{{ item }}"
+    state: link
+  loop:
+    - "libgsk8acmeidup_64.so"
+    - "libgsk8cms_64.so"
+    - "libgsk8dbfl_64.so"
+    - "libgsk8drld_64.so"
+    - "libgsk8iccs_64.so"
+    - "libgsk8kicc_64.so"
+    - "libgsk8km2_64.so"
+    - "libgsk8km_64.so"
+    - "libgsk8ldap_64.so"
+    - "libgsk8p11_64.so"
+    - "libgsk8ssl_64.so"
+    - "libgsk8sys_64.so"
+    - "libgsk8valn_64.so"
+
+- name: write IBMSP config files
+  template:
+    src: "opt/tivoli/tsm/client/ba/bin/{{ item }}.j2"
+    dest: "/opt/tivoli/tsm/client/ba/bin/{{ item }}"
+  loop:
+    - "dsm.opt"
+    - "dsm.sys"
+  notify: restart dsmcad
+
+# - based on Michail Angelos Simos' Ansible Role:
+#   https://github.com/mikesimos/tsm-client.git
+# - dsmc CLI arg ducumentation can be found at:
+#   https://publib.boulder.ibm.com/tividd/td/TSMC/GC32-0789-01/en_US/HTML/ans5000016.htm#HDRCMD6036
+- name: write password file
+  command:
+    #use: dsmc set password       <Old PW>               <New PW>
+    cmd: "dsmc set password {{ ansible_hostname }} {{ ansible_hostname }}"
+    creates: "/etc/adsm/TSM.sth"
+  register: dsmc_result
+  failed_when: (dsmc_result.rc != 0) and (dsmc_result.rc != 8)
+  notify: restart dsmcad
+
+- name: Start dsmcad service. This service triggers regular checks for backup schedules on the IBMSP server.
+  systemd:
+    name: "dsmcad.service"
+    state: started
+
+# check is run as a logrotage PreCmd, so no Cronjob/Timer is required
+- name: install check-backup scripts
+  block:
+    - name: install Git (required by Ansible builtin Git module)
+      apt:
+        name: "git"
+        state: latest
+    - name: install logrotate (required by check-backup script)
+      apt:
+        name: "logrotate"
+        state: latest
+    - name: check out check-backup Git repo
+      git:
+        repo: "git@git.slub-dresden.de:slub-referat-2-3/check-backup.git"
+        dest: "/tmp/check-backup/"
+        key_file: "~/.ssh/id_ed25519_deploykey"
+        accept_hostkey: true
+        force: true
+    - name: copy binaries and config to the system
+      copy:
+        src: "/tmp/check-backup/Linux{{ item.name }}"
+        dest: "{{ item.name }}"
+        mode: "{{ item.mode }}"
+        remote_src: true
+      loop:
+        - name: "/etc/logrotate.d/dsmcad"
+          mode: "0444"
+        - name: "/usr/share/doc/check-backup.man"
+          mode: "0444"
+        - name: "/usr/local/bin/check-backup.sh"
+          mode: "0555"
+    - name: template script config
+      template:
+        src: "etc/check-backup.cfg.j2"
+        dest: "/etc/check-backup.cfg"
+        owner: "root"
+        group: "root"
+        mode: "0644"

tasks/main.yml

+---
+# tasks file for ansible_lza_backup_proxy
+- include_vars: "{{ role_path }}/../ansible_vaults/{{ role_name }}/{{ item }}"
+  loop:
+    - "ibmsp.vault"
+    - "nfs_mounts.vault"
+  tags: [always]
+
+- import_tasks: "configure_ssh_keys.yml"
+  tags: [ssh, deploykey]
+- import_tasks: "install_ibmsp_client.yml"
+  tags: [ibmsp, tsm, backup]
+- import_tasks: "configure_nfs_mounts.yml"
+  tags: [nfs]