AWS SSM Session Manager CLI客户端：aws-gate使用教程

1. 项目介绍

aws-gate是一个开源项目，旨在改进AWS Systems Manager Session Manager的命令行用户体验。它提供了更灵活的连接方式，比如通过DNS、IP、标签、实例名称或自动扩展组来连接实例。此外，aws-gate还支持配置文件，以便存储和管理会话连接信息。

2. 项目快速启动

环境要求

• Python 3.5+版本
• AWS的session-plugin-manager
• EC2实例上安装SSM Agent版本2.3.68.0或更高
• 实例配置了正确的IAM权限

安装

通过pip安装：

pip install aws-gate

或者通过Homebrew安装：

brew tap xen0l/homebrew-taps
brew install aws-gate

还可以通过Docker安装：

docker login docker.pkg.github.com -u $YOUR_GH_USERNAME -p $GH_TOKEN
docker pull docker.pkg.github.com/xen0l/aws-gate/aws-gate:latest

配置

创建配置文件~/.aws-gate/config，以下是一个示例YAML语法：

hosts:
- alias: backend-pre
  name: backend
  profile: preproduction
  region: eu-west-1
- alias: backend-pro
  name: backend
  profile: production
  region: eu-west-1
defaults:
  profile: development
  region: eu-west-1

使用配置别名连接：

aws-gate session backend-pre

3. 应用案例和最佳实践

通过不同标识符查询实例

aws-gate支持以下标识符来查询实例：

• 实例ID
• DNS名称
• 私有DNS名称
• IP地址
• 私有IP地址
• 标签
• 名称（使用标签标识符）
• 自动扩展组名称（使用标签标识符）

例如，通过实例ID连接：

aws-gate session i-0772e4c1dcdd763b6

SSH代理命令支持

aws-gate支持通过SSH代理命令使用EC2 Instance Connect API上传临时SSH密钥。

生成SSH配置：

aws-gate ssh-config >> ~/.ssh/config

然后通过SSH连接：

ssh ssm-test.eu-west-1.default

SCP支持

aws-gate也支持通过SSM传输文件，但是可能会有速度限制。

# 从本地到远程
scp test_file ssm-test.eu-west-1.glovoapp:test_file

# 从远程到本地
scp ssm-test.eu-west-1.glovoapp:test_file test_file

4. 典型生态项目

aws-gate可以与AWS的其他服务配合使用，例如：

• AWS EC2实例
• AWS RDS数据库
• AWS Elastic Beanstalk应用

这些服务的结合可以为开发者提供强大的自动化运维能力，提高生产效率。