feat: fill bmc_fw_update role

Signed-off-by: Boris Glimcher <[email protected]>

CHANGELOG.rst

@@ -0,0 +1,13 @@
+=====================================
+OPI DPU Ansible Modules Release Notes
+=====================================
+
+.. contents:: Topics
+
+v1.0.0
+======
+
+New Roles
+---------
+
+- opi.dpu.bmc_fw_update - Firmware update of DPU BMC

changelogs/.plugin-cache.yaml

@@ -0,0 +1,23 @@
+objects:
+  role:
+    bmc_fw_update:
+      description: Firmware update of DPU BMC
+      name: bmc_fw_update
+      version_added: 1.0.0
+plugins:
+  become: {}
+  cache: {}
+  callback: {}
+  cliconf: {}
+  connection: {}
+  filter: {}
+  httpapi: {}
+  inventory: {}
+  lookup: {}
+  module: {}
+  netconf: {}
+  shell: {}
+  strategy: {}
+  test: {}
+  vars: {}
+version: 1.0.0

changelogs/changelog.yaml

@@ -0,0 +1,9 @@
+ancestor: null
+releases:
+  1.0.0:
+    objects:
+      role:
+      - description: Firmware update of DPU BMC
+        name: bmc_fw_update
+        namespace: null
+    release_date: '2024-02-20'

changelogs/config.yaml

@@ -0,0 +1,31 @@
+changelog_filename_template: ../CHANGELOG.rst
+changelog_filename_version_depth: 0
+changes_file: changelog.yaml
+changes_format: combined
+ignore_other_fragment_extensions: true
+keep_fragments: false
+mention_ancestor: true
+new_plugins_after_name: removed_features
+notesdir: fragments
+prelude_section_name: release_summary
+prelude_section_title: Release Summary
+sections:
+  - - major_changes
+    - Major Changes
+  - - minor_changes
+    - Minor Changes
+  - - breaking_changes
+    - Breaking Changes / Porting Guide
+  - - deprecated_features
+    - Deprecated Features
+  - - removed_features
+    - Removed Features (previously deprecated)
+  - - security_fixes
+    - Security Fixes
+  - - bugfixes
+    - Bugfixes
+  - - known_issues
+    - Known Issues
+title: OPI DPU Ansible Modules
+trivial_section_name: trivial
+use_fqcn: true

docs/bmc_fw_update_role.rst

