Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
- Puppet >= 6.21.0 < 8.0.0
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'graylog-graylog', '2.0.0'Learn more about managing modules with a PuppetfileDocumentation
Graylog Puppet Module
Table of Contents
- Description
- Setup - The basics of getting started with graylog
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
This module can be used to install and configure a Graylog system. (https://www.graylog.org/)
Native Types
Native types to configure dashboards, inputs, streams and others are provided by the community maintained puppet-graylog_api module.
Setup
What graylog affects
The graylog module manages the following things:
- APT/YUM repository
- Graylog packages
- Graylog configuration files
- Graylog service
Setup Requirements
The module only manages Graylog itself. You need other modules to install the required dependencies like MongoDB and OpenSearch.
You could use the following modules to install dependencies:
Beginning with graylog
The following modules are required to use the graylog module:
Those dependencies are automatically installed if you are using the Puppet module tool or something like librarian-puppet.
Puppet Module Tool
Use the following command to install the graylog module via the Puppet module tool.
puppet module install graylog/graylog
librarian-puppet
Add the following snippet to your Puppetfile.
mod 'graylog/graylog', 'x.x.x'
Make sure to use the latest version of the graylog module!
Usage
As mentioned above, the graylog module only manages the Graylog system. Other requirements like MongoDB and OpenSearch need to be managed via other modules.
The following config creates a setup with MongoDB, OpenSearch and Graylog on a single node.
class { 'mongodb::globals':
manage_package_repo => true,
}->
class { 'mongodb::server':
bind_ip => ['127.0.0.1'],
}
class { 'opensearch':
version => '2.9.0',
}
class { 'graylog::repository':
version => '5.1'
}->
class { 'graylog::server':
package_version => '5.1.0-6',
config => {
'password_secret' => '...', # Fill in your password secret
'root_password_sha2' => '...', # Fill in your root password hash
}
}
A more complex example
class { '::graylog::repository':
version => '5.1'
}->
class { '::graylog::server':
config => {
is_leader => true,
node_id_file => '/etc/graylog/server/node-id',
password_secret => 'password_secret',
root_username => 'admin',
root_password_sha2 => 'root_password_sha2',
root_timezone => 'Europe/Berlin',
allow_leading_wildcard_searches => true,
allow_highlighting => true,
http_bind_address => '0.0.0.0:9000',
http_external_uri => 'https://graylog01.domain.local:9000/',
http_enable_tls => true,
http_tls_cert_file => '/etc/ssl/graylog/graylog_cert_chain.crt',
http_tls_key_file => '/etc/ssl/graylog/graylog_key_pkcs8.pem',
http_tls_key_password => 'sslkey-password',
rotation_strategy => 'time',
retention_strategy => 'delete',
elasticsearch_max_time_per_index => '1d',
elasticsearch_max_number_of_indices => '30',
elasticsearch_shards => '4',
elasticsearch_replicas => '1',
elasticsearch_index_prefix => 'graylog',
elasticsearch_hosts => 'http://opensearch01.domain.local:9200,http://opensearch02.domain.local:9200',
mongodb_uri => 'mongodb://mongouser:mongopass@mongodb01.domain.local:27017,mongodb02.domain.local:27017,mongodb03.domain.local:27017/graylog',
},
}
Reference
Classes
Public Classes
graylog::repository: Manages the official Graylog package repositorygraylog::server: Installs, configures and manages the Graylog server servicegraylog::allinone: Creates a full Graylog setup including MongoDB and OpenSearch
Private Classes
graylog::params: Default settings for different platformsgraylog::repository::apt: Manages APT repositoriesgraylog::repository::yum: Manages YUM repositories
Class: graylog::repository
version
This setting is used to set the repository version that should be used to install the Graylog package. The Graylog package repositories are separated by major version.
It defaults to $graylog::params::major_version.
Example: version => '5.1'
url
This setting is used to set the package repository url.
Note: The module automatically detects the url for your platform so this setting should not be changed.
proxy
This setting is used to facilitate package installation with proxy.
release
This setting is used to set the package repository release.
Note: The Graylog package repositories only use stable as a release so
this setting should not be changed.
Class: graylog::server
The graylog::server class configures the Graylog server service.
package_name
This setting is used to choose the Graylog package name. It defaults to
graylog-server to install Graylog Open. You can use graylog-enterprise
to install the Graylog Enterprise package.
Example: package_name => 'graylog-server'
package_version
This setting is used to choose the Graylog package version. It defaults to
installed which means it installs the latest version that is available at
install time. You can also use latest so it will always update to the latest
stable version if a new one is available.
Example: package_version => '5.1.0-6'
config
This setting is used to specify the Graylog server configuration. The server configuration consists of key value pairs. Every available config option can be used here.
See the example graylog.conf to see a list of available options.
Required settings:
password_secretroot_password_sha2
Please find some default settings in $graylog::params::default_config.
Example:
config => {
'password_secret' => '...',
'root_password_sha2' => '...',
'is_leader' => true,
'output_batch_size' => 2500,
}
user
This setting is used to specify the owner for files and directories.
Note: This defaults to graylog because the official Graylog package uses
that account to run the server. Only change it if you know what you are doing.
group
This setting is used to specify the group for files and directories.
Note: This defaults to graylog because the official Graylog package uses
that account to run the server. Only change it if you know what you are doing.
ensure
This setting is used to configure if the Graylog service should be running or
not. It defaults to running.
Available options: running, 'stopped'
enable
This setting is used to configure if the Graylog service should be enabled.
It defaults to true.
java_initial_heap_size
Sets the initial Java heap size (-Xms) for Graylog. Defaults to 1g.
java_max_heap_size
Sets the maximum Java heap size (-Xmx) for Graylog. Defaults to 1g.
java_opts
Additional java options for Graylog. Defaults to ``.
restart_on_package_upgrade
This setting restarts the graylog-server service if the os package is upgraded.
It defaults to false.
Class: graylog::allinone
The graylog::allinone class configures a complete Graylog system including
MongoDB and OpenSearch
Note: This is nice to quickly setup a running system on a single node but
should only be used for testing or really small setups.
Use the graylog::server class for production deployments.
This class is using two Puppet modules from the forge to setup a complete system.
Please make sure you have these installed before using the graylog::allinone class.
Requirements:
opensearch
This setting is used to configure the opensearch Puppet module.
There is only on possible hash key:
version: The OpenSearch version to use
Example:
opensearch => {
version => '2.9.0',
}
graylog
This setting is used to configure the graylog::repository and graylog::server
classes.
Example:
graylog => {
major_version => '5.1',
config => {
# ... see graylog::server description for details
},
}
Limitations
Supported Graylog versions:
- 5.x
Supported platforms:
- Ubuntu/Debian
- RedHat/CentOS
Development
You can test this module by using Vagrant.
It uses the graylog::allinone class to setup a complete system inside
the Vagrant box.
$ vagrant up rockylinux8
$ vagrant provision rockylinux8
This is a quick way to see how the module behaves on a real machine.
Please see the CONTRIBUTING.md and CODE_OF_CONDUCT.md files for further details.
Release New Version
- Update and commit CHANGELOG
- Bump version via
bundle exec rake -f Rakefile.release module:bump:minor(or major/patch) - Commit
metadata.json - Test build with
bundle exec rake -f Rakefile.release module:build - Tag release with
bundle exec rake -f Rakefile.release module:tag - Push release to PuppetForge with
bundle exec -f Rakefile.release rake module:push - Push commits and tags to GitHub with
git push --follow-tags
2.0.0 (2023-08-14)
ATTENTION: This major release removes support for Graylog versions < 5.0
and switches the graylog::allinone module from Elasticsearch to OpenSearch.
- Add
java_optsconfig option to configure addition Java options. (#52, @timdeluxe) - Add stdlib 9.x compatibility. (#59, @cruelsmith)
- Replace deprecated
is_masterflag withis_leader. (#57) - Update default Graylog version to 5.1.
- Disable
JAVAsetting in environment file by default. (#60) - Update PDK to 3.0.
- Switch default MongoDB version to 5.0.19 in
graylog::allinone. - Add
package_namesetting forgraylog::server. - Remove java module requirement from documentation.
- Replace Elasticsearch with OpenSearch in
graylog::allinone. - Remove support for Graylog < 5.0.
1.0.0 (2021-10-25)
- Add ability to update Java Heapsize. (#47)
- Add ability to restart service on package upgrade. (#48, @clxnetom)
- Convert module to PDK. (#33)
0.9.1 (2021-10-21)
- Update the module to use the latest version of Graylog. (#44)
0.9.0 (2019-08-01)
- Fix problem with missing "/etc/apt/apt.conf.d" directory (#31)
- Attention: This also changes the proxy configuration file from
/etc/apt/apt.conf.d/01proxyto/etc/apt/apt.conf.d/01_graylog_proxy. Make sure to remove the old one when upgrading this module.
- Attention: This also changes the proxy configuration file from
- Run apt-get update after adding repo and before installing server package (#32)
0.8.0 (2019-02-14)
- Update for Graylog 3.0.0
- Add capability for installation behind proxy (yum/apt) (#20)
- Don't force
show_difftotrue(#24) - Bump required stdlib version to 4.16 for the length function (#23)
0.7.0 (2018-11-30)
- Update for Graylog 2.5.0
- Allow puppetlabs-apt < 7.0.0, puppetlabs-stdlib < 6.0.0 (#27)
0.6.0 (2018-02-02)
- Replace deprecated size() with length() (#22, #21)
- Replace deprecated elasticsearch module references (#17)
- Replace deprecated mongodb module references
- Allow puppetlabs/apt module version >3.0.0 (#16)
0.5.0 (2017-12-22)
- Update for Graylog 2.4.0
0.4.0 (2017-07-26)
- Update for Graylog 2.3.0
0.3.0 (2017-03-06)
- Adding a more complex example to README (#11)
- Fix variable scoping (#12, #10)
- Prepare for Graylog 2.2.0
- Fix dependency declaration in metadata.json (#8)
- Replace own custom function with
mergefrom stdlib. (#4) - Make the Vagrant setup work (#3)
0.2.0 (2016-09-01)
- Use Graylog 2.1.0 as default version
- Fixed a typo in the README
0.1.0 (2016-04-29)
Initial Release
Dependencies
- puppetlabs/stdlib (>= 4.16.0 < 10.0.0)
- puppetlabs/apt (>= 2.2.2 < 9.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.