skord/chef-graylog2

A Chef cookbook to install and configure the Graylog2 log management tool.

Description

A cookbook for Opscodes Chef open-source systems integration framework to install and configure the Graylog2 Server and Web-Interface.

Graylog2 is an open source log management solution that stores your logs in ElasticSearch. It consists of a server written in Java that accepts your syslog messages via TCP, UDP or AMQP and stores it in the database. The second part is a web interface that allows you to manage the log messages from your web browser.

http://www.graylog2.org

Requirements

Platform

The Cookbooks is build for the following platforms:

• Debian, Ubuntu
• CentOS, Red Hat

The Cookbooks is tested on the following platforms:

• Debian 6.05
• Ubuntu 10.04-4, 12.04
• CentOS 5.8, 6.2

Cookbooks

To install the coockbook use the following commands, depending to your platform:

gem install librarian
cd chef-repo
librarian-chef init

cat >> Cheffile <<END_OF_CHEFFILE
cookbook 'apt', :git => 'https://github.com/opscode-cookbooks/apt.git'
cookbook 'yum', :git => 'https://github.com/opscode-cookbooks/yum.git'
cookbook 'java', :git => 'https://github.com/opscode-cookbooks/java.git'
cookbook 'elasticsearch', :git => 'https://github.com/sebwendel/chef-elasticsearch.git'
cookbook 'mongodb', :git => 'https://github.com/sebwendel/chef-mongodb.git'
cookbook 'rvm', :git => 'https://github.com/fnichol/chef-rvm.git'
cookbook 'apache2', :git => 'https://github.com/opscode-cookbooks/apache2.git'
cookbook 'graylog2', :git => 'https://github.com/sebwendel/chef-graylog2.git'
END_OF_CHEFFILE

librarian-chef install

knife cookbook upload apt yum java elasticsearch mongodb rvm apache2 graylog2

Recipes

The cookbock provides the following recipes:

• recipe[graylog2] - Deploye the graylog2 server and web-interface.
• recipe[graylog2::server] - Just deploye the graylog2 server.
• recipe[graylog2::web-interface] - Just deploye the graylog2 web-interface.

This will install the java dependencie, the graylog2 server and the declared plugins.

Attributes

The Cookbook comes with a bunch of attributes the following are the the most important. All attributes work out of the box but can be overridden.

Version

• default['graylog2']['server_version'] - Specify the server version you want to install, default is "0.9.6p1".
• default['graylog2']['web_version'] - Specify the web-inteface version you want to install, default is "0.9.6p1".

EMail

• default['graylog2']['email_host'] - Specify the mail server to send the reports, default is "127.0.0.1".
• default['graylog2']['email_port'] - Specify the mail servers port, default is "25".
• default['graylog2']['email_auth'] - Specify the mail merver authentication protocol, default is "plain".
• default['graylog2']['email_user'] - Specify the mail server user for authentication, default is "nil".
• default['graylog2']['email_passwd'] - Specify the mail server password for authentication, default is "nil".
• default['graylog2']['email_address'] - Specify the senders mail address, default is "graylog2@#{node['fqdn']}".
• default['graylog2']['email_domain'] - Specify the senders mail domain, default is "127.0.0.1".

Reports

• default['graylog2']['stream_alarms_cron_minute'] - Specify the cron cycle to send alarm, default is 15 minutes.
• default['graylog2']['stream_subscriptions_cron_minute'] - Specify the cron cycle to send subscriptions, default is 15 minutes.

For a better understanding of which configuration parameters are available have a look in the default attributes file.

Usage

1. download and install all dependencies

2. override the attributes if necessary

3. check all interface, port and authentication config

4. add the recipe to your nodes runlist

   { "run_list": [ "recipe[graylog2]" ] }

If you use all dependencies from the described sources the cookbook should work out of the box without any changes of attributes.

Limitations and Issues

If you have any questions or recommendations just create a issue at the github repository. If you want to help have a lock at the github issues section, patches are more than welcome.

• For now there is no authentication on the backend side.
• All dependencies will be automatically installed and cannot be define alternatively.

License and Author

Author: Sebastian Wendel, ([email protected])

Copyright: 2012, SourceIndex IT-Serives

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.