kivaprotocol/fsp-controller

Protocol Aries Controllers 镜像文档

镜像概述和主要用途

Protocol Aries Controllers 是基于 aries-controller 基础构建的控制器集合，包含 FSP、Kiva 和 TDC 三种控制器。这些控制器从私有仓库 https://github.com/kiva/protocol-aries 复制而来，主要用于实现特定协议功能，需配合额外的协议资源使用。

核心功能和特性

• 控制器类型：包含 FSP、Kiva 和 TDC 三种控制器
• 依赖集成：需与 aries-guardianship-agency、aries-key-guardian 等协议资源协同工作
• 容器化部署：支持通过 Docker 和 docker-compose 进行部署和管理

依赖资源

该镜像依赖以下外部协议资源：

• https://github.com/kiva/aries-guardianship-agency
• https://github.com/kiva/aries-key-guardian.git
• https://github.com/kiva/protocol-common.git
• https://github.com/kiva/protocol.git

前置设置

必备软件

需在本地环境安装以下软件：

• git
• docker
• docker-compose
• npm
• nodejs
• java

Docker 资源配置

推荐调整 Docker 资源分配：

• CPU：8 核
• 内存：7 GB
• 交换空间：2 GB

使用方法和配置说明

1. 创建主目录

创建一个顶级目录（如 "protocol-all"），用于存放所有相关仓库，后续命令均在此目录下执行。

2. 克隆仓库

在主目录中执行以下命令克隆仓库（需配置 SSL）：

bash
git clone git@github.com:kiva/protocol-aries.git

3. 配置环境变量

进入 protocol-aries 目录并生成环境变量文件：

bash
cd protocol-aries
./scripts/dummy_env.sh

注意：部分 token 值需从 Google 文档 获取并补充。

4. 拉取基础镜像

手动拉取最新的 bcgov 镜像：

bash
docker pull bcgovimages/aries-cloudagent:py36-1.16-1_0.7.1

5. 启动依赖容器

在 protocol-aries-controllers 目录下，启动依赖容器（可添加 -d 参数后台运行）：

bash
docker-compose -f docker-compose.dep.yml build
docker-compose -f docker-compose.dep.yml up

6. 启动控制器容器

启动 protocol-aries-controllers 容器：

bash
docker-compose -f docker-compose.local.yml up --build --force-recreate

7. 验证容器状态

执行以下命令检查容器运行状态，确保所有必要容器状态为 "Up"：

bash
docker ps --format "table {{.Names}}\t{{.Status}}"

需确认以下容器正常运行：

NAMES                           STATUS
fsp-controller                  Up [时间]
tdc-controller                  Up [时间]
kiva-controller                 Up [时间]
tdc-agent                       Up [时间]
fsp-agent                       Up [时间]
kiva-agent                      Up [时间]

8. 配置控制器

执行 setup 脚本完成控制器配置：

bash
./scripts/setup.sh