9 Commits
1.1.1 ... 2.1.1

17 changed files with 83 additions and 85 deletions

View File

@ -2,6 +2,7 @@
exclude_paths: exclude_paths:
- molecule/ - molecule/
- .pre-commit-config.yaml - .pre-commit-config.yaml
- .github/
parseable: true parseable: true

View File

@ -10,6 +10,7 @@ jobs:
runs-on: ubuntu-20.04 runs-on: ubuntu-20.04
steps: steps:
- name: galaxy - name: galaxy
uses: robertdebock/galaxy-action@1.1.1 uses: robertdebock/galaxy-action@1.2.1
with: with:
galaxy_api_key: ${{ secrets.galaxy_api_key }} galaxy_api_key: ${{ secrets.galaxy_api_key }}
git_branch: main

View File

@ -8,43 +8,75 @@ on: # yamllint disable-line rule:truthy
pull_request: pull_request:
jobs: jobs:
setup:
name: Setup scenarios matrix
runs-on: ubuntu-22.04
outputs:
scenarios: ${{ steps.matrix.outputs.scenarios }}
steps:
- uses: actions/checkout@v3
- id: matrix
run: |
JSON="["
for s in $(find molecule -mindepth 1 -maxdepth 1 -type d -exec basename "{}" \;); do
JSON="${JSON}\"${s}\","
done
JSON="${JSON%?}"
JSON="$JSON]"
echo "::set-output name=scenarios::$(echo $JSON)"
lint: lint:
runs-on: ubuntu-20.04 name: Lint
needs:
- setup
runs-on: ubuntu-22.04
steps: steps:
- name: checkout - name: checkout
uses: actions/checkout@v2 uses: actions/checkout@v3
with: with:
path: "${{ github.repository }}" path: "${{ github.repository }}"
- name: molecule - name: molecule
uses: robertdebock/molecule-action@2.6.17 uses: robertdebock/molecule-action@4.0.9
with: with:
command: lint command: lint
scenario: ${{ fromJson(needs.setup.outputs.scenarios)[0] }}
test: test:
name: Scenario "${{ matrix.scenario }}" on ${{ matrix.config.image }}:${{ matrix.config.tag }}
needs: needs:
- lint - lint
- setup
runs-on: ubuntu-20.04 runs-on: ubuntu-20.04
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
scenario: ${{ fromJson(needs.setup.outputs.scenarios) }}
config: config:
- image: "amazonlinux" - image: "amazonlinux"
tag: "latest" tag: "latest"
- image: "centos" - name: "redhat"
tag: "8" image: "registry.access.redhat.com/ubi8/ubi"
tag: "latest"
- image: "debian" - image: "debian"
tag: "11" tag: "11"
- image: "debian" - image: "debian"
tag: "10" tag: "10"
- image: "ubuntu" - image: "ubuntu"
tag: "20.04" tag: "22.04"
steps: steps:
- name: checkout - name: checkout
uses: actions/checkout@v2 uses: actions/checkout@v3
with: with:
path: "${{ github.repository }}" path: "${{ github.repository }}"
- name: molecule - name: molecule
uses: robertdebock/molecule-action@2.6.17 uses: robertdebock/molecule-action@4.0.9
with: with:
image: ${{ matrix.config.image }} image: ${{ matrix.config.image }}
tag: ${{ matrix.config.tag }} tag: ${{ matrix.config.tag }}
scenario: ${{ matrix.scenario }}
env:
name: ${{ matrix.config.name }}

2
.gitignore vendored
View File

@ -1,3 +1,5 @@
###VSCode###
.vscode
###MacOS### ###MacOS###
.DS_Store .DS_Store

View File

