byoda/byoda-pod

Byoda Pod 镜像文档

一、镜像概述和主要用途

Byoda Pod 镜像是 Byoda 网络生态中的核心容器化组件，用于部署和运行 Byoda 网络中的独立服务节点（Pod）。该镜像封装了 Byoda 协议栈、服务运行时环境及基础配置框架，支持快速启动符合 Byoda 规范的去中心化服务实例，适用于构建分布式应用、微服务集群或去中心化网络节点。

二、核心功能和特性

1. 核心功能

• Byoda 协议兼容：内置完整的 Byoda 网络协议实现，支持节点发现、身份认证、数据传输等核心功能。
• 服务隔离：每个 Pod 实例作为独立服务单元运行，实现资源与网络隔离。
• 动态配置：支持通过环境变量或配置文件动态调整服务参数，适应不同场景需求。
• 日志与监控：集成基础日志收集和健康检查机制，便于服务运维与问题排查。

2. 关键特性

• 轻量级部署：基于容器化架构，支持快速启停和水平扩展。
• 跨平台兼容：适配主流容器运行时（Docker、containerd）及 Kubernetes 环境。
• 安全加固：内置基础安全策略，包括网络访问控制、数据加密传输支持。
• 持久化支持：支持外部存储挂载，确保服务状态与数据持久化。

三、使用场景和适用范围

1. 典型使用场景

• 去中心化应用节点：作为去中心化应用（DApp）的后端服务节点，提供数据存储或计算能力。
• 企业微服务集群：部署为企业内部微服务单元，实现服务解耦与独立扩缩容。
• 边缘计算服务：在边缘设备或边缘节点部署，提供低延迟的本地化服务。
• 测试与开发环境：快速搭建 Byoda 协议测试节点，验证协议兼容性或应用功能。

2. 适用范围

• 需构建去中心化网络服务的开发者或企业用户。
• 微服务架构下的独立服务节点部署。
• 对服务隔离性、可扩展性有要求的分布式系统场景。

四、使用方法和配置说明

1. 环境要求

• 容器运行时：Docker 20.10+ 或兼容的容器引擎。
• 资源要求：最低 1 CPU 核心、2GB 内存，建议根据服务负载调整。
• 网络：需开放 Pod 服务端口（默认 8080/TCP）及 Byoda 协议端口（默认 443/TCP）。

2. 基础使用方法（Docker Run）

2.1 最简启动命令

bash
docker run -d \
  --name byoda-pod \
  -p 8080:8080 \
  -p 443:443 \
  docker.xuanyuan.run/byoda/pod:latest

2.2 带基础配置的启动命令

bash
docker run -d \
  --name byoda-pod \
  -p 8080:8080 \
  -p 443:443 \
  -e LOG_LEVEL=info \
  -e POD_NAME=service-node-01 \
  -e NETWORK=mainnet \
  -v /host/path/to/config:/app/config \
  -v /host/path/to/data:/app/data \
  docker.xuanyuan.run/byoda/pod:latest

3. Docker Compose 部署示例

创建 docker-compose.yml 文件如下：

yaml
version: '3.8'

services:
  byoda-pod:
    image: docker.xuanyuan.run/byoda/pod:latest
    container_name: byoda-pod-instance
    restart: unless-stopped
    ports:
      - "8080:8080"  # 服务访问端口
      - "443:443"    # Byoda 协议端口
    environment:
      - LOG_LEVEL=debug  # 日志级别：debug/info/warn/error
      - POD_ID=pod-12345  # 自定义 Pod 唯一标识
      - NETWORK=testnet   # 网络环境：mainnet/testnet/devnet
      - MAX_CONCURRENT=100  # 最大并发连接数
    volumes:
      - ./config:/app/config  # 挂载外部配置文件
      - ./data:/app/data      # 挂载数据持久化目录
    networks:
      - byoda-network

networks:
  byoda-network:
    driver: bridge

启动命令：

bash
docker-compose up -d

4. 配置参数说明

4.1 环境变量配置

4.2 配置文件说明

若通过外部挂载配置文件（如 ./config/config.yaml），可覆盖环境变量默认配置，典型配置项示例：

yaml
# /app/config/config.yaml
pod:
  id: "pod-12345"
  name: "user-service-pod"
  description: "User authentication service pod"
network:
  discovery: "https://discovery.byoda.org"  # 节点发现服务地址
  port: 443
service:
  type: "auth"  # 服务类型（根据 Byoda 服务定义）
  endpoints:
    - path: "/api/v1/auth"
      port: 8080
storage:
  max_size: "10G"  # 最大存储容量限制

五、注意事项

1. 持久化存储：建议通过 DATA_PATH 挂载外部卷，避免容器重启导致数据丢失。
2. 网络配置：若部署在防火墙或 NAT 环境下，需确保 443 端口（Byoda 协议端口）可被外部节点访问。
3. 权限管理：挂载宿主机目录时，需确保容器进程对挂载目录有读写权限（建议设置目录权限为 755）。
4. 版本兼容性：不同版本镜像可能存在配置项差异，升级前需参考 Byoda 官方版本变更日志。

六、常见问题

Q：如何查看 Pod 运行日志？

A：通过容器日志命令查看：

bash
docker logs -f byoda-pod  # 实时查看日志
docker logs --tail 100 byoda-pod  # 查看最近 100 行日志

Q：如何自定义服务类型？

A：通过配置文件 config.yaml 中的 service.type 字段指定，需符合 Byoda 服务类型规范（详见 Byoda 协议文档）。

Q：Pod 无法加入网络怎么办？

A：检查 NETWORK 环境变量是否匹配目标网络，确保 discovery 地址可访问，且本地防火墙未拦截 443 端口。