improve running and docs

README.md

@@ -1,2 +1,16 @@
-# ansible_role_template
+ ansible role rtl_nic_firmware
-Template for Ansible roles
+===============================
+
+Ansible role to deploy ``rtl_nic`` Firmware for APU.
+
+This role is only running at:
+```yaml
+when:
+  - ansible_board_name == 'APU'
+  - ansible_product_name == 'APU'
+```
+
+It will download the defined Firmware Files from the ``rtl_nic__firmware`` variable.
+Then we run ``update-initramfs -k all -u``.
+
+You can change the downloaded firmware file names by modifying the default variables.

defaults/main.yml

@@ -24,7 +24,8 @@ rtl_nic__firmware:
   - 'rtl_nic/rtl8168d-2.fw'
   - 'rtl_nic/rtl8168d-1.fw'
 
-rtl_nic__path: '/lib/firmware'
+rtl_nic__path_prefix: '/lib/firmware'
+rtl_nic__path_suffix: 'rtl_nic'
 
 # should we do a version check? (recomended)
 submodules_versioncheck: false

tasks/kernel_firmware_download.yml

@@ -1,9 +1,19 @@
 ---
+- name: "create {{ rtl_nic__path_prefix }}/{{ rtl_nic__path_suffix }}"
+  become: true
+  ansible.builtin.file:
+    path: "{{ rtl_nic__path_prefix }}/{{ item }}"
+    state: directory
+    mode: 0755
+    owner: root
+    group: root
+  with_items: "{{ rtl_nic__path_suffix }}"
+
 - name: download rtl_nic firmware
   become: true
   ansible.builtin.get_url:
     url: "{{ rtl_nic__download_prefix }}/{{ item }}"
-    dest: "{{ rtl_nic__path }}/{{ item }}"
+    dest: "{{ rtl_nic__path_prefix }}/{{ item }}"
     owner: root
     group: root
     mode: 0644

vars/main.yml

@@ -1,4 +1,4 @@
 ---
 # versionscheck
-playbook_version_number: 3
+playbook_version_number: 4
 playbook_version_path: 'do1jlr.rtl_nic_firmware.version'