From 13a43f7b841e26f90193ef2b7bdb950a82ad4d55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Sachse?= <joerg.sachse@slub-dresden.de> Date: Fri, 14 Apr 2023 14:39:54 +0200 Subject: [PATCH] initial commit --- .ansible-lint | 86 +++ .config/molecule/config.yml | 2 + .gitattributes | 6 + .githooks/pre-commit | 139 ++++ .gitignore | 86 +++ .gitlab-ci.yml | 33 + .gitlab/issue_templates/Default.md | 16 + .gitlab/merge_request_templates/Default.md | 7 + .yamllint | 23 + CODE-OF-CONDUCT.md | 3 + CONTRIBUTING.md | 0 LICENSE | 674 ++++++++++++++++++ README.md | 117 ++- ansible.cfg | 66 ++ defaults/main.yml | 2 + files/README.txt | 1 + handlers/main.yml | 29 + kudos.txt | 48 ++ meta/main.yml | 33 + molecule/default | 1 + molecule/resources/playbooks/Dockerfile | 20 + molecule/resources/playbooks/INSTALL.rst | 23 + molecule/resources/playbooks/README.md | 3 + molecule/resources/playbooks/converge.yml | 17 + molecule/resources/playbooks/prepare.yml | 30 + molecule/resources/playbooks/verify.yml | 10 + molecule/virtualbox_debian11/molecule.yml | 41 ++ setup_gitconfig.sh | 13 + site.yml | 55 ++ tasks/README.txt | 1 + tasks/configure_iptables_externalusers.yml | 41 ++ tasks/configure_processing_user.yml | 13 + tasks/configure_proxy.yml | 31 + tasks/create_users_groups.yml | 23 + tasks/install_move_logs.yml | 45 ++ tasks/install_packages.yml | 43 ++ tasks/install_subapp.yml | 95 +++ tasks/main.yml | 41 ++ templates/subapp.cfg.j2 | 90 +++ .../systemd/system/check_ie_sample.service.j2 | 29 + .../systemd/system/check_ie_sample.timer.j2 | 18 + vars/README.txt | 1 + vars/iptables.vault.example | 22 + vars/main.yml | 1 + vars/proxy.vault.example | 6 + vars/users.vault.example | 14 + 46 files changed, 2030 insertions(+), 68 deletions(-) create mode 100644 .ansible-lint create mode 100644 .config/molecule/config.yml create mode 100644 .gitattributes create mode 100755 .githooks/pre-commit create mode 100644 .gitignore create mode 100644 .gitlab-ci.yml create mode 100644 .gitlab/issue_templates/Default.md create mode 100644 .gitlab/merge_request_templates/Default.md create mode 100644 .yamllint create mode 100644 CODE-OF-CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 ansible.cfg create mode 100644 defaults/main.yml create mode 100644 files/README.txt create mode 100644 handlers/main.yml create mode 100644 kudos.txt create mode 100644 meta/main.yml create mode 120000 molecule/default create mode 100644 molecule/resources/playbooks/Dockerfile create mode 100644 molecule/resources/playbooks/INSTALL.rst create mode 100644 molecule/resources/playbooks/README.md create mode 100644 molecule/resources/playbooks/converge.yml create mode 100644 molecule/resources/playbooks/prepare.yml create mode 100644 molecule/resources/playbooks/verify.yml create mode 100644 molecule/virtualbox_debian11/molecule.yml create mode 100755 setup_gitconfig.sh create mode 100644 site.yml create mode 100644 tasks/README.txt create mode 100644 tasks/configure_iptables_externalusers.yml create mode 100644 tasks/configure_processing_user.yml create mode 100644 tasks/configure_proxy.yml create mode 100644 tasks/create_users_groups.yml create mode 100644 tasks/install_move_logs.yml create mode 100644 tasks/install_packages.yml create mode 100644 tasks/install_subapp.yml create mode 100644 tasks/main.yml create mode 100644 templates/subapp.cfg.j2 create mode 100644 templates/usr/local/lib/systemd/system/check_ie_sample.service.j2 create mode 100644 templates/usr/local/lib/systemd/system/check_ie_sample.timer.j2 create mode 100644 vars/README.txt create mode 100644 vars/iptables.vault.example create mode 100644 vars/main.yml create mode 100644 vars/proxy.vault.example create mode 100644 vars/users.vault.example diff --git a/.ansible-lint b/.ansible-lint new file mode 100644 index 0000000..98d64bd --- /dev/null +++ b/.ansible-lint @@ -0,0 +1,86 @@ +--- +# based on documentation available at +# https://ansible-lint.readthedocs.io/en/latest/configuring/ + +# exclude_paths included in this file are parsed relative to this file's location +# and not relative to the CWD of execution. CLI arguments passed to the --exclude +# option will be parsed relative to the CWD of execution. +exclude_paths: + - .cache/ # implicit unless exclude_paths is defined in config + - .git/ + - .githooks/ + - backups/ +# parseable: true +# quiet: true +# verbosity: 1 + +# Mock modules or roles in order to pass ansible-playbook --syntax-check +# mock_modules: +# - zuul_return +# # note the foo.bar is invalid as being neither a module or a collection +# - fake_namespace.fake_collection.fake_module +# - fake_namespace.fake_collection.fake_module.fake_submodule +# mock_roles: +# - mocked_role +# - author.role_name # old standalone galaxy role +# - fake_namespace.fake_collection.fake_role # role within a collection + +# Enable checking of loop variable prefixes in roles +loop_var_prefix: "{role}_" + +use_default_rules: true +# Load custom rules from this specific folder +# rulesdir: +# - ./rule/directory/ + +# This makes linter to fully ignore rules/tags listed below +skip_list: + - skip_this_tag + - git-latest + - name[casing] + - package-latest + +# Any rule that has the 'opt-in' tag will not be loaded unless its 'id' is +# mentioned in the enable_list: +enable_list: + # - empty-string-compare # opt-in + - no-log-password # opt-in + - no-same-owner # opt-in + # add yaml here if you want to avoid ignoring yaml checks when yamllint + # library is missing. Normally its absence just skips using that rule. + - yaml +# Report only a subset of tags and fully ignore any others +# tags: +# - var-spacing + +# This makes the linter display but not fail for rules/tags listed below: +warn_list: + - skip_this_tag + - git-latest + - experimental # experimental is included in the implicit list + # - role-name + +# Offline mode disables installation of requirements.yml +offline: false + +# Define required Ansible's variables to satisfy syntax check +# extra_vars: +# foo: bar +# multiline_string_variable: | +# line1 +# line2 +# complex_variable: ":{;\t$()" + +# Uncomment to enforce action validation with tasks, usually is not +# needed as Ansible syntax check also covers it. +# skip_action_validation: false + +# List of additional kind:pattern to be added at the top of the default +# match list, first match determines the file kind. +kinds: + # - playbook: "**/examples/*.{yml,yaml}" + # - galaxy: "**/folder/galaxy.yml" + # - tasks: "**/tasks/*.yml" + # - vars: "**/vars/*.yml" + # - meta: "**/meta/main.yml" + - yaml: "**/*.yaml-too" diff --git a/.config/molecule/config.yml b/.config/molecule/config.yml new file mode 100644 index 0000000..ece7ff6 --- /dev/null +++ b/.config/molecule/config.yml @@ -0,0 +1,2 @@ +--- +prerun: false diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..20595a1 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,6 @@ +# 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 diff --git a/.githooks/pre-commit b/.githooks/pre-commit new file mode 100755 index 0000000..02df4d5 --- /dev/null +++ b/.githooks/pre-commit @@ -0,0 +1,139 @@ +#!/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 ! yamllint "${file}"; then + exit 1 + fi + done +fi && echo "SUCCESS: Yamllint stage." + +### ANSIBLE-LINT stage +ansible-lint "site.yml" || exit 1 +echo "SUCCESS: Ansible-lint 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}" + if grep -e "\$ANSIBLE_VAULT;[[:digit:]]\.[[:digit:]];AES256" "${file}"; then + echo "ERROR: Ansible-Vault in String found in file '${file}'." && exit 1 + fi + done +fi +echo "SUCCESS: Vault detection stage." + +### URL detection stage +if "${GREP_CMD}" "${GREP_EXCLUDES}" -e "http[s]*.*git.*SLUB" -e "http[s]*.*git.*slub" -e "git@" "${REPOPATH}"; 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\}' +if "${GREP_CMD}" "${GREP_EXCLUDES}" -e "${IP_REGEX}" "${REPOPATH}" | grep -v "127.0.0"; then + echo "ERROR: found IP address." + exit 1; +fi +echo "SUCCESS: IP address detection stage." + +### SSH-Key detection stage +if "${GREP_CMD}" "${GREP_EXCLUDES}" -e "ssh-[dr]sa " "${REPOPATH}"; then + echo "ERROR: found SSH key." + exit 1; +fi +echo "SUCCESS: SSH Key detection stage." + +### SHELLSCRIPT CHECK stage +SH_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep ".sh$") +if [[ ${SH_FILES} != "" ]]; then + for file in ${SH_FILES}; do + shellcheck "${file}" + done +fi +echo "SUCCESS: SHELLSCRIPT CHECK stage." + + + + +### DONE +# Return explicit 0. +exit 0; diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c6bb39d --- /dev/null +++ b/.gitignore @@ -0,0 +1,86 @@ +# 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_* + diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..55bee84 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,33 @@ +--- +# A pipeline is composed of independent jobs that run scripts, grouped into stages. +# Stages run in sequential order, but jobs within stages run in parallel. +# +# For more information, see: https://docs.gitlab.com/ee/ci/yaml/index.html#stages + +stages: # List of stages for jobs, and their order of execution + - test + +default: + before_script: + - source /opt/molecule/bin/activate + - ansible --version + - molecule --version + +test-job: + stage: test + tags: + - "shell" + script: + # make sure that Ansible Vaults are present and can be decrypted + - echo "${VAULT_INGEST}" > ../lza_ingest.pass + - export ANSIBLE_VAULT_PASSWORD_FILE=../lza_ingest.pass + - rm -rf ../ansible_vaults/ + - git clone https://gitlab+deploy-token-25:${VAULT_ACCESS_TOKEN}@git.slub-dresden.de/slub-referat-2-3/ansible_vaults.git ../ansible_vaults/; \ + # run Molecule tests + - molecule syntax --scenario-name default + - molecule lint --scenario-name default + - molecule create --scenario-name default + - molecule converge --scenario-name default + - molecule idempotence --scenario-name default + # - molecule verify --scenario-name default + - molecule destroy --scenario-name default diff --git a/.gitlab/issue_templates/Default.md b/.gitlab/issue_templates/Default.md new file mode 100644 index 0000000..acc60bf --- /dev/null +++ b/.gitlab/issue_templates/Default.md @@ -0,0 +1,16 @@ +## Expected Behavior + + +## Actual Behavior + + +## Steps to Reproduce the Problem + + 1. + 1. + 1. + +## Specifications + + - Version/Commit: + - Platform: diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md new file mode 100644 index 0000000..4030f6f --- /dev/null +++ b/.gitlab/merge_request_templates/Default.md @@ -0,0 +1,7 @@ +Fixes # + +## Proposed Changes + + - + - + - diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..7c0f15c --- /dev/null +++ b/.yamllint @@ -0,0 +1,23 @@ +--- +# based on documentation available at +# https://yamllint.readthedocs.io/en/stable/rules.html + +extends: default + +rules: + braces: + max-spaces-inside: 1 + level: error + brackets: + max-spaces-inside: 1 + level: error + comments: + min-spaces-from-content: 4 + comments-indentation: disable + document-end: disable + document-start: + level: warning + octal-values: + forbid-explicit-octal: false + line-length: disable + truthy: enable diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md new file mode 100644 index 0000000..19d2d20 --- /dev/null +++ b/CODE-OF-CONDUCT.md @@ -0,0 +1,3 @@ +# Code of Conduct + +Just be excellent to each other. That's it. EoC. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f053beb --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + ansible_lza_iesample + Copyright (C) 2022 Digital Preservation + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) 2022 Digital Preservation + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/README.md b/README.md index 72f5847..972ddde 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,73 @@ -# ansible_lza_iesample +# Ansible-Role "ansible_lza_iesample" +## Description +This role is intended to provide all necessary tasks to install Submission Application based check_ie_sample servers for digital preservation in the SLUBArchiv. -## Getting started - -To make it easy for you to get started with GitLab, here's a list of recommended next steps. - -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +## Prerequisites -## Add your files +To use this role, the following software must be installed on your workstation: +* ansible -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +To deploy this role to a managed host, the following software must be installed on the target: +* Python3 +* SSHd +Other roles required by this role can be easily installed using `ansible-galaxy` if necessary. As the roles reside in SLUB's local Git server instance, you might need a password for certain repositories despite most of them being publicly available. This command will install the required roles in the correct location so they are found in the search path: ``` -cd existing_repo -git remote add origin https://git.slub-dresden.de/digital-preservation/ansible_lza_iesample.git -git branch -M main -git push -uf origin main + ansible-galaxy install -r requirements.yml -p ../ ``` -## Integrate with your tools - -- [ ] [Set up project integrations](https://git.slub-dresden.de/digital-preservation/ansible_lza_iesample/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. +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. -## Suggestions for a good README -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. +## Quick Start -## Name -Choose a self-explaining name for your project. +Most options already have sensible defaults in `ansible.cfg`. However, you can override these defaults using CLI options/flags if you want to. The flags can be combined if necessary, and most of them have long versions as well. Get more information using `ansible-playbook --help`. -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. +To simply run the playbook, just call the `site.yml` playbook like this: +``` + ansible-playbook site.yml -u <username> +``` -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. +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*> +``` -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. +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 +``` -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +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 +``` -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. +## Testing the role -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. +Tests have been implemented using the Molecule framework. The details on using the test suite are described below `molecule/`. -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +## Variables -## Contributing -State if you are open to contributions and what your requirements are for accepting them. +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. -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +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>/`. -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. +## git configuration -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +Just run the `setup_gitconfig.sh` script that comes with the repo to correctly setup all necessary local Git configurations. -## License -For open source projects, say how it is licensed. +## Author Information -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +If you have any comments or find bugs, please contact langzeitarchiv@slub-dresden.de or issue a pull request. diff --git a/ansible.cfg b/ansible.cfg new file mode 100644 index 0000000..b54d371 --- /dev/null +++ b/ansible.cfg @@ -0,0 +1,66 @@ +[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, ../slub_osquery.pass, ../lza_server_hardening.pass, ../lza_ingest.pass +vault_identity_list = ../lza_iesample.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 + +# Toggle to control displaying skipped task/host entries in a task in the +# default callback. +# https://docs.ansible.com/ansible/latest/reference_appendices/config.html#display-skipped-hosts +# DEFAULT: display_skipped_hosts = true +display_skipped_hosts = false + +use_persistent_connections=true + +# list all Ansible Callback Plugins: "ansible-doc -t callback -l" +# online documentation: https://docs.ansible.com/ansible/latest/plugins/callback.html +# run code profiling for performance analysis +# callbacks_enabled = profile_roles, profile_tasks, timer +# get formatted output +# callbacks_enabled = yaml +# get minimal output +# callbacks_enabled = dense + +# set default output callback plugin +stdout_callback = yaml + +# Setting a callback plugin for ad-hoc commands +bin_ansible_callbacks = True + +callbacks_enabled: yaml + +[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 diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..23ba084 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,2 @@ +--- +# defaults file for ansible_lza_iesample diff --git a/files/README.txt b/files/README.txt new file mode 100644 index 0000000..06384bb --- /dev/null +++ b/files/README.txt @@ -0,0 +1 @@ +This directory contains files, script files and directories for use with the copy/script resource. \ No newline at end of file diff --git a/handlers/main.yml b/handlers/main.yml new file mode 100644 index 0000000..a651550 --- /dev/null +++ b/handlers/main.yml @@ -0,0 +1,29 @@ +--- +- name: Ordner für iptables-Config erstellen + ansible.builtin.file: + path: "/etc/iptables" + state: directory + owner: "root" + group: "root" + mode: "0755" + listen: "save iptables rules" + +- name: install netfilter-persistent to be able to save iptables rules + ansible.builtin.apt: + name: "netfilter-persistent" + state: present + listen: "save iptables rules" + +- name: save iptables rules # noqa no-changed-when + ansible.builtin.command: 'netfilter-persistent save' + listen: "save iptables rules" + +- name: activate kernel parameter changes # noqa no-changed-when + ansible.builtin.command: sysctl -p + +- name: create PIDfiles # noqa no-changed-when + ansible.builtin.command: systemd-tmpfiles --create + +- name: daemon-reload + ansible.builtin.systemd: + daemon_reload: true diff --git a/kudos.txt b/kudos.txt new file mode 100644 index 0000000..c857b63 --- /dev/null +++ b/kudos.txt @@ -0,0 +1,48 @@ +# kudos.txt - Express gratitude to your contributors. +# https://github.com/kudos-txt + +project: + - name: ansible_lza_iesample + site: https://git.slub-dresden.de/digital-preservation/ansible_lza_iesample +# blog: <blog url> +# help: <support url> +# news: <news url>, <news feed url> +# mail: <mail@domain.tld> +# chat: <service:nick>, <service:channel>, <url> +# note: <free text notes> + +contributor: +# - name: <name or nick of the contributor> +# role: <role in the project> +# site: <website url> +# blog: <blog url> +# mail: <mail@domain.tld> +# chat: <service:nick>, <service:channel>, <url> +# home: <country>, <region>, <zip>, <city>, <address> +# work: <company>, <job title>, <job description> +# note: <free text notes> + - name: Jörg Sachse + role: Maintainer + mail: Joerg.Sachse@slub-dresden.de + home: Germany, Saxony, 01059, Dresden, Zellescher Weg 18 + work: SLUB Dresden, Digital Preservationist &IT Administrator & Installation Wizard + +#partner: +# - name: <name of the partner> +# site: <website url> +# blog: <blog url> +# help: <support url> +# news: <news url>, <news feed url> +# mail: <mail@domain.tld> +# chat: <service:nick>, <service:channel>, <url> +# note: <free text notes> + +#software: +# - name: <name of the software> +# site: <website url> +# blog: <blog url> +# help: <support url> +# news: <news url>, <news feed url> +# mail: <mail@domain.tld> +# chat: <service:nick>, <service:channel>, <url> +# note: <free text notes> diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..6d9bfa6 --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,33 @@ +--- +galaxy_info: + role_name: "ansible_lza_iesample" + namespace: "slub" + author: "Jörg Sachse" + company: "SLUB Dresden" + description: role to install Submission Application based IE sampling server for the SLUBarchiv digital preservation repository + 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. + # issue_tracker_url: "https://example.com/" + # 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 + license: public domain + # Some suggested licenses: - BSD + # (default) - MIT - GPLv2 - GPLv3 - Apache - CC-BY + min_ansible_version: "2.8" + # If this a Container Enabled role, provide the minimum Ansible Container version. min_ansible_container_version: Optionally specify the branch Galaxy will use when accessing the GitHub repo + # for this role. During role install, if no tags are available, Galaxy will use this branch. During import Galaxy will access files on this branch. If Travis integration is configured, only + # notifications for this branch will be accepted. Otherwise, in all cases, the repo's default branch (usually master) will be used. github_branch: + # 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: + - "buster" + - "bullseye" +dependencies: [] diff --git a/molecule/default b/molecule/default new file mode 120000 index 0000000..0c538fb --- /dev/null +++ b/molecule/default @@ -0,0 +1 @@ +./virtualbox_debian11 \ No newline at end of file diff --git a/molecule/resources/playbooks/Dockerfile b/molecule/resources/playbooks/Dockerfile new file mode 100644 index 0000000..da596e7 --- /dev/null +++ b/molecule/resources/playbooks/Dockerfile @@ -0,0 +1,20 @@ +FROM debian:stable-slim + +RUN adduser lza; + +### configure SLUB Debian Repository +RUN apt-get update; \ + apt-get install -y --no-install-recommends gnupg wget git python3 ansible sudo; \ + wget -O - http://sdvdebianrepo.slub-dresden.de/deb-repository/pub.gpg.key | apt-key add - ; \ + echo "deb http://sdvdebianrepo.slub-dresden.de/deb-repository bullseye main" > /etc/apt/sources.list.d/slub.list; \ + apt-get update; + #apt-get -y --no-install-recommends install python3-pip python3-virtualenv; + +RUN echo "lza ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/lza-user + +#RUN mkdir /opt/venv/ && cd /opt/venv/; \ +# virtualenv -p python3 molecule; \ +# . /opt/venv/molecule/bin/activate; \ +# pip3 install ansible molecule molecule-docker; + +USER lza diff --git a/molecule/resources/playbooks/INSTALL.rst b/molecule/resources/playbooks/INSTALL.rst new file mode 100644 index 0000000..0c4bf5c --- /dev/null +++ b/molecule/resources/playbooks/INSTALL.rst @@ -0,0 +1,23 @@ +********************************* +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' diff --git a/molecule/resources/playbooks/README.md b/molecule/resources/playbooks/README.md new file mode 100644 index 0000000..0c91883 --- /dev/null +++ b/molecule/resources/playbooks/README.md @@ -0,0 +1,3 @@ +This drectory contains shared playbooks and a shared Dockerfile. + +Visit https://molecule.readthedocs.io/en/latest/examples.html#sharing-across-scenarios for details on sharing playbooks, tests etc. across multiple scenarios. diff --git a/molecule/resources/playbooks/converge.yml b/molecule/resources/playbooks/converge.yml new file mode 100644 index 0000000..840d47c --- /dev/null +++ b/molecule/resources/playbooks/converge.yml @@ -0,0 +1,17 @@ +--- +- name: Converge + hosts: all + pre_tasks: + - name: update apt cache + ansible.builtin.apt: + update_cache: true + upgrade: dist + become: true + when: ansible_os_family == "Debian" + - name: update yum cache + ansible.builtin.yum: + update_cache: true + become: true + when: ansible_os_family == "RedHat" + roles: + - {role: "ansible_lza_iesample", become: true} diff --git a/molecule/resources/playbooks/prepare.yml b/molecule/resources/playbooks/prepare.yml new file mode 100644 index 0000000..77c4fdf --- /dev/null +++ b/molecule/resources/playbooks/prepare.yml @@ -0,0 +1,30 @@ +--- +- name: Prepare + hosts: "*" + tasks: + - name: install GPG + ansible.builtin.apt: + name: "gnupg" + state: latest + update_cache: true + become: true + - name: add non-free repos to be able to install libmath-random-perl from Debian public repo + ansible.builtin.replace: + path: "/etc/apt/sources.list" + regexp: '^(.*) main$' + replace: '\g<1> main non-free' + become: true + - name: add GPG key for SLUB Debian repository + ansible.builtin.apt_key: + # url: "https://sdvdebianrepo.slub-dresden.de/deb-repository/pub.gpg.key" + url: "http://bdv141.slub-dresden.de/deb-repository/pub.gpg.key" + state: present + become: true + - name: add repo URL to sources.list + ansible.builtin.apt_repository: + # repo: "deb https://sdvdebianrepo.slub-dresden.de/deb-repository bullseye main" + repo: "deb http://bdv141.slub-dresden.de/deb-repository lza-testing main" + state: present + update_cache: true + mode: "0644" + become: true diff --git a/molecule/resources/playbooks/verify.yml b/molecule/resources/playbooks/verify.yml new file mode 100644 index 0000000..a5cfa75 --- /dev/null +++ b/molecule/resources/playbooks/verify.yml @@ -0,0 +1,10 @@ +--- +# This is an example playbook to execute Ansible tests. + +- name: Verify + hosts: all + gather_facts: false + tasks: + - name: Example assertion + ansible.builtin.assert: + that: true diff --git a/molecule/virtualbox_debian11/molecule.yml b/molecule/virtualbox_debian11/molecule.yml new file mode 100644 index 0000000..b465ee7 --- /dev/null +++ b/molecule/virtualbox_debian11/molecule.yml @@ -0,0 +1,41 @@ +--- +dependency: + name: galaxy + enabled: false +driver: + name: vagrant +lint: | + set -e + yamllint . + ansible-lint -x no-loop-var-prefix,command-instead-of-module,package-latest +platforms: + # Check out the documentation at + # https://github.com/ansible-community/molecule-vagrant#documentation + # for more platform parameters. + - name: molecule-test + box: debian/bullseye64 + memory: 1024 + # List of raw Vagrant `config` options. + # provider_raw_config_args: + # - "customize [ 'modifyvm', :id, '--natdnshostresolver1', 'on' ]" + # Dictionary of `config` options. + config_options: + ssh.keep_alive: true + ssh.remote_user: "'lza'" +provisioner: + name: ansible + log: true + config_options: + defaults: + # https://stackoverflow.com/questions/57435811/ansible-molecule-pass-multiple-vault-ids + # vault_identity_list: "@$HOME/.ansible/roles/lza_install_common.pass, @$HOME/.ansible/roles/passfile_1.pass" + vault_identity_list: "../lza_iesample.pass" + vvv: false + playbooks: + # create: ../resources/playbooks/create.yml + # destroy: ../resources/playbooks/destroy.yml + converge: ../resources/playbooks/converge.yml + prepare: ../resources/playbooks/prepare.yml + verify: ../resources/playbooks/verify.yml +verifier: + name: ansible diff --git a/setup_gitconfig.sh b/setup_gitconfig.sh new file mode 100755 index 0000000..3e15afe --- /dev/null +++ b/setup_gitconfig.sh @@ -0,0 +1,13 @@ +#!/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" diff --git a/site.yml b/site.yml new file mode 100644 index 0000000..dae1f12 --- /dev/null +++ b/site.yml @@ -0,0 +1,55 @@ +--- +- name: prechecks + hosts: localhost + connection: local + post_tasks: + - name: check for FIXMEs + ansible.builtin.find: + path: "{{ playbook_dir }}" + pattern: "*.yml" + recurse: true + contains: ".*(FIXME|TODO).*" + excludes: + - "site.yml" + register: result_fixmes + - name: CHECK FOR UNRESOLVED ISSUES/TODOs + ansible.builtin.debug: + msg: "Unresolved FIXME/TODO in {{ item.path }}" + loop: "{{ result_fixmes.files }}" + when: result_fixmes.matched > 0 + +- name: install + hosts: "*" + + # strategy plugin setting, default: linear, docu: https://docs.ansible.com/ansible/latest/plugins/strategy.html + # execution strategy, possible values: debug, linear, serial, free (https://docs.ansible.com/ansible/latest/user_guide/playbooks_strategies.html) + # strategy: free + # strategy: debug + strategy: linear + + pre_tasks: + - name: Verify that the installed version of Ansible meets this playbook's version requirements. + ansible.builtin.assert: + that: "ansible_version.full is version_compare('2.8', '>=')" + msg: > + "You must update Ansible to at least 2.8 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 + + roles: + # - { role: ansible_lza_install_common, become: true } + # - { role: ansible_lza_server_hardening, become: true } + # - { role: ansible_slub_osquery, become: true } + - { role: ansible_lza_iesample, become: true} diff --git a/tasks/README.txt b/tasks/README.txt new file mode 100644 index 0000000..8127585 --- /dev/null +++ b/tasks/README.txt @@ -0,0 +1 @@ +This directory contains the actual main.yml playbook that runs all necessary tasks on the managed host. \ No newline at end of file diff --git a/tasks/configure_iptables_externalusers.yml b/tasks/configure_iptables_externalusers.yml new file mode 100644 index 0000000..81c268b --- /dev/null +++ b/tasks/configure_iptables_externalusers.yml @@ -0,0 +1,41 @@ +--- +# Configure common rules +- name: iptables-Regeln setzen (alle Beteiligten) + ansible.builtin.iptables: + action: insert + chain: INPUT + comment: "{{ item.comment }}" + destination: "{{ item.dest | default(omit) }}" + destination_port: "{{ item.dest_port | default(omit) }}" + jump: ACCEPT +# limit: 100/s +# limit_burst: 1000/s + protocol: tcp +# rule_num: 1 + source: "{{ item.src | default(omit) }}" + source_port: "{{ item.src_port | default(omit) }}" + state: "{{ item.state | default('present') }}" + table: filter + loop: "{{ vault_iptables_all | flatten(levels=1) }}" + notify: + - save iptables rules + +- name: iptables-Regeln setzen (Sanitytest) + ansible.builtin.iptables: + action: insert + chain: INPUT + comment: "{{ item.comment }}" + destination: "{{ item.dest | default(omit) }}" + destination_port: "{{ item.dest_port | default(omit) }}" + jump: ACCEPT +# limit: 100/s +# limit_burst: 1000/s + protocol: tcp +# rule_num: 1 + source: "{{ item.src | default(omit) }}" + source_port: "{{ item.src_port | default(omit) }}" + state: "{{ item.state | default('present') }}" + table: filter + loop: "{{ vault_iptables_sanitytest | flatten(levels=1) }}" + notify: + - save iptables rules diff --git a/tasks/configure_processing_user.yml b/tasks/configure_processing_user.yml new file mode 100644 index 0000000..238c8ac --- /dev/null +++ b/tasks/configure_processing_user.yml @@ -0,0 +1,13 @@ +--- +### VIM SKEL FÜR PROCESSING USER ### +- name: check if vim skel exists + ansible.builtin.stat: + path: "/etc/skel/.vimrc" + register: vimrc_skel +- name: copy vim skel to processing users + ansible.builtin.copy: + remote_src: true + src: "/etc/skel/.vimrc" + dest: "/home/{{ vault_subapp_user }}/.vimrc" + mode: "0644" + when: vimrc_skel.stat.exists diff --git a/tasks/configure_proxy.yml b/tasks/configure_proxy.yml new file mode 100644 index 0000000..c1c6bd6 --- /dev/null +++ b/tasks/configure_proxy.yml @@ -0,0 +1,31 @@ +--- +### PROXY KONFIGURIEREN ### +- name: Konfigurationsdateien einspielen - Proxy + ansible.builtin.blockinfile: + dest: "/etc/environment" + create: "yes" + mode: "0644" + owner: "root" + group: "root" + state: present + block: | + ### HTTP: + # http_proxy=http://<Benutzername>:<Passwort>@<Proxy>:<Port> + http_proxy=http://{{ vault_proxy_hostname }}.{{ vault_proxy_domain }}:{{ vault_proxy_http_port }} + #Der Benutzer und das Passwort müssen lediglich bei geforderter + #Authentifizierung angegeben werden. Ansonsten einfach den Proxy und + #den Port angeben. + + ### HTTPS: + # https_proxy=https://<Benutzername>:<Passwort>@<Proxy>:<Port> + # https_proxy=https://{{ vault_proxy_hostname }}.{{ vault_proxy_domain }}:{{ vault_proxy_https_port }} + + # no_proxy=localhost,<auszuschließende Domains> + no_proxy=localhost,127.0.0.1,{{ ansible_hostname }},{{ ansible_hostname }}.{{ vault_proxy_domain }},{{ vault_no_proxy }} + soap_use_proxy=on + insertafter: EOF + +- name: Konfigurationsdateien einspielen - apt-get fuer Proxyverwendung konfigurieren + ansible.builtin.lineinfile: + dest: "/etc/apt/apt.conf.d/70debconf" + line: 'Acquire::http::Proxy { "http://{{ vault_proxy_hostname }}.{{ vault_proxy_domain }}:{{ vault_proxy_http_port }}" };' diff --git a/tasks/create_users_groups.yml b/tasks/create_users_groups.yml new file mode 100644 index 0000000..913e210 --- /dev/null +++ b/tasks/create_users_groups.yml @@ -0,0 +1,23 @@ +--- +- name: create primary groups for users + ansible.builtin.group: + name: "{{ item.group }}" + loop: "{{ vault_users }}" + +- name: create ROBOT users and set groups + ansible.builtin.user: + comment: "{{ item.comment | default(omit) }}" + create_home: "yes" + generate_ssh_key: "{{ item.generate_ssh_key | default('true') }}" + group: "{{ item.group | default(omit) }}" + groups: "{{ item.groups | default(omit) }}" + home: "/home/{{ item.name }}/" + name: "{{ item.name }}" + non_unique: "{{ item.non_unique | default(false) }}" + password: "{{ lookup('password', '/dev/null length=100 chars=ascii_letters') | password_hash('sha512') | default(omit) }}" + shell: "{{ item.shell | default('/bin/bash') }}" + state: "{{ item.state | default('present') }}" + uid: "{{ item.uid | default(omit) }}" + update_password: on_create + loop: "{{ vault_users }}" + no_log: true diff --git a/tasks/install_move_logs.yml b/tasks/install_move_logs.yml new file mode 100644 index 0000000..15bf060 --- /dev/null +++ b/tasks/install_move_logs.yml @@ -0,0 +1,45 @@ +--- +- name: create SystemD unit directory + ansible.builtin.file: + path: "/usr/local/lib/systemd/system/" + state: directory + mode: "0750" + +- name: install timer and script for moving old logs to archive + ansible.builtin.copy: + src: "{{ item.path }}" + dest: "/{{ item.path }}" + mode: "{{ item.mode }}" + owner: "{{ item.owner | default('root') }}" + group: "{{ item.group | default('root') }}" + loop: + - path: "usr/local/lib/systemd/system/move_old_logs.timer" + mode: "0644" + - path: "usr/local/bin/move_old_logs.sh" + mode: "0755" + notify: daemon-reload + +- name: install service for moving old logs to archive + ansible.builtin.template: + src: "usr/local/lib/systemd/system/move_old_logs_@.service.j2" + dest: "/usr/local/lib/systemd/system/move_old_logs_@.service" + mode: "0644" + owner: "root" + group: "root" + notify: daemon-reload + +- name: enable move_old_logs services + ansible.builtin.systemd: + name: "move_old_logs_@{{ item }}.service" + daemon_reload: true + enabled: true + loop: +# - "disapp" + - "subapp" +# - "subapp_webservice" + +- name: start timer for moving old logs to archive (the service is triggered by the timer and doesn't need to be started separately) + ansible.builtin.systemd: + name: "move_old_logs.timer" + enabled: true + state: started diff --git a/tasks/install_packages.yml b/tasks/install_packages.yml new file mode 100644 index 0000000..a6bc5be --- /dev/null +++ b/tasks/install_packages.yml @@ -0,0 +1,43 @@ +--- +### PAKETINSTALLATIONEN SUBMISSION APPLICATION ### +- name: Install/Update packages + ansible.builtin.apt: + name: [ + 'curl', + # 'inotify-tools', + 'libpath-class-perl', + # 'libxalan-c111', + 'libxalan-c112', + 'libxerces-c-dev', + 'libxml2-utils', + 'netcat-openbsd', + 'p7zip-full', + # 'rsync', + 'sqlite3', + 'tar', + 'unzip', + # 'imagemagick', + # 'libtiff-tools' + ] + state: latest + update_cache: true + +- name: uninstall outdated perl-modules-5.28 package from Debian 11 Bullseye VMs + ansible.builtin.apt: + name: 'perl-modules-5.28' + state: absent + +- name: Install/Update Perl-Pakete + ansible.builtin.apt: + name: [ + 'libcurses-ui-perl', + 'libnet-scp-perl', + 'libtest-exception-perl', + 'libtest-file-perl', + 'libtest-output-perl', + 'libtext-csv-xs-perl', + 'perl', + 'perl-base', + 'perl-modules-5.32', + ] + state: latest diff --git a/tasks/install_subapp.yml b/tasks/install_subapp.yml new file mode 100644 index 0000000..c85a6d9 --- /dev/null +++ b/tasks/install_subapp.yml @@ -0,0 +1,95 @@ +--- +- name: Berechtigungen für Blockdevice ".subapp" korrigieren + ansible.builtin.file: + path: "{{ item.path }}" + state: directory + owner: "{{ item.owner | default(omit) }}" + group: "{{ item.group | default(omit) }}" + mode: "0750" + loop: + - path: "/home/{{ vault_subapp_user }}/.subapp/" + owner: "{{ vault_subapp_user }}" + group: "{{ vault_subapp_group }}" + - path: "/usr/local/lib/systemd/system/" + +# erst nach der Erstellung der User/Gruppen durchführen! +- name: update Sources + ansible.builtin.apt: + update_cache: true +- name: Submission Application installieren + ansible.builtin.apt: + name: [ + "common-application4rosetta", + "submission-application4rosetta", + ] + state: latest + allow_unauthenticated: "true" + +### KONFIGURATIONEN FÜR SUBMISSION APPLICATION INSTALLIEREN ### +- name: SubApp-Config einspielen + block: + - name: write new SubApp config file + ansible.builtin.template: + src: "subapp.cfg.j2" + dest: "{{ vault_subapp_vars.files.subapp.path }}" + owner: "{{ vault_subapp_vars.files.subapp.owner }}" + group: "{{ vault_subapp_vars.files.subapp.group }}" + mode: "{{ vault_subapp_vars.files.subapp.mode | default('0400') }}" +# loop: "{{ vault_check_ie_sample_hosts.hosts[ansible_hostname] | default(vault_check_ie_sample_hosts.hosts['molecule-test']) }}" + +- name: Symlinks für SubApp-Konfigurationen und nach /var/log setzen + ansible.builtin.file: + src: "{{ item.src }}" + dest: "{{ item.dest }}" + state: "{{ item.state | default('link') }}" + mode: "{{ item.mode | default(omit) }}" + owner: "{{ item.owner }}" + group: "{{ item.group }}" + loop: + # SubApp + - src: "{{ vault_subapp_vars.files.subapp.path }}" + dest: "/home/{{ vault_subapp_user }}/.subapp.cfg" + owner: "{{ vault_subapp_user }}" + group: "{{ vault_subapp_group }}" + +- name: deploy check_ie_sample Service + ansible.builtin.template: + src: "usr/local/lib/systemd/system/check_ie_sample.service.j2" + dest: "/usr/local/lib/systemd/system/check_ie_sample.service" + owner: "root" + group: "root" + mode: "0644" + loop: "{{ lookup('dict', vault_check_ie_sample_hosts) }}" + when: ansible_hostname == item.key +# no_log: true + +- name: deploy check_ie_sample Timer + ansible.builtin.template: + src: "usr/local/lib/systemd/system/check_ie_sample.timer.j2" + dest: "/usr/local/lib/systemd/system/check_ie_sample.timer" + owner: "root" + group: "root" + mode: "0644" + loop: "{{ lookup('dict', vault_check_ie_sample_hosts) }}" + when: ansible_hostname == item.key + no_log: true + +- name: enable check_ie_sample Service + ansible.builtin.systemd: + unit: "check_ie_sample.service" + enabled: true + daemon_reload: true + loop: "{{ lookup('dict', vault_check_ie_sample_hosts) }}" + when: ansible_hostname == item.key + no_log: true + +- name: enable & start check_ie_sample Timer + ansible.builtin.systemd: + unit: "check_ie_sample.timer" + enabled: true + state: restarted + daemon_reload: true + loop: "{{ lookup('dict', vault_check_ie_sample_hosts) }}" + when: ansible_hostname == item.key + no_log: true + changed_when: false # "state: restarted" is never idempotent diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..04fb5c1 --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,41 @@ +--- +- name: include vars main + ansible.builtin.include_vars: "main.yml" + tags: [always] +- name: include Ansible Vaults + ansible.builtin.include_vars: "{{ role_path }}/../ansible_vaults/{{ role_name }}/{{ item }}" + loop: + - "iptables.vault" + - "proxy.vault" + - "check_ie_sample.vault" +# - "subapp.vault" + - "users.vault" + tags: [always] + +- name: install dependencies for Submission Application + ansible.builtin.import_tasks: "install_packages.yml" + tags: [subapp] + +- name: configure Client HTTP Proxy + ansible.builtin.import_tasks: "configure_proxy.yml" + tags: [proxy] + +- name: create users and groups + ansible.builtin.import_tasks: "create_users_groups.yml" + tags: [users, groups] + +- name: SubApp installieren + ansible.builtin.import_tasks: "install_subapp.yml" + tags: [subapp] + +- name: Userbezogene Konfiguration für User processing einspielen + ansible.builtin.import_tasks: "configure_processing_user.yml" + tags: [users, bash] + +- name: iptables-Regeln für externe Produzenten setzen + ansible.builtin.import_tasks: "configure_iptables_externalusers.yml" + tags: [iptables] + +- name: install scripts and services for moving old logs to archive + ansible.builtin.import_tasks: "install_move_logs.yml" + tags: [log, cleanup] diff --git a/templates/subapp.cfg.j2 b/templates/subapp.cfg.j2 new file mode 100644 index 0000000..b27b3db --- /dev/null +++ b/templates/subapp.cfg.j2 @@ -0,0 +1,90 @@ +########################### +### OPTIONAL PARAMETERS ### +########################### + + + +### optional processing and log settings + +# Absolute path to a file that contains a CSV list of SIPs that should be ignored by the subapp. One entry per line. You can create the file and leave it empty if you like; subapp will then act as if there was no blacklist at all and process all the SIPs. +blacklist_sip_file:/home/{{ vault_subapp_user }}/.subapp/usa_blacklist_file.csv +# Absolute path to a PID file +pid_file:/run/subapp/subapp_rosetta.pid +# Log4perl log level +logger_min_level:debug + + + +############################ +### MANDATORY PARAMETERS ### +############################ + + + +### internal working directories + +# Absolute path to the directory which is used for placing lockfiles into for SIPs when their processing commences. +directory_lock:/home/{{ vault_subapp_user }}/.subapp/lockdir/ +# Absolute path to the directory which contains symlinks to the SIPs that encountered errors during the processing and are put into quarantine. These SIPs will be ignored until the error is resolved. +directory_quarantine:/home/{{ vault_subapp_user }}/.subapp/quarantine/ +# Absolute path to the directory which is used for processing SIPs that contain an AIP update. +directory_shared_aipupdate:/mnt/{{ ansible_hostname }}_ingest/aipupdate/ +# Absolute path to the directory producers use to upload their SIPs to. +directory_shared_import:/mnt/import/ +# Absolute path to the directory that the submission application uses to put processed SIPs into for them to be fetched by Rosetta. Please note that the path to this directory needs to be accessible by Rosetta as well, and it needs to have the exact same name, so put extra attention into the naming of volumes, mount points and NFS export policy (or equivalent). +directory_shared_ingest:/mnt/{{ ansible_hostname }}_ingest/ + + + +### user/group settings + +# Name of the Linux user that owns the subapp's ingest directory. +owner_user_ingest_dir:{{ vault_subapp_user }} +# Name of the Linux group that owns the subapp's import directory. +owner_group_import_dir:import +# Name of the Linux group that owns the subapp's ingest directory. +owner_group_ingest_dir:{{ vault_subapp_group }} + + + +### Rosetta settings + +# FQDN of a) the host that the Rosetta application with the DEP role is running on or b) the load balancer that is in front of a Rosetta application cluster +rosetta_host:{{ vault_check_ie_sample_hosts[ansible_hostname].RosettaHost | default("ROSETTA_HOSTNAME_TEMPLATE") }} +# FQDN of the host that the PDS authentication server is running on +rosetta_pdshost:{{ vault_check_ie_sample_hosts[ansible_hostname].PdsHost | default("PDS_HOSTNAME_TEMPLATE") }} +# name of the institution in Rosetta that the subapp will ingest its SIPs into +rosetta_institute:{{ vault_check_ie_sample_hosts[ansible_hostname].Institute | default("INSTITUTE_NAME_TEMPLATE") }} +# Material Flow ID of the Material Flow that will be used for processing SIPs in Rosetta +rosetta_materialflowId:{{ vault_check_ie_sample_hosts[ansible_hostname].MaterialFlowID | default("MATERIAL_FLOW_ID_TEMPLATE") }} +# username of the user that the subapp will use for authentication against PDS/Rosetta +rosetta_user:{{ vault_check_ie_sample_hosts[ansible_hostname].User | default("SUBMISSION_APPLICATION_USER_TEMPLATE") }} +# password of that user +rosetta_password:{{ vault_check_ie_sample_hosts[ansible_hostname].password }} + + + +### processing configuration + +# Workflow name as agreed upon in the contract between producer and archive. +fullname_workflow:{{ vault_check_ie_sample_hosts[ansible_hostname].fullname_workflow | default("WORKFLOW_NAME_TEMPLATE") }} + +# Path to the XML file that contains the encoded significant properties as agreed upon with the producer. +significant_properties_file:{{ vault_check_ie_sample_hosts[ansible_hostname].significant_properties_file | default("SIGNIFICANT_PROPERTIES_FILE_PATH_TEMPLATE") }} + + + +### email notification configuration + +# notification email address for producers (high level error information) +logger_producer_email:{{ vault_check_ie_sample_hosts[ansible_hostname].logger_producer_email | default("LOGGER_PRODUCER_EMAIL_TEMPLATE") }} +# notification email address for archive staff (low level error information) +logger_staff_email:{{ vault_check_ie_sample_hosts[ansible_hostname].logger_staff_email | default("LOGGER_STAFF_EMAIL_TEMPLATE") }} + + + +### database configuration + +# Absolute path to SQLite database file for storing and loading message queues and SIP states +# Hints: using /tmp is not allowed by SQLite, furthermore security requires the parent directory to be set to at least '750' (drwxr-x---) +database_file:/home/{{ vault_subapp_user }}/.subapp/subapp.db diff --git a/templates/usr/local/lib/systemd/system/check_ie_sample.service.j2 b/templates/usr/local/lib/systemd/system/check_ie_sample.service.j2 new file mode 100644 index 0000000..9371162 --- /dev/null +++ b/templates/usr/local/lib/systemd/system/check_ie_sample.service.j2 @@ -0,0 +1,29 @@ +[Unit] +Description=service: daily report for sampling {{ item.value.institute_name }} workflows +Documentation=perldoc /usr/local/bin/check_ie_sample.pl + +[Service] +Type=oneshot +Restart=no +# Sampling factor = 1/100/365 +#ExecStart=/usr/bin/perl -I /usr/local/perl /usr/local/bin/check_ie_sample.pl \ +# --institute {{ item.value.institute_name }} \ +# --email langzeitarchiv@slub-dresden.de \ +# --host {{ item.value.rosetta_host }}.slub-dresden.de \ +# --user {{ item.value.user }} \ +# --password {{ item.value.password }} \ +# --sampling_factor 0.0000274 \ +# --dead_reference {{ item.value.institute_dead_ref_process_id }} +ExecStart=/usr/bin/perl -I /usr/local/perl /usr/local/bin/check_ie_sample.pl \ + --institute {{ item.value.institute_name }} \ + --email langzeitarchiv@slub-dresden.de \ + --host {{ item.value.rosetta_host }}.slub-dresden.de \ + --user {{ item.value.user }} \ + --password {{ item.value.password }} \ + --sampling_factor 0.0000274 \ + --fixity_check {{ item.value.institute_fixity_check_process_id }} +User={{ vault_subapp_user }} +Group={{ vault_subapp_group }} + +[Install] +WantedBy=default.target diff --git a/templates/usr/local/lib/systemd/system/check_ie_sample.timer.j2 b/templates/usr/local/lib/systemd/system/check_ie_sample.timer.j2 new file mode 100644 index 0000000..0a42a55 --- /dev/null +++ b/templates/usr/local/lib/systemd/system/check_ie_sample.timer.j2 @@ -0,0 +1,18 @@ +[Unit] +Description=timer: daily report for sampling {{ item.value.institute_name }} workflows +Documentation=perldoc /usr/local/bin/check_ie_sample.pl + +[Timer] +OnCalendar=daily +#RandomizedDelaySec=14400 +#Wake system from suspend mode +WakeSystem=true +#When activated, it triggers the service immediately if it missed the last start time, for example due to the system being powered off +Persistent=true +#Unit to activate when the timer elapses. (default is set to the same name as the timer unit, except for the suffix) +Unit=check_ie_sample.service + +[Install] +#is requires to activate the timer permanently +#on first init a symbolic link of /etc/systemd/system/basic.target.wants will be created +WantedBy=default.target diff --git a/vars/README.txt b/vars/README.txt new file mode 100644 index 0000000..2a72486 --- /dev/null +++ b/vars/README.txt @@ -0,0 +1 @@ +place YML files that contain variables associated with this role into this directory \ No newline at end of file diff --git a/vars/iptables.vault.example b/vars/iptables.vault.example new file mode 100644 index 0000000..a7d50ea --- /dev/null +++ b/vars/iptables.vault.example @@ -0,0 +1,22 @@ +--- +### This dictionary contains rules that apply to ALL target hosts. + +vault_iptables_all: + - comment: WHAT_IS_THIS_RULE_FOR? + src: 192.168.1.0/24 + dest_port: PORT_NUMBER + ... + +### These dictionaries contain rules that apply selectively. + +vault_iptables_<PRODUCER_1>: + - comment: WHAT_IS_THIS_RULE_FOR? + src: 192.168.1.0/24 + dest_port: PORT_NUMBER + ... + +vault_iptables_<PRODUCER_n>: + - comment: WHAT_IS_THIS_RULE_FOR? + src: 192.168.1.0/24 + dest_port: PORT_NUMBER + ... diff --git a/vars/main.yml b/vars/main.yml new file mode 100644 index 0000000..ed97d53 --- /dev/null +++ b/vars/main.yml @@ -0,0 +1 @@ +--- diff --git a/vars/proxy.vault.example b/vars/proxy.vault.example new file mode 100644 index 0000000..ef70d26 --- /dev/null +++ b/vars/proxy.vault.example @@ -0,0 +1,6 @@ +--- +vault_proxy_hostname: "{{ 'PRODUCTION_PROXY_HOSTNAME' if not 'test' in ansible_hostname else 'TEST_PROXY_HOSTNAME' }}" +vault_proxy_domain: "example.com" +vault_proxy_http_port: "PORT_NUMBER" +vault_proxy_https_port: "PORT_NUMBER" +vault_no_proxy: "LIST, OF, FQDNs, THAT, SHOULD, BE, REACHED, DIRECTLY" diff --git a/vars/users.vault.example b/vars/users.vault.example new file mode 100644 index 0000000..45581c3 --- /dev/null +++ b/vars/users.vault.example @@ -0,0 +1,14 @@ +--- +# These are users that don't ever login. They don't get "real" passwords. +# Instead, they get random, hashed passwords that are not saved anywhere in +# plaintest, so if anyone wants to get in, they'll have to crack SHA512 or +# own the correct SSH-Key. +vault_users: + USERNAME: + groups: "LIST, OF, GROUPS" + comment: "COMMENT" + generate_ssh_key: true + password: "{{ lookup('password', '/dev/null length=100 chars=ascii_letters')|password_hash('sha512') }}" + password_lock: true + shell: "/bin/false" + uid: "1337" -- GitLab