@ -9,9 +9,9 @@
> :star: Star us on GitHub — it motivates us a lot! > :star: Star us on GitHub — it motivates us a lot!
Install and configure dynamic MOTD and SSH banner Install and configure dynamic MOTD
This role uses [https://github.com/claranet/motd](https://github.com/claranet/motd) by default to get the banner and the MOTD This role uses [https://github.com/claranet/motd](https://github.com/claranet/motd) by default to get the MOTD
``` ```
System info: System info:
@ -35,7 +35,7 @@ Ansible:
## :warning: Requirements ## :warning: Requirements
Ansible >= 2.9 Ansible >= 2.10
## :zap: Installation ## :zap: Installation
@ -48,11 +48,6 @@ ansible-galaxy install claranet.motd
Variable | Default value | Description Variable | Default value | Description
-----------------------------|------------------------------------------------------------------------|---------------------------------------------------------------- -----------------------------|------------------------------------------------------------------------|----------------------------------------------------------------
motd_disable_default_motd | true | Disable system default MOTD (/etc/motd) motd_disable_default_motd | true | Disable system default MOTD (/etc/motd)
motd_banner_template | https://raw.githubusercontent.com/claranet/motd/master/banner | SSH banner template<br>Can be a URL, a local template or `null`
motd_banner_template_prepend | "" | Prepend raw content to `motd_banner_template`
motd_banner_template_append | "" | Append raw content to `motd_banner_template`
motd_banner_template_username| {{ motd_template_username }} | Used when `motd_banner_template` is an URL
motd_banner_template_password| {{ motd_template_password }} | Used when `motd_banner_template` is an URL
motd_template | https://raw.githubusercontent.com/claranet/motd/master/scripts/00-basic| Dynmaic MOTD template<br>Can be a URL or a local template motd_template | https://raw.githubusercontent.com/claranet/motd/master/scripts/00-basic| Dynmaic MOTD template<br>Can be a URL or a local template
motd_template_prepend | "" | Prepend raw content to `motd_template` motd_template_prepend | "" | Prepend raw content to `motd_template`
motd_template_append | See [defaults/main.yml](defaults/main.yml) | Append raw content to `motd_template` motd_template_append | See [defaults/main.yml](defaults/main.yml) | Append raw content to `motd_template`

View File

@ -1,9 +1,6 @@
--- ---
motd_disable_default_motd: true motd_disable_default_motd: true
motd_banner_template: https://raw.githubusercontent.com/claranet/motd/master/banner
motd_template: https://raw.githubusercontent.com/claranet/motd/master/scripts/00-basic motd_template: https://raw.githubusercontent.com/claranet/motd/master/scripts/00-basic
motd_banner_template_prepend: ""
motd_banner_template_append: ""
motd_template_prepend: "" motd_template_prepend: ""
motd_template_append: | motd_template_append: |
@ -13,5 +10,3 @@ motd_template_append: |
motd_template_username: "" motd_template_username: ""
motd_template_password: "" motd_template_password: ""
motd_banner_template_username: "{{ motd_template_username }}"
motd_banner_template_password: "{{ motd_template_password }}"

View File

@ -1,4 +1,4 @@
- name: Restart sshd - name: Restart sshd
service: ansible.builtin.service:
name: sshd name: sshd
state: restarted state: restarted

View File

@ -7,7 +7,7 @@ galaxy_info:
license: "MPL2" license: "MPL2"
min_ansible_version: 2.9 min_ansible_version: "2.10"
galaxy_tags: ['claranet', 'motd', 'system', 'dynmotd', 'dynamic'] galaxy_tags: ['claranet', 'motd', 'system', 'dynmotd', 'dynamic']

View File

@ -14,8 +14,11 @@ ENV {{ var }} {{ value }}
{% endfor %} {% endfor %}
{% endif %} {% 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; \ RUN if [ $(command -v apt-get) ]; then apt-get update && apt-get install -y python3 sudo bash ca-certificates iproute2 systemd wget && apt-get clean; \
elif [ $(command -v yum) ]; then yum install -y python3 sudo bash iproute systemd firewalld initscripts; \ elif [ $(command -v yum) ]; then yum install -y python3 sudo bash iproute systemd initscripts wget; \
elif [ $(command -v zypper) ]; then zypper refresh && zypper install -y python sudo bash python-xml iproute2 && zypper clean -a; \ elif [ $(command -v zypper) ]; then zypper refresh && zypper install -y python sudo bash python-xml iproute2 wget && zypper clean -a; \
elif [ $(command -v apk) ]; then apk update && apk add --no-cache python sudo bash ca-certificates; \ elif [ $(command -v apk) ]; then apk update && apk add --no-cache python sudo bash ca-certificates wget; \
elif [ $(command -v xbps-install) ]; then xbps-install -Syu && xbps-install -y python sudo bash ca-certificates iproute2 && xbps-remove -O; fi elif [ $(command -v xbps-install) ]; then xbps-install -Syu && xbps-install -y python sudo bash ca-certificates iproute2 wget && xbps-remove -O; fi
RUN wget -O /usr/bin/systemctl https://raw.githubusercontent.com/gdraheim/docker-systemctl-replacement/master/files/docker/systemctl3.py && \
chmod +x /usr/bin/systemctl

View File

@ -3,7 +3,6 @@
hosts: all hosts: all
roles: roles:
- role: claranet.motd - role: claranet.motd
motd_banner_template: null
pre_tasks: pre_tasks:
- name: "Update APT cache" - name: "Update APT cache"

View File

@ -6,7 +6,9 @@ driver:
name: docker name: docker
platforms: platforms:
- name: claranet_motd_${image:-debian}-${tag:-latest} # On "${name:-${image:-debian}", the last brace does not miss, it works like that...
# The env var "name" should be used when the image variable refers to a full registry path like registry.access.redhat.com/ubi8/ubi
- name: claranet_motd_${name:-${image:-debian}-${tag:-latest}-${scenario:-default}
image: ${image:-debian}:${tag:-latest} image: ${image:-debian}:${tag:-latest}
privileged: true privileged: true
tty: true tty: true

View File

@ -12,11 +12,6 @@ motd_file_path = "/usr/local/bin/dynmotd"
pam_line = f"session optional pam_exec.so type=open_session stdout {motd_file_path}" 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): def test_motd_file(host):
file = host.file(motd_file_path) file = host.file(motd_file_path)
assert file.exists assert file.exists

View File

@ -1,18 +0,0 @@
---
- name: configure_banner | Apply template {{ motd_banner_template }} on {{ _motd_banner_file_path }}
copy:
content: "{{ motd_banner_template_prepend + _motd_banner_template_content + motd_banner_template_append }}"
dest: "{{ _motd_banner_file_path }}"
owner: root
group: root
mode: '0644'
when: motd_banner_template != None and motd_banner_template|length>0
- name: configure_banner | 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
...

View File

@ -1,19 +0,0 @@
---
- name: configure_motd | Apply template {{ motd_template }} on {{ _motd_file_path }}
copy:
content: "{{ motd_template_prepend + _motd_template_content + motd_template_append }}"
dest: "{{ _motd_file_path }}"
owner: root
group: root
mode: '0755'
tags:
- molecule-idempotence-notest
- name: configure_motd | 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 }}"
...

