updated docs
1 file changed
tree: 7fad5cb1afd2b6583b705fd810c3d7218a6605a0
  1. .gitignore
  2. clean.yml
  3. consistency.yml
  4. opdk-backup.yml
  5. opdk-setup-log-files.yml
  6. README.md
  7. repair.yml
  8. requirements.yml
  9. rolling-restart.yml
  10. update-replication-factor.yml
README.md

Apigee OPDK Playbook Maintenance - Cassandra Replication Factor Change Runbook

This is an Ansible playbook that performs a modification of the Cassandra replication factor used with Apigee components with zero downtime in a two data center topology.

Requirements and Usage Overview

This playbook uses ansible-galaxy to download roles that are used by this playbook. Once roles are downloaded the playbook and be invoked in several ways. The playbook can be invoked in its entirety, a tag can be used to invoke a subset of playbook services or the playbook may be run manually. These ways of invoking the playbook are described below.

Description: Download Roles

The playbook roles and their location is found in the requirements.yml file. This file is provided to ansible-galaxy so that the roles may be downloaded.

Usage: Ansible Galaxy

Ansible galaxy will download the required roles when invoked with the install action and the requirements file. This is accomplished in the following way:

ansible-galaxy install -r requirements.yml

Update Replication Factor Overview

The update-replication-factor.yml script performs the update of the Cassandra replication factor for keyspaces in a Cassandra ring. This playbook assumes that you are changing Cassandra replication on a planet that is composed of two regions or two data centers.

This script expects you to provide the replication_factor setting you wish to use when the script is invoked at the command line.

Usage: Full Playbook Invocation

The full playbook invocation is performed in the following way:

ansible-playbook update-replication-factor -e replication_factor=6 -vvv -b 

Usage: Manaul Playbook Invocation

This playbook enables tasks to be invoked manually. Manual invocation of this playbook is accomplished in the following way:

ansible-playbook update-replication-factor -e replication_factor=6 -vvv --step

During manual invocation the playbook will stop before every task. The user is prompted on each task
for permission to execute, stop execution or continue execution to the first task of the next play. The prompt accepts y to execute; n to stop execution or c to continue execution and stop on the first task of the next play.

Usage: update.yml

This playbook contains a convenience playbook that uses the replication_factor_update.yml and requires that you specify only the replication_factor.

ansible-playbook update.yml -vv -b -e replication_factor=3

Defined Tags

Playbook NameTag NameDescription
update.ymldc-1All tasks on dc-1 only
update.ymldc-2All tasks on dc-2 only
update.ymlrestartRestart apigee components other than ds profile components
replication_factor_update.ymlcacheUpdate ansible cache, includes apigee specific attributes
replication_factor_update.ymlupdateUpdate replication factor
replication_factor_update.ymlrepairPerform nodetool repair
replication_factor_update.ymlrestartRestart all apigee components on the node
replication_factor_update.ymlstopStop all apigee components on the node
replication_factor_update.ymlstartStart all apigee components on the node