Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.04 KB

README.md

File metadata and controls

70 lines (45 loc) · 2.04 KB
Raw

OpsWorks CLI

Command line interface for Amazon OpsWorks.

Commands

Run opsworks with one of the following commands:

  • ssh Generate and update SSH configuration files.

    Instances are added in stack order to the SSH configuration. If you have instances with the same name in multiple stacks, the one from the first stack will be used by SSH.

  • dsh Generate and update dsh configuration files.

    Instances are added in stack order to the dsh machines.list in $HOME/.dsh, as per ssh above. A file is created in $HOME/.dsh/group for each layer in each stack.

Configuration

This gem uses the same configuration file as the AWS CLI. This requires you to have a working AWS CLI setup before continuing.

Add the following section to ~/.aws/config or to the file pointed out by the AWS_CONFIG_FILE environment variable:

[opsworks]
stack-id=<MY STACK IDs>
ssh-user-name=<MY SSH USER NAME>

The stack ID can be found in the stack settings, under OpsWorks ID (or in the address bar of your browser as console.aws.amazon.com/opsworks/home?#/stack/<STACK_ID>/stack). You can add several stack IDs belonging to the same IAM account separated by commas (stack-id=STACK1,...,STACKN). If no stack-id is specified all accessible stacks are used.

The ssh-user-name value should be set to the username you want to use when logging in remotely, most probably the user name from your My Settings page on OpsWorks.

Installation

Install for use on the command line (requires Ruby and Rubygems):

$ gem install opsworks

Then run opsworks:

$ opsworks --help

To use the gem in a project, add this to your Gemfile:

gem 'opsworks'

And then execute:

$ bundle

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request