ibmcom/helloworld

IBM Cloud Code Engine 示例镜像文档

1. 镜像概述和主要用途

1.1 概述

本镜像为 IBM Cloud Code Engine 的官方示例镜像，源代码托管于 https://github.com/IBM/CodeEngine%E3%80%82%E9%95%9C%E5%83%8F%E8%AE%BE%E8%AE%A1%E4%B8%BA%E8%BD%BB%E9%87%8F%E7%BA%A7%E5%AE%B9%E5%99%A8%E7%A4%BA%E4%BE%8B%EF%BC%8C%E6%97%A8%E5%9C%A8%E6%BC%94%E7%A4%BA%E5%A6%82%E4%BD%95%E9%80%9A%E8%BF%87 IBM Cloud Code Engine 服务部署和运行容器化应用。

1.2 主要用途

• 作为开发者学习 IBM Cloud Code Engine 服务的入门示例
• 演示容器化应用在 Code Engine 环境中的基本部署流程
• 提供基础应用框架，帮助用户快速理解 Code Engine 的核心功能（如自动扩缩容、无服务器容器运行等）

2. 核心功能与特性

• 轻量级设计：基于精简基础镜像构建，镜像体积小，启动速度快
• Code Engine 原生集成：预配置适配 Code Engine 运行环境的基础参数（如端口监听、健康检查等）
• 基础 HTTP 服务：内置简单 HTTP 服务，支持通过浏览器或 API 访问，便于验证部署结果
• 可配置性：支持通过环境变量自定义服务行为（如端口、响应消息等）
• 开源示例：完整源代码开源，可作为自定义应用开发的参考模板

3. 使用场景和适用范围

3.1 典型使用场景

• 开发者学习：新手通过该示例了解 Code Engine 的应用部署流程、资源配置和运行机制
• 环境测试：验证本地或 Cloud Code Engine 环境的容器运行能力及网络连通性
• 部署演示：向团队或用户展示 Code Engine 的无服务器容器部署能力
• 基础模板：基于示例代码扩展开发自定义业务逻辑，快速迁移至 Code Engine 运行

3.2 适用范围

• 环境：开发环境、测试环境（不建议用于生产环境，仅为示例用途）
• 用户：容器技术初学者、IBM Cloud Code Engine 新用户、需要快速验证部署流程的开发者

4. 使用方法和配置说明

4.1 本地运行（Docker 环境）

4.1.1 拉取镜像

bash
docker pull icr.io/ibm/codeengine-sample  # 假设官方镜像托管于 IBM 容器仓库，实际请以 GitHub 仓库说明为准

4.1.2 启动容器

bash
docker run -d -p 8080:8080 --name codeengine-sample \
  -e PORT=8080 \
  -e MESSAGE="Hello from Code Engine Sample" \
  icr.io/ibm/codeengine-sample

• 参数说明：
  • -p 8080:8080：映射容器端口 8080 到本地端口 8080
  • -e PORT：指定服务监听端口（默认 8080）
  • -e MESSAGE：自定义 HTTP 响应消息（默认 "Hello World"）

4.1.3 验证运行

访问 http://localhost:8080，应返回配置的 MESSAGE 内容。

4.2 通过 IBM Cloud Code Engine 部署

4.2.1 前提条件

• 已注册 IBM Cloud 账号并开通 Code Engine 服务
• 本地安装 IBM Cloud CLI 并登录（ibmcloud login）

4.2.2 部署步骤

1. 创建 Code Engine 项目（若无现有项目）：

   bash
   ibmcloud ce project create --name my-codeengine-project
   

2. 部署示例镜像：

   bash
   ibmcloud ce app create --name codeengine-sample \
     --image icr.io/ibm/codeengine-sample \
     --port 8080 \
     --env MESSAGE="Deployed via Code Engine"
   

3. 获取应用访问 URL：

   bash
   ibmcloud ce app get --name codeengine-sample --output url
   

4. 通过返回的 URL 访问应用，验证部署结果。

4.3 配置说明

4.3.1 环境变量

4.3.2 端口配置

默认监听容器内 8080 端口，需确保 Code Engine 应用或 Docker 运行时映射该端口至外部访问。

5. 注意事项

• 本镜像为示例性质，未包含生产环境所需的安全加固、监控告警等机制，不建议用于生产环境
• 镜像功能和配置可能随 GitHub 仓库更新而变化，建议通过 https://github.com/IBM/CodeEngine 获取最新代码和文档
• 部署至 Code Engine 时，需确保项目所在区域与镜像仓库区域一致，避免网络延迟或访问限制

6. 参考资料

• IBM Cloud Code Engine 官方文档
• https://github.com/IBM/CodeEngine