TetraMem MX100 SDK Docker镜像文档

镜像概述

TetraMem MX100 SDK Docker镜像是针对TetraMem MX100硬件平台的软件开发工具包（SDK）容器化解决方案。该镜像预配置了开发、编译、调试MX100应用所需的完整工具链、库文件、头文件及辅助工具，旨在为开发人员提供一致、隔离且开箱即用的开发环境，避免因主机系统差异导致的依赖冲突问题，同时简化团队协作和跨平台开发流程。

核心功能和特性

核心功能

• 完整工具链集成：包含MX100平台专用编译器、链接器、调试器及构建工具（如make、cmake）
• 依赖管理：预安装MX100 SDK运行时库、驱动接口库及第三方依赖组件
• 文档与示例：内置SDK***文档及基础应用示例代码，便于快速上手
• 环境隔离：基于Docker容器化技术，与主机系统隔离，不影响本地环境配置

特性

• 跨平台兼容：支持Linux、macOS、Windows（需Docker Desktop）等主流操作系统
• 版本固定：镜像标签对应SDK特定版本，确保开发环境版本一致性
• 轻量级设计：基于精简基础镜像构建，减少存储空间占用
• 可扩展性：支持通过环境变量或挂载配置文件自定义开发参数

使用场景和适用范围

适用场景

• 应用开发：开发人员在本地构建、调试MX100平台应用程序
• 团队协作：统一团队开发环境，避免"在我机器上能运行"问题
• CI/CD集成：作为自动化构建、测试流程的基础环境，集成到Jenkins、GitHub Actions等平台
• 快速评估：新用户无需手动配置环境，快速体验MX100 SDK功能

适用人群

• TetraMem MX100硬件平台应用开发工程师
• 需要跨平台开发MX100相关项目的团队
• 自动化测试与构建流程的维护人员

使用方法和配置说明

前提条件

• 已安装Docker Engine（版本20.10+）或Docker Desktop
• 主机系统需满足Docker运行要求（Linux内核3.10+、开启虚拟化支持等）
• 网络环境可访问Docker镜像仓库（如需要拉取镜像）

镜像获取

从***镜像仓库拉取最新版本（如未指定标签，默认拉取latest）：

bash
docker pull tetramem/mx100-sdk:latest

如需指定特定SDK版本（如v1.2.0）：

bash
docker pull tetramem/mx100-sdk:v1.2.0

基础使用示例

1. 启动交互式开发环境

挂载本地项目目录到容器内，以交互模式启动容器并进入终端：

bash
docker run -it --rm \
  -v /本地项目路径:/workspace \
  -w /workspace \
  tetramem/mx100-sdk:latest \
  /bin/bash

• -v /本地项目路径:/workspace：将本地项目目录挂载到容器内/workspace目录（需替换为实际路径）
• -w /workspace：设置容器工作目录为/workspace
• --rm：容器退出后自动删除，避免残留容器实例
• -it：启用交互式终端

2. 编译示例项目

在容器终端内，进入示例代码目录并执行构建：

bash
# 进入内置示例目录（如存在）
cd /opt/tetramem/mx100-sdk/examples/hello_world

# 使用make构建项目
make

3. 运行自动化构建脚本

通过容器执行本地构建脚本，完成项目编译（非交互式）：

bash
docker run --rm \
  -v /本地项目路径:/workspace \
  -w /workspace \
  tetramem/mx100-sdk:latest \
  sh build.sh

配置参数说明

环境变量

可通过-e参数设置环境变量，自定义容器行为：

示例：设置日志级别为debug并指定目标平台：

bash
docker run -it --rm \
  -e TETRAMEM_SDK_LOG_LEVEL=debug \
  -e MX100_TARGET_PLATFORM=mx100-rev-a \
  tetramem/mx100-sdk:latest

数据卷挂载

常用挂载点说明：

高级配置

持久化开发环境

如需保留容器状态（如已安装的临时依赖），可创建命名容器而非使用--rm：

bash
# 创建命名容器
docker run -it --name mx100-dev-env \
  -v /本地项目路径:/workspace \
  tetramem/mx100-sdk:latest

# 后续通过名称重新进入容器
docker start -ai mx100-dev-env

端口映射（调试场景）

如使用容器内调试服务（如GDB服务器），需映射端口到主机：

bash
docker run -it --rm \
  -v /本地项目路径:/workspace \
  -p 1234:1234 \  # 将容器1234端口映射到主机1234端口
  tetramem/mx100-sdk:latest \
  gdbserver 0.0.0.0:1234 ./app

注意事项

• 镜像默认以root用户运行，如需限制权限，可通过USER_ID环境变量指定非root用户ID（需确保挂载目录权限匹配）
• 大规模项目构建建议挂载本地缓存目录（如~/.ccache）以加速编译过程
• 不同SDK版本镜像可能存在配置差异，使用时建议指定具体版本标签而非latest
• 如遇网络问题导致依赖下载失败，可配置Docker镜像加速器或检查主机网络代理设置