added my previous netplan role code

README.md

@@ -1,92 +1,38 @@
-# manage_netplan
+Role Name
+=========
 
+A brief description of the role goes here.
 
+Requirements
+------------
 
-## Getting started
+Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+Role Variables
+--------------
 
-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)!
+A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
 
-## Add your files
+Dependencies
+------------
 
-- [ ] [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:
+A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
 
-```
-cd existing_repo
-git remote add origin https://gitlab.ednz.fr/homelab/ansible-resources/roles/manage_netplan.git
-git branch -M main
-git push -uf origin main
-```
+Example Playbook
+----------------
 
-## Integrate with your tools
+Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
 
-- [ ] [Set up project integrations](https://gitlab.ednz.fr/homelab/ansible-resources/roles/manage_netplan/-/settings/integrations)
+    - hosts: servers
+      roles:
+         - { role: username.rolename, x: 42 }
 
-## Collaborate with your team
+License
+-------
 
-- [ ] [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)
+BSD
 
-## Test and Deploy
+Author Information
+------------------
 
-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.
-
-## 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.
-
-## Name
-Choose a self-explaining name for your project.
-
-## 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.
-
-## 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.
-
-## 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.
-
-## 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.
-
-## 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.
-
-## 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.
-
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
-
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
-
-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.
-
-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.
-
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
-
-## License
-For open source projects, say how it is licensed.
-
-## 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.
+An optional section for the role authors to include contact information, or a website (HTML is not allowed).

defaults/main.yml

@@ -0,0 +1,78 @@
+---
+# defaults file for manage_netplan
+manage_netplan_config_file: /etc/netplan/ansible-config.yaml # this MUST be .yaml, .yml will not be picked up by netplan
+manage_netplan_renderer: networkd # supported value is 'NetworkManager' or 'networkd'
+manage_netplan_remove_existing: false
+manage_netplan_packages:
+  - netplan.io
+manage_netplan_search_domain: example.org
+manage_netplan_check_install: true
+manage_netplan_apply: true
+manage_netplan_configuration:
+  {}
+  # network:
+  #   version: 2
+  #   ethernets:
+  #     enp0s3:
+  #       dhcp4: true
+  #     enp0s8:
+  #       addresses:
+  #         - 192.168.250.10/24
+  #         - 192.168.250.11/24
+  #       nameservers:
+  #         addresses:
+  #           - 10.0.2.3
+  #           - 8.8.8.8
+  #           - 8.8.4.4
+  #         search:
+  #           # Custom variable
+  #           - "{{ manage_netplan_search_domain }}"
+  #       gateway4: 192.168.250.1
+  #       optional: true
+  #       routes:
+  #         - to: 0.0.0.0/0
+  #           via: 9.9.9.9
+  #           on-link: true
+  #         - to: 192.168.5.0/24
+  #           via: 192.168.5.1
+  #           table: 102
+  #       routing-policy:
+  #         - from: 192.168.5.0/24
+  #           table: 102
+  #     lo:
+  #       match:
+  #         name: lo
+  #       addresses: [7.7.7.7/32]
+  #   wifis:
+  #     wlp2s0b1:
+  #       dhcp4: no
+  #       dhcp6: no
+  #       addresses: [192.168.0.21/24]
+  #       gateway4: 192.168.0.1
+  #       access-points:
+  #         "network_ssid_name":
+  #           password: "**********"
+  #   bonds:
+  #     bond0:
+  #       dhcp4: yes
+  #       interfaces:
+  #         - enp0s3
+  #         - enp4s0
+  #       parameters:
+  #         # modes can be one of balance-rr, active-backup, balance-xor, broadcast,
+  #         # 802.3ad, balance-tlb, and balance-alb.
+  #         mode: active-backup
+  #         primary: enp0s3
+  #   bridges:
+  #     br0:
+  #       dhcp4: yes
+  #       interfaces:
+  #         - enp0s3
+  #     br0:
+  #       addresses: [10.3.99.25/24]
+  #       interfaces: [vlan15]
+  #   vlans:
+  #     vlan15:
+  #       accept-ra: no
+  #       id: 15
+  #       link: enp0s25

handlers/main.yml

@@ -0,0 +1,12 @@
+---
+# handlers file for manage_netplan
+- name: "Generate netplan configuration"
+  ansible.builtin.command: netplan generate
+  listen: "netplan-generate"
+  notify:
+    - "netplan-apply"
+
+- name: "Apply netplan configuration"
+  ansible.builtin.command: netplan apply
+  listen: "netplan-apply"
+  when: manage_netplan_apply

meta/main.yml

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

molecule/default/converge.yml

@@ -0,0 +1,7 @@
+---
+- name: Converge
+  hosts: all
+  tasks:
+    - name: "Include ednxzu.manage_netplan"
+      include_role:
+        name: "ednxzu.manage_netplan"

molecule/default/molecule.yml

@@ -0,0 +1,13 @@
+---
+dependency:
+  name: galaxy
+driver:
+  name: docker
+platforms:
+  - name: instance
+    image: quay.io/centos/centos:stream8
+    pre_build_image: true
+provisioner:
+  name: ansible
+verifier:
+  name: testinfra

molecule/default/tests/conftest.py

@@ -0,0 +1,22 @@
+"""PyTest Fixtures."""
+from __future__ import absolute_import
+
+import os
+
+import pytest
+
+
+def pytest_runtest_setup(item):
+    """Run tests only when under molecule with testinfra installed."""
+    try:
+        import testinfra
+    except ImportError:
+        pytest.skip("Test requires testinfra", allow_module_level=True)
+    if "MOLECULE_INVENTORY_FILE" in os.environ:
+        pytest.testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
+            os.environ["MOLECULE_INVENTORY_FILE"]
+        ).get_hosts("all")
+    else:
+        pytest.skip(
+            "Test should run only from inside molecule.", allow_module_level=True
+        )

molecule/default/tests/test_default.py

@@ -0,0 +1,10 @@
+"""Role testing files using testinfra."""
+
+
+def test_hosts_file(host):
+    """Validate /etc/hosts file."""
+    f = host.file("/etc/hosts")
+
+    assert f.exists
+    assert f.user == "root"
+    assert f.group == "root"

tasks/configure.yml

@@ -0,0 +1,13 @@
+---
+# task/configure file for manage_netplan
+- name: "Configuring Netplan"
+  ansible.builtin.template:
+    src: etc_netplan.yaml.j2
+    dest: "{{ manage_netplan_config_file }}"
+    mode: '0644'
+    owner: root
+    group: root
+    backup: true
+  when: manage_netplan_configuration != []
+  notify:
+    - "Generate netplan configuration"

tasks/install.yml

@@ -0,0 +1,14 @@
+---
+# task/install_packages file for manage_netplan
+- name: "Install netplan:latest"
+  ansible.builtin.include_role:
+    name: ednxzu.manage_apt_packages
+  vars:
+    manage_apt_packages_list: "{{ manage_netplan_packages }}"
+
+- name: "Install network-manager:latest when used as renderer"
+  ansible.builtin.include_role:
+    name: ednxzu.manage_apt_packages
+  vars:
+    manage_apt_packages_list: "{{ manage_netplan_networkmanager_pkg }}"
+  when: manage_netplan_renderer == 'NetworkManager'

tasks/main.yml

@@ -0,0 +1,15 @@
+---
+# task/main file for manage_netplan
+- name: "Import prerequisites.yml"
+  ansible.builtin.include_tasks: prerequisites.yml
+
+- name: "Import install.yml"
+  ansible.builtin.include_tasks: install.yml
+  when: manage_netplan_check_install
+
+- name: "Import remove_existing.yml"
+  ansible.builtin.include_tasks: remove_existing.yml
+  when: manage_netplan_remove_existing
+
+- name: "Import configure.yml"
+  ansible.builtin.include_tasks: configure.yml

tasks/prerequisites.yml

@@ -0,0 +1,9 @@
+---
+# task/prerequisites file for manage_netplan
+- name: "Install required roles"
+  ansible.builtin.command:
+    cmd: "ansible-galaxy install {{ item }}"
+  loop: "{{ manage_netplan_prerequisites_roles }}"
+  changed_when: false
+  delegate_to: localhost
+  run_once: true

tasks/remove_existing.yml

@@ -0,0 +1,15 @@
+---
+# task/remove_existing file for manage_netplan
+- name: "Capturing existing configurations"
+  ansible.builtin.find:
+    paths: /etc/netplan
+    patterns: "*.yml,*.yaml"
+  register: _netplan_configs
+
+- name: "Removing existing configurations"
+  ansible.builtin.file:
+    path: "{{ item['path'] }}"
+    state: absent
+  loop: "{{ _netplan_configs['files'] }}"
+  when: item['path'] != manage_netplan_config_file
+    and manage_netplan_configuration != []

templates/etc_netplan.yaml.j2

@@ -0,0 +1,31 @@
+---
+# {{ ansible_managed }}
+network:
+  version: {{ manage_netplan_configuration['network']['version']|default('2') }}
+{% if manage_netplan_renderer is not none %}
+  renderer: {{ manage_netplan_renderer }}
+{% endif %}
+{% if manage_netplan_configuration['network']['ethernets'] is defined %}
+  ethernets:
+{{ manage_netplan_configuration['network']['ethernets']|to_nice_yaml|indent(4, true) }}
+{% endif %}
+{% if manage_netplan_configuration['network']['wifis'] is defined %}
+  wifis:
+{{ manage_netplan_configuration['network']['wifis']|to_nice_yaml|indent(4, true) }}
+{% endif %}
+{% if manage_netplan_configuration['network']['bonds'] is defined %}
+  bonds:
+{{ manage_netplan_configuration['network']['bonds']|to_nice_yaml|indent(4, true) }}
+{% endif %}
+{% if manage_netplan_configuration['network']['bridges'] is defined %}
+  bridges:
+{{ manage_netplan_configuration['network']['bridges']|to_nice_yaml|indent(4, true) }}
+{% endif %}
+{% if manage_netplan_configuration['network']['vlans'] is defined %}
+  vlans:
+{{ manage_netplan_configuration['network']['vlans']|to_nice_yaml|indent(4, true) }}
+{% endif %}
+{% if manage_netplan_configuration['network']['tunnels'] is defined %}
+  tunnels:
+{{ manage_netplan_configuration['network']['tunnels']|to_nice_yaml|indent(4, true) }}
+{% endif %}

vars/main.yml

@@ -0,0 +1,12 @@
+---
+# vars file for manage_netplan
+manage_netplan_prerequisites_roles:
+  - ednxzu.manage_apt_packages
+manage_netplan_packages:
+  - name: netplan.io
+    version: latest
+    state: present
+manage_netplan_networkmanager_pkg:
+  - name: network
+    version: latest
+    state: present