From ca8d48964da89fc6adef904c9e695cd78a1c281c Mon Sep 17 00:00:00 2001 From: Brad Cowie Date: Sat, 1 Oct 2022 16:48:36 +1300 Subject: [PATCH 1/2] Add test and lint GitHub Action workflows. --- .github/dependabot.yml | 7 ++++++ .github/workflows/lint.yml | 34 +++++++++++++++++++++++++++ .github/workflows/test.yml | 43 ++++++++++++++++++++++++++++++++++ molecule/default/Dockerfile.j2 | 20 ++++++++++++++++ molecule/default/converge.yml | 9 +++++++ molecule/default/molecule.yml | 18 ++++++++++++++ requirements.txt | 1 + test-requirements.txt | 3 +++ 8 files changed, 135 insertions(+) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/lint.yml create mode 100644 .github/workflows/test.yml create mode 100644 molecule/default/Dockerfile.j2 create mode 100644 molecule/default/converge.yml create mode 100644 molecule/default/molecule.yml create mode 100644 requirements.txt create mode 100644 test-requirements.txt diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..64284b9 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,7 @@ +--- +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "monthly" diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..cb6289f --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,34 @@ +--- +name: Lint + +on: + pull_request: + branches: + - main + +jobs: + ansible-lint: + name: Ansible Lint + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Install dependencies + run: pip3 install -r requirements.txt + - name: Lint ansible + uses: wandansible/action-ansible-lint@v1 + + jinja2-lint: + name: Jinja2 Lint + runs-on: ubuntu-latest + env: + J2LINT_FILES_REGEX: '^templates/.+$' + steps: + - name: Checkout repo + uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Lint jinja2 files + uses: wandansible/action-j2lint@v1 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..a80639e --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,43 @@ +--- +name: Tests + +on: + pull_request: + branches: + - main + +jobs: + generate-matrix: + name: Generate matrix + runs-on: ubuntu-latest + outputs: + matrix: ${{ steps.generate-matrix.outputs.matrix }} + steps: + - name: Generate matrix + id: generate-matrix + uses: wanduow/action-distro-release-matrix@v1 + + molecule: + name: Molecule + runs-on: ubuntu-latest + needs: generate-matrix + strategy: + matrix: + target: ${{ fromJson(needs.generate-matrix.outputs.matrix) }} + exclude: + - target: "ubuntu:bionic" + steps: + - name: Checkout repo + uses: actions/checkout@v3 + - name: Setup python + uses: actions/setup-python@v4 + with: + python-version: '3.x' + - name: Install dependencies + run: pip3 install -r requirements.txt + - name: Install test dependencies + run: pip3 install -r test-requirements.txt + - name: Run molecule + run: molecule test + env: + MOLECULE_DOCKER_IMAGE: ${{ matrix.target }} diff --git a/molecule/default/Dockerfile.j2 b/molecule/default/Dockerfile.j2 new file mode 100644 index 0000000..6d84a42 --- /dev/null +++ b/molecule/default/Dockerfile.j2 @@ -0,0 +1,20 @@ +{% if item.registry is defined and '/' not in item.image %} +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 export DEBIAN_FRONTEND=noninteractive \ + && apt-get update \ + && apt-get install -y python3 sudo bash ca-certificates iproute2 python3-apt aptitude systemd gnupg \ + && apt-get clean + +CMD ["/lib/systemd/systemd"] diff --git a/molecule/default/converge.yml b/molecule/default/converge.yml new file mode 100644 index 0000000..5f46ded --- /dev/null +++ b/molecule/default/converge.yml @@ -0,0 +1,9 @@ +--- +- name: Converge + hosts: all + tasks: + - name: "Include wandansible.desktop" + ansible.builtin.include_role: + name: "wandansible.desktop" + vars: + desktop_browser_snaps: [] diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml new file mode 100644 index 0000000..d2bfb00 --- /dev/null +++ b/molecule/default/molecule.yml @@ -0,0 +1,18 @@ +--- +dependency: + name: galaxy +driver: + name: docker +platforms: + - name: instance + image: ${MOLECULE_DOCKER_IMAGE:-ubuntu:latest} + pre_build_image: false + override_command: false + privileged: true + volumes: + - /sys/fs/cgroup:/sys/fs/cgroup:ro +provisioner: + name: ansible + log: true +verifier: + name: ansible diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..45c1e03 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +jmespath diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..a0bac02 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,3 @@ +ansible +molecule-docker==2.0.0 +molecule[docker] From 361b160f5877199f2633cde3418325520cacf40c Mon Sep 17 00:00:00 2001 From: Brad Cowie Date: Sat, 1 Oct 2022 16:48:49 +1300 Subject: [PATCH 2/2] Release role. --- LICENSE | 202 ++++++++++++++++++++++++++ README.md | 383 ++++++++++++++++++++++++++++++++++++++++++++++++++ meta/main.yml | 23 +++ 3 files changed, 608 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 meta/main.yml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cc08bc1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2022 The University of Waikato, Hamilton, New Zealand. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..50cbbbc --- /dev/null +++ b/README.md @@ -0,0 +1,383 @@ +Ansible role: Desktop +===================== + +Setup a desktop environment. +Install and configure a desktop environment: install up to +date browsers via snap, install slack and dropbox, configure +printers, manage sudoers to allow desktop owner to run some +commands with sudo, and apply optimisations to make NFS home +mounts work. + +Requirements +------------ + +To use this role, the python package `jmespath` must be installed on the host running ansible. + +Role Variables +-------------- + +``` +ENTRY POINT: main - Setup a desktop environment + + Install and configure a desktop environment: install up to + date browsers via snap, install slack and dropbox, configure + printers, manage sudoers to allow desktop owner to run some + commands with sudo, and apply optimisations to make NFS home + mounts work. + +OPTIONS (= is mandatory): + +- desktop_bind_mounts + Local home filesystem bind mounts to move individual + directories off NFS + [Default: (null)] + elements: dict + type: list + + OPTIONS: + + = dst + Path for bind mount destination + + type: str + + = src + Path for bind mount source + + type: str + +- desktop_browser_snaps + List of browser snap packages to install + [Default: ['firefox', 'chromium', 'chromium-ffmpeg']] + elements: str + type: list + +- desktop_dm + Desktop display manager to install and configure + [Default: (null)] + type: str + +- desktop_dm_configs + Configuration for each display manager + [Default: (null)] + elements: dict + type: list + + OPTIONS: + + = config + Configuration for the display manager + Top-level = name of the section + Second-level = options and their values + + type: dict + + = dm + Display manager + + type: str + +- desktop_dm_paths + List of display managers and their paths + [Default: (null)] + elements: dict + type: list + + OPTIONS: + + = binary + Path to display manager binary + + type: str + + = config_file + Path to display manager configuration + + type: str + + = dm + Display manager + + type: str + +- desktop_dropbox_apt_key_fingerprint + The apt key fingerprint for the dropbox repo + [Default: (null)] + type: str + +- desktop_dropbox_install + If true, install dropbox + [Default: False] + type: bool + +- desktop_env + Desktop environment to install and use. Use 'tasksel --list- + tasks' to get list of possible desktop environments. Defaults + to ubuntu-desktop on Ubuntu and gnome-desktop on Debian. + [Default: (null)] + type: str + +- desktop_env_default_dms + List of desktop environments and their default display + managers + [Default: (null)] + elements: dict + type: list + + OPTIONS: + + = dm + Default display manager + + type: str + + = env + Desktop environment + + type: str + +- desktop_env_sessions + List of desktop environments and their session names + [Default: (null)] + elements: dict + type: list + + OPTIONS: + + = env + Desktop environment + + type: str + + = session + Session name (where name is the name of the session + .desktop file from /usr/share/xsessions/*.desktop) + + type: str + +- desktop_nfs_home + If true, apply NFS home mount optimisations + [Default: False] + type: bool + +- desktop_printer_drivers + List of printer drivers to download and install + [Default: (null)] + elements: dict + type: list + + OPTIONS: + + = checksum + Checksum of the driver + + type: str + + - checksum_type + Type of checksum + [Default: sha256] + type: str + + - extract_file + Path for the file to extract if the driver is compressed + [Default: (null)] + type: str + + - file_extension + File extension added to the driver + [Default: .ppd] + type: str + + = name + Name of the driver + + type: str + + = url + URL for the driver + + type: str + +- desktop_printers + List of printers to configure + [Default: (null)] + elements: dict + type: list + + OPTIONS: + + - auth + Authentication required for printing + [Default: none] + type: str + + - driver + Driver path (use paths from the command 'lpinfo -m') + [Default: everywhere] + type: str + + - model + Additional model name if the driver supports multiple + models + [Default: (null)] + type: str + + = name + Name of the printer + + type: str + + - page_size + Default page size + [Default: A4] + type: str + + = uri + URI for the printer + + type: str + +- desktop_slack_apt_key_fingerprint + The apt key fingerprint for the slack repo + [Default: (null)] + type: str + +- desktop_slack_install + If true, install slack + [Default: False] + type: bool + +- desktop_slack_parameters + Configuration for the slack defaults file + [Default: {'repo_add_once': 'false', + 'repo_reenable_on_distupgrade': 'false'}] + type: dict + +- desktop_tracker_services + List of GNOME File Indexing systemd services to disable when + NFS optimisations are enabled + [Default: (null)] + elements: str + type: list + +- samba_workgroup + The samba workgroup + [Default: WORKPLACE] + type: str + +- snap_packages_install + List of snap packages to install + [Default: (null)] + elements: dict + type: list + + OPTIONS: + + - channel + The release that is installed and tracked for updates + [Default: stable] + type: str + + - classic + If true, put the snap in classic mode and disable security + confinement + [Default: False] + type: bool + + = name + Name of snap package + + type: str + +- sudoers + Configuration for sudoers + [Default: (null)] + elements: dict + type: list + + OPTIONS: + + = contents + Contents for the sudoers file + + type: str + + = file + Name for file in the sudoers.d directory + + type: str +``` + +Installation +------------ + +This role can either be installed manually with the ansible-galaxy CLI tool: + + ansible-galaxy install git+https://github.com/wandansible/desktop,main,wandansible.desktop + +Or, by adding the following to `requirements.yml`: + + - name: wandansible.desktop + src: https://github.com/wandansible/desktop + +Roles listed in `requirements.yml` can be installed with the following ansible-galaxy command: + + ansible-galaxy install -r requirements.yml + +Example Playbook +---------------- + + - hosts: desktops + roles: + - role: wandansible.desktop + become: true + vars: + desktop_owner: example_user + + desktop_env: ubuntu-desktop + + desktop_dm_configs: + - dm: gdm3 + config: + org/gnome/login-screen: + disable-user-list: "true" + - dm: sddm + config: + Users: {} + X11: + SessionLogFile: "" + - dm: lightdm + config: + Seat:*: + allow-guest: "false" + greeter-hide-users: "true" + greeter-show-manual-login: "true" + user-session: "{{ (desktop_env_sessions | selectattr('env', 'equalto', desktop_env) | first).session }}" + + desktop_nfs_home: true + + samba_workgroup: example + + desktop_printers: + - name: follow-me-queue + uri: smb://print.example.org/follow-me + driver: lsb/local/konica_minolta_bizhub_colour_series.ppd + model: C368 + auth: username,password + desktop_printer_drivers: + - name: konica_minolta_bizhub_colour_series + url: https://p.knova.konicaminolta.com/PublicDownload/download?fileId=D637401A-F5F0-46D1-A37D-CECD4A338713 + file_extension: .zip + checksum: d16a4cdce996c6a63376b6a9c4d33280ac0ff3bdbd88a006af88ebd3627accbb + extract_file: IT5PPDLinux_1100010000MU/English/CUPS1.2/KOC759UX.ppd + + sudoers: + - file: cmnd_aliases + contents: | + Cmnd_Alias SOFTWARE = /usr/bin/apt-get, /usr/bin/apt, /usr/bin/snap + Cmnd_Alias SERVICES = /usr/sbin/service, /bin/systemctl + Cmnd_Alias PROCESSES = /usr/bin/renice, /bin/kill, /usr/bin/killall + Cmnd_Alias DOCKER = /usr/bin/docker + - file: owner + contents: | + {{ desktop_owner }} ALL=(root) SOFTWARE, SERVICES, PROCESSES, DOCKER diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..4527d34 --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,23 @@ +--- +galaxy_info: + namespace: wandansible + role_name: desktop + author: WAND Network Research Group + description: Setup a desktop environment + + license: Apache-2.0 + + min_ansible_version: "2.10" + + platforms: + - name: Debian + versions: + - buster + - bullseye + - name: Ubuntu + versions: + - focal + + galaxy_tags: [] + +dependencies: []