AWS SSH 配置生成器使用教程

1. 项目目录结构及介绍

本项目为 aws-ssh-config，旨在通过查询 AWS EC2 API 生成 SSH 配置文件，以便用户能够方便地通过 SSH 连接到 EC2 实例。项目目录结构如下：

• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目使用的 GPL-2.0 许可证文件。
• README.md: 项目说明文件，包含项目描述、使用方法和示例。
• aws-ssh-config.py: 主程序脚本，用于生成 SSH 配置文件。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目的启动文件介绍

项目的启动文件是 aws-ssh-config.py。该脚本通过查询 AWS EC2 API，根据实例的标签和 IP 地址生成 SSH 配置文件。以下是启动文件的一些基本用法：

python aws-ssh-config.py > ~/.ssh/config

上述命令会生成一个 SSH 配置文件，并将其保存到用户的 ~/.ssh/config 路径下。

主要参数

• --default-user: 如果无法从 AMI 名称中检测到默认的 SSH 用户名，可以使用此参数指定默认用户。
• --keydir: 指定私钥文件存放的目录。
• --no-identities-only: 不包含 IdentitiesOnly=yes 在 SSH 配置中，可能会导致使用 ssh-agent 时连接被拒绝。
• --postfix: 为所有主机名指定后缀。
• --prefix: 为所有主机名指定前缀。
• --private: 使用私有 IP 地址，默认使用公有 IP 地址。
• --profile: 指定 AWS 凭据配置文件。
• --proxy: 指定堡垒主机作为 ProxyCommand 使用。
• --region: 在主机名中附加区域名称。
• --ssh-key-name: 覆盖默认的 SSH 密钥名称。
• --strict-hostkey-checking: 不包含 StrictHostKeyChecking=no 在 SSH 配置中。
• --tags: 指定用于生成主机名的标签列表。
• --user: 覆盖所有主机的 SSH 用户名。
• --white-list-region: 指定必须包含哪些区域，如果未指定，则考虑所有区域。

3. 项目的配置文件介绍

本项目不需要额外的配置文件。所有的配置选项都可以通过命令行参数进行设置。不过，如果用户需要对生成 SSH 配置的方式有更复杂的定制需求，可以修改 aws-ssh-config.py 脚本中的以下部分：

• AMIS_TO_USER: 一个字典，用于根据 AMI 名称正则表达式匹配默认的 SSH 用户名。

如果需要对配置进行更复杂的调整，用户可以直接编辑 aws-ssh-config.py 脚本，根据具体需求添加自定义逻辑。