Skip to content

Commit 52fe5ca

Browse files
committed
Merge branch '4.13' into merge-4.13-into-4.14.0
2 parents 6eec04d + f110671 commit 52fe5ca

File tree

8 files changed

+462
-346
lines changed

8 files changed

+462
-346
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,12 @@ All notable changes to this project will be documented in this file.
4141
- **Post-release**: Removed duplicated introductory bullets from source/cloud-security/azure/index.rst ([#8987](https://github.com/wazuh/wazuh-documentation/pull/8987))
4242
- **Post-release**: Updated the *Installation from sources* documentation. ([#8980](https://github.com/wazuh/wazuh-documentation/pull/8980))
4343
- **Post-release**: Updated the Amazon Security Lake integration documentation. ([#8989](https://github.com/wazuh/wazuh-documentation/pull/8989))
44+
- **Post-release**: Updated the *Deployment with Puppet* documentation. ([#8994](https://github.com/wazuh/wazuh-documentation/pull/8994))
4445

4546
### Fixed
4647

4748
- **Post-release**: Removed wazuh-states-fim index references. ([#8948](https://github.com/wazuh/wazuh-documentation/pull/8948))
49+
- **Post-release**: Removed unnecessary code block from agent installation from sources. ([#9000](https://github.com/wazuh/wazuh-documentation/pull/9000))
4850

4951
## [v4.13.0]
5052

source/deployment-options/deploying-with-puppet/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
Deployment with Puppet
99
======================
1010

11-
Puppet is an open-source software tool that gives you an automatic way to inspect, deliver, operate, and future-proof all of your software, no matter where it is executed. It runs on many Unix-like systems as well as on Microsoft Windows and includes its own declarative language to describe system configuration. It is very simple to use and allows you to install and configure Wazuh easily.
11+
Puppet is an open source software that automatically inspects, delivers, operates, and future-proofs all of your software, no matter where it is executed. It runs on many Unix-like systems as well as Microsoft Windows and includes its own declarative language to describe system configuration. It gives an alternative to install and configure Wazuh.
1212

1313
.. topic:: Contents
1414

source/deployment-options/deploying-with-puppet/setup-puppet/index.rst

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,16 @@
88
Set up Puppet
99
=============
1010

11-
In this section, we are going to give a short explanation of how to install the different instances of Puppet. For a more detailed guide, go to the `official Puppet documentation. <https://puppet.com/docs/puppet/latest/puppet_index.html>`_
11+
In this section, we will explain how to install the different instances of Puppet. For a more detailed guide, see the `official Puppet documentation <https://puppet.com/docs/puppet/latest/puppet_index.html>`_.
1212

1313
Before we get started with Puppet, confirm that the following network requirements are met:
1414

15-
- **Private network DNS**: Forward and reverse DNS must be configured, and every server must have a unique hostname. If you do not have DNS configured, you must use your hosts file for name resolution. We will assume that you will use your private network for communication within your infrastructure.
16-
- **Firewall open ports**: The Puppet master must be reachable on TCP port 8140.
15+
- **Private network DNS**: Forward and reverse DNS must be configured, and every server must have a unique hostname. If you do not have DNS configured, use your hosts file for name resolution. We assume you will use your private network for communication within your infrastructure.
1716

18-
.. note::
17+
- **Firewall open ports**: The Puppet master must be reachable on TCP port 8140.
1918

19+
.. note::
20+
2021
We made this guide using Puppet version 7.16. You need root user privileges to run all the commands described below.
2122

2223
.. topic:: Contents
@@ -27,3 +28,20 @@ Before we get started with Puppet, confirm that the following network requiremen
2728
install-puppet-master.rst
2829
install-puppet-agent.rst
2930
setup-puppet-certificates.rst
31+
32+
33+
This section explains how to install puppet-master. Follow this link to check the `official installation guide <https://puppet.com/docs/puppetserver/latest/install_from_packages.html>`_.
34+
35+
If you do not have DNS configured, you must use your hosts file for name resolution.
36+
Edit the ``/etc/hosts`` file and add the following:
37+
38+
.. code-block:: console
39+
40+
<PUPPET_MASTER_IP> puppet puppet-master
41+
<PUPPET_AGENT_IP> puppet-agent
42+
43+
Where:
44+
45+
- ``PUPPET_MASTER_IP`` is the IP address of your Puppet master.
46+
47+
- ``PUPPET_AGENT_IP`` is the IP address of your Puppet agent.

source/deployment-options/deploying-with-puppet/setup-puppet/install-puppet-agent.rst

Lines changed: 47 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -8,69 +8,76 @@
88
Installing Puppet agent
99
=======================
1010

11-
In this section it is explained how to install *puppet-agent*. Follow this link to check the `official installation guide <https://puppet.com/docs/puppet/6.4/install_agents.html>`_.
11+
This section explains how to install Puppet Agent. Follow this link to check the `official installation guide <https://puppet.com/docs/puppet/6.4/install_agents.html>`_.
1212

1313
We assume that you have already installed the ``apt`` or ``yum`` Puppet repository on your agent system in the same way that you did on your Puppet Server.
1414

15-
If you do not have DNS configured, you must use your hosts file for name resolution.
15+
If you do not have DNS configured, use your hosts file for name resolution.
1616

1717
Edit the ``/etc/hosts`` file, and add the IP address and hostname of the Puppet master and agent:
1818

1919
.. code-block:: console
2020
21-
[puppet master ip] puppet puppet-master
22-
[puppet agent ip] puppet-agent
21+
<PUPPET_MASTER_IP> puppet puppet-master
22+
<PUPPET_AGENT_IP> puppet-agent
23+
24+
Where:
25+
26+
- ``PUPPET_MASTER_IP`` is the IP address of your Puppet master.
27+
- ``PUPPET_AGENT_IP`` is the IP address of your Puppet agent.
2328

2429

2530
Installation on CentOS/RHEL/Fedora
2631
----------------------------------
2732

28-
Install the Puppet yum repository and then the "puppet-agent" package. See this `index <https://yum.puppetlabs.com/>`_ to find the correct rpm file needed to install the puppet repo for your Linux distribution. For example, to install Puppet 7 for CentOS 7 or RHEL 7, do the following:
33+
See this `index <https://yum.puppetlabs.com/>`_ to find the correct rpm file to install the Puppet repo for your Linux distribution. For example, to install Puppet 7 for RHEL 9, do the following:
2934

30-
.. code-block:: console
35+
#. Install the Puppet yum repository and the puppet-agent package:
3136

32-
# sudo rpm -Uvh https://yum.puppetlabs.com/puppet7-release-el-8.noarch.rpm
33-
# yum -y install puppet-agent
37+
.. code-block:: console
3438
39+
# rpm -Uvh https://yum.puppetlabs.com/puppet7-release-el-9.noarch.rpm
40+
# yum -y install puppet-agent
3541
36-
Create a symbolic link between the installed binary file and your default binary file:
42+
#. Create a symbolic link between the installed binary file and your default binary file:
3743

38-
.. code-block:: console
44+
.. code-block:: console
3945
40-
# ln -s /opt/puppetlabs/bin/puppet /bin
46+
# ln -s /opt/puppetlabs/bin/puppet /usr/local/bin
4147
4248
4349
Installation on Debian/Ubuntu
4450
-----------------------------
4551

46-
The manifest supports the following releases to install wazuh.
52+
The manifest supports the following releases for installing Wazuh.
4753

4854
- **Debian**: 7 (wheezy), 8 (jessie), 9 (stretch), 10 (buster), 11 (bullseye), 12 (bookworm)
49-
- **Ubuntu**: 12.04 (Precise Pangolin), 14.04 (Trusty Tahr), 15.04 (Vivid Vervet), 15.10 (Wily Werewolf), 16.04 (Xenial Xerus), 16.10 (Yakkety Yak), 18.04 (Bionic Beaver), 20.04 (Focal Fossa), 22.04 (Jammy Jellyfish)
50-
51-
Install ``curl``, ``apt-transport-https`` and ``lsb-release``:
52-
53-
.. code-block:: console
5455

55-
# apt-get update
56-
# apt-get install curl apt-transport-https lsb-release wget
56+
- **Ubuntu**: 12.04 (Precise Pangolin), 14.04 (Trusty Tahr), 15.04 (Vivid Vervet), 15.10 (Wily Werewolf), 16.04 (Xenial Xerus), 16.10 (Yakkety Yak), 18.04 (Bionic Beaver), 20.04 (Focal Fossa), 22.04 (Jammy Jellyfish), 24.04 (Noble Numbat).
5757

58+
#. Install ``curl``, ``apt-transport-https`` and ``lsb-release``:
5859

59-
Install the appropriate Puppet apt repository, and then the “puppet-agent” package. See https://apt.puppetlabs.com to find the correct deb file to install the puppet repo for your Linux distribution.
60+
.. code-block:: console
61+
62+
# apt-get update
63+
# apt-get install curl apt-transport-https lsb-release wget
6064
61-
.. code-block:: console
6265
63-
# wget https://apt.puppet.com/puppet7-release-focal.deb
64-
# dpkg -i puppet7-release-focal.deb
65-
# apt-get update
66-
# apt-get install -y puppet-agent
66+
#. Install the appropriate Puppet apt repository, and then the “puppet-agent” package. See https://apt.puppetlabs.com for the correct Debian file to install the Puppet repo for your Linux distribution.
6767

68+
.. code-block:: console
69+
70+
# wget https://apt.puppet.com/puppet7-release-focal.deb
71+
# dpkg -i puppet7-release-focal.deb
72+
# apt-get update
73+
# apt-get install -y puppet-agent
6874
69-
Create a symbolic link between the installed binary file and your default binary file:
7075
71-
.. code-block:: console
76+
#. Create a symbolic link between the installed binary file and your default binary file:
7277

73-
# ln -s /opt/puppetlabs/bin/puppet /bin
78+
.. code-block:: console
79+
80+
# ln -s /opt/puppetlabs/bin/puppet /usr/local/bin
7481
7582
7683
Installation on Windows
@@ -90,41 +97,38 @@ Installation on Windows
9097

9198
- Execute the GUI with elevated privileges.
9299
- During installation, Puppet asks you for the hostname of your Puppet master server.
93-
- For standalone Puppet nodes that wont connect to a master, use the default hostname (`puppet`). You might also want to install it on the command line and set the agent startup mode to `Disabled`.
100+
- For standalone Puppet nodes that won't connect to a master, use the default hostname (puppet). You might also want to install it on the command line and set the agent startup mode to Disabled.
94101
- Once the installer finishes, Puppet will be installed and running.
95102

96103

97104
b. Using command line:
98105

99106
.. code-block:: console
100107
101-
msiexec /qn /norestart /i puppet-agent-<VERSION>-x64.msi
108+
> msiexec /qn /norestart /i puppet-agent-<VERSION>-x64.msi
102109
103-
Optionally, you can specify ``/l*v install.txt`` to log the installations progress to a file. You can also set several MSI properties to pre-configure Puppet as you install it.
110+
Specify ``/l*v install.txt`` to log the installation's progress to a file. You can also set several MSI properties to pre-configure Puppet as you install it.
104111

105112

106-
Agent Configuration
113+
Agent configuration
107114
^^^^^^^^^^^^^^^^^^^
108115

109-
To configure the Puppet agent, edit the configuration file in the node.
110-
111-
- ``/etc/puppetlabs/puppet/puppet.conf`` for Linux systems
112-
- ``C:\ProgramData\PuppetLabs\puppet\etc\puppet.conf`` for Windows systems
116+
To configure the Puppet agent, edit the configuration file on the node.
113117

114-
Add the ``server`` setting to the ``[main]`` section of the file. If you have set up your own DNS, replace ``puppet-master`` with the Fully Qualified Domain Name (FQDN) of your Puppet server.
118+
- ``/etc/puppetlabs/puppet/puppet.conf`` for Linux systems
115119

116-
.. code-block:: none
120+
- ``C:\ProgramData\PuppetLabs\puppet\etc\puppet.conf`` for Windows systems
117121

118-
[main]
119-
server = puppet-master
120-
122+
Add the ``server`` setting to the ``[main]`` section of the file. If you have set up your own DNS, replace puppet-master with the Fully Qualified Domain Name (FQDN) of your Puppet server.
121123

122-
.. note:: The Puppet server FQDN should be resolved by the Puppet agent host.
124+
.. code-block:: none
123125
126+
[main]
127+
server = puppet-master
124128
125129
Restart and check the status of the Puppet service:
126130

127131
.. code-block:: console
128132
129133
# puppet resource service puppet ensure=running enable=true
130-
# sudo systemctl status puppet
134+
# systemctl status puppet

source/deployment-options/deploying-with-puppet/setup-puppet/install-puppet-master.rst

Lines changed: 51 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -8,101 +8,94 @@
88
Installing Puppet master
99
========================
1010

11-
This section explains how to install *puppet-master*. Follow this link to check the `official installation guide <https://puppet.com/docs/puppetserver/latest/install_from_packages.html>`_.
12-
13-
If you do not have DNS configured, you must use your hosts file for name resolution.
14-
Edit the ``/etc/hosts`` file and add the following:
15-
16-
.. code-block:: console
17-
18-
[puppet master ip] puppet puppet-master
19-
[puppet agent ip] puppet-agent
2011

2112

2213
Installation on CentOS/RHEL/Fedora
23-
----------------------------------
24-
25-
Install the Puppet yum repository and then the “puppetserver” package. See this `index <https://yum.puppetlabs.com/>`_ to find the correct rpm file needed to install the puppet repo for your Linux distribution. For example, to install Puppet 7 for CentOS 8 or RHEL 8, do the following:
14+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2615

27-
.. code-block:: console
16+
#. Install the Puppet yum repository and then the "puppetserver" package. See this `index <https://yum.puppetlabs.com/>`_ for the correct RPM file to install the Puppet repo for your Linux distribution. For example, to install Puppet 7 for RHEL 9, do the following:
2817

29-
# sudo rpm -Uvh https://yum.puppetlabs.com/puppet7-release-el-8.noarch.rpm
30-
# yum -y install puppetserver
18+
.. code-block:: console
3119
20+
# rpm -Uvh https://yum.puppetlabs.com/puppet7-release-el-9.noarch.rpm
21+
# yum -y install puppetserver
3222
33-
Create a symbolic link between the installed binary file and your default binary file:
23+
#. Create a symbolic link between the installed binary file and your default binary file:
3424

35-
.. code-block:: console
25+
.. code-block:: console
3626
37-
# ln -s /opt/puppetlabs/bin/puppet /bin
38-
# ln -s /opt/puppetlabs/server/bin/puppetserver /bin
27+
# ln -s /opt/puppetlabs/bin/puppet /usr/local/bin
28+
# ln -s /opt/puppetlabs/server/bin/puppetserver /usr/local/bin
3929
4030
Installation on Debian/Ubuntu
41-
-----------------------------
31+
------------------------------
4232

43-
The manifest supports the following releases to install wazuh.
33+
The manifest supports the following releases for installing Wazuh.
4434

4535
- **Debian**: 7 (wheezy), 8 (jessie), 9 (stretch), 10 (buster), 11 (bullseye), 12 (bookworm)
4636
- **Ubuntu**: 12.04 (Precise Pangolin), 14.04 (Trusty Tahr), 15.04 (Vivid Vervet), 15.10 (Wily Werewolf), 16.04 (Xenial Xerus), 16.10 (Yakkety Yak), 18.04 (Bionic Beaver), 20.04 (Focal Fossa), 22.04 (Jammy Jellyfish)
4737

48-
Install ``curl``, ``apt-transport-https`` and ``lsb-release``:
38+
#. Install ``curl``, ``apt-transport-https``, and ``lsb-release``:
4939

50-
.. code-block:: console
40+
.. code-block:: console
5141
52-
# apt-get update
53-
# apt-get install curl apt-transport-https lsb-release wget
42+
# apt-get update
43+
# apt-get install curl apt-transport-https lsb-release wget
5444
45+
#. Install the appropriate Puppet apt repository, and then the "puppetserver" package. See https://apt.puppetlabs.com to find the correct Debian file to install the Puppet 8 repo for your Linux distribution.
5546

56-
Install the appropriate Puppet apt repository, and then the “puppetserver” package. See https://apt.puppetlabs.com to find the correct deb file to install the Puppet 7 repo for your Linux distribution.
47+
.. code-block:: console
5748
58-
.. code-block:: console
49+
# wget https://apt.puppet.com/puppet7-release-focal.deb
50+
# dpkg -i puppet7-release-focal.deb
51+
# apt-get update
52+
# apt-get install -y puppetserver
5953
60-
# wget https://apt.puppet.com/puppet7-release-focal.deb
61-
# dpkg -i puppet7-release-focal.deb
62-
# apt-get update
63-
# apt-get install -y puppetserver
54+
#. Create a symbolic link between the installed binary file and your default binary file:
6455

56+
.. code-block:: console
6557
66-
Create a symbolic link between the installed binary file and your default binary file:
58+
# ln -s /opt/puppetlabs/bin/puppet /usr/local/bin
59+
# ln -s /opt/puppetlabs/server/bin/puppetserver /usr/local/bin
6760
68-
.. code-block:: console
6961
70-
# ln -s /opt/puppetlabs/bin/puppet /bin
71-
# ln -s /opt/puppetlabs/server/bin/puppetserver /bin
62+
Memory allocation
63+
-----------------
7264

65+
By default, Puppet Server will be configured to use 2GB of RAM. However, if you want to experiment with Puppet Server on a VM, you can safely allocate as little as 512MB of memory. You can edit the init config file to change Puppet Server memory allocation.
7366

74-
Memory Allocation
75-
-----------------
67+
.. tabs::
68+
69+
.. group-tab:: CentOS/RHEL/Fedora
70+
71+
.. code-block:: none
7672
77-
By default, Puppet Server will be configured to use 2GB of RAM. However, if you want to experiment with Puppet Server on a VM, you can safely allocate as little as 512MB of memory. To change Puppet Server memory allocation, you can edit the following init config file.
73+
/etc/sysconfig/puppetserver
7874
79-
* ``/etc/sysconfig/puppetserver`` -- CentOS/RHEL/Fedora
80-
* ``/etc/default/puppetserver`` -- Debian/Ubuntu
75+
.. group-tab:: Debian/Ubuntu
8176

82-
Replace 2g in the ``JAVA_ARGS`` variable with the amount of memory you want to allocate to Puppet Server. For example, to allocate 1GB of memory, use ``JAVA_ARGS="-Xms1g -Xmx1g"``; for 512MB, use ``JAVA_ARGS="-Xms512m -Xmx512m"``.
77+
.. code-block:: none
78+
79+
/etc/default/puppetserver
80+
81+
Replace 2g in the ``JAVA_ARGS`` variable with the memory you want to allocate to Puppet Server. For example, to allocate 1GB of memory, use ``JAVA_ARGS="-Xms1g -Xmx1g"``; for 512MB, use ``JAVA_ARGS="-Xms512m -Xmx512m"``.
8382

8483
Configuration
8584
-------------
8685

87-
Edit the ``/etc/puppetlabs/puppet/puppet.conf`` file to configure the Puppet server. Add the following settings to the ``[main]`` section. You need to create the section if it doesn't exist. If you have set up your own DNS, replace ``puppet`` and ``puppet-master`` with your Fully Qualified Domain Names (FQDNs).
86+
Edit the ``/etc/puppetlabs/puppet/puppet.conf`` file to configure the Puppet server. Add the following settings to the ``[server]`` section. You need to create the section if it doesn't exist. If you have set up your own DNS, replace ``puppet`` and ``puppet-master`` with your Fully Qualified Domain Names (FQDNs).
8887

8988
.. code-block:: none
9089
91-
[main]
90+
[server]
9291
server = puppet-master
9392
dns_alt_names = puppet, puppet-master
9493
9594
.. note:: If you find ``templatedir=$confdir/templates`` in the config file, delete that line. It has been deprecated.
9695

9796

98-
For Ubuntu/Debian machines, in case puppetserver does not start. Edit the puppetserver file, ``/etc/default/puppetserver``. Modify the following line to change the memory size to 1G or 512MB:
99-
100-
.. code-block:: console
101-
102-
JAVA_ARGS="-Xms512m -Xmx512m -Djruby.logger.class=com.puppetlabs.jruby_utils.jruby.Slf4jLogger"
10397

104-
105-
Then, start your Puppet Server:
98+
Start your Puppet Server:
10699

107100
.. tabs::
108101

@@ -120,3 +113,11 @@ Then, start your Puppet Server:
120113
121114
# service puppetserver start
122115
# update-rc.d puppetserver
116+
117+
.. note::
118+
119+
For Ubuntu/Debian machines, in case puppetserver does not start due to a lack of memory. Edit the ``/etc/default/puppetserver`` config file. Modify the following line to change the memory size to 1GB or 512MB:
120+
121+
.. code-block:: console
122+
123+
JAVA_ARGS="-Xms512m -Xmx512m -Djruby.logger.class=com.puppetlabs.jruby_utils.jruby.Slf4jLogger"

0 commit comments

Comments
 (0)