cookbook 'aerospike-cluster', '= 0.1.0'
aerospike-cluster (8) Versions 0.1.0 Follow1
Installs/Configures aerospike-cluster
cookbook 'aerospike-cluster', '= 0.1.0', :supermarket
knife supermarket install aerospike-cluster
knife supermarket download aerospike-cluster
aerospike-cluster Cookbook
This is a Chef cookbook to manage Aerospike.
Repository
https://github.com/vkhatri/chef-aerospike-cluster
Supported OS
This cookbook was tested on Amazon Linux & Ubuntu 14.04 and expected to work on other RHEL platforms.
Supported Edition
Currently cookbook only supports Aerospike Community
edition. Enterprise
edition support will be added over time.
Installation Method
Currently cookbook only supports Aerospike tarball
installtion. Package
installation will be added soon.
TODO
- add support for
enterprise
edition - add
package
installation - add
specs
- manage aerospike
dependencies
, e.g. python-bcrypt etc. - add
role
examples
Recipes
aerospike-cluster::default
- default recipe (use it for run_list)aerospike-cluster::attributes
- aerospike derived attributesaerospike-cluster::install
- install aerospikeaerospike-cluster::user
- setup aerospike useraerospike-cluster::tarball
- aerospike tarball installationaerospike-cluster::package
- aerospike package installationaerospike-cluster::config
- configure aerospike
Advanced Attributes
default['aerospike']['version']
(default:3.6.3
): aerospike versiondefault['aerospike']['tarball_url']
(default:auto
): aerospike tarball urldefault['aerospike']['notify_restart']
(default:true
): whether to restart aerospike service on configuration file changedefault['aerospike']['install_method']
(default:tarball
): aerospike install method, options: tarballdefault['aerospike']['install_edition']
(default:community
): aerospike edition, options: communitydefault['aerospike']['tarball_purge']
(default:false
): whether to purge old tarball versionsdefault['aerospike']['cookbook']
(default:aerospike-cluster
): whether to purge old tarball versions
Core Attributes
default['aerospike']['user']
(default:user
): aerospike user namedefault['aerospike']['group']
(default:user
): aerospike group namedefault['aerospike']['setup_user']
(default:true
): setup aerospike user for tarball install methoddefault['aerospike']['conf_dir']
(default:/etc/aerospike
): aerospike yaml configuration file directorydefault['aerospike']['conf_file']
(default:/etc/aerospike/aerospike.conf
): aerospike configuration filedefault['aerospike']['log_dir']
(default:/var/log/aerospike
): aerospike log file directorydefault['aerospike']['log_file']
(default:/var/log/aerospike/aerospike.log
): aerospike log filedefault['aerospike']['data_dir']
(default:/var/lib/aerospike
): aerospike data directorydefault['aerospike']['parent_dir']
(default:/usr/local/aerospike
): aerospike tarball setup directorydefault['aerospike']['service_action']
(default:[:enable, :restart]
): aerospike service resource actiondefault['aerospike']['umask']
(default:0022
): umask for execute resourcedefault['aerospike']['mode']
(default:0755
): file directory default permission
Configuration File aerospike.conf Attributes
-
default['aerospike']['config_attribute']
(default:config
): aerospike configuration node attribute
Note:
aerospike.conf
is dynamically generated and few of the attributes are managed differently, likedefault['aerospike']['config']['service']['logging']['file <calculated log file /var/log/aerospike/aerospike.log']['context']
,default['aerospike']['config']['network']['heartbeat']['mesh-seed-address-port']
anddefault['aerospike']['config']['namespace']['test']['storage-engine device']['scheduler-mode']
. Please check out helper methodas_config_generator
for more details.
Configuration File aerospike.conf service {} Attributes
default['aerospike']['config']['service']['user']
(default:root
): aerospike configuration attributedefault['aerospike']['config']['service']['group']
(default:root
): aerospike configuration attributedefault['aerospike']['config']['service']['paxos-single-replica-limit']
(default:1
): aerospike configuration attributedefault['aerospike']['config']['service']['pidfile']
(default:/var/run/aerospike/asd.pid
): aerospike configuration attributedefault['aerospike']['config']['service']['service-threads']
(default:4
): aerospike configuration attributedefault['aerospike']['config']['service']['transaction-queues']
(default:4
): aerospike configuration attributedefault['aerospike']['config']['service']['transaction-threads-per-queue']
(default:4
): aerospike configuration attributedefault['aerospike']['config']['service']['proto-fd-max']
(default:15000
): aerospike configuration attribute
Configuration File aerospike.conf logging {} Attributes
-
default['aerospike']['config']['logging']['file config_log_file']['context']
(default:any info
): aerospike log file context
config_log_file
location is calculated dynamically
Configuration File aerospike.conf mod-lua {} Attributes
default['aerospike']['config']['mod-lua']['user-path']
(default:/opt/aerospike/usr/udf/lua
): aerospike mod-lua attributedefault['aerospike']['config']['mod-lua']['system-path']
(default:/opt/aerospike/sys/udf/lua
): aerospike mod-lua attribute
Configuration File aerospike.conf network {} Attributes
default['aerospike']['config']['network']['service']['address']
(default:any
): aerospike configuration attributedefault['aerospike']['config']['network']['service']['port']
(default:3000
): aerospike configuration attributedefault['aerospike']['config']['network']['heartbeat']['mode']
(default:mesh
): aerospike configuration attributedefault['aerospike']['config']['network']['heartbeat']['address']
(default:node['ipaddress']
): aerospike configuration attributedefault['aerospike']['config']['network']['heartbeat']['port']
(default:3002
): aerospike configuration attributedefault['aerospike']['config']['network']['heartbeat']['mesh-seed-address-port']
(default:[]
): aerospike unicast cluster seed ip addresses
as
mesh-seed-address-port
accepts multiple values, variable type is set toArray
and parameter is rendered differently in helper methodas_config_generator
default['aerospike']['config']['network']['heartbeat']['interval']
(default:150
): aerospike configuration attributedefault['aerospike']['config']['network']['heartbeat']['timeout']
(default:10
): aerospike configuration attributedefault['aerospike']['config']['network']['fabric']['port']
(default:3001
): aerospike configuration attributedefault['aerospike']['config']['network']['heartbeat']['info']
(default:3003
): aerospike configuration attribute
Configuration File aerospike.conf namespace {} Attributes
namespace configuration can be added to
aerospike.conf
configuration file via attributedefault['aerospike']['config']['namespace']['NAMESPACE_NAME']['option'] = value
. By default, a namespacetest
is added to the configuration. Below are the default options fortest
namespace.
default['aerospike']['config']['namespace']['test']['replication-factor']
(default:1
): aerospike namespace configuration attributedefault['aerospike']['config']['namespace']['test']['memory-size']
(default:1M
): aerospike namespace configuration attributedefault['aerospike']['config']['namespace']['test']['default-ttl']
(default:1h
): aerospike namespace configuration attribute
Configure Memory Storage Engine
-
default['aerospike']['config']['namespace']['test']['storage-engine']
(default:memory
): aerospike namespace configuration attribute
Configure SSD Device Storage Engine
default['aerospike']['config']['namespace']['test']['storage-engine device']['device']
(default:['/dev/xvdb', 'dev/xvdc']
): aerospike namespace configuration attributedefault['aerospike']['config']['namespace']['test']['storage-engine device']['write-block-size']
(default:128k
): aerospike namespace configuration attributedefault['aerospike']['config']['namespace']['test']['storage-engine device']['data-in-memory']
(default:true
): aerospike namespace configuration attribute
Configure HDD Device Storage Engine
default['aerospike']['config']['namespace']['test']['storage-engine device']['file']
(default:/var/lib/aerospike/test.ns
): aerospike namespace configuration attributedefault['aerospike']['config']['namespace']['test']['storage-engine device']['filesize']
(default:1G
): aerospike namespace configuration attributedefault['aerospike']['config']['namespace']['test']['storage-engine device']['scheduler-mode']
(default:noop
): aerospike namespace configuration attributedefault['aerospike']['config']['namespace']['test']['storage-engine device']['data-in-memory']
(default:true
): aerospike namespace configuration attribute
Contributing
- Fork the repository on Github
- Create a named feature branch (like
add_component_x
) - Write your change
- Write tests for your change (if applicable)
- Run the tests (
rake & rake knife
), ensuring they all pass - Write new resource/attribute description to
README.md
- Write description about changes to PR
- Submit a Pull Request using Github
Copyright & License
Authors:: Virender Khatri and Contributors
<pre>
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.
</pre>
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
aerospike-cluster CHANGELOG
This file is used to list changes made in each version of the aerospike-cluster cookbook.
0.1.0
- Virender Khatri - Initial release of aerospike-cluster
Check the Markdown Syntax Guide for help with Markdown.
The Github Flavored Markdown page describes the differences between markdown on github and standard markdown.
Foodcritic Metric
0.1.0 passed this metric
0.1.0 passed this metric