Usar un archivo de claves SSH con Fabric

¿Cómo se configura la estructura para conectarse a hosts remotos mediante archivos de claves SSH (por ejemplo, instancias Amazon EC2)?

También vale la pena mencionar aquí que puede usar los argumentos de la línea de comando para esto:

fab command -i /path/to/key.pem [-H [user@]host[:port]]

Encontrar un fabfile simple con un ejemplo funcional del uso de archivos de claves SSH no es fácil por alguna razón. Escribí una publicación de blog al respecto ( con una esencia coincidente ).

Básicamente, el uso es algo como esto:

from fabric.api import *

env.hosts = ['host.name.com']
env.user = 'user'
env.key_filename = '/path/to/keyfile.pem'

def local_uname():
    local('uname -a')

def remote_uname():
    run('uname -a')

Lo importante es configurar la env.key_filenamevariable de entorno, para que la configuración de Paramiko pueda buscarla al conectarse.

Otra característica interesante disponible a partir de Fabric 1.4: Fabric ahora admite configuraciones SSH .

Si ya tiene todos los parámetros de conexión SSH en su ~/.ssh/configarchivo, Fabric lo admitirá de forma nativa, todo lo que necesita hacer es agregar:

env.use_ssh_config = True

al comienzo de su fabfile.

Para fabric2 en fabfile, use lo siguiente:

from fabric import task, Connection

@task
def staging(ctx):
    ctx.name = 'staging'
    ctx.user = 'ubuntu'
    ctx.host = '192.1.1.1'
    ctx.connect_kwargs.key_filename = os.environ['ENV_VAR_POINTS_TO_PRIVATE_KEY_PATH']

@task
def do_something_remote(ctx):
    with Connection(ctx.host, ctx.user, connect_kwargs=ctx.connect_kwargs) as conn:
        conn.sudo('supervisorctl status')

y ejecutarlo con:

fab staging do_something_remote

ACTUALIZACIÓN:
para varios hosts (un host también lo hará) puede usar esto:

from fabric2 import task, SerialGroup

@task
def staging(ctx):
    conns = SerialGroup(
        'user@10.0.0.1',
        'user@10.0.0.2',
        connect_kwargs=
        {
            'key_filename': os.environ['PRIVATE_KEY_TO_HOST']
        })
    ctx.CONNS = conns
    ctx.APP_SERVICE_NAME = 'google'

@task
def stop(ctx):
    for conn in ctx.CONNS:
        conn.sudo('supervisorctl stop ' + ctx.APP_SERVICE_NAME)

y ejecutarlo con fab o fab2:

fab staging stop

Para mí, lo siguiente no funcionó:

env.user=["ubuntu"]
env.key_filename=['keyfile.pem']
env.hosts=["xxx-xx-xxx-xxx.ap-southeast-1.compute.amazonaws.com"]

o

fab command -i /path/to/key.pem [-H [user@]host[:port]]

Sin embargo, lo siguiente hizo:

env.key_filename=['keyfile.pem']
env.hosts=["ubuntu@xxx-xx-xxx-xxx-southeast-1.compute.amazonaws.com"]

o

env.key_filename=['keyfileq.pem']
env.host_string="ubuntu@xxx-xx-xxx-xxx.ap-southeast-1.compute.amazonaws.com"

Tuve que hacer esto hoy, mi archivo .py era lo más simple posible, como el que se publicó en la respuesta de @YuvalAdam, pero aún así me seguían pidiendo una contraseña ...

Mirando el paramikoregistro (la biblioteca utilizada por fabric para ssh), encontré la línea:

Peer ssh incompatible (no hay algoritmo kex aceptable)

Actualicé paramikocon:

sudo pip install paramiko --upgrade

Y ahora está funcionando.

Como se indicó anteriormente, Fabric admitirá la configuración del archivo .ssh / config de alguna manera, pero usar un archivo pem para ec2 parece ser problemático. IOW, un archivo .ssh / config correctamente configurado funcionará desde la línea de comandos a través de 'ssh servername' y no funcionará con 'fab sometask' cuando env.host = ['servername'].

Esto se superó especificando env.key_filename = 'keyfile' en mi fabfile.py y duplicando la entrada IdentityFile que ya estaba en mi .ssh / config.

Este podría ser Fabric o paramiko, que en mi caso fue Fabric 1.5.3 y Paramiko 1.9.0.

Ninguna de estas respuestas me funcionó en py3.7, fabric2.5.0 y paramiko 2.7.1.

Sin embargo, el uso del atributo PKey en la documentación funciona: http://docs.fabfile.org/en/2.5/concepts/authentication.html#private-key-objects

from paramiko import RSAKey
ctx.connect_kwargs.pkey = RSAKey.from_private_key_file('path_to_your_aws_key')
with Connection(ctx.host, user, connect_kwargs=ctx.connect_kwargs) as conn:
    //etc....