@@ -0,0 +1,202 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+    :trim:
+
+.. meta::
+  :antsibull-docs: 2.7.0
+
+.. Anchors
+
+.. _ansible_collections.opi.dpu.bmc_fw_update_role:
+
+.. Title
+
+opi.dpu.bmc_fw_update role -- Firmware update of DPU BMC
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+    This role is part of the `opi.dpu collection <https://galaxy.ansible.com/ui/repo/published/opi/dpu/>`_ (version 1.0.0).
+
+    It is not included in ``ansible-core``.
+    To check whether it is installed, run :code:`ansible-galaxy collection list`.
+
+    To install it use: :code:`ansible-galaxy collection install opi.dpu`.
+
+    To use it in a playbook, specify: :code:`opi.dpu.bmc_fw_update`.
+
+.. contents::
+   :local:
+   :depth: 2
+
+
+.. Entry point title
+
+Entry point ``main`` -- Firmware update of DPU BMC
+--------------------------------------------------
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in opi.dpu 1.0.0
+
+.. Deprecated
+
+
+Synopsis
+^^^^^^^^
+
+.. Description
+
+- Update the Firmware of the DPU BMC from URL or local file.
+
+.. Requirements
+
+
+.. Options
+
+Parameters
+^^^^^^^^^^
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+  :width: 100%
+  :widths: auto
+  :header-rows: 1
+  :class: longtable ansible-option-table
+
+  * - Parameter
+    - Comments
+
+  * - .. raw:: html
+
+        <div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-main--bmc_fw_update_job_wait"></div>
+
+      .. _ansible_collections.opi.dpu.bmc_fw_update_role__parameter-main__bmc_fw_update_job_wait:
+
+      .. rst-class:: ansible-option-title
+
+      **bmc_fw_update_job_wait**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-main--bmc_fw_update_job_wait" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`boolean`
+
+
+
+
+      .. raw:: html
+
+        </div>
+
+    - .. raw:: html
+
+        <div class="ansible-option-cell">
+
+      Whether to wait for job completion or not.
+
+
+      .. rst-class:: ansible-option-line
+
+      :ansible-option-choices:`Choices:`
+
+      - :ansible-option-choices-entry:`false`
+      - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-main--bmc_fw_update_reboot"></div>
+
+      .. _ansible_collections.opi.dpu.bmc_fw_update_role__parameter-main__bmc_fw_update_reboot:
+
+      .. rst-class:: ansible-option-title
+
+      **bmc_fw_update_reboot**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-main--bmc_fw_update_reboot" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`boolean`
+
+
+
+
+      .. raw:: html
+
+        </div>
+
+    - .. raw:: html
+
+        <div class="ansible-option-cell">
+
+      Provides the option to apply the update packages immediately or in the next reboot.
+
+      If \ :emphasis:`reboot`\  is set to \ :literal:`true`\ ,  then the packages  are applied immediately.
+
+      If \ :emphasis:`reboot`\  is set to \ :literal:`false`\ , then the packages are staged and applied in the next reboot.
+
+      Packages that do not require a reboot are applied immediately irrespective of I (reboot).
+
+
+      .. rst-class:: ansible-option-line
+
+      :ansible-option-choices:`Choices:`
+
+      - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
+      - :ansible-option-choices-entry:`true`
+
+
+      .. raw:: html
+
+        </div>
+
+
+.. Attributes
+
+
+.. Notes
+
+
+.. Seealso
+
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+  - title: "Issue Tracker"
+    url: "https://github.com/opiproject/ansible-opi-dpu/issues"
+    external: true
+  - title: "Repository (Sources)"
+    url: "https://github.com/opiproject/ansible-opi-dpu"
+    external: true
+
+
+.. Parsing errors
+

docs/index.rst

@@ -26,7 +26,7 @@ Ansible modules for DPUs
 
 **Supported ansible-core versions:**
 
-* 2.9.10 or newer
+* 2.14.0 or newer
 
 .. ansible-links::
 
@@ -50,3 +50,16 @@ Plugin Index
 There are no plugins in the opi.dpu collection with automatically generated documentation.
 
 
+Role Index
+----------
+
+These are the roles in the opi.dpu collection:
+
+* :ansplugin:`bmc_fw_update role <opi.dpu.bmc_fw_update#role>` -- Firmware update of DPU BMC
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    bmc_fw_update_role
+

playbooks/firmware.yml

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) 2022-2024 Dell Inc, or its subsidiaries.
+
+- name: Update DPU Firmware
+  hosts: all
+  gather_facts: false
+  roles:
+    - bmc_fw_update

roles/bmc_fw_update/defaults/main.yml

@@ -1,2 +1,8 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) 2022-2024 Dell Inc, or its subsidiaries.
+
 ---
 # defaults file for bmc_fw_update
+
+bmc_fw_update_reboot: true
+bmc_fw_update_job_wait: true

roles/bmc_fw_update/meta/argument_specs.yml

@@ -0,0 +1,22 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) 2022-2024 Dell Inc, or its subsidiaries.
+---
+argument_specs:
+  main:
+    version_added: "1.0.0"
+    short_description: Firmware update of DPU BMC
+    description:
+      - Update the Firmware of the DPU BMC from URL or local file.
+    options:
+      bmc_fw_update_reboot:
+        description:
+          - Provides the option to apply the update packages immediately or in the next reboot.
+          - If I(reboot) is set to C(true),  then the packages  are applied immediately.
+          - If I(reboot) is set to C(false), then the packages are staged and applied in the next reboot.
+          - Packages that do not require a reboot are applied immediately irrespective of I (reboot).
+        type: bool
+        default: false
+      bmc_fw_update_job_wait:
+        description: Whether to wait for job completion or not.
+        type: bool
+        default: true