From 0816ee18e0fff4121ba27049013b33af232392d3 Mon Sep 17 00:00:00 2001 From: DFolchA Date: Thu, 3 Aug 2023 19:37:10 +0200 Subject: [PATCH] Add new packages to: - Packages list - install guide - upgrade guide - package generation guide --- .../packaging/generate-osx-package.rst | 3 +- source/installation-guide/packages-list.rst | 9 ++- .../wazuh-agent/wazuh-agent-package-macos.rst | 60 ++++++++++++------- source/upgrade-guide/wazuh-agent/macos.rst | 16 ++++- 4 files changed, 61 insertions(+), 27 deletions(-) diff --git a/source/development/packaging/generate-osx-package.rst b/source/development/packaging/generate-osx-package.rst index b2fa5ed4f3..6b1051e032 100644 --- a/source/development/packaging/generate-osx-package.rst +++ b/source/development/packaging/generate-osx-package.rst @@ -39,7 +39,8 @@ Execute the ``generate_wazuh_packages.sh`` script, with the different options yo Usage: ./generate_wazuh_packages.sh [OPTIONS] Build options: - -b, --branch [Required] Select Git branch or tag. + -a, --architecture [Optional] Select architecture to build (intel64 or arm64). Default: intel64 + -b, --branch [Required] Select Git branch or tag e.g. -s, --store-path [Optional] Set the destination absolute path of package. -j, --jobs [Optional] Number of parallel jobs when compiling. -r, --revision [Optional] Package revision that append to version e.g. x.x.x-rev diff --git a/source/installation-guide/packages-list.rst b/source/installation-guide/packages-list.rst index e09953fc53..8cb3d77af9 100755 --- a/source/installation-guide/packages-list.rst +++ b/source/installation-guide/packages-list.rst @@ -342,15 +342,20 @@ Windows | XP or later | 32/64bits | |WindowsXP_32_64| | +-----------------+--------------+---------------------------+ +.. _packages_list_agent_macos: + macOS ^^^^^ -.. |macOS_64| replace:: `wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.pkg `__ (`sha512 `__) +.. |macOS_intel_64| replace:: `wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.pkg `__ (`sha512 `__) +.. |macOS_arm64| replace:: `wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.pkg `__ (`sha512 `__) +--------------+-------------------------+ | Architecture | Package | +==============+=========================+ -| 64bits | |macOS_64| | +| intel64 | |macOS_intel_64| | ++--------------+-------------------------+ +| arm64 | |macOS_arm64| | +--------------+-------------------------+ Solaris diff --git a/source/installation-guide/wazuh-agent/wazuh-agent-package-macos.rst b/source/installation-guide/wazuh-agent/wazuh-agent-package-macos.rst index dcb1d25386..59c8bc50b4 100644 --- a/source/installation-guide/wazuh-agent/wazuh-agent-package-macos.rst +++ b/source/installation-guide/wazuh-agent/wazuh-agent-package-macos.rst @@ -12,39 +12,57 @@ The agent runs on the endpoint you want to monitor and communicates with the Waz .. note:: You need root user privileges to run all the commands described below. -#. To start the installation process, download the `Wazuh agent for macOS `_. The package is suitable for macOS Sierra or later. +#. To start the installation process, download the :ref:`Wazuh agent for macOS `. The package is suitable for macOS Sierra or later. #. Select the installation method you want to follow: command line interface (CLI) or graphical user interface (GUI). .. tabs:: .. group-tab:: CLI - - #. To deploy the Wazuh agent on your endpoint, edit the ``WAZUH_MANAGER`` variable to contain your Wazuh manager IP address or hostname and run the following command. + + .. tabs:: - .. code-block:: console - - # echo "WAZUH_MANAGER='10.0.0.2'" > /tmp/wazuh_envs && installer -pkg wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.pkg -target / - - .. note:: For version 4.4.2 and earlier, run the following command instead. Replace ```` with your package version, such as ``4.4.2-1``. - :class: not-long + .. group-tab:: intel64 - .. code-block:: console - - # launchctl setenv WAZUH_MANAGER "10.0.0.2" && installer -pkg wazuh-agent-.pkg -target / + To deploy the Wazuh agent on your endpoint, edit the ``WAZUH_MANAGER`` variable to contain your Wazuh manager IP address or hostname and run the following command. - For additional deployment options such as agent name, agent group, and registration password, see the :doc:`Deployment variables for macOS ` section. - - .. note:: Alternatively, if you want to install an agent without registering it, omit the deployment variables. To learn more about the different registration methods, see the :doc:`Wazuh agent enrollment ` section. + .. code-block:: console + + # echo "WAZUH_MANAGER='10.0.0.2'" > /tmp/wazuh_envs && installer -pkg wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.intel64.pkg -target / + + .. note:: For version 4.4.2 and earlier, run the following command instead. Replace ```` with your package version, such as ``4.4.2-1``. + :class: not-long - #. To complete the installation process, start the Wazuh agent. - - .. code-block:: console - - # /Library/Ossec/bin/wazuh-control start + .. code-block:: console + + # launchctl setenv WAZUH_MANAGER "10.0.0.2" && installer -pkg wazuh-agent-.pkg -target / + + For additional deployment options such as agent name, agent group, and registration password, see the :doc:`Deployment variables for macOS ` section. + + .. note:: Alternatively, if you want to install an agent without registering it, omit the deployment variables. To learn more about the different registration methods, see the :doc:`Wazuh agent enrollment ` section. + + .. group-tab:: arm64 + + #. To deploy the Wazuh agent on your endpoint, edit the ``WAZUH_MANAGER`` variable to contain your Wazuh manager IP address or hostname and run the following command. + + .. code-block:: console + + # echo "WAZUH_MANAGER='10.0.0.2'" > /tmp/wazuh_envs && installer -pkg wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.arm64.pkg -target / + + + For additional deployment options such as agent name, agent group, and registration password, see the :doc:`Deployment variables for macOS ` section. + + .. note:: Alternatively, if you want to install an agent without registering it, omit the deployment variables. To learn more about the different registration methods, see the :doc:`Wazuh agent enrollment ` section. + + + To complete the installation process, start the Wazuh agent. + + .. code-block:: console + + # /Library/Ossec/bin/wazuh-control start - The installation process is now complete, and the Wazuh agent is successfully deployed and running on your macOS endpoint. + The installation process is now complete, and the Wazuh agent is successfully deployed and running on your macOS endpoint. .. group-tab:: GUI diff --git a/source/upgrade-guide/wazuh-agent/macos.rst b/source/upgrade-guide/wazuh-agent/macos.rst index 24d515ed1e..5eace829d8 100644 --- a/source/upgrade-guide/wazuh-agent/macos.rst +++ b/source/upgrade-guide/wazuh-agent/macos.rst @@ -11,7 +11,7 @@ Follow these steps to upgrade Wazuh agents locally on macOS systems. If you want .. note:: To perform the agent upgrade, administrator privileges are required. -#. Download the latest `macOS installer `_. +#. Download the latest :ref:`macOS installer `. #. Run the macOS installer by using the command line interface (CLI) or the graphical user interface (GUI). @@ -20,10 +20,20 @@ Follow these steps to upgrade Wazuh agents locally on macOS systems. If you want .. group-tab:: CLI To upgrade the Wazuh agent by using the command line, run the installer: + + .. tabs:: - .. code-block:: console + .. group-tab:: intel64 + + .. code-block:: console - # installer -pkg wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.pkg -target / + # installer -pkg wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.intel64.pkg -target / + + .. group-tab:: arm64 + + .. code-block:: console + + # installer -pkg wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.arm64.pkg -target / .. group-tab:: GUI