hyperledger/cello-api-engine

Hyperledger Cello 镜像文档

镜像概述和主要用途

Hyperledger Cello是一个供应和操作系统，旨在帮助用户高效管理网络。通过Cello，用户可以快速从零构建即服务（BaaS）平台，即时供应定制化的网络（如Hyperledger Fabric v1.0网络），在裸机、虚拟云（如虚拟机、vSphere云）、容器集群（如Docker、Swarm、Kubernetes）上维护运行中的***网络池，并通过仪表板检查系统状态、调整链数量、扩展资源等。

核心功能和特性

• 生命周期管理：支持的创建、启动、停止、删除及自动健康维护
• 定制化支持**：可根据需求（如规模、共识机制）供应**，目前主要支持Hyperledger Fabric
• 多环境支持：支持原生Docker主机、Swarm或Kubernetes作为工作节点，更多环境支持正在开发中
• 异构架构兼容：支持X86、POWER和Z等架构，从裸机服务器到虚拟机
• 可扩展性：通过集成额外组件，可扩展监控、日志、健康检查和分析功能

使用场景和适用范围

• 快速构建企业级BaaS平台
• 管理多个定制化***网络的生命周期
• 在混合基础设施（裸机、虚拟机、容器集群）上部署和运维***网络
• 需要通过直观仪表板监控和调整***资源的场景

详细使用方法和配置说明

环境准备

需提前安装以下依赖：

1. Docker：安装指南
2. Docker Compose：安装指南
3. Make：所有Cello服务管理脚本均通过Makefile实现
4. Kubernetes（可选）：安装指南

构建镜像（可选）

目前Docker Hub自动构建尚未就绪，需手动构建Cello服务所需镜像：

bash
make docker

启动Cello服务

默认使用docker-compose部署，若已配置Kubernetes环境，可通过DEPLOY_METHOD=k8s指定Kubernetes部署：

bash
# 默认docker-compose部署
make start

# Kubernetes部署
DEPLOY_METHOD=k8s make start

Docker Compose部署输出示例

服务启动后，可看到类似以下容器运行状态：

bash
CONTAINER ID        IMAGE                          COMMAND                  CREATED             STATUS              PORTS                    NAMES
ddf938ed927e        hyperledger/cello-dashboard    "bash -c '/config-ng…"   2 days ago          Up 2 days           0.0.0.0:8081->80/tcp     cello-dashboard
41ab47784b28        hyperledger/cello-api-engine   "/bin/sh -c 'bash /e…"   2 days ago          Up 2 days           0.0.0.0:8085->8080/tcp   cello-api-engine
073a5f46276e        hyperledger/cello-api-engine   "bash -c 'celery -A …"   2 days ago          Up 2 days                                   cello-api-engine-tasks
54d2c615d7d9        postgres:11.1                  "docker-entrypoint.s…"   2 days ago          Up 2 days           5432/tcp                 cello-postgres-server
1e0fc6386891        redis:4.0.13                   "docker-entrypoint.s…"   2 days ago          Up 2 days           6379/tcp                 cello-redis

Kubernetes部署输出示例

使用Kubernetes部署时，可看到类似以下资源状态：

bash
NAME                                     READY   UP-TO-DATE   AVAILABLE   AGE
deployment.extensions/api-engine         1/1     1            1           7s
deployment.extensions/api-engine-tasks   1/1     1            1           7s
deployment.extensions/postgres           1/1     1            1           8s
deployment.extensions/redis              1/1     1            1           8s

NAME                                    READY   STATUS    RESTARTS   AGE
pod/api-engine-5844d7d9d4-zqw9k         1/1     Running   0          7s
pod/api-engine-tasks-74484d6f45-jj6p9   1/1     Running   0          7s
pod/postgres-774d5cd5f-p5j5l            1/1     Running   0          8s
pod/redis-6bf574b8c5-p2dnl              1/1     Running   0          7s

NAME                                    HOSTS   ADDRESS   PORTS   AGE
ingress.extensions/ingress-api-engine   *                 80      7s

访问仪表板

服务启动后，通过8081端口访问仪表板，默认用户名/密码为admin/pass。

停止Cello服务

停止服务时需指定与启动时相同的部署方式：

bash
# 默认docker-compose停止
make stop

# Kubernetes停止
DEPLOY_METHOD=k8s make stop

文档和开发指南

新用户建议先阅读tutorial或index。更多信息可参考在线文档，或通过make doc启动本地文档网站（监听localhost:8000）。

项目命名由来

"Cello"（大提琴），因为没有人比大提琴更擅长"演奏"链条（chains）了。

孵化说明

该项目是Hyperledger的孵化项目，于2017年1月7日经Hyperledger TSC批准，提案文档见此处。关于"孵化"阶段的详细信息，可参考Hyperledger项目生命周期文档。

本作品采用知识共享署名4.0国际许可协议进行许可。