Updated and improved doc changes:

- Improved dependencies file for each cloud and container section. - Added pythonversion constant to conf.py and added to section. - Fixed warning. - Added new url to redirect.js file. - Added present tense and summrazied text where needed.
wazuh · Jun 6, 2023 · e2acdf0 · e2acdf0
1 parent 040bea0
commit e2acdf0
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 24 deletions.
diff --git a/source/_static/js/redirects.js b/source/_static/js/redirects.js
@@ -162,6 +162,12 @@ redirections.push(
     },
 );
 
+/* Pages added in 4.6 */
+
+newUrls['4.6'] = [
+  '/user-manual/agents/cloud-and-container-monitoring.html',
+];
+
 /* Pages added in 4.4 */
 
 newUrls['4.4'] = [

diff --git a/source/amazon/services/prerequisites/considerations.rst b/source/amazon/services/prerequisites/considerations.rst
@@ -55,7 +55,7 @@ The ``--debug 2`` parameter gets a verbose output. This is useful to show the sc
 Connection configuration for retries
 ------------------------------------
 
-Some calls to AWS services may fail when made in highly congested environments. The :ref:`boto-3` client raises `ClientError` exceptions describing the errors. This kind of exception often needs repeating the call, without further handling. To help retry these calls, Boto3 provides `Retries <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/retries.html>`__. This feature allows retrying client calls to AWS services when errors like ``ThrottlingException`` are experienced.
+Some calls to AWS services may fail when made in highly congested environments. The `boto-3 <https://boto3.amazonaws.com/v1/documentation/api/latest/index.html>`_ client raises `ClientError` exceptions describing the errors. This kind of exception often needs repeating the call, without further handling. To help retry these calls, Boto3 provides `Retries <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/retries.html>`__. This feature allows retrying client calls to AWS services when errors like ``ThrottlingException`` are experienced.
 
 Users can customize two retry configurations.
 

diff --git a/source/amazon/services/prerequisites/dependencies.rst b/source/amazon/services/prerequisites/dependencies.rst
@@ -5,18 +5,28 @@
 
 .. _amazon_dependencies:
 
+Python
+------
+
+AWS module require `Python 3 <https://www.python.org/>`_. It is compatible with
+`Python |PYTHON_CLOUD_CONTAINERS| - 3.10 <https://www.python.org/downloads/>`_.
+
+.. note::
+   Python versions 3.11+ should work although it is not guaranteed.
+
 Installing dependencies
 =======================
 
+
 .. warning::
   The Wazuh manager includes all dependencies installed, these steps are only necessary when configuring the integration in a Wazuh agent.
 
-To learn more about agent cloud monitoring, check out :doc:`this section </user-manual/agents/cloud-and-container-monitoring>`.
+To learn more, see the :doc:`Cloud and container monitoring </user-manual/agents/cloud-and-container-monitoring>` section under the Agent management.
 
 `Boto3 <https://boto3.readthedocs.io/>`__ is the official package supported by Amazon to manage AWS resources. It is used to download the log messages from the different AWS services supported by Wazuh. The module is compatible with boto3 from ``1.13.1`` to ``1.17.85``. Future boto3 releases should maintain compatibility although it cannot be guaranteed.
 
 To install the dependencies, execute the following command:
 
 .. code-block:: console
 
-  # pip3 install boto3==1.17.85
+  # pip3 install boto3==1.17.85
diff --git a/source/azure/activity-services/prerequisites/dependencies.rst b/source/azure/activity-services/prerequisites/dependencies.rst
@@ -5,18 +5,27 @@
 
 .. _azure_monitoring_dependencies:
 
+Python
+------
+
+Azure module require `Python 3 <https://www.python.org/>`_. It is compatible with
+`Python |PYTHON_CLOUD_CONTAINERS| - 3.10 <https://www.python.org/downloads/>`_.
+
+.. note::
+   Python versions 3.11+ should work although it is not guaranteed.
+
 Installing dependencies
 =======================
 
 .. warning::
   The Wazuh manager includes all dependencies installed, these steps are only necessary when configuring the integration in a Wazuh agent.
 
-To learn more about agent cloud monitoring, check out :doc:`this section </user-manual/agents/cloud-and-container-monitoring>`.
-
 `Azure Storage Blobs client library <https://pypi.org/project/azure-storage-blob/>`_ is the official Python library for Microsoft's Azure Blob storage.
 
 To install the Azure Storage Blobs client library for Python and the required dependencies, execute the following command:
 
 .. code-block:: console
 
   # pip3 install azure-storage-blob==2.1.0 SQLAlchemy==1.3.11 pytz==2020.1
+
+To learn more, see the :doc:`Cloud and container monitoring </user-manual/agents/cloud-and-container-monitoring>` section under the Agent management.
diff --git a/source/conf.py b/source/conf.py
@@ -495,6 +495,7 @@ def customReplacements(app, docname, source):
     "|WAZUH_CURRENT_MAJOR|" : "4.x",
     "|WAZUH_CURRENT_MINOR|" : version,
     "|WAZUH_CURRENT|" : release,
+    "|PYTHON_CLOUD_CONTAINERS|" : "3.7",
     # --- Revision numbers for Wazuh agent and manager packages versions
     # Alpine APK packages revisions
     "|WAZUH_REVISION_APK_AGENT_I386|" : "r1",

diff --git a/source/container-security/docker-monitor/dependencies.rst b/source/container-security/docker-monitor/dependencies.rst
@@ -5,18 +5,27 @@
 
 .. _docker_monitoring_dependencies:
 
+Python
+------
+
+Docker container module require `Python 3 <https://www.python.org/>`_. It is compatible with
+`Python |PYTHON_CLOUD_CONTAINERS| - 3.10 <https://www.python.org/downloads/>`_.
+
+.. note::
+   Python versions 3.11+ should work although it is not guaranteed.
+
 Installing dependencies
 =======================
 
 .. warning::
   The Wazuh manager includes all dependencies installed, these steps are only necessary when configuring the integration in a Wazuh agent.
 
-To learn more about agent container monitoring, check out :doc:`this section </user-manual/agents/cloud-and-container-monitoring>`.
-
 `Python Docker library <https://pypi.org/project/docker/>`_ is the official Python library for the Docker Engine API. The Wazuh docker integration requires ``docker 4.2.0``.
 
 To install the Python Docker Library, execute the following command:
 
 .. code-block:: console
 
   # pip3 install docker==4.2.0
+
+To learn more, see the :doc:`Cloud and container monitoring </user-manual/agents/cloud-and-container-monitoring>` section under the Agent management.
diff --git a/source/gcp/prerequisites/dependencies.rst b/source/gcp/prerequisites/dependencies.rst
@@ -5,14 +5,21 @@
 
 .. _gcp_dependencies:
 
+Python
+------
+
+GCP module require `Python 3 <https://www.python.org/>`_. It is compatible with
+`Python |PYTHON_CLOUD_CONTAINERS| - 3.10 <https://www.python.org/downloads/>`_.
+
+.. note::
+   Python versions 3.11+ should work although it is not guaranteed.
+
 Installing dependencies
 =======================
 
 .. warning::
   The Wazuh manager includes all dependencies installed, the following steps are only necessary when configuring the integration in a Wazuh agent.
 
-To learn more about agent cloud monitoring, check out :doc:`this section </user-manual/agents/cloud-and-container-monitoring>`.
-
 `Google-cloud-pubsub <https://pypi.org/project/google-cloud-pubsub/>`_ is the official python library supported by Google to manage Google Cloud Pub/Sub resources. It is used to pull the log messages from the Pub/Sub queue.
 
 To install the necessary dependencies, execute the following command:
@@ -21,3 +28,4 @@ To install the necessary dependencies, execute the following command:
 
   # pip3 install google-cloud-core==1.7.1 google-cloud-pubsub==2.7.1 google-cloud-storage==1.39.0 pytz==2020.1
 
+To learn more, see the :doc:`Cloud and container monitoring </user-manual/agents/cloud-and-container-monitoring>` section under the Agent management.
diff --git a/source/user-manual/agents/cloud-and-container-monitoring.rst b/source/user-manual/agents/cloud-and-container-monitoring.rst
@@ -11,28 +11,16 @@ Cloud and container monitoring
 Wazuh offers the ability to monitor your cloud and container infrastructure, helping you maintain the highest levels of
 security. In this section, we will show how to configure your Wazuh agent to monitor various cloud providers and container technologies.
 
-To learn more about cloud security, check out :doc:`this section </monitoring>`.
-
-To learn more about container security, check out :doc:`this section </container-security/index>`.
+See the :doc:`Cloud security </monitoring>` and :doc:`Container security </container-security/index>` sections to learn more.
 
 .. note::
   Cloud and containers monitoring can be configured in both the Wazuh manager and the agent. The choice merely depends on how you want to access your cloud and container infrastructure and based on your needs.
 
-Python
-------
-
-Cloud and container modules require `Python 3 <https://www.python.org/>`_. They are compatible with
-`Python 3.7+ <https://www.python.org/downloads/>`_.
-
-.. warning::
-  Future Python releases should maintain compatibility although it is not guaranteed.
-
 Dependencies
 ------------
 
-All cloud and container providers require specific dependencies.
-`Pip <https://pypi.org/project/pip/>`_ is the package installer for Python and we will use it to install the required
-dependencies for each module.
+All cloud and container providers require specific dependencies. Check each section to learn more.
+We use `Pip <https://pypi.org/project/pip/>`_ , the package installer for Python, to install the required dependencies.
 
 - :doc:`AWS dependencies </amazon/services/prerequisites/dependencies>`
 - :doc:`AZURE dependencies </azure/activity-services/prerequisites/dependencies>`