Skip to content

Commit

Permalink
Add new packages to:
Browse files Browse the repository at this point in the history
- Packages list
- install guide
- upgrade guide
- package generation guide
  • Loading branch information
DFolchA committed Aug 3, 2023
1 parent 9687e2f commit 0816ee1
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 27 deletions.
3 changes: 2 additions & 1 deletion source/development/packaging/generate-osx-package.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <branch> [Required] Select Git branch or tag.
-a, --architecture <arch> [Optional] Select architecture to build (intel64 or arm64). Default: intel64
-b, --branch <branch> [Required] Select Git branch or tag e.g.
-s, --store-path <path> [Optional] Set the destination absolute path of package.
-j, --jobs <number> [Optional] Number of parallel jobs when compiling.
-r, --revision <rev> [Optional] Package revision that append to version e.g. x.x.x-rev
Expand Down
9 changes: 7 additions & 2 deletions source/installation-guide/packages-list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR_OSX|/macos/wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.pkg>`__ (`sha512 <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR_OSX|/checksums/wazuh/|WAZUH_CURRENT_OSX|/wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.pkg.sha512>`__)
.. |macOS_intel_64| replace:: `wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.pkg <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR_OSX|/macos/wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.intel64.pkg>`__ (`sha512 <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR_OSX|/checksums/wazuh/|WAZUH_CURRENT_OSX|/wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.intel64.pkg.sha512>`__)
.. |macOS_arm64| replace:: `wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.pkg <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR_OSX|/macos/wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.arm64.pkg>`__ (`sha512 <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR_OSX|/checksums/wazuh/|WAZUH_CURRENT_OSX|/wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.arm64.pkg.sha512>`__)

+--------------+-------------------------+
| Architecture | Package |
+==============+=========================+
| 64bits | |macOS_64| |
| intel64 | |macOS_intel_64| |
+--------------+-------------------------+
| arm64 | |macOS_arm64| |
+--------------+-------------------------+

Solaris
Expand Down
60 changes: 39 additions & 21 deletions source/installation-guide/wazuh-agent/wazuh-agent-package-macos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR_OSX|/macos/wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.pkg>`_. The package is suitable for macOS Sierra or later.
#. To start the installation process, download the :ref:`Wazuh agent for macOS <packages_list_agent_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 ``<WAZUH.VERSION-REV>`` 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-<WAZUH.VERSION-REV>.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 </user-manual/deployment-variables/deployment-variables-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 </user-manual/agent-enrollment/index>` 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 ``<WAZUH.VERSION-REV>`` 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-<WAZUH.VERSION-REV>.pkg -target /
For additional deployment options such as agent name, agent group, and registration password, see the :doc:`Deployment variables for macOS </user-manual/deployment-variables/deployment-variables-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 </user-manual/agent-enrollment/index>` 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 </user-manual/deployment-variables/deployment-variables-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 </user-manual/agent-enrollment/index>` 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
Expand Down
16 changes: 13 additions & 3 deletions source/upgrade-guide/wazuh-agent/macos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR_OSX|/macos/wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.pkg>`_.
#. Download the latest :ref:`macOS installer <packages_list_agent_macos>`.

#. Run the macOS installer by using the command line interface (CLI) or the graphical user interface (GUI).

Expand All @@ -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
Expand Down

0 comments on commit 0816ee1

Please sign in to comment.