Skip to content

Commit 64064f4

Browse files
ayodekoayodeko
authored
Merge pull request #8936 from wazuh/enhancement/idr355-add-installation-guide-rework
Enhancement/idr355 add installation guide rework
2 parents a35440b + 656aabf commit 64064f4

34 files changed

+694
-530
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ All notable changes to this project will be documented in this file.
4747
- **Post-release**: Updated 4.13.0 release notes entry. ([#8923](https://github.com/wazuh/wazuh-documentation/pull/8923)) ([#8925](https://github.com/wazuh/wazuh-documentation/pull/8925)) ([#8928](https://github.com/wazuh/wazuh-documentation/pull/8928))
4848
- **Post-release**: Updated steps in Upgrade Guide for exporting customizations from the Wazuh Dashboard. ([#8921](https://github.com/wazuh/wazuh-documentation/pull/8921))
4949
- **Post-release**: Updated references to Twitter. ([#8933](https://github.com/wazuh/wazuh-documentation/pull/8933))
50+
- **Post-release**: Updated the installation guide. ([#8936](https://github.com/wazuh/wazuh-documentation/pull/8936))
5051

5152
## [v4.12.0]
5253

‎source/_templates/installations/disable-wazuh-updates.rst‎

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,28 @@
11
.. Copyright (C) 2015, Wazuh, Inc.
22
3-
.. note::
3+
We recommend disabling the Wazuh package repositories after installing all components on this server to prevent accidental upgrades.
44

5-
**Recommended Action**: Disable Wazuh Updates.
5+
Execute the following command only after completing all installations:
66

7-
We recommend disabling the Wazuh package repositories after installing all components on this server to prevent accidental upgrades.
7+
.. tabs::
88

9-
Execute the following command only after completing all installations:
9+
.. group-tab:: APT
1010

11-
.. tabs::
11+
.. code-block:: console
1212
13-
.. group-tab:: APT
13+
# sed -i "s/^deb /#deb /" /etc/apt/sources.list.d/wazuh.list
14+
# apt update
1415
15-
.. code-block:: console
16+
.. group-tab:: YUM
1617

17-
# sed -i "s/^deb /#deb /" /etc/apt/sources.list.d/wazuh.list
18-
# apt update
18+
.. code-block:: console
1919
20-
.. group-tab:: YUM
20+
# sed -i "s/^enabled=1/enabled=0/" /etc/yum.repos.d/wazuh.repo
2121
22-
.. code-block:: console
22+
.. group-tab:: DNF
2323

24-
# sed -i "s/^enabled=1/enabled=0/" /etc/yum.repos.d/wazuh.repo
24+
.. code-block:: console
2525
26-
.. group-tab:: DNF
27-
28-
.. code-block:: console
29-
30-
# sed -i "s/^enabled=1/enabled=0/" /etc/yum.repos.d/wazuh.repo
26+
# sed -i "s/^enabled=1/enabled=0/" /etc/yum.repos.d/wazuh.repo
3127
3228
.. End of include file

‎source/_templates/installations/filebeat/opensearch/configure_filebeat.rst‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
.. Copyright (C) 2015, Wazuh, Inc.
22
3-
#. ``hosts``: The list of Wazuh indexer nodes to connect to. You can use either IP addresses or hostnames. By default, the host is set to localhost ``hosts: ["127.0.0.1:9200"]``. Replace it with your Wazuh indexer address accordingly.
4-
5-
If you have more than one Wazuh indexer node, you can separate the addresses using commas. For example, ``hosts: ["10.0.0.1:9200", "10.0.0.2:9200", "10.0.0.3:9200"]``
3+
#. ``hosts``: The list of Wazuh indexer nodes to connect to. You can use either IP addresses or hostnames. By default, the host is set to localhost ``hosts: ["127.0.0.1:9200"]``. Replace your Wazuh indexer IP address accordingly.
64

7-
.. code-block:: yaml
5+
If you have more than one Wazuh indexer node, you can separate the addresses using commas. For example, ``hosts: ["10.0.0.1:9200", "10.0.0.2:9200", "10.0.0.3:9200"]``
6+
7+
.. code-block:: yaml
88
:emphasize-lines: 3
99
10-
# Wazuh - Filebeat configuration file
11-
output.elasticsearch:
12-
hosts: ["10.0.0.1:9200"]
13-
protocol: https
14-
username: ${username}
15-
password: ${password}
16-
10+
# Wazuh - Filebeat configuration file
11+
output.elasticsearch:
12+
hosts: ["10.0.0.1:9200"]
13+
protocol: https
14+
username: ${username}
15+
password: ${password}
1716
1817
.. End of include file

‎source/_templates/installations/filebeat/opensearch/copy_certificates_filebeat_wazuh_cluster.rst‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
33
.. code-block:: console
44
5-
# NODE_NAME=<SERVER_NODE_NAME>
5+
# NODE_NAME=<SERVER_NODE_NAME>
66
77
.. code-block:: console
8-
9-
# mkdir /etc/filebeat/certs
10-
# tar -xf ./wazuh-certificates.tar -C /etc/filebeat/certs/ ./$NODE_NAME.pem ./$NODE_NAME-key.pem ./root-ca.pem
11-
# mv -n /etc/filebeat/certs/$NODE_NAME.pem /etc/filebeat/certs/filebeat.pem
12-
# mv -n /etc/filebeat/certs/$NODE_NAME-key.pem /etc/filebeat/certs/filebeat-key.pem
13-
# chmod 500 /etc/filebeat/certs
14-
# chmod 400 /etc/filebeat/certs/*
15-
# chown -R root:root /etc/filebeat/certs
16-
8+
9+
# mkdir /etc/filebeat/certs
10+
# tar -xf ./wazuh-certificates.tar -C /etc/filebeat/certs/ ./$NODE_NAME.pem ./$NODE_NAME-key.pem ./root-ca.pem
11+
# mv -n /etc/filebeat/certs/$NODE_NAME.pem /etc/filebeat/certs/filebeat.pem
12+
# mv -n /etc/filebeat/certs/$NODE_NAME-key.pem /etc/filebeat/certs/filebeat-key.pem
13+
# chmod 500 /etc/filebeat/certs
14+
# chmod 400 /etc/filebeat/certs/*
15+
# chown -R root:root /etc/filebeat/certs
16+
1717
.. End of copy_certificates_filebeat_wazuh_cluster.rst

‎source/_templates/installations/indexer/common/configure_indexer_nodes.rst‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
.. Copyright (C) 2015, Wazuh, Inc.
22
3+
#. Edit ``/etc/wazuh-indexer/opensearch.yml`` and replace the following values:
34

4-
#. Edit the ``/etc/wazuh-indexer/opensearch.yml`` configuration file and replace the following values:
55

6-
7-
#. ``network.host``: Sets the address of this node for both HTTP and transport traffic. The node will bind to this address and use it as its publish address. Accepts an IP address or a hostname.
8-
9-
Use the same node address set in ``config.yml`` to create the SSL certificates.
6+
#. ``network.host``: Sets the address of this node for both HTTP and transport traffic. The node will bind to this address and use it as its publish address. Accepts an IP address or a hostname.
7+
8+
Use the same node address set in ``config.yml`` to create the SSL certificates.
109

1110
#. ``node.name``: Name of the Wazuh indexer node as defined in the ``config.yml`` file. For example, ``node-1``.
1211

@@ -19,15 +18,15 @@
1918
- "node-2"
2019
- "node-3"
2120
22-
#. ``discovery.seed_hosts:`` List of the addresses of the master-eligible nodes. Each element can be either an IP address or a hostname. You may leave this setting commented if you are configuring the Wazuh indexer as a single node. For multi-node configurations, uncomment this setting and set the IP addresses of each master-eligible node.
21+
#. ``discovery.seed_hosts:`` List of the addresses of the master-eligible nodes. Each element can be either an IP address or a hostname. You may leave this setting commented if you are configuring the Wazuh indexer as a single node. For multi-node configurations, uncomment this setting and set the IP addresses of each master-eligible node.
2322

2423
.. code-block:: yaml
2524
2625
discovery.seed_hosts:
2726
- "10.0.0.1"
2827
- "10.0.0.2"
2928
- "10.0.0.3"
30-
29+
3130
#. ``plugins.security.nodes_dn``: List of the Distinguished Names of the certificates of all the Wazuh indexer cluster nodes. Uncomment the lines for ``node-2`` and ``node-3`` and change the common names (CN) and values according to your settings and your ``config.yml`` definitions.
3231

3332
.. code-block:: yaml

‎source/_templates/installations/indexer/common/deploy_certificates.rst‎

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
.. Copyright (C) 2015, Wazuh, Inc.
22
3+
#. Run the following commands, replacing ``<INDEXER_NODE_NAME>`` with the name of the Wazuh indexer node you are configuring as defined in ``config.yml``. For example, ``node-1``. This deploys the SSL certificates to encrypt communications between the Wazuh central components.
34

4-
#. Run the following commands replacing ``<INDEXER_NODE_NAME>`` with the name of the Wazuh indexer node you are configuring as defined in ``config.yml``. For example, ``node-1``. This deploys the SSL certificates to encrypt communications between the Wazuh central components.
5+
.. code-block:: console
6+
7+
# NODE_NAME=<INDEXER_NODE_NAME>
8+
9+
.. code-block:: console
10+
11+
# mkdir /etc/wazuh-indexer/certs
12+
# tar -xf ./wazuh-certificates.tar -C /etc/wazuh-indexer/certs/ ./$NODE_NAME.pem ./$NODE_NAME-key.pem ./admin.pem ./admin-key.pem ./root-ca.pem
13+
# mv -n /etc/wazuh-indexer/certs/$NODE_NAME.pem /etc/wazuh-indexer/certs/indexer.pem
14+
# mv -n /etc/wazuh-indexer/certs/$NODE_NAME-key.pem /etc/wazuh-indexer/certs/indexer-key.pem
15+
# chmod 500 /etc/wazuh-indexer/certs
16+
# chmod 400 /etc/wazuh-indexer/certs/*
17+
# chown -R wazuh-indexer:wazuh-indexer /etc/wazuh-indexer/certs
18+
19+
#. **Recommended action**: If no other Wazuh components will be installed on this node, run the following command to remove the ``wazuh-certificates.tar`` file.
520

621
.. code-block:: console
722
8-
# NODE_NAME=<INDEXER_NODE_NAME>
9-
10-
.. code-block:: console
11-
12-
# mkdir /etc/wazuh-indexer/certs
13-
# tar -xf ./wazuh-certificates.tar -C /etc/wazuh-indexer/certs/ ./$NODE_NAME.pem ./$NODE_NAME-key.pem ./admin.pem ./admin-key.pem ./root-ca.pem
14-
# mv -n /etc/wazuh-indexer/certs/$NODE_NAME.pem /etc/wazuh-indexer/certs/indexer.pem
15-
# mv -n /etc/wazuh-indexer/certs/$NODE_NAME-key.pem /etc/wazuh-indexer/certs/indexer-key.pem
16-
# chmod 500 /etc/wazuh-indexer/certs
17-
# chmod 400 /etc/wazuh-indexer/certs/*
18-
# chown -R wazuh-indexer:wazuh-indexer /etc/wazuh-indexer/certs
19-
20-
#. **Recommended action**: If no other Wazuh components are going to be installed on this node, remove the ``wazuh-certificates.tar`` file by running ``rm -f ./wazuh-certificates.tar`` to increase security.
23+
# rm -f ./wazuh-certificates.tar
2124
2225
.. End of include file

‎source/_templates/installations/indexer/common/install-dependencies.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. Copyright (C) 2015, Wazuh, Inc.
22
3-
#. Install the following packages if missing:
3+
#. Run the following command to install the following packages if missing:
44

55
.. tabs::
66

‎source/_templates/installations/manager/configure_indexer_connection.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ By default, the indexer settings have one host configured. It's set to ``0.0.0.0
2323

2424
- Ensure the Filebeat certificate and key name match the certificate files in ``/etc/filebeat/certs``.
2525

26-
If you are running a cluster infrastructure, add a ``<host>`` entry for each one of your nodes. For example, in a two-node configuration:
26+
If you are running a Wazuh indexer cluster infrastructure, add a ``<host>`` entry for each one of your nodes. For example, in a two-node configuration:
2727

2828
.. code-block:: xml
2929
@@ -32,6 +32,6 @@ If you are running a cluster infrastructure, add a ``<host>`` entry for each one
3232
<host>https://10.0.0.2:9200</host>
3333
</hosts>
3434
35-
Vulnerability detection prioritizes reporting to the first node in the list. It switches to the next node in case it is not available.
35+
The Wazuh server prioritizes reporting to the first Wazuh indexer node in the list. It switches to the next node in case it is not available.
3636

3737
.. End of include file

‎source/_templates/installations/manager/configure_wazuh_worker_node.rst‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
.. Copyright (C) 2015, Wazuh, Inc.
22
3-
Configure the cluster node by editing the following settings in the ``/var/ossec/etc/ossec.conf`` file.
3+
Configure the cluster node by editing the following settings in the ``/var/ossec/etc/ossec.conf`` file and configure the necessary parameters:
44

55
.. code-block:: xml
66
7-
<cluster>
8-
<name>wazuh</name>
9-
<node_name>worker-node</node_name>
10-
<node_type>worker</node_type>
11-
<key>c98b62a9b6169ac5f67dae55ae4a9088</key>
12-
<port>1516</port>
13-
<bind_addr>0.0.0.0</bind_addr>
14-
<nodes>
15-
<node><WAZUH_MASTER_ADDRESS></node>
16-
</nodes>
17-
<hidden>no</hidden>
18-
<disabled>no</disabled>
19-
</cluster>
7+
<cluster>
8+
<name>wazuh</name>
9+
<node_name>worker-node</node_name>
10+
<node_type>worker</node_type>
11+
<key>c98b62a9b6169ac5f67dae55ae4a9088</key>
12+
<port>1516</port>
13+
<bind_addr>0.0.0.0</bind_addr>
14+
<nodes>
15+
<node><WAZUH_MASTER_ADDRESS></node>
16+
</nodes>
17+
<hidden>no</hidden>
18+
<disabled>no</disabled>
19+
</cluster>
2020
2121
Parameters to be configured:
2222

‎source/_templates/installations/manager/restart_wazuh_manager.rst‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,17 @@
22
33
.. tabs::
44

5+
.. group-tab:: Systemd
56

6-
.. group-tab:: Systemd
7+
.. code-block:: console
78
9+
# systemctl restart wazuh-manager
810
9-
.. code-block:: console
11+
.. group-tab:: SysV init
1012

11-
# systemctl restart wazuh-manager
13+
.. code-block:: console
1214
13-
14-
.. group-tab:: SysV init
15-
16-
.. code-block:: console
17-
18-
# service wazuh-manager restart
15+
# service wazuh-manager restart
1916
2017
.. End of include file
2118

0 commit comments

Comments
 (0)