Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 2.46 KB

README.md

File metadata and controls

63 lines (41 loc) · 2.46 KB
Raw

EC2 SSH Fuzzy Finder

Type ec2 and you'll get an interactive fuzzy finder of all the instances in your EC2 account that have a public IP.

screenshot

Narrow the search by typing the instance name, region, IP address or tag value.

ENTER to select an instance and SSH into it.

This script assumes your EC2 SSH private key exists in ~/.ssh/[key-name].pem.

How this works

Instead of calling DescribeInstance on demand (which is painfully slow), this project contains a Serverless Lambda function that fetches the entire list of instances every minute and caches it in S3.

The bucket is accessible only to the IAM group dev. Tweak this with your org's relevant group name as appropriate.

Installing

The CLI

  1. You'll need FZF (the fuzzy finder).
  2. You'll also need the AWS CLI installed locally (pip install awscli).
  3. And of course your AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_ID envars should be defined.
  4. Clone this repo, and add its directory to your $PATH.
  5. The CLI assumes that your SSH keys exist in ~/.ssh/[KeyName].pem.

The Lambda (only once per organization)

You'll see serverless installed, and permissions to manage Lambda in your AWS account.

npm install -g serverless
make deploy

Lambda Configuration (per organization)

You can tweak the following to suit your organization.

Look in servereless.yml for the custom object and tweak it.

  1. You should change the bucket name to include your organization's name. The default won't work for you, since bucket name are universal.
    1. Update the BUCKET variable in the file ec2 as well.
  2. You can change the IAM group name (default is dev) that's allowed to see the list of instances this tool caches.
  3. You can specify the list of tags that are relevant for finding instances in your account. The defaults are relevant to Binaris (realm, service, ...), so you probably want to change this if you're not part of our team. :)
service: ec2-fzf

custom:
    # Choose your bucket name here, it will be created for you.
    bucket: ec2-cache.binaris.com
    # Specify a list of relevant tags for finding instances (space separated)
    tags: "realm service Name"
    # SSH IAM Group (IAM group that should be allowed to use this tool)
    group: "dev"
...

To deploy, run make deploy. It's a good idea to test locally first with make run_local.