kivaprotocol/kiva-controller

Protocol Aries Controllers 镜像文档

镜像概述和主要用途

本镜像包含基于aries-controller基础构建的控制器，具体包括FSP、Kiva和TDC控制器。这些控制器源自私有仓库https://github.com/kiva/protocol-aries%EF%BC%8C%E4%B8%BB%E8%A6%81%E7%94%A8%E4%BA%8E%E5%8D%8F%E8%AE%AE%E7%9B%B8%E5%85%B3%E7%9A%84%E6%8E%A7%E5%88%B6%E5%92%8C%E7%AE%A1%E7%90%86%E5%8A%9F%E8%83%BD%E3%80%82

核心功能和特性

• 包含控制器：FSP、Kiva和TDC三种控制器
• 依赖资源：需配合以下协议资源使用：
  • 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

使用场景和适用范围

适用于需要集成FSP、Kiva或TDC控制器的协议相关项目，需在满足前置依赖条件的环境中部署和运行。

前置要求

• 需在本地安装以下软件：git、docker、docker-compose、npm、nodejs和java
• Docker资源配置建议：
  • CPU：8核
  • 内存：7 GB
  • 交换空间：2 GB

详细使用方法和配置说明

1. 创建主目录

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

2. 克隆仓库

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

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

3. 进入工作目录

bash
cd protocol-aries

4. 生成环境变量文件

运行脚本生成包含默认环境变量的.env文件：

bash
./scripts/dummy_env.sh

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

5. 拉取基础镜像

手动拉取最新的bcgov镜像：

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

6. 启动依赖容器

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

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

7. 启动控制器容器

在protocol-aries-controllers目录下，构建并启动控制器容器：

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

8. 验证容器状态

执行以下命令检查容器是否正常运行：

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

需确保以下容器状态为Up：

NAMES                           STATUS
fsp-controller                  Up X minutes
tdc-controller                  Up X minutes
kiva-controller                 Up X minutes
tdc-agent                       Up X hours
fsp-agent                       Up X hours
kiva-agent                      Up X hours

9. 配置控制器

在protocol-aries-controllers目录下执行配置脚本：

bash
./scripts/setup.sh