cookbook 'cassandra-platform', '= 2.2.0'
cassandra-platform (6) Versions 2.2.0 Follow1
Install and Configure Apache Cassandra
cookbook 'cassandra-platform', '= 2.2.0', :supermarket
knife supermarket install cassandra-platform
knife supermarket download cassandra-platform
Cassandra Platform
Description
Install/Configure an Apache Cassandra cluster.
Cassandra is a free and open-source distributed database management system
designed to handle large amounts of data across many commodity servers.
Requirements
Cookbooks and gems
Declared in [metadata.rb](metadata.rb) and in [Gemfile](Gemfile).
Platforms
A systemd managed distribution:
- RHEL Family 7, tested on Centos
Usage
Test
This cookbook is fully tested through the installation of a working 3-nodes
cluster in docker hosts. This uses kitchen, docker and some monkey-patching.
For more information, see [.kitchen.yml](.kitchen.yml) and [test](test)
directory.
Easy Setup
Set node['cassandra-platform']['hosts']
to an array containing the
hostnames of the nodes of the Cassandra cluster.
Search
The recommended way to use this cookbook is through the creation of a role per
Cassandra cluster. This enables the search by role feature, allowing a
simple service discovery.
In fact, there are two ways to configure the search:
- With a static configuration through a list of hostnames (attributes
hosts
that isnode['cassandra-platform']['hosts']
) for nodes belonging to Cassandra cluster). Actually, only seeds are necessary. - With a real search, performed on a role (attributes
role
andsize
like innode['cassandra-platform']['role']
). The role should be in the run-list of all seeds of the cluster. The size is a safety and should be the number of nodes of this role.
If hosts is configured, role
and size
are ignored
See [roles](test/integration/roles) for some examples and
Cluster Search documentation for more information.
Attributes
Configuration is done by overriding default attributes. All configuration keys
have a default defined in:
[attributes/default.rb](attributes/default.rb),
[attributes/systemd.rb](attributes/systemd.rb).
Please read it to have a comprehensive view of what and how you can configure
this cookbook behavior.
Recipes
default
Include search
, user
, install
, config
and systemd
recipes.
search
Search Cassandra nodes that should join the cluster using
Cluster Search.
user
Create user/group used by Cassandra.
install
Install Apache Cassandra from an Apache mirror.
config
Generate and deploy Cassandra config.
systemd
Create systemd unit for Cassandra and make sure service is started.
backup
Install the script cassandra_backup.sh
in prefix_bin
which can be launched
to perform a full backup of a cassandra node.
Contributing
Please read carefully [CONTRIBUTING.md](CONTRIBUTING.md) before making a merge
request.
License and Author
- Author:: Vincent Baret (vbaret@gmail.com)
- Author:: Samuel Bernard (samuel.bernard@gmail.com)
- Author:: Florian Philippon (florian.philippon@gmail.com)
Copyright (c) 2017 Sam4Mobile, 2017 Make.org 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.
Dependent cookbooks
cluster-search >= 0.0.0 |
ark >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Changelog
2.2.0
Main:
- feat(backup): create an unique compressed archive
Tests:
- test: use package_retries on gem install to prevent temporarily failure
2.1.0
Manual Migration Needed:
- if you use default data dir configuration:
- stop Cassandra, move all data from $CASSANDRA_HOME/data to /var/opt/cassandra
- remove $CASSANDRA_HOME/data
- launch chef with latest cookbook version
Main:
- feat: set default version to 3.11.1
- feat: add support for a Prometheus exporter
- Activate with an attribute the capability to have a file Prometheus exporter for Cassandra. By combining it with "node exporter", you can export Cassandra metrics to Prometheus.
- feat: move default data dir to /var/opt/cassandra
- feat: install backup script through backup recipe
Tests:
- test(gitlab): up gitlab-ci.yml to 20170731
- test: increase exporter timeout to 30*5s
- test: add tests for backup recipe & script
Misc:
- docs(supermarket): fix issues url
- chore: add foodcritic & rubocop in Gemfile
- docs: add backup recipe in README
2.0.0
Main:
- handover maintainance to Make.org
- switch to Apache 3.10 (was datastax dsc30)
- manage all configuration files & simplify config merge with upstream default
Fixes:
- chef13: use default package retries correctly
- search: remove need to be in searched role
Tests:
- use .gitlab-ci.yml template [20170529]
- set build_pull true, use sbernard image
- add a 3rd node (true minimum setup)
- add tests on service (running & enabled)
- config: add tests on configuration files
- simplify kitchen.yml
Misc:
- rubocop: (%i stuff) & up kitchen_command
- foodcritic: FC005 on install
- search: clarify seeds definition
- docs: use karma for git format in contributing
1.0.0
- Initial version
Collaborator Number Metric
2.2.0 failed this metric
Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
2.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
2.2.0 passed this metric
License Metric
2.2.0 passed this metric
No Binaries Metric
2.2.0 passed this metric
Testing File Metric
2.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
2.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
2.2.0 failed this metric
2.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
2.2.0 passed this metric
License Metric
2.2.0 passed this metric
No Binaries Metric
2.2.0 passed this metric
Testing File Metric
2.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
2.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
2.2.0 passed this metric
2.2.0 passed this metric
No Binaries Metric
2.2.0 passed this metric
Testing File Metric
2.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
2.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
2.2.0 passed this metric
2.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
2.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
2.2.0 failed this metric