From e54a9678ca49bee7aa7164957a14703324a9f61d Mon Sep 17 00:00:00 2001 From: L3D Date: Wed, 1 Sep 2021 11:05:52 +0200 Subject: [PATCH] update docs --- .github/galaxy.svg | 451 +++++++++++++++++++++++++++++++++++++++------ README.md | 45 ++++- meta/main.yml | 2 +- vars/main.yml | 2 +- 4 files changed, 440 insertions(+), 60 deletions(-) diff --git a/.github/galaxy.svg b/.github/galaxy.svg index 7f868c1..42b009b 100644 --- a/.github/galaxy.svg +++ b/.github/galaxy.svg @@ -1,59 +1,398 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - do1jlr.role_name - do1jlr.role_name - diff --git a/README.md b/README.md index f68b052..2babaa0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +[![Galaxy](https://github.com/roles-ansible/ansible_role_rtl_nic_firmware/raw/main/.github/galaxy.svg)](https://galaxy.ansible.com/do1jlr/rtl_nic_firmware) +[![License](https://github.com/roles-ansible/ansible_role_rtl_nic_firmware/raw/main/.github/license.svg)](https://github.com/roles-ansible/ansible_role_rtl_nic_firmware/blob/main/LICENSE) + ansible role rtl_nic_firmware =============================== @@ -10,7 +13,45 @@ when: - 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``. ++ 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. + +Optionally you can perform a simple versionscheck, that can prevent you from running a older version of this role accidentially. + + Variables +----------- +```yaml +--- +# define download url prefix +rtl_nic__download_prefix: 'https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/plain' + +# defined firmware list +rtl_nic__firmware: + - 'rtl_nic/rtl8107e-2.fw' + - 'rtl_nic/rtl8107e-1.fw' + - 'rtl_nic/rtl8168h-2.fw' + - 'rtl_nic/rtl8168h-1.fw' + - 'rtl_nic/rtl8168g-3.fw' + - 'rtl_nic/rtl8168g-2.fw' + - 'rtl_nic/rtl8106e-2.fw' + - 'rtl_nic/rtl8106e-1.fw' + - 'rtl_nic/rtl8411-2.fw' + - 'rtl_nic/rtl8411-1.fw' + - 'rtl_nic/rtl8402-1.fw' + - 'rtl_nic/rtl8168f-2.fw' + - 'rtl_nic/rtl8168f-1.fw' + - 'rtl_nic/rtl8105e-1.fw' + - 'rtl_nic/rtl8168e-3.fw' + - 'rtl_nic/rtl8168e-2.fw' + - 'rtl_nic/rtl8168e-1.fw' + - 'rtl_nic/rtl8168d-2.fw' + - 'rtl_nic/rtl8168d-1.fw' + +rtl_nic__path_prefix: '/lib/firmware' +rtl_nic__path_suffix: 'rtl_nic' + +# should we do a version check? (true is recomended) +submodules_versioncheck: false +``` diff --git a/meta/main.yml b/meta/main.yml index 369802b..d09d0ff 100644 --- a/meta/main.yml +++ b/meta/main.yml @@ -2,7 +2,7 @@ galaxy_info: role_name: rtl_nic_firmware author: do1jlr - description: Ansible role to install some missing ``rtl_nic`` Firmware for APU + description: Ansible role to install some missing rtl_nic Firmware for APU license: "MIT" min_ansible_version: 2.11 github_branch: main diff --git a/vars/main.yml b/vars/main.yml index 3e51fbd..9bdce72 100644 --- a/vars/main.yml +++ b/vars/main.yml @@ -1,4 +1,4 @@ --- # versionscheck -playbook_version_number: 4 +playbook_version_number: 5 playbook_version_path: 'do1jlr.rtl_nic_firmware.version'