caa-playbooks

caa-playbooks

This repo provides a CLI for running through different scenarios in the form of a 'do-nothing' script. It provides a series of terminal based prompts that guide you through different scenarios. Over time, we can choose to evolve these scripts so that they actively mitigate the situation - i.e they may evolve to accept credentials and perform tasks at key points in the prompt sequence.

Getting started

Install the package globally

npm install -location=global @ovotech/caa-playbooks

Then you should have the playbooks command available on your command line

How it works

Just fire the commands above, and it should guide you through the rest. The first prompt picks the scenario you want assistance with. Under the hood, this loads a subsequent set of prompts which are configured in the ./src/scenarios directory. Future scenarios can be added to this and included in the options

Writing scenarios

The prompts in this repo are created with Inquirer: https://www.npmjs.com/package/inquirer Scenarios are created by creating an Inquirer prompt with arrays of Question objects. For linear sequences, there are a couple of utility functions to enforce the sequence, and to restart the prompt if any step fails.

forceSequence - this ensures that the next question in the sequence is only shown if the previous step was confirmed. It requires each question to be named thus: stepX - i.e step1, step2

retryIfAnyFalse - will restart the prompt loop from the beginning.

Current scenarios

• dead letter queue: dlq

Development

You can build the package using the npm run watch or npm run build command. You can then test it locally by running npm link in the project directory