Skip to content

Commit 85d1b39

Browse files
committed
Merge Wazuh documents
1 parent 0f0d96f commit 85d1b39

File tree

3 files changed

+36
-93
lines changed

3 files changed

+36
-93
lines changed

doc/source/configuration/wazuh.rst

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,20 @@
22
Wazuh
33
=====
44

5+
`Wazuh <https://wazuh.com>`_ is a security monitoring platform.
6+
It monitors for:
7+
8+
* Security-related system events.
9+
* Known vulnerabilities (CVEs) in versions of installed software.
10+
* Misconfigurations in system security.
11+
512
The short version
613
=================
714

815
#. Create an infrastructure VM for the Wazuh manager, and add it to the wazuh-manager group
916
#. Configure the infrastructure VM with kayobe: ``kayobe infra vm host configure``
1017
#. Edit your config under
11-
``etc/kayobe/inventory/group_vars/wazuh-manager/wazuh-manager``, in
18+
``$KAYOBE_CONFIG_PATHinventory/group_vars/wazuh-manager/wazuh-manager``, in
1219
particular the defaults assume that the ``provision_oc_net`` network will be
1320
used.
1421
#. Generate secrets: ``kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/wazuh-secrets.yml``
@@ -234,9 +241,12 @@ You may need to modify some of the variables, including:
234241
- etc/kayobe/wazuh-manager.yml
235242
- etc/kayobe/inventory/group_vars/wazuh/wazuh-agent/wazuh-agent
236243

244+
You'll need to run ``wazuh-manager.yml`` playbook again to apply customisation.
245+
237246
Secrets
238247
-------
239248

249+
Wazuh requires that secrets or passwords are set for itself and the services with which it communiticates.
240250
Wazuh secrets playbook is located in ``etc/kayobe/ansible/wazuh-secrets.yml``.
241251
Running this playbook will generate and put pertinent security items into secrets
242252
vault file which will be placed in ``$KAYOBE_CONFIG_PATH/wazuh-secrets.yml``.
@@ -252,6 +262,10 @@ It will be used by wazuh secrets playbook to generate wazuh secrets vault file.
252262
kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/wazuh-secrets.yml
253263
ansible-vault encrypt --vault-password-file ~/vault.pass $KAYOBE_CONFIG_PATH/wazuh-secrets.yml
254264
265+
.. note:: Use ``ansible-vault`` to view the secrets:
266+
267+
``ansible-vault view --vault-password-file ~/vault.password $KAYOBE_CONFIG_PATH/inventory/group_vars/wazuh-manager/wazuh-secrets.yml``
268+
255269
Configure Wazuh Dashboard's Server Host
256270
---------------------------------------
257271

@@ -392,6 +406,25 @@ Deploy the Wazuh agents:
392406

393407
``kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/wazuh-agent.yml``
394408

409+
The Wazuh Agent is deployed to all hosts in the ``wazuh-agent``
410+
inventory group, comprising the ``seed`` group
411+
plus the ``overcloud`` group (containing all hosts in the
412+
OpenStack control plane).
413+
414+
.. code-block:: ini
415+
416+
[wazuh-agent:children]
417+
seed
418+
overcloud
419+
420+
The hosts running Wazuh Agent should automatically be registered
421+
and visible within the Wazuh Manager dashboard.
422+
423+
.. note:: It is good practice to use a `Kayobe deploy hook
424+
<https://docs.openstack.org/kayobe/latest/custom-ansible-playbooks.html#hooks>`_
425+
to automate deployment and configuration of the Wazuh Agent
426+
following a run of ``kayobe overcloud host configure``.
427+
395428
Verification
396429
------------
397430

doc/source/operations/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
=================
1+
==============
22
Operator Guide
3-
=================
3+
==============
44

55
This guide is for operators of the StackHPC Kayobe configuration project.
66

@@ -23,4 +23,3 @@ This guide is for operators of the StackHPC Kayobe configuration project.
2323
secret-rotation
2424
tempest
2525
upgrading
26-
wazuh-operation

doc/source/operations/wazuh-operation.rst

Lines changed: 0 additions & 89 deletions
This file was deleted.

0 commit comments

Comments
 (0)