$ git clone https://github.com/mheffner/awsam.git $DIR/awsam
Setup PATH (for non gem installs)
$ echo "export PATH=\$PATH:$DIR/awsam/bin" >> $HOME/.bashrc $ source $HOME/.bashrc
Install BASH rc file
$ raem --init Initialized AWS Account Manager Add the following to your .bashrc: if [ -s $HOME/.awsam/bash.rc ]; then source $HOME/.awsam/bash.rc fi
Update repo (fetch && merge)
raem --init. Ignore instructions to setup .bashrc if you've already done so.
Close and reopen your shell or
Add an account
If the environment already contains AWS variables, these will be presented as defaults.
$ aem add Creating a new AWS account... Short name: staging Description: Staging account Access key : 123 Secret key [secret123456]: 455 Cert key file [/path/to/key_cert.pem]: cert.pem Private key file [/path/to/private_key.pem]: key.pem
Select the active account
This will update the current environment with the appropriate AWS environment variables.
$ aem use staging
When selecting an account you can mark it as the default account with
$ aem use --default staging
The active account will be marked with an arrow. The default, if set, will be marked with an asterisk.
$ aem list AWS Accounts: prod [Librato Production] [1 key: my-prod-key] => staging [Staging account] *dev [Librato Development] [1 key: devel-key]
Import a key pair
Add a key to the default account, or the specified account. Defaults chosen from current environment if set.
$ aem key add my-key-name /path/to/my-keypair.pem Imported key pair my-key-name for account staging [Staging account]
Select a key
This will select an SSH keypair to use from your current account and
set the environment variables
AMAZON_SSH_KEY_FILE appropriately. It will also highlight the key in
the list output with the '>' character.
$ aem key use my-key-name $ aem list AWS Accounts: staging [Staging account] => dev [Librato Development] [1 key: >my-key-name]
You can also define a default key for each account that will
automatically be selected when the account is chosen. Just use the
--default option when selecting a key to set a default key. Picking
a default will place an asterisk next to the key name in the
$ aem key use --default my-key-name
assh utility: SSH by instance ID
Instance IDs will be looked up using the current account details. If the instance's keypair name exists, that keyfile will be used as the identity file to ssh.
$ assh [user@]<instance-id>
$ assh ubuntu@i-123456 warning: peer certificate won't be verified in this SSL session Loging in as ubuntu to ec2-220.127.116.11.compute-1.amazonaws.com ... ubuntu@host:~$
ascp utility: SCP by instance ID
Instance IDs will be looked up using the current account details. If the instance's keypair name exists, that keyfile will be used as the identity file to scp.
$ ascp [user@]<instance ID>:remote-file local-file $ ascp local-file [user@]<instance ID>:remote-file
Remove a key
You can remove ah SSH key from an account (defaults to the current account).
$ aem key remove --acct prod my-prod-key
Remove an account
You can remove an account as long as it is not the active one.
$ aem remove staging
AWS Account Manager sets a variety of environment variables when
selecting accounts and SSH keypairs. Some of these environment
variables match the ones used by the Amazon EC2 CLI tools and some our
unique to AWSAM. It is often convenient to use these environment
variables in DevOPs scripts in place of hard-coded values -- allowing
your scripts to be seamlessly used for staging and production
environments simply by switching the active account with
The environment variables set when selecting an account are:
AMAZON_ACCESS_KEY_ID: API access key
AMAZON_SECRET_ACCESS_KEY: Secret API access key
AMAZON_AWS_ID: The integer ID of this AWS account
EC2_CERT: Full path to the EC2 certificate PEM file.
EC2_PRIVATE_KEY: Full path to the EC2 private key PEM file.
When selecting an SSH key, the following environment variables are set:
AMAZON_SSH_KEY_NAME: Name of the keypair.
AMAZON_SSH_KEY_FILE: Full path to the public key PEM file
- list accounts by name
- choose account by name (sets environ)
- list shows active account
- support default account
- accounts as yaml config files
- ssh's to an instance name
- ssh to a tag name (multiple?)
- caches instance id => hostname for fast lookup
- determines correct key to add
- determines user?
Contributing to awsam
- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
- Fork the project
- Start a feature/bugfix branch
- Commit and push until you are happy with your contribution
- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
Copyright (c) 2011 Mike Heffner. See LICENSE.txt for further details.