Fabric库中禁用load_ssh_configs的策略与实践

本文旨在提供在fabric作为python库使用时，禁用其默认加载`~/.ssh/config`文件的方法。我们将探讨两种主要策略：通过创建全局配置文件进行设置，以及通过编程方式在代码中精确控制配置加载。重点将放在后者，即通过向`fabric.config`对象传递空的`paramiko.sshconfig`实例，实现灵活且无文件依赖的ssh配置管理。

Fabric是一个强大的Python库，用于自动化SSH任务和部署。默认情况下，当Fabric初始化其配置时，它会自动尝试加载用户的~/.ssh/config文件，以便利用其中定义的别名、端口、用户等SSH连接参数。然而，在某些场景下，特别是在将Fabric作为更大应用程序的一部分使用时，开发者可能希望完全禁用这种自动加载行为，以实现更精细的控制，避免本地SSH配置对程序逻辑产生意外影响，或者在没有~/.ssh/config文件的环境中运行。

方法一：通过配置文件全局禁用SSH配置加载

如果你希望在所有Fabric会话中全局禁用SSH配置加载，并且不介意使用一个配置文件，那么在用户主目录下创建一个~/.fabric.yaml文件是直接有效的方法。

步骤：

1. 在你的用户主目录（通常是/home/youruser或C:\Users\youruser）下创建一个名为.fabric.yaml的文件。

2. 在该文件中添加以下内容：

   load_ssh_configs: false

   登录后复制

说明： 当Fabric启动时，它会查找并加载这个全局配置文件。设置load_ssh_configs: false会指示Fabric不再尝试读取~/.ssh/config文件。这种方法简单易行，适用于需要全局禁用该功能的场景。

方法二：通过代码编程禁用SSH配置加载 (推荐用于库模式)

当Fabric作为Python库被集成到应用程序中时，通常更倾向于通过代码进行控制，而不是依赖外部配置文件。这样可以使应用程序更加自包含和可移植。

问题的核心在于，Fabric的配置加载通常发生在fabric.Config对象初始化时。如果直接在fabric.Config实例创建后设置conf.load_ssh_configs = False，可能为时已晚，因为默认的SSH配置可能已经被加载到conf.base_ssh_config中了。

最可靠的编程方法是在创建fabric.Config对象时，明确地告诉它不要加载默认的SSH配置。这可以通过向fabric.Config构造函数传递一个空的paramiko.SSHConfig实例来实现。

实现步骤：

1. 导入paramiko和fabric库。
2. 创建一个空的paramiko.SSHConfig对象。paramiko是Fabric底层SSH连接的依赖库，SSHConfig是其用于管理SSH配置的类。
3. 在实例化fabric.Config时，将这个空的paramiko.SSHConfig对象作为ssh_config参数传递。
4. 使用这个自定义的Config对象来创建fabric.Connection实例。

示例代码：

OpenAI Codex

可以生成十多种编程语言的工作代码，基于 OpenAI GPT-3 的自然语言处理模型

144

查看详情

#!/usr/bin/env python3
import paramiko
import fabric

# 1. 创建一个空的paramiko.SSHConfig对象
# 这会阻止Fabric加载默认的~/.ssh/config文件
empty_ssh_config = paramiko.SSHConfig()

# 2. 将空的SSHConfig对象传递给fabric.Config
# 这样创建的config对象就不会加载任何默认的SSH配置
custom_config = fabric.Config(ssh_config=empty_ssh_config)

# 3. 使用自定义的config对象创建Connection
# 此时，'host_alias'将不会从~/.ssh/config中解析
# 你需要提供完整的连接信息，例如 'user@hostname:port'
try:
    # 假设你要连接一个名为'primary'的主机，但其配置不会从~/.ssh/config中加载
    # 因此，'primary'在这里必须是一个完整的hostname或IP
    conn = fabric.Connection(host="your_actual_hostname_or_ip", config=custom_config, user="your_username", port=22)

    print(f"成功创建连接到 {conn.host} (用户: {conn.user})")

    # 示例：执行一个简单命令
    with conn:
        result = conn.run("hostname", hide=True)
        print(f"主机名: {result.stdout.strip()}")

except Exception as e:
    print(f"连接失败: {e}")

原理分析：

fabric.Config的构造函数在接收到ssh_config参数时，会优先使用传入的paramiko.SSHConfig实例，而不是尝试自己去加载默认路径下的~/.ssh/config。通过传入一个刚刚创建的、没有任何内容的paramiko.SSHConfig对象，我们有效地绕过了Fabric的默认加载机制。

其他尝试的说明：

• 直接设置load_ssh_configs = False：

  import fabric
  conf = fabric.Config()
  conf.load_ssh_configs = False # 这可能为时已晚

  登录后复制

  这种方式可能无效，因为fabric.Config()在不带参数初始化时，已经执行了默认的配置加载逻辑，包括读取~/.ssh/config。修改load_ssh_configs属性并不能回溯性地“撤销”已加载的配置。

• 使用fabric.Config(lazy=True)：

  conf2 = fabric.Config(lazy=True)
  c = fabric.Connection('host1', config=conf2)

  登录后复制

  lazy=True参数确实可以延迟某些配置的加载，包括~/.ssh/config。在这种情况下，Fabric不会在Config对象创建时立即加载SSH配置。然而，当Connection对象需要用到SSH配置时（例如，解析主机别名），它仍然可能会去加载。相比之下，ssh_config=paramiko.SSHConfig()更明确地表达了“不使用任何预设SSH配置”的意图。

注意事项与最佳实践

1. 配置对象的传递：无论你选择哪种编程方式，请务必将自定义的fabric.Config对象传递给fabric.Connection的构造函数。如果fabric.Connection没有收到明确的config参数，它将使用默认的全局配置，这可能会重新加载~/.ssh/config。
2. 明确性：ssh_config=paramiko.SSHConfig()方法是最明确和推荐的方式，因为它直接替换了Fabric内部用于处理SSH配置的对象，确保不会有意外的默认配置加载。
3. 非单例模式：fabric.Config对象不是单例模式。每次创建fabric.Config()都会得到一个新的实例。这意味着你需要在需要禁用SSH配置加载的每个Connection或相关操作中，使用你自定义的Config实例。
4. 完整的连接信息：当你禁用~/.ssh/config加载后，fabric.Connection将无法从该文件中解析主机别名、用户名、端口等信息。因此，你需要在fabric.Connection的host参数中提供完整的连接字符串（如user@hostname:port），或者通过user、port等参数显式指定。

总结

在Fabric作为库使用时，禁用load_ssh_configs是实现精细化控制的关键。对于全局且不介意配置文件的场景，~/.fabric.yaml文件提供了一个简单的解决方案。然而，对于需要在代码中灵活控制的应用程序，通过向fabric.Config构造函数传递一个空的paramiko.SSHConfig()实例，是实现编程禁用SSH配置加载的最推荐和最可靠的方法。这种方法确保了应用程序的自包含性，并避免了本地SSH配置可能带来的不确定性。

以上就是Fabric库中禁用load_ssh_configs的策略与实践的详细内容，更多请关注php中文网其它相关文章！