docker/cruise-example-app

Docker EE Hosted Demo 示例应用镜像文档

1. 镜像概述

1.1 主要用途

本镜像为 Docker EE（Docker Enterprise Edition）托管演示环境的官方示例应用，旨在提供一个轻量级、可直接部署的应用案例，用于演示 Docker EE 平台的核心功能、容器化部署流程及企业级特性验证。

2. 核心功能和特性

• 基础 Web 服务：内置轻量级 HTTP 服务，支持静态页面展示和简单 API 响应，可直接用于演示容器化应用的访问流程。
• Docker EE 集成示例：预设与 Docker EE 平台特性（如服务发现、负载均衡、健康检查）兼容的配置，可快速验证平台功能。
• 可配置化参数：支持通过环境变量和配置文件自定义应用行为（如端口、日志级别、演示内容），适应不同演示场景。
• 轻量级设计：基于 Alpine 基础镜像构建，镜像体积小（<50MB），启动速度快，适合快速部署和资源受限环境。

3. 使用场景和适用范围

• Docker EE 新手演示：向新用户展示 Docker EE 平台的基本部署流程（如镜像拉取、容器启动、服务访问）。
• 企业内部培训：作为培训素材，用于讲解 Docker 容器化、Docker Compose 编排、Docker EE 平台操作等基础概念。
• Docker EE 功能验证：验证 Docker EE 环境的网络配置（如端口映射、跨主机通信）、存储挂载、安全策略（如镜像签名验证）等功能。
• CI/CD 流程演示：可集成到简单的 CI/CD 管道中，展示从代码构建到 Docker EE 平台部署的完整流程。

4. 使用方法和配置说明

4.1 获取镜像

假设镜像托管于 Docker Hub 或企业私有仓库，通过以下命令拉取（实际镜像名称需替换为环境中的真实名称）：

bash
docker pull [仓库地址]/ee-hosted-demo-example:latest

4.2 快速启动（docker run）

使用 docker run 命令直接启动容器，默认配置下提供 Web 服务（端口 8080）：

bash
docker run -d \
  --name demo-app \
  -p 8080:8080 \
  -e APP_PORT=8080 \
  -e DEMO_MESSAGE="Welcome to Docker EE Hosted Demo!" \
  [仓库地址]/ee-hosted-demo-example:latest

• 说明：
  • -p 8080:8080：将容器内 8080 端口映射到主机 8080 端口，可通过 http://localhost:8080 访问应用。
  • -e APP_PORT=8080：指定应用监听端口（需与容器内端口一致）。
  • -e DEMO_MESSAGE：自定义应用首页展示的欢迎消息。

4.3 使用 docker-compose 部署

创建 docker-compose.yml 文件，定义服务配置（支持多容器协同演示，如搭配数据库或缓存服务）：

yaml
version: '3.8'
services:
  demo-app:
    image: [仓库地址]/ee-hosted-demo-example:latest
    container_name: demo-app
    ports:
      - "8080:8080"  # 主机端口:容器端口
    environment:
      - APP_PORT=8080  # 应用监听端口
      - DEMO_MESSAGE="Docker EE Hosted Demo with docker-compose"  # 自定义演示消息
      - LOG_LEVEL=info  # 日志级别（debug/info/warn/error）
    restart: unless-stopped  # 容器退出时自动重启（除非手动停止）
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8080/health"]  # 健康检查命令
      interval: 10s  # 检查间隔
      timeout: 5s  # 超时时间
      retries: 3  # 重试次数

启动服务：

bash
docker-compose up -d

5. 配置参数说明

6. 环境变量说明

7. 注意事项

• 本镜像为演示用途，不建议用于生产环境。生产环境需根据实际需求进行安全加固（如非 root 用户运行、镜像签名验证等）。
• 若使用 Docker EE 平台的私有仓库，需确保节点已配置仓库访问权限（如通过 docker login 认证）。
• 健康检查端点 /health 默认返回 200 OK，可通过 ENABLE_HEALTHCHECK=false 禁用。
• 实际部署时，需将文档中的 [仓库地址] 替换为 Docker EE 环境中的真实镜像仓库地址（如企业私有仓库 URL）。