将 SSH 密钥文件与 Fabric 结合使用

Question

如何配置结构以使用 SSH 密钥文件连接到远程主机（例如 Amazon EC2 实例）？

Answer 1

由于某种原因，找到一个带有 SSH 密钥文件使用示例的简单 fabfile 并不容易。我写了一篇关于它的博客文章（具有匹配的要点）。

基本上，用法是这样的：

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')

重要的部分是设置 env.key_filename 环境变量，以便 Paramiko 配置可以在连接时查找它。

Answer 2

这里还值得一提的是，您可以使用命令行参数来执行此操作：

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

Answer 3

Fabric 1.4 提供的另一个很酷的功能 - Fabric 现在支持 SSH配置。

如果您的 ~/.ssh/config 文件中已包含所有 SSH 连接参数，Fabric 将原生支持它，您所需要做的就是

env.use_ssh_config = True

在 fabfile 的开头添加： 。

Answer 4

对于 fabfile 中的 fabric2，请使用以下命令：

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')

并运行它：

fab staging do_something_remote

更新：
对于多个主机（一台主机也可以），您可以使用以下命令：

from fabric2 import task, SerialGroup

@task
def staging(ctx):
    conns = SerialGroup(
        '[email protected]',
        '[email protected]',
        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)

并使用 fab 或 fab2 运行它：

fab staging stop

Answer 5

对我来说，以下内容不起作用：

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

或

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

但是，以下内容有效：

env.key_filename=['keyfile.pem']
env.hosts=["[email protected]"]

或

env.key_filename=['keyfileq.pem']
env.host_string="[email protected]"

Answer 6

我今天必须这样做，我的 .py 文件尽可能简单，就像 @YuvalAdam 的答案中发布的文件一样，但我仍然不断收到输入密码的提示......

看看 paramiko （fabric 用于 ssh 的库）日志，我发现了这一行：

不兼容的 ssh 对等点（没有可接受的 kex 算法）

我更新了 paramiko：

sudo pip install paramiko --upgrade

现在它可以工作了。

Answer 7

这些答案在 py3.7、fabric2.5.0 和 paramiko 2.7.1 上都不适用于我。

但是，在文档中使用 PKey 属性确实有效： 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.... 

Answer 8

如上所述，Fabric 将支持 .ssh/config 文件设置，但对 ec2 使用 pem 文件似乎有问题。 IOW 正确设置的 .ssh/config 文件将通过“ssh servername”从命令行工作，并且当 env.host=['servername'] 时无法使用“fab sometask”。

通过在 fabfile.py 中指定 env.key_filename='keyfile' 并复制 .ssh/config 中已有的 IdentityFile 条目，可以克服这个问题。

这可以是 Fabric 或 paramiko，在我的例子中是 Fabric 1.5.3 和 Paramiko 1.9.0。