akamai/sandbox:v2.3.2 镜像文档

1. 镜像概述和主要用途

1.1 概述

akamai/sandbox:v2.3.2 是一个预配置的Docker镜像，包含Akamai CLI核心工具及Sandbox CLI扩展，用于提供本地化的Akamai配置开发与测试环境。

1.2 主要用途

提供容器化的Akamai Sandbox环境，支持本地创建、管理和模拟Akamai配置，无需依赖生产环境即可验证配置变更效果。

2. 核心功能和特性

2.1 核心组件

• Akamai CLI核心：版本1.2.1，提供基础命令行交互框架。
• Akamai Sandbox CLI：版本1.5.0，扩展CLI功能，支持沙箱环境的创建、启动、停止及配置模拟。

2.2 关键特性

• 环境一致性：固定组件版本（CLI core 1.2.1 + Sandbox CLI 1.5.0），避免版本差异导致的环境不一致问题。
• 容器化部署：简化依赖管理，无需本地安装Akamai CLI及系统级依赖。
• 本地沙箱模拟：支持在本地环境模拟Akamai边缘配置，验证规则、缓存策略等变更效果。

3. 使用场景和适用范围

3.1 典型使用场景

• Akamai配置本地开发：开发者在本地编写、修改Akamai配置（如边缘规则、缓存设置），通过沙箱验证功能。
• 配置变更预验证：无需访问生产环境，即可模拟配置变更对边缘节点行为的影响。
• CI/CD集成：作为自动化测试环节，在CI/CD流程中集成沙箱测试，验证配置变更的正确性。
• 团队协作：统一开发团队的沙箱环境，确保所有人使用相同版本的工具和配置。

3.2 适用范围

• Akamai客户的开发与测试团队
• 需要本地化验证Akamai配置的场景
• 对环境一致性要求较高的开发流程（如多团队协作、CI/CD）

4. 使用方法和配置说明

4.1 前置条件

• 已安装Docker Engine（20.10+推荐）。
• 已获取Akamai API凭证（包含client_secret、host、access_token、client_token），并配置在~/.edgerc文件中（Akamai CLI标准配置文件）。

4.2 基础使用命令

4.2.1 镜像拉取

docker pull akamai/sandbox:v2.3.2

4.2.2 基础运行（交互式终端）

通过挂载本地~/.edgerc配置文件，启动容器并进入交互式终端：

docker run -it --rm \
  -v ~/.edgerc:/root/.edgerc:ro \  # 只读挂载Akamai CLI配置文件
  akamai/sandbox:v2.3.2 \
  /bin/bash

说明：~/.edgerc为Akamai CLI标准配置文件，包含API凭证，需确保文件权限正确（如chmod 600 ~/.edgerc）。

4.2.3 直接执行Sandbox命令

无需进入终端，直接在容器中执行Sandbox CLI命令（如创建沙箱）：

docker run --rm \
  -v ~/.edgerc:/root/.edgerc:ro \
  akamai/sandbox:v2.3.2 \
  akamai sandbox create --name my-first-sandbox  # 创建名为"my-first-sandbox"的沙箱

4.3 配置说明

4.3.1 核心配置文件

• ~/.edgerc：Akamai CLI配置文件，需包含沙箱操作所需的API凭证（配置段通常为[default]或自定义名称）。
  示例配置格式：

  [default]
  client_secret = <your_client_secret>
  host = <your_host>
  access_token = <your_access_token>
  client_token = <your_client_token>
  

4.3.2 环境变量配置

容器支持通过环境变量调整运行参数，常用变量如下：

4.4 常用Sandbox CLI命令示例

在容器终端中，可直接执行以下Sandbox命令（需先通过4.2.2进入终端）：

• 查看沙箱列表：

  akamai sandbox list
  

• 启动沙箱：

  akamai sandbox start --name my-first-sandbox
  

• 停止沙箱：

  akamai sandbox stop --name my-first-sandbox
  

• 删除沙箱：

  akamai sandbox delete --name my-first-sandbox
  

4.5 docker-compose配置示例

如需在多容器环境中集成，可使用docker-compose.yml：

version: "3.8"
services:
  akamai-sandbox:
    image: akamai/sandbox:v2.3.2
    volumes:
      - ~/.edgerc:/root/.edgerc:ro
    environment:
      - AKAMAI_PROFILE=default  # 使用~/.edgerc中的"default"配置段
    tty: true  # 启用交互式终端

启动命令：

docker-compose up -d && docker-compose exec akamai-sandbox /bin/bash

5. 注意事项

• ~/.edgerc文件包含敏感API凭证，建议通过ro（只读）模式挂载，避免容器内修改。
• 沙箱环境数据默认存储在容器内部，如需持久化，可额外挂载数据目录（如-v ./sandbox-data:/root/.akamai/sandbox）。
• 容器内用户为root，本地挂载文件需确保权限兼容（如避免root写入本地非特权用户目录）。