Skip to main content

Generate 'ssh_config' files, based on current Amazon EC2 state.

Project description

SSH config synchronisation for AWS

Build Status PyPI version

Generate ssh_config files, based on current Amazon EC2 state.

Features

  • Connect to one or more regions at once.
  • Filter EC2 instances by name. Useful for including relevant nodes only or for creating separate config sets for the same environment (e.g. use a different User for different nodes).
  • Identify hosts using tags or instance IDs:
    • Index duplicates (e.g. in autoscaling groups) using instance launch time.
    • Include a global name prefix and/or a region ID to identify the connection in a unique way.
  • Use public or private IPs.
  • Set various SSH params:
    • Skip strict host checking, if needed. Can be useful when working with (internal) autoscaling groups.
    • Provide a server alive interval to keep the connection from timing out.
    • Use custom identity files.
    • Setup a proxy command for utilizing jump hosts.
    • ...
  • Write to stdout or a master file with config-key substitution. Useful for working with tools, that don't support the Include directive.

Installation

You can install the latest package using pip:

pip install aws-ssh-sync

Usage

To get a full list of options:

aws_ssh_sync --help

Preview

The easiest way to get a preview of the current config in AWS is to print the output directly to stdout:

aws_ssh_sync --profile <profile> --region <region>

Utilising the 'Include' directive

If you want to isolate the generated config, you can write it to a dedicated file, and Include it in the main config. The base use-case is as follows:

aws_ssh_sync --profile <profile> --region <region> > ~/.ssh/config.d/<some_file>

To extend your ~/.ssh/config, add the following line:

Include config.d/*

Working with a single config file

Splitting config into multiple, small files keeps things elegant and clean - you should probably stick to that, if you can.

Unfortunatelly, some tools may still have trouble with the Include directive itself. If you want to use a single file (e.g. ~/.ssh/config) for keeping all configuration, then you can specify the --output-file together with a --config-key:

aws_ssh_sync --profile <profile> --region <region> --config-key <key> --output-file <path>

Behaviour:

  • Configuration is written to the --output-file rather than stdout.
  • If the file doesn't exist, then it will be created.
  • If a section identified by --config-key exists, then it will be replaced.
  • If no --config-key was found, then a new section will be appended to the file.
  • No backup file is created at the moment.

References

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 aws-ssh-sync, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size aws_ssh_sync-0.3.0-py3-none-any.whl (10.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size aws-ssh-sync-0.3.0.tar.gz (7.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page