Skip to main content

FZF selector for cloud instances

Project description

FZF Cloud Select

Build Status codecov MIT License PyPI - Python Version Codacy Badge code style

You may find a documentation at the Read The Docs

PyPI - The Latest Version

Environments

Purpose

We should jump between nodes quickly, having a pack of cloud accounts. Each account could be in a different region. Some nodes are publicity available, some of them not. Dozen of nodes sit behind bastion hosts. And a few of them sit behind a group of jump points. And they all have different SSH keys.

There is a ~/.ssh/config, but it is not enough because of the dynamic nature of the cloud. It is too clumsy and not suitable for cases when IP addresses are changing instantly, and instances are creating and destroying in minutes.

I tried to structure that chaos with shell scripts, but the shell is not enough. I believe that tools like C/C++/Java/Node.JS/Go?/Rust are too heavy for this case. Python is the exact thing. I like to have a dynamic and lightweight solution. Cloud Select is fast enough to go through thousands of nodes. Maybe if my scope will be higher, then I'll create something other.

Cloud Select is useful for diving inside geo-distributed onion enterprise environments with weird security settings.

Implementation

CloudSelect retrieves node list from the cloud, passes that list to FZF, adds some useful information to selected nodes (like jump hosts, sudo -i command, etc...), and returns dictionary that could be used by other programs. CloudSelect is a team player in a shell environment. We can automatically open interactive SSH sessions in parallel and provide passwords to sudo -i under TMUX environment.

Demo

demo

The tool is:

  1. connecting to bastion host with public IP 54.171.154.230
  2. using locally stored key on bastion because the usage of ssh-agent is restricted by security team ?lol? and sshd settings are AllowTcpForwarding no, GatewayPorts no
  3. jumping to 4 EC2 web instances in development environment that located in private subnet 172.30.x.x
  4. running sudo -i at startup
  5. entering sudo password 12345678

And after that, we have four ready to use interactive sessions in our terminal...

You may find a demo files in docs/demo directory.

Basic usage

  • Connect to a single known_hosts server
  • Connect to a single EC2 AWS instance

Advanced usage

  • Connect to multiple known_hosts servers, run sudo -i command at startup and enter sudo password
  • Connect to multiple EC2 AWS instances, run sudo -i command at startup and enter sudo password
  • Connect to multiple EC2 AWS instances through a bastion host, run sudo -i command at startup and enter sudo password

Features

:rocket: We may use jump hosts even if jump host hasn't been configured to allow remote port forwarding and we have the following settings in sshd_config:

AllowTcpForwarding no
GatewayPorts no

Installation

CloudSelect is on PyPi! You can install CloudSelect with a simple pip command:

pip install cloudselect

Add profile bash completion:

complete -C cloudselect_completer cloudselect

You may copy suitable wrapper from example directory.

License

MIT © Alexey Aksenov et al

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cloudselect, version 20.1.14
Filename, size File type Python version Upload date Hashes
Filename, size cloudselect-20.1.14-py3-none-any.whl (42.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size cloudselect-20.1.14.tar.gz (21.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page