cognite/toolkit

CDF Toolkit Docker镜像文档

镜像概述

CDF Toolkit是一个专为Cognite Data Fusion (CDF)项目设计的命令行工具(CLI)，旨在简化CDF项目的配置管理和日常运维操作。通过Docker容器化部署，确保工具在不同环境中具备一致的运行依赖和执行行为，适用于各类CDF项目的配置初始化、资源管理及自动化任务处理。

核心功能与特性

• 项目配置管理：支持CDF项目的初始化配置、参数调整及配置文件的导入/导出
• 资源操作支持：提供对CDF项目中各类资源（如数据源、访问策略、数据模型等）的创建、查询、更新和删除功能
• 自动化工作流：可集成至脚本或CI/CD流程，实现配置部署、资源同步等重复性任务的自动化
• 环境一致性：容器化封装避免了系统依赖冲突，确保工具在开发、测试和生产环境中行为一致

使用场景与适用范围

• CDF项目管理员：日常进行项目配置调整、资源监控及权限管理
• 开发团队：在本地开发环境中快速配置CDF连接，或通过脚本自动化测试环境配置
• 运维自动化：通过CLI命令批量执行资源操作，简化大规模CDF项目的管理流程

使用方法与配置说明

基本使用命令

通过Docker运行CDF Toolkit容器，基本命令格式如下：

bash
docker run --rm cognite/cdf-toolkit:latest [command] [options]

说明：--rm参数确保容器退出后自动清理，[command]为CDF Toolkit支持的具体操作命令

查看工具版本信息

bash
docker run --rm cognite/cdf-toolkit:latest --version

配置文件挂载

为持久化存储配置或使用本地配置文件，需将主机目录挂载至容器内默认配置路径（通常为/root/.cdf-toolkit）：

bash
docker run --rm -v $(pwd)/.cdf-toolkit:/root/.cdf-toolkit cognite/cdf-toolkit:latest configure

上述命令会在当前目录创建.cdf-toolkit文件夹并存储配置文件，执行configure命令可启动交互式配置流程

环境变量配置

CDF Toolkit需通过环境变量指定CDF项目访问凭证，常用环境变量说明如下：

带环境变量的命令示例

bash
docker run --rm \
  -e CDF_PROJECT_ID=my-cdf-project \
  -e CDF_API_KEY=your-api-key \
  -e CDF_BASE_URL=https://api.cognitedata.com \
  cognite/cdf-toolkit:latest resource list

常用命令示例

1. 初始化项目配置

bash
docker run --rm -v $(pwd)/.cdf-toolkit:/root/.cdf-toolkit cognite/cdf-toolkit:latest init

2. 列出项目资源

bash
docker run --rm -v $(pwd)/.cdf-toolkit:/root/.cdf-toolkit cognite/cdf-toolkit:latest resource list --type dataset

3. 导出项目配置

bash
docker run --rm \
  -v $(pwd)/exports:/root/exports \
  -v $(pwd)/.cdf-toolkit:/root/.cdf-toolkit \
  cognite/cdf-toolkit:latest config export --output /root/exports/cdf-config.json

注意事项

• 挂载配置目录时需确保主机目录具备读写权限，避免容器内权限不足导致配置失败
• 敏感凭证（如API密钥）建议通过环境变量或加密配置文件传递，避免明文存储
• 定期执行docker pull cognite/cdf-toolkit:latest获取工具最新版本及安全更新