🦆 chaos-duck

Description

Chaos Duck is a Node.js serverless implementation of Netflix's Chaos Monkey. Chaos Duck will randomly stop and failover resources in your AWS account allowing you to test and build highly available applications.

Table of Contents

• How It Works
• Supported Services
• Quick Start
• Using duck.json
  • Supported Properties
• Using CLI Options
• Using HTTP POST
• Contributing

How it works

Chaos Duck will randomly choose from the services you provide and perform a single chaotic action to the chosen service. To cause more chaos, simply invoke Chaos Duck again. If no services are explicitly specified in the POST body, all supported services will be considered fair game.

Supported services

These are the current supported AWS services to wreak havoc on. Choose wisely.

• EC2: Chaos Duck will randomly stop your EC2 instances
• ECS: Chaos Duck will randomly stop your ECS tasks
• ElastiCache: Chaos Duck will randomly failover your ElastiCache instance
• RDS: Chaos Duck will randomly failover your DB clusters

Quick start

Before getting started make sure you have Node.js and AWS CLI installed. Once you have set that up, make sure you have your AWS account number and role to assume to deploy lambda

1. Clone the project and install all dependencies

    npm install
   

2. Create a symlink to enable the chaos-duck command globally

    npm run link
   

3. Follow the prompts in order to configure Chaos Duck. Read more about the supported properties here

    chaos-duck config
   

4. Once you are done with the configuration, a duck.json config file will be created (or modified) for you in your current directory

   {
       "account": "12345678912",
       "alias": "sandbox",
       "profile": "default",
       "role": "Sandbox-Developer",
       "services": "ECS,RDS,ElastiCache",
       "stage": "dev"
   }

5. Deploy Chaos Duck

    chaos-duck deploy
   

   NOTE: Once Chaos Duck has been deployed your duck.json file will be updated to include your chaosUrl

6. To begin wreaking chaos, simply invoke it

    chaos-duck invoke
   

7. To undeploy

    chaos-duck undeploy
   

Using duck.json

In addition to using CLI options, you can also deploy or invoke by providing the path to a duck.json config file. To generate a new duck.json file, simply run:

chaos-duck config

Supported properties

• account: AWS account number
• alias: Account alias. Can be any string used by you to identify an account
• chaosUrl: The url to call when invoking Chaos Duck
  • This value will be ignored during deployments
• emailFrom: The email address emails will be sent from
  • This email will need to be verified in AWS SES. Read more here
• emailTo: The email address emails will be sent to
  • This email will need to be verified in AWS SES. Read more here
• profile: Profile in your AWS .credentials file to use
  • Default: default
• role: AWS role to assume during deploy. Whatever profile you specify needs to have access to assume this role
  • This can be a full role ARN or simply the name of the role. If you provide the full ARN then the account number will be derived for you
• schedule: The schedule to run Chaos Duck. Defaults to disabled
  • This value is expressed as a value which can be a positive integer along with a unit which can be minute(s), hour(s), or day(s)
    • For a singular value the unit must be singular ('1 day'), otherwise plural ('5 days')
• services: Comma separated service values to invoke chaos on
  • Default: all services
  • These values are not case sensitive
  • Read more about supported services here
• slackWebhookUrl: Slack webhook url to post notifications to
• stage: Deployment stage name. Can be any string to differentiate between different versions of the same stack
  • Default: dev

Example

{
    "account": "12345678912",
    "alias": "sandbox",
    "chaosUrl": "https://abcde123.execute-api.us-east-1.amazonaws.com/dev/chaos",
    "emailFrom": "chaosduck@gmail.com",
    "emailTo": "development@acme.com",
    "profile": "default",
    "role": "Sandbox-Developer",
    "schedule": "1 hour",
    "services": "ECS,RDS,ElastiCache",
    "slackWebhookUrl": "https://hooks.slack.com/services/ABCDE123/FGHIJK456/laduhgfa98u234234",
    "stage": "dev"
}

Using CLI Options

chaos-duck --help

Usage: chaos-duck [options] [command]

Chaos Duck 🦆

Options:
  --version             output the version number
  -h, --help            output usage information

Commands:
  config|c [options]    Setup Chaos Duck
  deploy|d [options]    Deploy Chaos Duck
  invoke|i [options]    Unleash Chaos Duck
  undeploy|u [options]  Undeploy Chaos Duck

Using HTTP POST

POST <chaosUrl>

{
    "services": ["ECS", "ElastiCache"]
}

Note: the <chaosUrl> can be found in your duck.json file