Changes after latest comments: wpk upgrade improvements

wazuh · Apr 30, 2024 · 60eb2ee · 60eb2ee
1 parent 1e9d9cf
commit 60eb2ee
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 11 deletions.
diff --git a/...ce/user-manual/agent/agent-management/remote-upgrading/agent-upgrade-module.rst b/...ce/user-manual/agent/agent-management/remote-upgrading/agent-upgrade-module.rst
@@ -48,9 +48,10 @@ The module expects 3 parameters:
     |                 +-------------------+---------------+----------+------------------------------+----------------------------------------------------------------------------------+
     |                 | **use_http**      | true, false   | no       | false                        | Whether retrieve the WPK file over http or https                                 |
     |                 +-------------------+---------------+----------+------------------------------+----------------------------------------------------------------------------------+
-    |                 | **force_upgrade** | true, false   | no       | false                        | Forces the agents to upgrade, ignoring version and package type validations      |
+    |                 | **force_upgrade** | true, false   | no       | false                        | Forces the agents to upgrade, ignoring package type and version validations      |
     |                 +-------------------+---------------+----------+------------------------------+----------------------------------------------------------------------------------+
-    |                 | **package_type**  | string        | no       | Inferred by the manager      | Specify the type of package to use to upgrade the agents (rpm, deb)              |
+    |                 | **package_type**  | string        | no       | Manager-inferred             | Specify the type of package to use to upgrade the agents (rpm, deb),             |
+    |                 |                   |               |          |                              | especially useful for upgrading unrecognized system platforms                    |
     +-----------------+-------------------+---------------+----------+------------------------------+----------------------------------------------------------------------------------+
 
     Example message:

diff --git a/source/user-manual/agent/agent-management/remote-upgrading/custom-repository.rst b/source/user-manual/agent/agent-management/remote-upgrading/custom-repository.rst
@@ -14,10 +14,10 @@ WPK files must be named using the following pattern:
     wazuh_agent_W_X_Y.Z.wpk
 
 Where:
-    - W is the version of the release,
-    - X is the name of the operating system,
-    - Y is the machine's architecture, and
-    - Z is the type of package included in the WPK file.
+    - ``W`` represents the release version.
+    - ``X`` denotes the target operating system.
+    - ``Y`` indicates the machine architecture. Empty for Windows.
+    - ``Z`` represents the package type included in the WPK file. Empty for Windows.
 
 For instance:
 
@@ -52,4 +52,4 @@ Every folder must contain a file named ``versions`` that lists each version repr
     v4.9.0 df5397c8c4a1b29c42726dfa821330fa1bac7058
 
 
-This repository structure is necessary for the manager to check the agent OS, version, architecture, and type of package and look for the correct upgrade package. For example, for an agent installed on Centos 7 x86_64, the manager will look for the latest package in *our_wpk_repo/linux/rpm/x86_64/*.
+The Wazuh manager checks the agent OS, architecture, and package type. This repository structure helps the manager look for the correct upgrade package. For example, for an agent installed on Centos 7 x86_64, the manager looks for the latest package in ``our_wpk_repo/linux/rpm/x86_64/``.
diff --git a/source/user-manual/agent/agent-management/remote-upgrading/wpk-list.rst b/source/user-manual/agent/agent-management/remote-upgrading/wpk-list.rst
@@ -10,33 +10,36 @@ Linux
 
 .. |WPK_Linux_DEB| replace:: `wazuh_agent_v|WAZUH_CURRENT|_linux_amd64.deb.wpk <https://packages.wazuh.com/4.x/wpk/linux/deb/amd64/wazuh_agent_v|WAZUH_CURRENT|_linux_amd64.deb.wpk>`__ (`sha512 <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR|/checksums/wazuh/|WAZUH_CURRENT|/wazuh_agent_v|WAZUH_CURRENT|_linux_amd64.deb.wpk.sha512>`__)
 .. |WPK_Linux_RPM| replace:: `wazuh_agent_v|WAZUH_CURRENT|_linux_x86_64.rpm.wpk <https://packages.wazuh.com/4.x/wpk/linux/rpm/x86_64/wazuh_agent_v|WAZUH_CURRENT|_linux_x86_64.rpm.wpk>`__ (`sha512 <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR|/checksums/wazuh/|WAZUH_CURRENT|/wazuh_agent_v|WAZUH_CURRENT|_linux_x86_64.rpm.wpk.sha512>`__)
+.. |WAZUH_CUR_VER| replace:: |WAZUH_CURRENT|
 
 +--------------+-----------------+--------------+-------------------------------+
 | Distribution | Version         | Architecture | WPK Package                   |
 +==============+=================+==============+===============================+
-|  Linux (deb) | |WAZUH_CURRENT|           |    64bit     | |WPK_Linux_DEB|               |
+|  Linux (deb) | |WAZUH_CUR_VER| |    64bit     | |WPK_Linux_DEB|               |
 +--------------+-----------------+--------------+-------------------------------+
-|  Linux (rpm) | |WAZUH_CURRENT|           |    64bit     | |WPK_Linux_RPM|               |
+|  Linux (rpm) | |WAZUH_CUR_VER| |    64bit     | |WPK_Linux_RPM|               |
 +--------------+-----------------+--------------+-------------------------------+
 
 Windows
 -------
 
 .. |WPK_Windows| replace:: `wazuh_agent_v|WAZUH_CURRENT_WINDOWS|_windows.wpk <https://packages.wazuh.com/4.x/wpk/windows/wazuh_agent_v|WAZUH_CURRENT_WINDOWS|_windows.wpk>`__ (`sha512 <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR_WINDOWS|/checksums/wazuh/|WAZUH_CURRENT_WINDOWS|/wazuh_agent_v|WAZUH_CURRENT_WINDOWS|_windows.wpk.sha512>`__)
+.. |WAZUH_CUR_WIN| replace:: |WAZUH_CURRENT_WINDOWS|
 
 +--------------+-------------------------+--------------+------------------------------------------------------+
 | Distribution | Version                 | Architecture | WPK Package                                          |
 +==============+=========================+==============+======================================================+
-|   Windows    | |WAZUH_CURRENT_WINDOWS|                   |   32/64bit   | |WPK_Windows|                                        |
+|   Windows    | |WAZUH_CUR_WIN|         |   32/64bit   | |WPK_Windows|                                        |
 +--------------+-------------------------+--------------+------------------------------------------------------+
 
 macOS
 -----
 
 .. |WPK_macOS| replace:: `wazuh_agent_v|WAZUH_CURRENT_OSX|_macos_intel64.pkg.wpk <https://packages.wazuh.com/4.x/wpk/macos/pkg/intel64/wazuh_agent_v|WAZUH_CURRENT_OSX|_macos_intel64.pkg.wpk>`__ (`sha512 <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR_OSX|/checksums/wazuh/|WAZUH_CURRENT_OSX|/wazuh_agent_v|WAZUH_CURRENT_OSX|_macos_intel64.pkg.wpk.sha512>`__)
+.. |WAZUH_CUR_OSX| replace:: |WAZUH_CURRENT_OSX|
 
 +--------------+---------------------+--------------+---------------------------------------------+
 | Distribution | Version             | Architecture | WPK Package                                 |
 +==============+=====================+==============+=============================================+
-|    macOS     | |WAZUH_CURRENT_OSX|               |    64bit     | |WPK_macOS|                                 |
+|    macOS     | |WAZUH_CUR_OSX|     |    64bit     | |WPK_macOS|                                 |
 +--------------+---------------------+--------------+---------------------------------------------+