"`，则意味着已成功验证签名，您可以继续运行 EC2Rescue for Linux 安装脚本。
如果输出包含短语 `BAD signature`，则检查是否正确执行了此过程。如果您持续获得此响应，请联系 Amazon Web Services，而不要运行之前下载的安装文件。
下面是有关您可能看到的警告的详细信息：
+ **WARNING: This key is not certified with a trusted signature\$1 There is no indication that the signature belongs to the owner.**这表示您坚信自己拥有 EC2Rescue for Linux 的可信公有密钥的个人信任级别。理想情况下，您将前往 Amazon Web Services 办公室并亲自接收此密钥。但更常见的情况是，从网站下载此密钥。在这种情况下，该网站是 Amazon Web Services 网站。
+ **gpg2: no ultimately trusted keys found.** 这意味着您 (或您信任的其他人) 对特定密钥不是“绝对信任”。
有关更多信息，请参阅 [https://www.gnupg.org/](https://www.gnupg.org/)。
# 在 Amazon EC2 Linux 实例上运行 EC2Rescue 命令
EC2Rescue 是一个命令行工具。在 Linux 实例上安装 EC2Rescue 后，您可以通过运行 `./ec2rl help` 获得有关如何使用该工具的一般帮助。您可以通过运行 `./ec2rl list` 查看可用模块，也可以通过运行 `./ec2rl help module_name` 获得有关特定模块的帮助。
下面是您可以执行以便开始使用此工具的常见任务。
**Topics**
+ [运行 EC2Rescue 模块](#ec2rl_running_module)
+ [上传 EC2Rescue 模块结果](#ec2rl_uploading_results)
+ [创建 Amazon EC2 Linux 实例的备份](#ec2rl_creating_backups)
## 运行 EC2Rescue 模块
**运行所有 EC2Rescue 模块**
使用 **./ec2rl run** 命令而不指定任何附加参数。有些模块需要根访问权限。如果您不是根用户，请在运行命令时使用 **sudo**。
```
./ec2rl run
```
**运行特定的 EC2Rescue 模块**
使用 **./ec2rl run** 命令并为 `--only-modules` 指定要运行的模块的名称。有些模块需要*参数*才能使用。
```
./ec2rl run --only-modules=module_name --arguments
```
例如，要运行 **dig** 模块查询 `amazon.com` 域，请使用以下命令。
```
./ec2rl run --only-modules=dig --domain=amazon.com
```
**查看 EC2Rescue 模块的结果**
运行该模块，然后查看 `cat /var/tmp/ec2rl/logfile_location` 中的日志文件。例如，可在以下位置找到 **dig** 模块的日志文件：
```
cat /var/tmp/ec2rl/timestamp/mod_out/run/dig.log
```
## 上传 EC2Rescue 模块结果
如果 支持 请求 EC2Rescue 模块的结果，则可以使用 EC2Rescue 工具上传日志文件。您可以将结果上传到 支持 提供的位置或您自己的 Amazon S3 存储桶。
**将结果上传到 支持 提供的位置**
使用 **./ec2rl upload** 命令。对于 `--upload-directory`，指定日志文件的位置。对于 `--support-url`，请指定 支持 提供的 URL。
```
./ec2rl upload --upload-directory=/var/tmp/ec2rl/logfile_location --support-url="url_provided_by_aws_support"
```
**将结果上传到 Amazon S3 存储桶**
使用 **./ec2rl upload** 命令。对于 `--upload-directory`，指定日志文件的位置。对于 `--presigned-url`，为 S3 存储桶指定预签名 URL。有关为 Amazon S3 生成预签名 URL 的更多信息，请参阅[使用预签名 URL 上传对象](https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html)。
```
./ec2rl upload --upload-directory=/var/tmp/ec2rl/logfile_location --presigned-url="presigned_s3_url"
```
## 创建 Amazon EC2 Linux 实例的备份
您可以使用 EC2Rescue 通过创建 AMI 或创建其附加卷的快照来备份您的 Linux 实例。
**创建 AMI**
使用 `./ec2rl run` 命令，并为 --`backup` 指定 `ami`。
```
./ec2rl run --backup=ami
```
**创建所有附加卷的多卷快照**
使用 `./ec2rl run` 命令，并为 --`backup` 指定 `allvolumes`。
```
./ec2rl run --backup=allvolumes
```
**创建特定附加卷的快照**
使用 `./ec2rl run` 命令，并为 --`backup` 指定要备份的卷的 ID。
```
./ec2rl run --backup=vol-01234567890abcdef
```
# 为 Amazon EC2 Linux 实例开发 EC2Rescue 模块
模块使用 YAML 编写，这是一种数据序列化标准。模块的 YAML 文件包括一个文档，用于表示模块及其属性。
## 添加模块属性
下表列出了可用的模块属性。
| 属性 | 说明 |
| --- | --- |
| name | 模块的名称。该名称长度应少于或等于 18 个字符。 |
| 版本 | 模块的版本号。 |
| 删除实例快照 | 模块的简短说明性标题。此值的长度应少于或等于 50 个字符。 |
| helptext | 模块的详细说明。每一行的长度应少于或等于 75 个字符。如果模块使用必需或可选参数，请在 helptext 值中包括这些参数。 例如： helptext: !!str |
Collect output from ps for system analysis
Consumes --times= for number of times to repeat
Consumes --period= for time period between repetition
|
| placement | 运行模块的阶段。支持的值： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/AWSEC2/latest/UserGuide/ec2rl_moduledev.html) |
| language | 编写模块代码使用的语言。支持的值： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/AWSEC2/latest/UserGuide/ec2rl_moduledev.html) Python 代码必须同时兼容 Python 2.7.9\$1 和 Python 3.2\$1。 |
| 修复 | 指示模块是否支持修正。支持的值为 `True` 或 `False`。 模块默认为 `False`（如果不存在），这使其成为那些不支持修正的模块的可选属性。 |
| content | 整个脚本代码。 |
| constraint | 包含限制值的对象的名称。 |
| 域 | 说明如何分组或分类模块的描述符。所包括的模块组使用以下域： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/AWSEC2/latest/UserGuide/ec2rl_moduledev.html) |
| class | 由模块执行的任务类型的描述符。所包括的模块组使用以下类： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/AWSEC2/latest/UserGuide/ec2rl_moduledev.html) |
| distro | 此模块支持的 Linux 发行版的列表。所包含的模块组使用以下发行版： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/AWSEC2/latest/UserGuide/ec2rl_moduledev.html) |
| 必需 | 模块从 CLI 选项使用的必需参数。 |
| optional | 模块可使用的可选参数。 |
| 软件 | 模块中使用的软件可执行文件。此属性用于指定默认情况下未安装的软件。EC2Rescue for Linux 逻辑在运行模块之前确保这些程序存在并且可执行。 |
| 程序包 | 可执行文件的源软件包。此属性用于随软件提供软件包的详细信息，包括用于下载或者获取更多信息的 URL。 |
| sudo | 指示运行模块是否需要根访问权限。 您无需在模块脚本中实施 sudo 检查。如果值为 true，则 EC2Rescue for Linux 逻辑仅在执行用户具有根访问权限时才运行模块。 |
| perfimpact | 指示模块对其运行环境是否会产生重大性能影响。如果值为 true 并且没有 `--perfimpact=true` 参数，则跳过模块。 |
| parallelexclusive | 指定需要互斥的程序。例如，所有指定“bpf”的模块以串行方式运行。 |
## 设置环境变量
下表列出了可用的环境变量。
| 环境变量 | 说明 |
| --- | --- |
| `EC2RL_CALLPATH` | ec2rl.py 的路径。此路径可用于定位 lib 目录和使用分发的 Python 模块。 |
| `EC2RL_WORKDIR` | 诊断工具的主 tmp 目录。 默认值：`/var/tmp/ec2rl`。 |
| `EC2RL_RUNDIR` | 用于存储所有输出的目录。 默认值：`/var/tmp/ec2rl/`。 |
| `EC2RL_GATHEREDDIR` | 用于放置收集的模块数据的根目录。 默认值:`/var/tmp/ec2rl//mod_out/gathered/`。 |
| `EC2RL_NET_DRIVER` | 为实例上第一个 (按照字母顺序排序) 非虚拟网络接口使用的驱动程序。 示例： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/AWSEC2/latest/UserGuide/ec2rl_moduledev.html) |
| `EC2RL_SUDO` | 如果 EC2Rescue for Linux 以根身份运行，则为 true；否则为 false。 |
| `EC2RL_VIRT_TYPE` | 由实例元数据提供的虚拟化类型。 示例： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/AWSEC2/latest/UserGuide/ec2rl_moduledev.html) |
| `EC2RL_INTERFACES` | 系统上的接口枚举列表。该值为包含名称的字符串，例如 `eth0`、`eth1` 等。这通过 `functions.bash` 生成，仅对其来源模块可用。 |
## 使用 YAML 语法
在您构建模块 YAML 文件时，应注意以下事项：
+ 三个连字符 (`---`) 表示文档的明确开始位置。
+ `!ec2rlcore.module.Module` 标签指示 YAML 分析器在从数据流创建对象时调用哪个构造函数。您可在 `module.py` 文件内部查找构造函数。
+ `!!str` 标签告知 YAML 解析器不尝试确定数据的类型，而是将内容解释为字符串文本。
+ 竖线字符 (`|`) 告知 YAML 解析器该值为文字类型的标量。在这种情况下，解析器包括所有空格。对于模块而言这非常重要，因为保留了缩进和换行字符。
+ YAML 标准缩进为两个空格，在下例中可以看到。请确保您为脚本保留了标准缩进 (例如，对于 Python 为四个空格)，然后在模块文件中将全部内容缩进两个空格。
## 模块示例
示例 1 (`mod.d/ps.yaml`)：
```
--- !ec2rlcore.module.Module
# Module document. Translates directly into an almost-complete Module object
name: !!str ps
path: !!str
version: !!str 1.0
title: !!str Collect output from ps for system analysis
helptext: !!str |
Collect output from ps for system analysis
Requires --times= for number of times to repeat
Requires --period= for time period between repetition
placement: !!str run
package:
- !!str
language: !!str bash
content: !!str |
#!/bin/bash
error_trap()
{
printf "%0.s=" {1..80}
echo -e "\nERROR: "$BASH_COMMAND" exited with an error on line ${BASH_LINENO[0]}"
exit 0
}
trap error_trap ERR
# read-in shared function
source functions.bash
echo "I will collect ps output from this $EC2RL_DISTRO box for $times times every $period seconds."
for i in $(seq 1 $times); do
ps auxww
sleep $period
done
constraint:
requires_ec2: !!str False
domain: !!str performance
class: !!str collect
distro: !!str alami ubuntu rhel suse
required: !!str period times
optional: !!str
software: !!str
sudo: !!str False
perfimpact: !!str False
parallelexclusive: !!str
```