View File

@ -1,18 +1,18 @@
--- ---
- name: disable_default_motd | Get stats of {{ _motd_sshd_config_file_path }} - name: disable_default_motd | Get stats of {{ _motd_sshd_config_file_path }}
stat: ansible.builtin.stat:
path: "{{ _motd_sshd_config_file_path }}" path: "{{ _motd_sshd_config_file_path }}"
register: _motd_sshd_config_file_stat register: _motd_sshd_config_file_stat
- name: disable_default_motd | Ensure PrintMotd is set to "no" in {{ _motd_sshd_config_file_path }} - name: disable_default_motd | Ensure PrintMotd is set to "no" in {{ _motd_sshd_config_file_path }}
lineinfile: ansible.builtin.lineinfile:
path: "{{ _motd_sshd_config_file_path }}" path: "{{ _motd_sshd_config_file_path }}"
regexp: "^PrintMotd " regexp: "^PrintMotd "
line: PrintMotd no line: PrintMotd no
when: _motd_sshd_config_file_stat.stat.exists when: _motd_sshd_config_file_stat.stat.exists
- name: disable_default_motd | Comment out pam_motd in pam - name: disable_default_motd | Comment out pam_motd in pam
replace: ansible.builtin.replace:
path: "{{ item }}" path: "{{ item }}"
regexp: '^(session\s+optional\s+pam_motd.so\s+.*)' regexp: '^(session\s+optional\s+pam_motd.so\s+.*)'
replace: '# \1' replace: '# \1'

View File

@ -1,9 +1,23 @@
--- ---
- include_tasks: configure_banner.yml - name: Include disable_default_motd.yml if motd_disable_default_motd is True
ansible.builtin.include_tasks: disable_default_motd.yml
- name: include_tasks disable_default_motd.yml if motd_disable_default_motd is True
include_tasks: disable_default_motd.yml
when: motd_disable_default_motd|bool when: motd_disable_default_motd|bool
- include_tasks: configure_motd.yml - name: configure_motd | Apply template {{ motd_template }} on {{ _motd_file_path }}
ansible.builtin.copy:
content: "{{ motd_template_prepend + _motd_template_content + motd_template_append }}"
dest: "{{ _motd_file_path }}"
owner: root
group: root
mode: '0755'
tags:
- molecule-idempotence-notest
- name: configure_motd | Add pam_exec {{ _motd_file_path }} in pam
ansible.builtin.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 }}"
... ...

View File

@ -2,10 +2,6 @@
_motd_sshd_config_file_path: /etc/ssh/sshd_config _motd_sshd_config_file_path: /etc/ssh/sshd_config
_motd_pam_login_file_path: /etc/pam.d/login _motd_pam_login_file_path: /etc/pam.d/login
_motd_pam_sshd_file_path: /etc/pam.d/sshd _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 _motd_file_path: /usr/local/bin/dynmotd
_motd_lookup_method: "{{ 'url' if motd_template is match('http(s)?:\/\/') else 'template' }}" _motd_lookup_method: "{{ 'url' if motd_template is match('http(s)?:\/\/') else 'template' }}"
_motd_template_content: "{{ lookup(_motd_lookup_method, motd_template, split_lines=False, username=motd_template_username, password=motd_template_password) }}" _motd_template_content: "{{ lookup(_motd_lookup_method, motd_template, split_lines=False, username=motd_template_username, password=motd_template_password) }}"
_motd_banner_lookup_method: "{{ 'url' if motd_banner_template is match('http(s)?:\/\/') else 'template' }}"
_motd_banner_template_content: "{{ lookup(_motd_banner_lookup_method, motd_banner_template, split_lines=False, username=motd_banner_template_username, password=motd_banner_template_password) }}"