.CCCCC                       CCCCC.
          .CCCCCC                       CCCCCC.
          .CCCCCC                       CCCCCC.
          .CCCCCC                       CCCCCC.
          .CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC.
          .CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC.
          .CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC.
           .CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC.

Couchbase Server is a high performance NoSQL document database available in Community and Enterprise editions for several supported operating systems.

This Ansible role can be used to install Couchbase Server on cluster nodes, initialize working clusters, create buckets, and load buckets with test documents with the playbooks included in the examples directory.

This role is tested for basic functionality with the following software:

• Couchbase Server (versions 2.5.2-3.0.3)
• Ansible (version 1.9.2)
• CentOS (versions 6-7)
• Debian (version 7)
• Ubuntu (versions 12.04-13.10)

This role is designed to be installed via the ansible-galaxy command instead of being directly run from the git repository.

You should install it like this:

ansible-galaxy install couchbase.couchbase-server

You'll want to make sure you have write access to /etc/ansible/roles/ since that is where the role will be installed by default, or define your own Ansible role path by creating a $HOME/.ansible.cfg file with these contents:

[defaults]
roles_path = <path_to_your_preferred_role_location>

Change <path_to_your_preferred_role_location> to a directory you have write access to.

See the ansible-galaxy documentation for more details.

In cases where you want simple clusters for development or other non-production use, the values for Couchbase Server role's default variables can be left as-is.

However, should you need specific performance or otherwise wish to tweak them for your particular purpose, this section describes all of the role's variables in detail including their default values for your reference.

The following variables should be set with caution as they have potential negative performance implications; they should not be used without knowledge of the changes which are made to the operating system configuration:

The examples directory contains some basic playbooks, host inventory examples, and Vagrant bits (primarily for development use) as follows:

• cluster_backup.yml full backup of cluster and retrieval of backup tarball
• cluster_collect_info.yml gathers cluster logs with cbcollect_info
• cluster_init.yml installs Couchbase Server and initializes the cluster
• cluster_install.yml prepares OS and installs Couchbase Server only
• create_bucket.yml creates an example bucket
• load_bucket.yml loads sample JSON data into a bucket
• node_failover.yml manual failover of cluster node
• retreive_ssl_cert.yml retrieve and store node's SSL certificate
• site.yml basic role inclusion example
• example_hosts example hosts inventory in format required by this project
• Vagrantfile example Vagrant development cluster definition
• vagrant_hosts default Vagrant hosts inventory file

The example playbook create_bucket.yml for bucket creation can be used as follows:

Upon first execution without specifying variable arguments via the ansible-playbook extra vars ('-e') option, the playbook will generate a bucket with the following properties:

• Bucket name: default
• Bucket type: couchbase
• Bucket port: 11211
• Bucket RAM size: 256MB
• Bucket replica number: 1

If you'd like to create your own buckets, then use the ansible-playbook extra vars ('-e') option and specify values for the b_name, b_type, b_port, b_ramsize, and b_replica variables like so:

ansible-playbook -i vagrant_hosts create_bucket.yml \
-e "b_name=danika b_type=couchbase b_port=11223 b_ramsize=256 b_replica=2"

or perhaps you'd like to make a memcached based bucket? No problem:

ansible-playbook -i vagrant_hosts create_bucket.yml \
-e "b_name=breandon b_type=memcached b_port=11224 b_ramsize=512 b_replica=0"

Follow these steps to have a simple 3 node CentOS based development or evaluation cluster on a machine with >= 8GB RAM, using VirtualBox and Vagrant:

1. export ROLESPATH=$ANSIBLE_ROLES_PATH
2. ansible-galaxy install couchbase.couchbase-server
3. cd $ROLESPATH/couchbase.couchbase-server/examples
4. vagrant up

Note that $ANSIBLE_ROLES_PATH defaults to /etc/ansible/roles or the path you've specified in ~/.ansible.cfg for roles_path.

This will install three (3) CentOS 6.5 nodes with 1.5GB RAM each and cluster them together. The nodes will be available at 10.1.42.10, 10.1.42.20, and 10.1.42.30 as defined in the Vagrantfile.

To install Debian based nodes, change the command in step 4 to:

BOX_NAME=chef/debian-7.4 vagrant up

To install Ubuntu based nodes, change the command in step 4 to:

BOX_NAME=ubuntu/trusty64 vagrant up

See examples/README_VAGRANT.md for more Vagrant cluster based details.

None

Apache

• Brian Shumate (brian at couchbase.com)