- 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
This module can be used to install and configure a Graylog system. (https://www.graylog.org/)
Native types to configure dashboards, inputs, streams and others are provided by the community maintained puppet-graylog_api module.
The graylog module manages the following things:
- APT/YUM repository
- Graylog packages
- Graylog configuration files
- Graylog service
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:
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.
Use the following command to install the graylog module via the Puppet module tool.
puppet module install graylog/graylog
Add the following snippet to your Puppetfile.
mod 'graylog/graylog', 'x.x.x'
Make sure to use the latest version of the graylog module!
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
}
}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:[email protected]:27017,mongodb02.domain.local:27017,mongodb03.domain.local:27017/graylog',
},
}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
graylog::params: Default settings for different platformsgraylog::repository::apt: Manages APT repositoriesgraylog::repository::yum: Manages YUM repositories
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'
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.
This setting is used to facilitate package installation with proxy.
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.
The graylog::server class configures the Graylog server service.
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'
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'
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,
}
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.
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.
This setting is used to configure if the Graylog service should be running or
not. It defaults to running.
Available options: running, 'stopped'
This setting is used to configure if the Graylog service should be enabled.
It defaults to true.
Sets the initial Java heap size (-Xms) for Graylog. Defaults to 1g.
Sets the maximum Java heap size (-Xmx) for Graylog. Defaults to 1g.
Additional java options for Graylog. Defaults to ``.
This setting restarts the graylog-server service if the os package is upgraded.
It defaults to false.
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:
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',
}
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
},
}
Supported Graylog versions:
- 5.x
Supported platforms:
- Ubuntu/Debian
- RedHat/CentOS
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.
- 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
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent