cookbook 'beaver', '= 0.1.0'
beaver (8) Versions 0.1.0 Follow5
Installs/Configures beaver
cookbook 'beaver', '= 0.1.0', :supermarket
knife supermarket install beaver
knife supermarket download beaver
beaver Cookbook
Install beaver — the python daemon that munches on logs and sends their
contents to logstash.
Requirements
Ohai and Chef:
This cookbook makes use of node['platform_family'] to simplify
platform selection logic. This attribute was introduced in Ohai v0.6.12.
Platform:
The following platform families are supported:
- Debian
Cookbooks
- python (to use the pip LWRP)
Attributes
beaver::default
| Key | Type | Description | Default |
|---|---|---|---|
| <tt>['beaver']['version']</tt> | String | Version to install via pip | <tt>29</tt> |
| <tt>['beaver']['log_path']</tt> | String | Log path | <tt>/var/log</tt> |
| <tt>['beaver']['log_file']</tt> | String | Log file | <tt>beaver.log</tt> |
| <tt>['beaver']['config_path']</tt> | String | Configuration path | <tt>/etc/beaver</tt> |
| <tt>['beaver']['config_file']</tt> | String | Configuration file | <tt>beaver.conf</tt> |
| <tt>['beaver']['respawn_delay']</tt> | String | Initial respawn delay for exponential backoff | <tt>3</tt> |
| <tt>['beaver']['max_failure']</tt> | String | Max failures before exponential backoff terminates | <tt>7</tt> |
| <tt>['beaver']['sincedb_path']</tt> | String | Full path to an sqlite3 database. Will be created at this path if it does not exist. | <tt>7</tt> |
| <tt>['beaver']['transport']</tt> | String | Either redis, mqtt, rabbitmq, sqs_aws, udp or zeromq | <tt>redis</tt> |
| <tt>['beaver']['format']</tt> | String | Format to use when sending to transport: either json, msgpack, string. | <tt>redis</tt> |
| <tt>['beaver']['redis']['url']</tt> | String | Redis URL | <tt>redis://localhost:6379/0</tt> |
| <tt>['beaver']['redis']['namespace']</tt> | String | Redis namespace | <tt>logstash:beaver</tt> |
| <tt>['beaver']['mqtt']['host']</tt> | String | Host for mosquitto | <tt>localhost</tt> |
| <tt>['beaver']['mqtt']['port']</tt> | Integer | Port for mosquitto | <tt>1883</tt> |
| <tt>['beaver']['mqtt']['clientid']</tt> | String | Clientid for mosquitto | <tt>mosquitto</tt> |
| <tt>['beaver']['mqtt']['keepalive']</tt> | Integer | Keepalive for mosquitto | <tt>60</tt> |
| <tt>['beaver']['mqtt']['topic']</tt> | String | Topic for mosquitto | <tt>/logstash</tt> |
| <tt>['beaver']['rabbitmq']['host']</tt> | String | Host for rabbitmq | <tt>localhost</tt> |
| <tt>['beaver']['rabbitmq']['port']</tt> | Integer | Port for rabbitmq | <tt>5672</tt> |
| <tt>['beaver']['rabbitmq']['vhost']</tt> | String | Vhost for rabbitmq | <tt>/</tt> |
| <tt>['beaver']['rabbitmq']['vhost']</tt> | String | Vhost for rabbitmq | <tt>/</tt> |
| <tt>['beaver']['rabbitmq']['username']</tt> | String | Username for rabbitmq | <tt>guest</tt> |
| <tt>['beaver']['rabbitmq']['password']</tt> | String | Password for rabbitmq | <tt>guest</tt> |
| <tt>['beaver']['rabbitmq']['queue']</tt> | String | Queue for rabbitmq | <tt>logstash-queue</tt> |
| <tt>['beaver']['rabbitmq']['exchange_type']</tt> | String | Exchange-type for rabbitmq | <tt>direct</tt> |
| <tt>['beaver']['rabbitmq']['exchange_durable']</tt> | Integer | Whether this exchange should be durable | <tt>0</tt> |
| <tt>['beaver']['rabbitmq']['key']</tt> | String | Key for rabbitmq | <tt>logstash-key</tt> |
| <tt>['beaver']['rabbitmq']['exchange']</tt> | String | Exchange for rabbitmq | <tt>logstash-exchange</tt> |
| <tt>['beaver']['sqs_aws']['access_key']</tt> | String | Access Key for AWS SQS | <tt></tt> |
| <tt>['beaver']['sqs_aws']['secret_key']</tt> | String | Secret Key for AWS SQS | <tt></tt> |
| <tt>['beaver']['sqs_aws']['region']</tt> | String | AWS region to use | <tt>us-east-1</tt> |
| <tt>['beaver']['sqs_aws']['queue']</tt> | String | Queue to use | <tt>us-east-1</tt> |
| <tt>['beaver']['udp']['host']</tt> | String | UDP host to send to | <tt>127.0.0.1</tt> |
| <tt>['beaver']['udp']['port']</tt> | Integer | UDP port to send to | <tt>127.0.0.1</tt> |
| <tt>['beaver']['zeromq']['address']</tt> | String | ZeroMQ address | <tt>tcp://localhost:2120</tt> |
| <tt>['beaver']['zeromq']['hwm']</tt> | String | High Watermark for ZeroMQ | <tt></tt> |
| <tt>['beaver']['zeromq']['bind']</tt> | String | Whether to bind ZeroMQ | <tt></tt> |
| <tt>['beaver']['use_tunnel']</tt> | Boolean | Use the selected transport through an ssh tunnel? | <tt>false</tt> |
| <tt>['beaver']['ssh']['tunnel']</tt> | String | SSH Tunnel in the format user@host:port | <tt>nil</tt> |
| <tt>['beaver']['ssh']['key_file']</tt> | String | Path to id_rsa key file relative to config_dir
|
<tt>id_rsa</tt> |
| <tt>['beaver']['ssh']['tunnel_port']</tt> | Integer | Port to have locally for tunnel | <tt>6379</tt> |
| <tt>['beaver']['ssh']['remote_host']</tt> | String | Remote host of ssh tunnel | <tt>localhost</tt> |
| <tt>['beaver']['ssh']['remote_port']</tt> | Integer | Remote port of ssh tunnel | <tt>6379</tt> |
| <tt>['beaver']['ssh']['generate_keypair']</tt> | Boolean | Whether to generate and expose keypair or not | <tt>false</tt> |
Usage
beaver::default
Just include beaver in your node's run_list:
{
"name":"my_node",
"run_list": [
"recipe[beaver]"
]
}
And configure beaver either in role or on the node. If you set
['beaver']['ssh']['generate_keypair'] to true the cokbook will create
a public-key pair in the config_path and will expose the public key on
the node. This key can then be searched by e.g. the logstash host and
grant password-free access to tunnel e.g. redis (or anything else)
through it.
Contributing
- Fork the repository on Github
- Create a named feature branch (like
add_component_x) - Write you change
- Write tests for your change (if applicable)
- Run the tests, ensuring they all pass
- Submit a Pull Request using Github
Authors
- Andreas Lappe
License
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.
