Agent remote upgrade documentation makes no sense at all

[ilsaloving]

https://github.com/wazuh/wazuh-documentation/blob/4.7/source/user-manual/agent/agent-management/remote-upgrading/agent-upgrade-module.rst

doesn't make any sense. It appears to be some kind of API reference rather than actual instructions.

Are we supposed to execute a particular command? Are we supposed to echo json data into the socket? What are the REST API targets?

It says API/CLI but it provides neither API endpoints nor CLI details.

[davidcr01]

Hello.

Yes, I have read the documentation and maybe it would be necessary to add more context, previous explanations, and examples about the usage of the module. I will transfer your petition to the corresponding team to improve this documentation and clarify it.

Meanwhile, I can give you more information about this documentation:

1. The API refers to the Wazuh API, a tool designed to make petitions to the Wazuh manager via API. Here I leave you the full reference of the API. Take into account that the shared link points to the Wazuh v4.7.5, and the latest version of Wazuh currently is the v4.8.2. The Wazuh API can be used either with the command line, getting a token as an authentication method; or via the Wazuh dashboard. Related documentation here. For example, in the documentation you reported:

   • The Upgrade request [API/CLI] refers to the Upgrade agents API reference documentation.
   • The Upgrade result request [API/CLI] refers to the Get upgrade results API reference documentation.

2. The CLI refers to the command line interface inside the machine where the Wazuh manager is installed. We have a dedicated documentation about the agent_upgrade tool here.

Hope it helps.