updated docs
diff --git a/README.md b/README.md index 96c8cf0..f45dc6b 100644 --- a/README.md +++ b/README.md
@@ -1,30 +1,53 @@ # Apigee OPDK Playbook Maintenance - Cassandra Replication Factor Change Runbook -This is an Ansible playbook that performs a modification of Cassandra replication factor on Apigee -components with Zero Downtime. +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 +## 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. -## Download Roles +## 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. -### ansible-galaxy usage +### 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``` -### Usage: replication_factor_update.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. -The ```replication_factor_update.yml``` requires that you specify the ```replication_factor```, -```opdk_region``` and the ```hosts```. +This script expects you to provide the ```replication_factor``` setting you wish to use when the +script is invoked at the command line. -```ansible-playbook replication_factor_update.yml -e hosts=dc-1-ds -e opdk_region=dc-1 -e replication_factor=3``` +#### 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```