ec2ssh 项目技术文档

1. 安装指南

1.1 安装 Ruby

首先，确保你的系统上已经安装了 Ruby。你可以通过以下命令检查 Ruby 是否已安装：

ruby -v

如果未安装，请根据你的操作系统安装 Ruby。例如，在 Ubuntu 上可以使用以下命令安装：

sudo apt-get update
sudo apt-get install ruby-full

1.2 安装 ec2ssh

安装 ec2ssh 非常简单，只需使用 Ruby 的包管理工具 gem 即可：

gem install ec2ssh

2. 项目的使用说明

2.1 设置实例的 'Name' 标签

在使用 ec2ssh 之前，你需要为你的 EC2 实例设置 'Name' 标签。例如，将标签 'app-server-1' 设置为实例 i-xxxxx 的 'Name' 标签。

2.2 配置 AWS 凭证

在 ~/.aws/credentials 文件中配置你的 AWS 凭证。示例如下：

[default]
aws_access_key_id=...
aws_secret_access_key=...

[myprofile]
aws_access_key_id=...
aws_secret_access_key=...

2.3 初始化 ec2ssh

安装完成后，使用以下命令初始化 ec2ssh：

ec2ssh init

2.4 编辑 .ec2ssh 文件

编辑 ~/.ec2ssh 文件以配置你的 AWS 配置文件和区域：

vi ~/.ec2ssh

示例配置：

profiles 'default', 'myprofile'
regions 'us-east-1', 'ap-northeast-1'

reject {|instance| !instance.tag('Name') }

filters([
  { name: 'instance-state-name', values: ['running', 'stopped'] }
])

host_line <<END
Host <%= tag('Name') %>.<%= placement.availability_zone %>
  HostName <%= public_dns_name || private_ip_address %>
END

2.5 更新 SSH 配置

使用以下命令更新 SSH 配置文件：

ec2ssh update

2.6 使用 SSH 连接实例

更新完成后，你可以使用实例的 'Name' 标签进行 SSH 连接：

ssh app-server-1.us-east-1a

3. 项目API使用文档

3.1 命令列表

ec2ssh 提供了以下命令：

• ec2ssh help [TASK]：查看可用任务或特定任务的帮助信息。
• ec2ssh init：在 ssh_config 中添加 ec2ssh 标记。
• ec2ssh update：更新 ssh_config 中的 EC2 主机列表。
• ec2ssh remove：从 ssh_config 中移除 ec2ssh 标记。

3.2 选项

每个命令都可以使用 --dotfile 选项来指定 .ec2ssh 文件的路径。默认路径为 ~/.ec2ssh。

示例：

ec2ssh init --dotfile /path/to/ssh_config

4. 项目安装方式

4.1 使用 RubyGems 安装

ec2ssh 可以通过 RubyGems 安装：

gem install ec2ssh

4.2 手动安装

你也可以从 GitHub 仓库下载源码并手动安装：

git clone https://github.com/mirakui/ec2ssh.git
cd ec2ssh
gem build ec2ssh.gemspec
gem install ec2ssh-*.gem

5. 注意事项

• ec2ssh 会更新你的 ~/.ssh/config 文件，建议在使用前备份该文件。
• 如果你从 3.x 版本升级，请注意 .ec2ssh 文件格式的变化。

6. Zsh 自动补全支持

ec2ssh 提供了 Zsh 自动补全支持，使用 zsh/_ec2ssh 文件即可启用。

7. 许可证

ec2ssh 项目基于 MIT 许可证发布，版权所有 (c) 2022 Issei Naruta。