cookbook 'aerospike-cluster', '= 0.2.0'
aerospike-cluster (8) Versions 0.2.0 Follow1
Installs/Configures aerospike-cluster
cookbook 'aerospike-cluster', '= 0.2.0', :supermarket
knife supermarket install aerospike-cluster
knife supermarket download aerospike-cluster
aerospike-cluster Cookbook
This is a Chef cookbook to manage Aerospike.
For Production environment, always prefer the most recent release.
Most Recent Release
cookbook 'aerospike-cluster'
From Git
cookbook 'aerospike-cluster', github: 'vkhatri/chef-aerospike-cluster'
Repository
https://github.com/vkhatri/chef-aerospike-cluster
Major Version Changes
For aerospike version ~> v3.10.0.3 (server), ~> v3.10.2 (tools)` use cookbook version ~>v0.2.0
For aerospike version < v3.10.0.3 (server), < v3.10.2 (tools)` use cookbook version ~>v0.1.9
Supported OS
This cookbook was tested on Amazon Linux & Ubuntu 14.04 and expected to work on other RHEL platforms.
Recently Aerospike added support for systemd tested on CentOS7 and expected to work on rhel7, Debian8 with systemd compatibility.
Supported Edition
Cookbook supports both Aerospike Community
and Enterprise
edition.
Note that
Enterprise
edition can only be installed using
package
install_method.
Supported Aerospike Version
-
Cookbook version ~>0.2.0
- ~> v3.10.0.3 (server), ~> v3.10.2 (tools)
-
Cookbook version <0.2.0
- < v3.10.0.3 (server), < v3.10.2 (tools)
TODO
- add
specs
- manage aerospike
dependencies
, e.g. python-bcrypt etc. if any - add
role
examples - add
amc
enterprise edition configuration parameters
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 aerospikeaerospike-cluster::cluster
- uses chef search to derive value for attributedefault['aerospike']['config']['network']['heartbeat']['mesh-seed-address-port']
aerospike-cluster::amc
- install and configure aerospike management console
Advanced Attributes
default['aerospike']['version']['server']
(default:3.10.1.1
): aerospike server versiondefault['aerospike']['version']['tools']
(default:3.10.2
): aerospike tools versiondefault['aerospike']['tarball_url']
(default:auto
): aerospike tarball urldefault['aerospike']['checksum_verify']
(default:true
): checking checksum of aerospike and amc tarballs/packagesdefault['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: community, enterprisedefault['aerospike']['tarball_purge']
(default:false
): whether to purge old tarball versionsdefault['aerospike']['cookbook']
(default:aerospike-cluster
): whether to purge old tarball versionsdefault['aerospike']['enable_test_namespace']
(default:true
): whether to addtest
namespace toaerospike.conf
default['aerospike']['enterprise']['username']
(default:nil
): aerospike enterprise user namedefault['aerospike']['enterprise']['password']
(default:nil
): aerospike enterprise user passworddefault['aerospike']['chef']['search']
(default:nil
): chef search query to set attributedefault['aerospike']['config']['network']['heartbeat']['mesh-seed-address-port']
, must include recipeaerospike-cluster::cluster
recipe to run_list
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']
formesh
;224.2.2.4
formulticast
): aerospike configuration attributedefault['aerospike']['config']['network']['heartbeat']['port']
(default:3002
formesh
;9918
formulticast
): 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
This attribute can be configuraed automaticly with Chef Search, checkaerospike-cluster::cluster
recipe
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
AMC Attributes
default['aerospike']['version']['amc']
(default:3.8.13
): amc versiondefault['aerospike']['amc']['conf_dir']
(default:/etc/amc/config
): amc config directorydefault['aerospike']['amc']['log_dir']
(default:/var/log/amc
): amc log directorydefault['aerospike']['amc']['service_action']
(default:[:enable, :start]
): amc service resource actiondefault['aerospike']['amc']['packages']
(default:clculated
): amc packages dependencydefault['aerospike']['amc']['package_url']
(default:auto
): amc package urldefault['aerospike']['amc']['update_interval']
(default:5
): amc.cfg configuration parameterdefault['aerospike']['amc']['host']
(default:node['ipaddress']
): amc gunicorn bind hostdefault['aerospike']['amc']['port']
(default:8081
): amc gunicorn bind portdefault['aerospike']['amc']['gunicorn_config']['bind']
(default:calculated
): amc gunicorn configuration parameterdefault['aerospike']['amc']['gunicorn_config']['errorlog']
(default:/var/log/amc/error.log
): amc gunicorn configuration parameterdefault['aerospike']['amc']['gunicorn_config']['loglevel']
(default:info
): amc gunicorn configuration parameterdefault['aerospike']['amc']['gunicorn_config']['workers']
(default:1
): amc gunicorn configuration parameterdefault['aerospike']['amc']['gunicorn_config']['timeout']
(default:150
): amc gunicorn configuration parameterdefault['aerospike']['amc']['gunicorn_config']['pidfile']
(default:/tmp/amc.pid
): amc gunicorn configuration parameterdefault['aerospike']['amc']['gunicorn_config']['proc_name']
(default:amc
): amc gunicorn configuration parameterdefault['aerospike']['amc']['gunicorn_config']['chdir']
(default:/opt/amc/server
): amc gunicorn configuration parameterdefault['aerospike']['amc']['gunicorn_config']['worker_class']
(default:eventlet
): amc gunicorn configuration parameter
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.8 (07/06/2015)
-
Oleksandr Sakharchuk:
- Update default attribute configuration
- Remove notify for AMC dashsboard as problem was fixed at AMC 3.6.8.2
- Disable empty
xdr
section in config file, wich caused an error for EE (Enterprise Edition) - Update
aerospike-cluster::amc
for installation AMC EE. Closed #8
0.1.8 (01/06/2015)
-
Oleksandr Sakharchuk:
- Remove cloning resource attributes from prior resource (CHEF-3694)
- Permanent fix for #8 - remote_file for enterprise edition with authentication
- After PR #12 attribute
mesh-seed-address-port
not needed. - Update cluster.rb recipe for default value and support chef-solo if possible
- Restart
amc
applicatoin ifaerospike
was restarted - test update
0.1.7 (31/05/2015)
-
Oleksandr Sakharchuk:
- Add test suit case for multicast mode cluster
- Update
aerospike-cluster::cluster
to ignoremesh
configuration formode: multicast
which cause an error
0.1.6 (26/05/2015)
-
Oleksandr Sakharchuk:
- Add RHEL7 support, after last Aerospike release
- Add Ubuntu-14.04 support
- Update kitchen config
- Add integration tests for old (3.6.3) and latest (3.8.2.3)
- Update kitchen test to docker
- Update travis-ci to use docker
0.1.5 (11/05/2016)
-
Oleksandr Sakharchuk:
- Fix foodcritic
- Fix a typo with attribure for package_url
- Added user cookbook as dependency
- Fix travis and typo
- Add atrribute to disable cheksum checking
- Added support for amc version attribute
- Fixed recipes dependencies
0.1.3 (28/12/2015)
Blair Hamilton - adding clustering via chef server
-
- #10, fix enable_test_namespace config disable for test namespace
- better namespace formatting
- fix rubocop #14
0.1.2 (31/10/2015)
-
Virender Khatri:
- #7, added enterprise edition support
- #4, added amc setup
- #3, make test namespace setup optional
0.1.1 (26/10/2015)
- Virender Khatri - #1, added package installation support
0.1.0 (24/10/2015)
- 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.
Collaborator Number Metric
0.2.0 failed this metric
Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Foodcritic Metric
0.2.0 passed this metric
License Metric
0.2.0 passed this metric
0.2.0 failed this metric
0.2.0 passed this metric
License Metric
0.2.0 passed this metric
0.2.0 passed this metric