Soror
Search for EC2 instances by tags 🔎
Installation
Add this line to your application's Gemfile:
gem 'soror'And then execute:
$ bundle
Or install it yourself as:
$ gem install soror
Usage
# Search for EC2 instances which have tags `[{ "Key": "role", "Value": "app" }, { "Key": "stage", "Value": "production" }]`
# You can use methods of Aws::EC2::Types::Instance for each element
# See http://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/Types/Instance.html
Soror.search_by(role: 'app', stage: 'production') #=> [<Aws::EC2::Types::Instance>, ...]Configuration
Soror.config.update(access_key_id: 'xxxxx', secret_access_key: 'xxxxx', region: 'ap-northeast-1')In addition, Soror supports a new and standardized way to manage credentials
CLI
ATTR is an instance method name of Aws::EC2::Types::Instance
$ soror --help
Usage: soror [options]
-t, --tags='KEY=VAL,KEY=VAL,...'
-a, --attributes=ATTR,ATTR,...
--[no-]header
--profile-name=NAME
--credentials-path=PATH
--access-key=KEY
--secret-key=KEY
--region=REGION
Example
$ soror --tags 'role=app,stage=production' --attributes 'instance_id,public_ip_address' --profile-name 'kirikiriyamama' --region 'ap-northeast-1'
instance_id public_ip_address
i-xxxxx xxx.xxx.xxx.xxx
i-xxxxx xxx.xxx.xxx.xxx
$ ssh -i ~/.ssh/id_rsa ec2-user@$(soror --tags 'role=app,stage=production' --attributes 'instance_id,public_ip_address' --profile-name 'kirikiriyamama' --region 'ap-northeast-1' --no-header | peco | awk '$0 = $2')
Required permissions
{
"Statement": [
{
"Effect": "Allow",
"Action": "ec2:Describe*",
"Resource": "*"
}
]
}Contributing
- Fork it ( https://github.com/kirikiriyamama/soror/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request