commit b95595ef6e70a42ae831f1972e8212810199ef97 Author: Élie Deloumeau-Prigent Date: Mon Sep 27 17:00:36 2021 +0200 Initial commit diff --git a/.ansible-lint b/.ansible-lint new file mode 100644 index 0000000..890b0fd --- /dev/null +++ b/.ansible-lint @@ -0,0 +1,74 @@ +--- +exclude_paths: + - molecule/ + - .pre-commit-config.yaml + +parseable: true + +use_default_rules: true + +enable_list: + command-shell: # Specific to use of command and shell modules + - command-instead-of-module + - command-instead-of-shell + - deprecated-command-syntax + - inline-env-var + - no-changed-when + - risky-shell-pipe + core: # Related to internal implementation of the linter + - internal-error + - load-failure + - parser-error + - syntax-check + deprecations: # Indicate use of features that are removed from Ansible + - deprecated-bare-vars + - deprecated-command-syntax + - deprecated-local-action + - deprecated-module + - no-jinja-when + - role-name + formatting: # Related to code-style + - no-jinja-nesting + - no-tabs + - playbook-extension + - risky-octal + - var-spacing + - yaml + idempotency: # Possible indication that consequent runs would produce different results + - git-latest + - hg-latest + - no-changed-when + - package-latest + idiom: # Anti-pattern detected, likely to cause undesired behavior + - command-instead-of-module + - command-instead-of-shell + - empty-string-compare + - inline-env-var + - literal-compare + - no-handler + - no-loop-var-prefix + - no-relative-paths + - unnamed-task + - var-naming + metadata: # Invalid metadata, likely related to galaxy, collections or roles + - meta-incorrect + - meta-no-tags + - meta-video-links + - role-name + unpredictability: + - ignore-errors + - partial-become + unskippable: + - syntax-check + yaml: # External linter which will also produce its own rule codes. + - yaml + +warn_list: + - experimental # all rules tagged as experimental + - meta-no-info # meta/main.yml should contain relevant info + - risky-file-permissions # File permissions unset or incorrect + +skip_list: + - role-name # BUG + +verbosity: 1 diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..af5cee8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,30 @@ + + +## Expected Behavior + + + +## Current Behavior + + + +## Possible Solution + + + +## Steps to Reproduce (for bugs) + + +1. +2. +3. +4. + +## Context + + + +## Your Environment + +* Version used: +* Operating System and Ansible version: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ab2413a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,28 @@ + + +## Description + + +## Motivation and Context + + + +## How Has This Been Tested? + + + + +## Screenshots (if appropriate): + +## Types of Changes + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) + +## Checklist: + + +- [ ] My code follows the code style of this project. +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. diff --git a/.github/workflows/galaxy.yml b/.github/workflows/galaxy.yml new file mode 100644 index 0000000..1b2e5df --- /dev/null +++ b/.github/workflows/galaxy.yml @@ -0,0 +1,15 @@ +--- +name: Import role on Ansible Galaxy + +on: # yamllint disable-line rule:truthy + release: + types: + - released +jobs: + release: + runs-on: ubuntu-20.04 + steps: + - name: galaxy + uses: robertdebock/galaxy-action@1.1.1 + with: + galaxy_api_key: ${{ secrets.galaxy_api_key }} diff --git a/.github/workflows/molecule.yml b/.github/workflows/molecule.yml new file mode 100644 index 0000000..7fdb440 --- /dev/null +++ b/.github/workflows/molecule.yml @@ -0,0 +1,50 @@ +--- +name: Ansible Molecule + +on: # yamllint disable-line rule:truthy + push: + tags_ignore: + - '*' + pull_request: + +jobs: + lint: + runs-on: ubuntu-20.04 + steps: + - name: checkout + uses: actions/checkout@v2 + with: + path: "${{ github.repository }}" + - name: molecule + uses: robertdebock/molecule-action@2.6.17 + with: + command: lint + + test: + needs: + - lint + runs-on: ubuntu-20.04 + strategy: + fail-fast: false + matrix: + config: + - image: "amazonlinux" + tag: "latest" + - image: "centos" + tag: "8" + - image: "debian" + tag: "11" + - image: "debian" + tag: "10" + - image: "ubuntu" + tag: "20.04" + steps: + - name: checkout + uses: actions/checkout@v2 + with: + path: "${{ github.repository }}" + - name: molecule + uses: robertdebock/molecule-action@2.6.17 + with: + image: ${{ matrix.config.image }} + tag: ${{ matrix.config.tag }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2b61b44 --- /dev/null +++ b/.gitignore @@ -0,0 +1,112 @@ +###MacOS### +.DS_Store + +###Ansible### +*.retry + +###Python### + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +.static_storage/ +.media/ +local_settings.py + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ \ No newline at end of file diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..2000151 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,7 @@ +--- +- repo: https://github.com/ansible-community/ansible-lint.git + rev: v5.1.3 + hooks: + - id: ansible-lint + files: \.(yaml|yml)$ + exclude: ^molecule/ diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..6a10386 --- /dev/null +++ b/.yamllint @@ -0,0 +1,12 @@ +--- +extends: default + +rules: + braces: + max-spaces-inside: 1 + level: error + brackets: + max-spaces-inside: 1 + level: error + line-length: disable + document-start: disable diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6003438 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,93 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a + build. +2. Update the README.md with details of changes to the role, this includes new variables, + useful file locations, etc... +3. Increase the version numbers in any examples files and the README.md to the new version that this + Pull Request would represent. The versioning scheme we use is [SemVer](https://semver.org/). +4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. + +## Code of Conduct + +### Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, color, religion, or sexual identity and +orientation. + +### Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +### Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +### Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +### Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at fr-ansible-github@fr.clara.net. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] and +[Good-CONTRIBUTING.md-template.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/HARDENING.md b/HARDENING.md new file mode 100644 index 0000000..85c1c1c --- /dev/null +++ b/HARDENING.md @@ -0,0 +1 @@ +There is no available hardening for this role diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ee6256c --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at https://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..efb1eac --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# Ansible role - motd +[![Maintainer](https://img.shields.io/badge/maintained%20by-claranet-e00000?style=flat-square)](https://www.claranet.fr/) +[![License](https://img.shields.io/github/license/claranet/ansible-role-motd?style=flat-square)](LICENSE) +[![Release](https://img.shields.io/github/v/release/claranet/ansible-role-motd?style=flat-square)](https://github.com/claranet/ansible-role-motd/releases) +[![Status](https://img.shields.io/github/workflow/status/claranet/ansible-role-motd/Ansible%20Molecule?style=flat-square&label=tests)](https://github.com/claranet/ansible-role-motd/actions?query=workflow%3A%22Ansible+Molecule%22) +[![Ansible version](https://img.shields.io/badge/ansible-%3E%3D2.9-black.svg?style=flat-square&logo=ansible)](https://github.com/ansible/ansible) +[![Ansible Galaxy](https://img.shields.io/badge/ansible-galaxy-black.svg?style=flat-square&logo=ansible)](https://galaxy.ansible.com/claranet/motd) + + +> :star: Star us on GitHub — it motivates us a lot! + +Install and configure dynamic MOTD and SSH banner + +``` +System info: + Hostname·········: claranet_motd_ubuntu-20.04 + Distro···········: Ubuntu 20.04.3 LTS + Kernel···········: Linux 5.10.47-linuxkit + Updates available: 6 (2 security) + Uptime···········: up 2 days, 23 hours, 18 minutes + Load·············: 1.33 (1m), 0.43 (5m), 0.20 (15m) + Processes········: 13 (root), 3 (user), 16 (total) + CPU··············: Intel(R) Core(TM) i7-8569U CPU @ 2.80GHz (4 vCPU) + Memory···········: 626Mi used, 2.6Gi avail, 3.8Gi total + Local IPs········: 172.17.0.6 + +Disk usage: + / 9% used out of 63G + [====··············································] + +Ansible: + Last deployment···: 2021-09-27T13:33:33.665714Z +``` + +## :warning: Requirements + +Ansible >= 2.9 + +## :zap: Installation + +```bash +ansible-galaxy install claranet.motd +``` + +## :gear: Role variables + +Variable | Default value | Description +--------------------------|-----------------------|---------------------------------------- +motd_disable_default_motd | true | Disable system default MOTD (/etc/motd) +motd_banner_template | etc/banner | SSH banner template +motd_template | usr/local/bin/dynmotd | Dynmaic MOTD template + +## :pencil2: Example Playbook + +```yaml +--- +- hosts: all + roles: + - claranet.motd +``` + +## :closed_lock_with_key: [Hardening](HARDENING.md) + +## :heart_eyes_cat: [Contributing](CONTRIBUTING.md) + +## :copyright: [License](LICENSE) + +[Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/) diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..9d2e210 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,4 @@ +--- +motd_disable_default_motd: true +motd_banner_template: etc/banner +motd_template: usr/local/bin/dynmotd diff --git a/handlers/main.yml b/handlers/main.yml new file mode 100644 index 0000000..784cf59 --- /dev/null +++ b/handlers/main.yml @@ -0,0 +1,4 @@ +- name: Restart sshd + service: + name: sshd + state: restarted diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..67f8c5d --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,28 @@ +galaxy_info: + role_name: "motd" + namespace: "claranet" + description: "Install and configure dynamic MOTD" + author: "Claranet" + company: "Claranet France" + + license: "MPL2" + + min_ansible_version: 2.9 + + galaxy_tags: ['claranet', 'motd', 'system', 'dynmotd', 'dynamic'] + + platforms: + - name: EL + versions: + - all + - name: Amazon + versions: + - all + - name: Debian + versions: + - all + - name: Ubuntu + versions: + - all + +dependencies: [] diff --git a/molecule/default/Dockerfile.j2 b/molecule/default/Dockerfile.j2 new file mode 100644 index 0000000..71c58f2 --- /dev/null +++ b/molecule/default/Dockerfile.j2 @@ -0,0 +1,21 @@ +# Molecule managed + +{% if item.registry is defined %} +FROM {{ item.registry.url }}/{{ item.image }} +{% else %} +FROM {{ item.image }} +{% endif %} + +{% if item.env is defined %} +{% for var, value in item.env.items() %} +{% if value %} +ENV {{ var }} {{ value }} +{% endif %} +{% endfor %} +{% endif %} + +RUN if [ $(command -v apt-get) ]; then apt-get update && apt-get install -y python3 sudo bash ca-certificates iproute2 systemd && apt-get clean; \ + elif [ $(command -v yum) ]; then yum install -y python3 sudo bash iproute systemd firewalld initscripts; \ + elif [ $(command -v zypper) ]; then zypper refresh && zypper install -y python sudo bash python-xml iproute2 && zypper clean -a; \ + elif [ $(command -v apk) ]; then apk update && apk add --no-cache python sudo bash ca-certificates; \ + elif [ $(command -v xbps-install) ]; then xbps-install -Syu && xbps-install -y python sudo bash ca-certificates iproute2 && xbps-remove -O; fi diff --git a/molecule/default/converge.yml b/molecule/default/converge.yml new file mode 100644 index 0000000..8632b99 --- /dev/null +++ b/molecule/default/converge.yml @@ -0,0 +1,17 @@ +--- +- name: Converge + hosts: all + roles: + - role: claranet.motd + motd_banner_template: null + + pre_tasks: + - name: "Update APT cache" + apt: + update_cache: true + when: + - ansible_pkg_mgr == "apt" + + - name: Install sshd + package: + name: openssh-server diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml new file mode 100644 index 0000000..fc6888f --- /dev/null +++ b/molecule/default/molecule.yml @@ -0,0 +1,41 @@ +--- +dependency: + name: galaxy + +driver: + name: docker + +platforms: + - name: claranet_motd_${image:-debian}-${tag:-latest} + image: ${image:-debian}:${tag:-latest} + privileged: true + tty: true + volumes: + - "/sys/fs/cgroup:/sys/fs/cgroup:rw" + - "/var/run/docker.sock:/var/run/docker.sock:ro" + stop_signal: "SIGRTMIN+3" + capabilities: + - SYS_ADMIN + - SYS_TIME + - LINUX_IMMUTABLE + command: "/lib/systemd/systemd" + +provisioner: + name: ansible + env: + ANSIBLE_FORCE_COLOR: "true" + options: + v: true + +verifier: + name: testinfra + lint: + name: flake8 + options: + verbose: true + s: true + +lint: | + set -e + yamllint . + ansible-lint diff --git a/molecule/default/tests/test_default.py b/molecule/default/tests/test_default.py new file mode 100644 index 0000000..6136f7e --- /dev/null +++ b/molecule/default/tests/test_default.py @@ -0,0 +1,45 @@ +#!/usr/bin/env python + +import os +import stat +import testinfra.utils.ansible_runner + +testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner( + os.environ["MOLECULE_INVENTORY_FILE"] +).get_hosts("all") + +motd_file_path = "/usr/local/bin/dynmotd" +pam_line = f"session optional pam_exec.so type=open_session stdout {motd_file_path}" + + +def test_banner_file(host): + file = host.file("/etc/banner") + assert not file.exists + + +def test_motd_file(host): + file = host.file(motd_file_path) + assert file.exists + assert file.is_file + assert file.user == "root" + assert file.group == "root" + assert file.mode == 0o755 + + +def test_motd_output(host): + command = host.run(motd_file_path) + assert command.succeeded + assert command.stderr == "" + print(f"\n{command.stdout}") + + +def test_pam_login_file(host): + file = host.file("/etc/pam.d/login") + assert file.exists + assert file.contains(pam_line) + + +def test_pam_sshd_file(host): + file = host.file("/etc/pam.d/sshd") + assert file.exists + assert file.contains(pam_line) diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..9db41c1 --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,58 @@ +--- +- block: + - name: Get stats of {{ _motd_sshd_config_file_path }} + stat: + path: "{{ _motd_sshd_config_file_path }}" + register: _motd_sshd_config_file_stat + + - name: Ensure PrintMotd is set to "no" in {{ _motd_sshd_config_file_path }} + lineinfile: + path: "{{ _motd_sshd_config_file_path }}" + regexp: "^PrintMotd " + line: PrintMotd no + when: _motd_sshd_config_file_stat.stat.exists + + - name: Comment out pam_motd in pam + replace: + path: "{{ item }}" + regexp: '^(session\s+optional\s+pam_motd.so\s+.*)' + replace: '# \1' + loop: + - "{{ _motd_pam_login_file_path }}" + - "{{ _motd_pam_sshd_file_path }}" + when: motd_disable_default_motd|bool + +- name: Apply template {{ motd_banner_template }} on {{ _motd_banner_file_path }} + template: + src: "{{ motd_banner_template }}" + dest: "{{ _motd_banner_file_path }}" + owner: root + group: root + mode: '0644' + when: motd_banner_template + +- name: Ensure line "Banner {{ _motd_banner_file_path }}" is {{ _motd_banner_state }} in {{ _motd_sshd_config_file_path }} + lineinfile: + path: "{{ _motd_sshd_config_file_path }}" + regexp: "^(#?)Banner " + line: Banner {{ _motd_banner_file_path }} + state: "{{ _motd_banner_state }}" + notify: Restart sshd + +- name: Apply template {{ motd_template }} on {{ _motd_file_path }} + template: + src: "{{ motd_template }}" + dest: "{{ _motd_file_path }}" + owner: root + group: root + mode: '0755' + tags: + - molecule-idempotence-notest + +- name: Add pam_exec {{ _motd_file_path }} in pam + lineinfile: + path: "{{ item }}" + line: session optional pam_exec.so type=open_session stdout {{ _motd_file_path }} + loop: + - "{{ _motd_pam_login_file_path }}" + - "{{ _motd_pam_sshd_file_path }}" diff --git a/templates/etc/banner b/templates/etc/banner new file mode 100644 index 0000000..0a9e54f --- /dev/null +++ b/templates/etc/banner @@ -0,0 +1,32 @@ + ,╓╗╖æææææ╖╖, + ,╗╣╬╬╣╝╜╙╙"╙╙╜╝╣Ñ╬æ╖ + ╓╣╬╝╜ "╙╣╬╣µ + ╓╬╬M "╢╬╣, + ╣╬╝ ╣Ñæ ╙╬╬╖╖╖╖╖╓, + ,,╓╣╬M ,╗ ╬╬╬ ╓╖, ╝╜╜╜╜╝╣╬╬╣╖ + ╓æ╣Ñ╬╣╝╝╝ ╓╣╬╝ ╬╬╬ ²╣╬╣µ `╙╣╬æ, + ╓╣╬╝^ ╣╬╝ ╬╬╬ `╣╬æ ╙╬╬φ + ╣╬M ║╬╬ ╢╣M ╬╬U ╢╬φ + ╬╬M ║╬╬ ╬╬M ╬╬∩ + ║╬╬ "╬ѵ ╓Ñ╬ ╟╬┼ + ╟╬┼ `╣╬╖, ,╢╬╣ ╟╬┼ + ║╬╬ ╙╢╬╬╣ææ╬╣╬╬╝` ╬╬M + ╬╬µ `"""` ╣╬M + `╬╬φ ╓╬╬M + ╚╬╬╖, ,╗╣╬╝ + ╙╣Ñ╬╣æ╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖╖æ╣╬╬╝╜ + `"╙╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╜╙" ® + + ╖╖┬ ╓╖╖ + ╬╬M ╓╬╬ + ,╗╣╬╬╣æ, ╬╬M ,æ╣╬╬╬æ╖ ß╣ß╓æ╣ ╓æ╣╬╬╣æ, -╣╣╓æ╣╬╣╖ ,╖╣╬╬╣╖, ╢╣╬╬╣╣ + ║╬╬" `╝╜* ╬╬M ╝╝┘ ╟╬φ ╬╬╬M"` ª╝╝ ╙╬Ñ "╬╬M ║╬╬ ╢╬M ╢╬φ ╓╬╬ + -╬╬H ╬╬M ╓æ╣╬╬╣╬╬M ╬╬╬ ╗╢╣╬╣╣╬╬⌐ "╬╬ ╓╬╬ ╬╬╬╬╬╬╬╬╬╬ ╓╬╬ + ╢╬φ ╓,, ╬╬M ╢╬M ╟╬M ╬╬╪ ╬╬M ,╬╬⌐ "╬╬ ╓╬╬ ╬╬φ ╓ ╓╬╬ + ╚╬╬╣╣╣╬╝ ╬╬M ╙╣╬╣æ╣╬╬╬M ╬╬╪ ║╬╬ææ╣╣╬╬⌐ "╬╬ ╓╬╬ ╚╬╬╣╣╣╬╣╜ '╬╬╣æ + `` `` ``` ``` ``` + +WARNING : Unauthorized access to this system is forbidden and will be +prosecuted by law. By accessing this system, you agree that your actions +may be monitored if unauthorized usage is suspected. + diff --git a/templates/usr/local/bin/dynmotd b/templates/usr/local/bin/dynmotd new file mode 100644 index 0000000..c3c6dbc --- /dev/null +++ b/templates/usr/local/bin/dynmotd @@ -0,0 +1,85 @@ +#!/bin/bash + +# get load averages +IFS=" " read LOAD1 LOAD5 LOAD15 <<<$(awk '{ print $1,$2,$3 }' /proc/loadavg) +# get free memory +IFS=" " read USED AVAIL TOTAL <<<$(free -htm | grep "Mem" | awk {'print $3,$7,$2'}) +# get processes +PROCESS=$(ps -eo user=|sort|uniq -c | awk '{ print $2 " " $1 }') +PROCESS_ALL=$(echo "$PROCESS"| awk {'print $2'} | awk '{ SUM += $1} END { print SUM }') +PROCESS_ROOT=$(echo "$PROCESS"| grep root | awk {'print $2'}) +PROCESS_USER=$(echo "$PROCESS"| grep -v root | awk {'print $2'} | awk '{ SUM += $1} END { print SUM }') +# get processors +PROCESSOR_NAME=$(grep "model name" /proc/cpuinfo | cut -d ' ' -f3- | awk {'print $0'} | head -1) +PROCESSOR_COUNT=$(grep -ioP 'processor\t:' /proc/cpuinfo | wc -l) + +LOCAL_IP_ADDRESSES=$(hostname -I | sed 's/ /\n\ /g' | sed '/^[[:space:]]*$/d') + +# Processing available updates with yum is too long +{% if ansible_pkg_mgr == "apt" %} +UPDATES_AVAILABLE=$(apt list --upgradable 2>/dev/null) +UPDATES_AVAILABLE_NB=$(echo -e "$UPDATES_AVAILABLE" | wc -l) +SECURITY_UPDATES_AVAILABLE_NB=$(echo -e "$UPDATES_AVAILABLE" | grep "\-security" | wc -l) +{% endif %} + +# colors +W="\e[0;39m" +G="\e[1;32m" +R="\e[1;31m" + +dim="\e[2m" +undim="\e[0m" + +echo -e "${W}System info: +$W Hostname$dim·········$undim: $W${HOSTNAME} +$W Distro$dim···········$undim: $W$(grep "PRETTY_NAME" /etc/*release | cut -d "=" -f 2- | sed 's/"//g') +$W Kernel$dim···········$undim: $W$(uname -sr) +{% if ansible_pkg_mgr == "apt" %} +$W Updates available: $W$UPDATES_AVAILABLE_NB ($SECURITY_UPDATES_AVAILABLE_NB security) +{% endif %} +$W Uptime$dim···········$undim: $W$(uptime -p) +$W Load$dim·············$undim: $G$LOAD1$W (1m), $G$LOAD5$W (5m), $G$LOAD15$W (15m) +$W Processes$dim········$undim: $G$PROCESS_ROOT$W (root), $G$PROCESS_USER$W (user), $G$PROCESS_ALL$W (total) +$W CPU$dim··············$undim: $W$PROCESSOR_NAME ($G$PROCESSOR_COUNT$W vCPU) +$W Memory$dim···········$undim: $G$USED$W used, $G$AVAIL$W avail, $G$TOTAL$W total +$W Local IPs$dim········$undim: $LOCAL_IP_ADDRESSES$W" + +# config +max_usage=90 +bar_width=50 + +# disk usage: ignore zfs, squashfs & tmpfs +mapfile -t dfs < <(df -H -x zfs -x squashfs -x tmpfs -x devtmpfs -x overlay --output=target,pcent,size | tail -n+2) +printf "\nDisk usage:\n" + +for line in "${dfs[@]}"; do + # get disk usage + usage=$(echo "$line" | awk '{print $2}' | sed 's/%//') + used_width=$((($usage*$bar_width)/100)) + # color is green if usage < max_usage, else red + if [ "${usage}" -ge "${max_usage}" ]; then + color=$R + else + color=$G + fi + # print green/red bar until used_width + bar="[${color}" + for ((i=0; i<$used_width; i++)); do + bar+="=" + done + # print dimmmed bar until end + bar+="${W}${dim}" + for ((i=$used_width; i<$bar_width; i++)); do + bar+="·" + done + bar+="${undim}]" + # print usage line & bar + echo "${line}" | awk '{ printf("%-31s%+3s used out of %+4s\n", $1, $2, $3); }' | sed -e 's/^/ /' + echo -e "${bar}" | sed -e 's/^/ /' +done + +printf "\n" + +echo -e "${W}Ansible: +${W} Last deployment$dim···$undim: {{ ansible_date_time.iso8601_micro }} +" diff --git a/vars/main.yml b/vars/main.yml new file mode 100644 index 0000000..513f68c --- /dev/null +++ b/vars/main.yml @@ -0,0 +1,7 @@ +--- +_motd_sshd_config_file_path: /etc/ssh/sshd_config +_motd_pam_login_file_path: /etc/pam.d/login +_motd_pam_sshd_file_path: /etc/pam.d/sshd +_motd_banner_file_path: /etc/banner +_motd_banner_state: "{{ 'present' if motd_banner_template else 'absent' }}" +_motd_file_path: /usr/local/bin/dynmotd