add first draw of lab 1

friendlypenguin · friendlypenguin · commit 957ea21db2f5 · 2025-03-04T11:43:25.000+01:00
diff --git a/content/en/docs/12/01/_index.en.md b/content/en/docs/12/01/_index.en.md
@@ -4,294 +4,42 @@ weight: 121
 sectionnumber: 12
 ---
 
-In this lab we are going to learn how to use Event Driven Ansible.
-For the following tasks, server `node1` and `node2` act as webservers. You can use Lab 4.0 as a guideline.
+In this lab we are going to learn how Ansible uses modules and where to find information about developing a custom module.
 
 ### Task 1
 
-* Point your webbrowser to the official documentation of `ansible-rulebook`.
-* Install and configure everything needed to run ansible-rulebook and source plugins.
-* Check the version of `ansible-rulebook`
+* In which language has a module to be written?
+* Point your webbrowser to the official documentation about developing modules.
+* Point your webbrowser to the official documentation about developing modules best practices.
+* Point your webbrowser to the official documentation about developing collections.
+* Point your webbrowser to the official documentation about debugging your module.
+* Which environment variable lets you keep the remote module files after executing the module (instead of deleting it)?
 
 {{% details title="Solution Task 1" %}}
 
-[https://ansible-rulebook.readthedocs.io/en/stable/index.html](https://ansible-rulebook.readthedocs.io/en/stable/index.html)
+* either Pyhon (Linux) or Powershell (Windows)
+* [https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html](https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html)
+* [https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_best_practices.html#developing-modules-best-practices](https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_best_practices.html#developing-modules-best-practices)
+* [https://docs.ansible.com/ansible/latest/dev_guide/developing_collections.html#developing-collections](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections.html#developing-collections)
+* [https://docs.ansible.com/ansible/latest/dev_guide/debugging.html#debugging-modules](https://docs.ansible.com/ansible/latest/dev_guide/debugging.html#debugging-modules)
+* `ANSIBLE_KEEP_REMOTE_FILES`
 
-Fedora 36+:
-```bash
-sudo dnf --assumeyes install java-17-openjdk python3-pip
-export JAVA_HOME=/usr/lib/jvm/jre-17-openjdk
-pip install ansible ansible-rulebook
-ansible-galaxy collection install ansible.eda
-```
-
-Enterprise Linux 9:
-```bash
-sudo dnf install java-17-openjdk
-export JAVA_HOME=/usr/lib/jvm/jre-17-openjdk
-sudo dnf install python3-pip
-python3 -m venv ~/python
-. ~/python/bin/activate
-pip install --upgrade pip
-pip install ansible ansible-rulebook
-
-ansible-galaxy collection install ansible.eda
-
-sudo dnf install systemd-devel gcc python3-devel
-
-pip install -r  ~/.ansible/collections/ansible_collections/ansible/eda/requirements.txt
-```
-
-```bash
-ansible-rulebook --version
-```
-Output on EL9:
-```bash
-version__ = '1.0.0'
-Executable location = /home/ansible/python/bin/ansible-rulebook
-Drools_jpy version = 0.3.4
-Java home = /usr/lib/jvm/java-17-openjdk-17.0.7.0.7-3.el9.x86_64
-Java version = 17.0.7
-Python version = 3.9.16 (main, Dec  8 2022, 00:00:00) [GCC 11.3.1 20221121 (Red Hat 11.3.1-4)]
-```
 {{% /details %}}
 
 ### Task 2
 
-* Write a playbook `webserver.yml` that installs the servers in group `web` as webservers. See Lab 4.0 for guidelines.
-* Ensure that the playbook also sets a webpage at `/var/www/html/index.html`.
-* Ensure that the inventory file `hosts` in the folder inventory has the group `web` with `node1` and `node2` as members.
-* Run the playbook `webserver.yml` and check that the webservers are up and running.
+* for possible content of the `my_module.py` file, see the [official documentation](https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html#creating-a-module) 
+* 
 
 {{% details title="Solution Task 2" %}}
 
 ```bash
-cat webserver.yml
-```
-```bash
----
-- hosts: web
-  become: true
-  tasks:
-    - name: install httpd
-      ansible.builtin.dnf:
-        name:
-          - httpd
-          - firewalld
-        state: installed
-    - name: start and enable httpd
-      ansible.builtin.systemd_service:
-        name: httpd
-        state: started
-        enabled: true
-    - name: put default webpage
-      ansible.builtin.copy:
-        content: "Ansible Labs by Puzzle ITC"
-        dest: /var/www/html/index.html
-        owner: root
-        group: root
-        mode: "0644"
-    - name: start and enable firewalld
-      ansible.builtin.systemd_service:
-        name: firewalld
-        state: started
-        enabled: true
-    - name: open firewall for http
-      ansible.posix.firewalld:
-        service: http
-        state: enabled
-        permanent: true
-        immediate: true
-```
-```bash
-cat inventory/hosts
-```
-```bash
-[controller]
-control0 ansible_host=<ip-of-control0>
-
-[web]
-node1 ansible_host=<ip-of-node1>
-node2 ansible_host=<ip-of-node2>
-```
-```bash
-ansible-playbook -i inventory/hosts webserver.yml
-sudo dnf install -y lynx
-lynx http://<ip-of-node1>
-lynx http://<ip-of-node2>
-```
-{{% /details %}}
-
-### Task 3
-
-* Write a rulebook `webserver_rulebook.yml` that checks if the webpages on `node1` and `node2` are up and running.
-* If the webpages are not available anymore, the `webserver.yml` playbook should be re-run.
-* Use `url_check` from the `ansible.eda` collection as the source plugin in your rulebook.
-* Check the availability of the websites every 8 seconds.
-
-{{% alert title="Note" color="primary" %}}
-If you don't have the `ansible.eda` collection installed yet,
-`ansible-rulebook` would start, but fail because the `url_check` source plugin cannot be found.
-{{% /alert %}}
-
-{{% details title="Solution Task 3" %}}
-```bash
-cat webserver_rulebook.yml
-```
-```bash
----
-- name: rebuild webservers if site down
-  hosts: web
-  sources:
-    - name: check webserver
-      ansible.eda.url_check:
-        urls:
-          - http://<ip-of-node1>:80/
-          - http://<ip-of-node2>:80/
-        delay: 8
-  rules:
-    - name: check if site down and rebuild
-      condition: event.url_check.status == "down"
-      action:
-        run_playbook:
-          name: webserver.yml
-```
-{{% /details %}}
-
-### Task 4
-
-* Start `webserver_rulebook.yml` in verbose mode.
-* Stop the httpd service on `node1` with ansible from another terminal on `control0`
-and see how the playbook `webserver.yml` is re-run.
-(You could also just stop the service directly on `node1`.)
-
-{{% details title="Solution Task 4" %}}
-```bash
-ansible-rulebook --rulebook webserver_rulebook.yml -i inventory/hosts --verbose
-
-ansible node1 -i inventory/hosts -b -m ansible.builtin.systemd_service -a "name=httpd state=stopped"
-```
-{{% /details %}}
-
-
-### Task 5
-
-* Write the rulebook `webhook_rulebook.yml` that opens a webhook on port 5000 of the control node `control0`.
-* The rulebook should re-run the playbook `webserver.yml`
-if the webhook receives a message matching exactly the string "webservers down".
-* Use `webhook` from the `ansible.eda` collection as the source plugin in your rulebook.
-
-{{% details title="Solution Task 5" %}}
-```bash
-cat webhook_rulebook.yml 
-```
-```yaml
----
-- name: rebuild webserver if webhook receives message that matches rule condition
-  hosts: web
-  sources:
-    - name: start webhook and listen for messages
-      ansible.eda.webhook:
-        host: 0.0.0.0
-        port: 5000
-  rules:
-    - name: rebuild webserver if monitoring tool sends alert
-      condition: event.payload.message == "webservers down"
-      action:
-        run_playbook:
-          name: webserver.yml
-```
-{{% /details %}}
-
-### Task 6
-
-* Run the rulebook `webhook_rulebook.yml` in verbose mode.
-* Send the string "webservers running" to the webhook.
-* You can do this by issuing:
-`curl -H 'Content-Type: application/json' -d "{\"message\": \"webservers running\"}" 127.0.0.1:5000/endpoint`
-* See how the message is received, processed, but no actions are taken since the message doesn't match the condition defined.
-* Now send the message "webservers down" to the webhook. See how the playbook `webserver.yml` is run.
-
-{{% details title="Solution Task 6" %}}
-```bash
-ansible-rulebook --rulebook webhook_rulebook.yml -i inventory/hosts --verbose
-```
-```bash
-curl -H 'Content-Type: application/json' -d "{\"message\": \"webservers running\"}" 127.0.0.1:5000/endpoint
-```
-```bash
-curl -H 'Content-Type: application/json' -d "{\"message\": \"webservers down\"}" 127.0.0.1:5000/endpoint
+$ mkdir /home/ansible/techlab/library/
+$ touch /home/ansible/techlab/library/my_module.py
 ```
 {{% /details %}}
 
-### Task 7
-
-* Write the rulebook `complex_rulebook.yml`. It has to meet the following requirements:
-* It should check for three things:
-  * check if the website on one of the two webservers is down. (Same as Task 3 above)
-  * check if the message matches exactly the string "webservers down" (Same as Task 5 above)
-  * check if the message contains the string "ERROR" or "error"
-* If one of the criteria above are met, do two things:
-  1. run the ansible shell module to print the string "WEBSERVER ISSUES, REMEDIATION IN PROGRESS."
-  into the journald log. (Use the command `systemd-cat echo "WEBSERVER ISSUES, REMEDIATION IN PROGRESS."`)
-  2. run playbook `webservers.yml`
-* Start the rulebook `complex_rulebook.yml` and send the message "webservers down" to the webhook again.
-
-{{% details title="Solution Task 7" %}}
-
-```bash
-cat complex_rulebook.yml
-```
-```bash
----
-- name: rebuild webserver if webhook receives message that matches rule condition
-  hosts: web
-  sources:
-    - name: check webserver
-      ansible.eda.url_check:
-        urls:
-          - http://<ip-of-node1>:80/
-          - http://<ip-of-node2>:80/
-        delay: 8
-    - name: start webhook and listen for messages
-      ansible.eda.webhook:
-        host: 0.0.0.0
-        port: 5000
-  rules:
-    - name: rebuild webserver if any source reports an alert
-      condition:
-        any:
-          - event.url_check.status == "down"
-          - event.payload.message == "webservers down"
-          - event.payload.message is search("ERROR",ignorecase=true)
-      actions:
-        - run_module:
-            name: ansible.builtin.shell
-            module_args:
-              cmd: "systemd-cat echo \"WEBSERVER ISSUES, REMEDIATION IN PROGRESS.\""
-        - run_playbook:
-            name: webserver.yml
-```
-
-```bash
-ansible-rulebook --rulebook complex_rulebook.yml -i inventory/hosts --verbose
-```
-```bash
-curl -H 'Content-Type: application/json' -d "{\"message\": \"webservers down\"}" 127.0.0.1:5000/endpoint
-```
-Note, that you would have to open port 5000 on the firewall if the curl command is not sent from the controller itself.
-{{% /details %}}
-
-### Task 8
-
-* What source plugins are available in the `ansible.eda` collection?
-[Search the content of event-driven-ansible on GitHub.com](https://github.com/ansible/event-driven-ansible).
-
-{{% details title="Solution Task 8" %}}
-[Event Driven Ansible on GitHub](https://github.com/ansible/event-driven-ansible/tree/main/extensions/eda/plugins/event_source)
-{{% /details %}}
-
 ### All done?
 
-* [Ansible-rulebook documentation](https://ansible-rulebook.readthedocs.io/en/stable/)
-* [AnsibleAutomates YouTube channel for more examples](https://www.youtube.com/@AnsibleAutomation/videos)
+* [Ansible module development on YouTube](https://www.youtube.com/results?search_query=ansible+module+development)
+* Have a look at the [Puzzle OPNsense Ansible Collection](https://github.com/puzzle/puzzle.opnsense)
