starlingx/stx-nova

StarlingX 容器镜像文档

1. 镜像概述和主要用途

StarlingX 是一个开源分布式云平台，其项目组件被构建为容器镜像，用于创建和部署分布式云基础设施。该镜像集合提供了构建高可用、低延迟、轻量级分布式云环境的核心组件，适用于边缘计算、物联网（IoT）及分布式数据中心场景。

2. 核心功能和特性

2.1 核心功能

• 分布式云基础设施构建：通过容器化组件快速部署完整的分布式云平台。
• 高可用性支持：内置冗余机制，保障节点故障时服务持续可用。
• 边缘计算优化：针对边缘场景设计，支持资源受限环境下的高效运行。
• 多节点管理：提供跨节点集群管理能力，支持动态扩缩容。

2.2 关键特性

• 容器化架构：基于容器化组件构建，支持标准化部署和版本管理。
• 轻量级设计：优化资源占用，适合边缘节点等资源受限环境。
• 自动化运维：集成监控、日志和故障恢复工具，简化运维流程。
• 灵活扩展：支持单节点到多节点集群部署，适应不同规模需求。

3. 使用场景和适用范围

3.1 主要使用场景

• 边缘计算环境：工业物联网（IIoT）、智能城市、智能交通等边缘节点部署。
• 分布式数据中心：跨地域多节点协同的分布式云基础设施构建。
• 低延迟应用场景：对网络延迟敏感的业务（如实时数据处理、自动驾驶）。
• 高可用关键业务：需要持续运行的核心业务系统（如能源、电信基础设施）。

3.2 适用范围

• 硬件环境：x86/ARM架构服务器、边缘网关设备。
• 软件依赖：Docker引擎、Kubernetes（可选，用于容器编排）。
• 网络要求：支持多节点间通信的局域网或广域网环境。

4. 使用方法和配置说明

4.1 前提条件

• 已安装 Docker Engine（20.10+ 版本）或兼容容器运行时。
• 节点间网络互通（建议配置静态IP及端口开放，具体端口参考官方文档）。
• 硬件资源：最低 2 CPU 核心、4GB 内存、20GB 存储空间（单节点）。

4.2 获取镜像

StarlingX 容器镜像可通过官方仓库或项目构建流程获取。具体镜像名称及标签请参考 https://docs.starlingx.io/。示例拉取命令（假设镜像名称为 starlingx/platform）：

bash
docker pull docker.xuanyuan.run/starlingx/platform:latest

4.3 基本部署示例（单节点模式）

以下为单节点测试环境的部署示例，生产环境需参考官方文档进行多节点配置：

4.3.1 Docker Run 命令

bash
docker run -d \
  --name starlingx-node \
  --privileged \
  --network host \
  -v /var/lib/starlingx:/data \
  -e NODE_ROLE=controller \
  -e MGMT_IP=192.168.1.100 \
  docker.xuanyuan.run/starlingx/platform:latest

• 参数说明：
  • --privileged：启用特权模式（需访问主机设备及系统资源）。
  • --network host：使用主机网络（简化网络配置，生产环境建议自定义网络）。
  • -v /var/lib/starlingx:/data：挂载数据卷，持久化节点配置及运行数据。
  • -e NODE_ROLE=controller：指定节点角色（控制器节点）。
  • -e MGMT_IP：设置管理网IP地址。

4.3.2 Docker Compose 配置（多节点示意）

生产环境多节点部署建议使用 docker-compose 或 Kubernetes 编排。以下为双节点（控制器+计算节点）的 docker-compose.yml 示例框架：

yaml
version: '3.8'
services:
  controller:
    image: docker.xuanyuan.run/starlingx/platform:latest
    container_name: starlingx-controller
    privileged: true
    network_mode: host
    volumes:
      - /var/lib/starlingx/controller:/data
    environment:
      - NODE_ROLE=controller
      - MGMT_IP=192.168.1.100
      - HA_MODE=false  # 单控制器模式，多控制器需设为 true
    restart: always

  compute:
    image: docker.xuanyuan.run/starlingx/platform:latest
    container_name: starlingx-compute
    privileged: true
    network_mode: host
    volumes:
      - /var/lib/starlingx/compute:/data
    environment:
      - NODE_ROLE=compute
      - CONTROLLER_IP=192.168.1.100  # 指向控制器节点IP
    restart: always

4.4 配置参数和环境变量

StarlingX 镜像支持通过环境变量配置节点参数，常用变量如下（完整列表请参考 https://docs.starlingx.io/）：

5. 相关资源

• 官方文档：https://docs.starlingx.io/
• 源代码仓库：https://opendev.org/starlingx
• 社区信息：https://www.starlingx.io/community/

6. 许可证

StarlingX 容器镜像及项目代码基于 Apache License 2.0 许可发布，详见 https://www.apache.org/licenses/LICENSE-2.0。