ploy-fabric 2.0.0

概述

The ploy_fabric plugin provides integration of Fabric with ploy.

安装

ploy_fabric最好通过easy_install、pip或buildout中的zc.recipe.egg安装。

安装后，其功能可以立即与ploy一起使用。

命令

该插件为ploy添加了以下命令。

do

使用简化的参数语法运行Fabric任务。只需在任务名称后面将位置参数放在命令行上即可。对于关键字参数，请使用name=value语法。例如

ploy do something arg key=value

fab

运行Fabric任务并将命令行选项传递给Fabric。这基本上反映了Fabric的fab脚本。

选项

实例仅获得新的fabfile选项来指定查找任务的文件。位置相对于ploy.conf。

实例方法

对于Python端，每个实例都获得了 do(task, *args, **kwargs) 方法。其中 task 参数是要运行的 Fabric 脚本中任务的名称。其余参数将传递给该任务。

每个实例还增加了一个可以通过实例上的 fabric 属性访问的上下文管理器。使用它，您可以在 Fabric 任务中切换到具有不同用户的新的 ssh 连接。

from fabric.api import env, run


def sometask():
    run("whoami")  # prints the default user (root)
    with env.instance.fabric(user='foo'):
      run("whoami")  # prints 'foo' if the connection worked
    run("whoami")  # prints the default user (root)

上下文管理器退出时，将撤销对 Fabric 环境的所有更改。

Fabric 任务装饰器

通过 ploy_fabric.context，您可以装饰一个任务以使用具有单独连接的特定用户。上下文管理器退出时，将撤销对 Fabric 环境的所有更改。如果您想在另一个任务内部运行一个任务，这非常有用。

from fabric.api import env, run
from ploy_fabric import context


@context  # always run with the default user
def sometask():
    run("whoami")  # prints the default user (root)


@context(user=None)  # always run with the default user (alternate syntax)
def someothertask():
    env.forward_agent = True
    run("whoami")  # prints the default user (root)


@context(user='foo')  # always run as foo user
def anothertask():
    env.forward_agent = False
    run("whoami")  # prints the default user (user)
    someothertask()
    assert env.forward_agent == False

Fabric 环境

Fabric 环境具有以下默认设置。

reject_unknown_hosts

始终设置为 True，ssh 连接由该插件和 ploy 处理。

disable_known_hosts

始终设置为 True，由 ploy 处理。

host_string

当前实例的唯一 标识符，只有当您知道自己在做什么时才进行操作！

known_hosts

ploy 管理的 known_hosts 文件的路径。

instances

允许访问其他实例以获取变量或调用方法的字典。

instance

当前实例，可以访问 config 属性中的变量或其他东西和方法。

config_base

ploy.conf 的目录。

以 fabric- 开头的实例任何选项都将移除 fabric- 前缀，并覆盖具有该名称的环境设置。

变更日志