WARCannon 使用与配置指南

1. 项目目录结构及介绍

WARCannon 的目录结构如下所示：

warcannon/
├── bin/
├── cloudshell/
├── jsonnet/
├── lambda_functions/
├── site_contents/
├── templates/
├── .gitignore
├── LICENSE.md
├── README.md
├── package-lock.json
├── package.json
├── populate_athena.sh
├── settings.json.sample
└── terraform.jsonnet

• bin/: 存放项目的一些可执行脚本。
• cloudshell/: 包含 AWS CloudShell 部署相关的脚本。
• jsonnet/: 存放 JSONnet 配置文件。
• lambda_functions/: Lambda 函数的代码，用于在 AWS 中执行特定的任务。
• site_contents/: 网站内容相关的文件。
• templates/: 模板文件，用于生成项目配置。
• .gitignore: Git 忽略文件列表，用于指定 Git 应该忽略的文件和目录。
• LICENSE.md: 项目的许可协议文件。
• README.md: 项目的说明文件，通常包含项目描述、使用方法和安装指南。
• package-lock.json: npm 的锁定文件，用于确保安装的依赖项版本一致。
• package.json: npm 的配置文件，定义了项目的依赖项和其他元数据。
• populate_athena.sh: 脚本文件，用于填充 Athena 数据。
• settings.json.sample: 配置文件的示例，用于指导用户如何设置自己的配置文件。
• terraform.jsonnet: Terraform 的 JSONnet 配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过 package.json 文件中定义的 npm 脚本来进行。以下是一些关键的启动命令：

• npm install: 安装项目依赖。
• npm link: 创建符号链接，使得可以全局访问 warcannon 命令。
• warcannon deploy: 部署 WARCannon 基础设施。
• warcannon testLocal -s: 在本地测试正则表达式。

具体的启动命令会根据用户的需求和项目的阶段来选择。

3. 项目的配置文件介绍

项目的配置主要通过 settings.json.sample 文件来进行。用户应该根据实际情况编辑此文件，并保存为 settings.json。以下是一些重要的配置项：

• nodeInstanceType: 用于并行处理的实例类型数组。
• nodeCapacity: 在并行处理期间请求的节点数。
• nodeParallelism: 每个虚拟 CPU 同时处理的 WARC 数量。
• nodeMaxDuration: 计算节点的最大生命周期（以秒为单位）。
• sshKeyName: 存在于 us-east-1 区域的 EC2 SSH Key 名称。
• allowSSHFrom: 允许 SSH 连接的 CIDR 掩码。

用户需要根据 AWS 资源和自身的需求来调整这些配置项。