plivo / opsworks Goto Github PK

The missing OpsWorks CLI

License: MIT License

JavaScript 100.00%

opsworks's Introduction

OpsWorks CLI

The missing OpsWorks CLI, run commands across stacks (and across regions), check your instances, apps, deployments, ELBs, with a smart filtering system.

Installation

npm install -g opsworks

Usage

opsworks <command> [args]

The OpsWorks CLI has multiple commands, similar to git, apt-get or brew. When you run opsworks with no arguments, you get an interactive prompt.

GUI / Prompt

For simple tasks, just use opsworks without a command and you'll get an interactive prompt.

Configuration

opsworks needs to access the AWS API using your credentials. Just like the AWS SDK or CLI, it will look for credentials in two places :

From the shared credentials file (~/.aws/credentials)
From environment variables

To use the credentials file, create a ~/.aws/credentials file based on the template below :

[default]
aws_access_key_id=your_access_key
aws_secret_access_key=your_secret_key

Commands

command	description
stacks	list OpsWorks stacks
deployments	list OpsWorks deployments
instances	list instances
apps	list apps
elbs	list Elastic Load Balancers
update	update cookbooks
setup	run setup recipes
configure	run configure recipes
deploy	deploy specified app
recipes	run specified recipes

Shared options for these commands

-f Specify filter (see below)
-u Update cookbooks before running the command
-y Do not ask for confirmation

Note: by default, when you do not specify -y, the CLI will display a summary of what commands it will run and on which layer of which stacks as a precaution.

Filtering

Any opsworks command accepts filters. There are three built-in filters :

field	description
layer	The Shortname of the layer
stack	The Name of the stack
region	The stack's region

The format is field:filter,field2:filter2,... You can use wildcards, or even use regexes.

For example the command bellow would match all stacks whose name contain wordpress, and only include their database layer.

opsworks instances -f 'stack:*wordpress*,layer:database'

Using regexes to check ELBs of two wordpress stacks at once :

opsworks instances -f 'stack:(prod|staging)-wordpress'

Additionally, if you use custom JSON on your stacks or layers, you can use arbitrary filters. For example, if your custom JSON has an env variable, this would work :

opsworks instances -f 'env:production'

Issues?

Please feel free to open an issue if you find a bug or to request a feature. Please make sure to include all relevant logs.

Authors

Developed by Tristan Foureur for Plivo

License

All code is licensed under the MIT License. See LICENSE.md file for details.

opsworks's People

Contributors

Stargazers

Watchers

Forkers

kshinn isabella232 djalal

opsworks's Issues

AWS Throttling : Rate Exceeded

Running commands on a high number of stacks can exceed the rates allowed.

info: Running command update_custom_cookbooks on 8 stacks
error:  ThrottlingException: Rate exceeded
    at Request.extractError (/Users/esya/.nvm/versions/node/v4.4.5/lib/node_modules/opsworks/node_modules/aws-sdk/lib/protocol/json.js:43:27)
    at Request.callListeners (/Users/esya/.nvm/versions/node/v4.4.5/lib/node_modules/opsworks/node_modules/aws-sdk/lib/sequential_executor.js:105:20)
    at Request.emit (/Users/esya/.nvm/versions/node/v4.4.5/lib/node_modules/opsworks/node_modules/aws-sdk/lib/sequential_executor.js:77:10)
    at Request.emit (/Users/esya/.nvm/versions/node/v4.4.5/lib/node_modules/opsworks/node_modules/aws-sdk/lib/request.js:615:14)
    at Request.transition (/Users/esya/.nvm/versions/node/v4.4.5/lib/node_modules/opsworks/node_modules/aws-sdk/lib/request.js:22:10)
    at AcceptorStateMachine.runTo (/Users/esya/.nvm/versions/node/v4.4.5/lib/node_modules/opsworks/node_modules/aws-sdk/lib/state_machine.js:14:12)
    at /Users/esya/.nvm/versions/node/v4.4.5/lib/node_modules/opsworks/node_modules/aws-sdk/lib/state_machine.js:26:10
    at Request.<anonymous> (/Users/esya/.nvm/versions/node/v4.4.5/lib/node_modules/opsworks/node_modules/aws-sdk/lib/request.js:38:9)
    at Request.<anonymous> (/Users/esya/.nvm/versions/node/v4.4.5/lib/node_modules/opsworks/node_modules/aws-sdk/lib/request.js:617:12)
    at Request.callListeners (/Users/esya/.nvm/versions/node/v4.4.5/lib/node_modules/opsworks/node_modules/aws-sdk/lib/sequential_executor.js:115:18)

Enable region specific stacks

Given that AWS is enabling and defaulting to region specific stacks, there is an option missing to specify which region we want the tool to send the AWS commands to.

For example, I have the following regionless stacks:

Stack A
Stack B

And the following Regional stacks in us-west-1:

Stack C
Stack D

When I run the tool, only Stack A and Stack B are available.

Please add an option where a user can specify a specific region.

Add 'instance' filter to built in filters

I want to run a specific recipe (or a list of recipes) in a specific instance. So I tried to specify three filters 'stack', 'layer' and 'instance'. But looks like there is no filter called instance.

It would be great to have instance filter, so that below command works

opsworks recipes -f 'stack:my_stack,layer:my_layer,instance:my_instance' -u -v my_cookbook::my_recipe

Have a rolling deploy feature, with a configurable "step", ie: do simultaneous deployments on all layers of all stacks matching filters, but only instance by instance, or X instances by X instances (configurable with a parameter)

XMPP Bot

Possibly have a long-running version of the OpsWorks CLI that sits in an XMPP room and accepts the same CLI commands, runs them, and gives the output on the room.