cognite/function-action

Cognite Function部署容器

镜像概述

该容器用于将Python函数部署到Cognite Functions，并支持可选的调度配置。适用于自动化部署流程，可集成到CI/CD管道中。Azure Pipelines示例仓库：https://github.com/cognitedata/functions-deploy-azure-pipelines

核心功能与特性

• 部署Python函数到Cognite Functions，支持基于external_id覆盖现有函数
• 可选附加调度配置，通过YAML文件定义定时任务
• 支持共享代码文件夹，便于多函数共享通用代码
• 环境变量驱动的配置方式，适配不同部署场景
• 提供部署超时控制、部署后清理等辅助功能
• 支持数据集关联，实现函数代码文件的权限管理

使用场景与适用范围

• CI/CD流程中自动化部署Python函数到Cognite Functions
• 需要定时执行的Cognite函数部署与调度管理
• 多环境（开发、测试、生产）的函数部署自动化
• 包含共享代码的多函数项目部署

使用方法与配置说明

输入参数

所有参数通过执行python /app/index.py时设置为环境变量。

必填参数

1. INPUT_FUNCTION_EXTERNAL_ID: 函数的external_id，项目内需唯一，若已存在则覆盖现有函数
2. INPUT_FUNCTION_FOLDER: 函数代码的父文件夹，该文件夹内所有内容将被上传
3. INPUT_CDF_PROJECT: CDF项目名称
4. INPUT_CDF_CLUSTER: CDF项目所在集群，如westeurope-1或greenfield
5. INPUT_DEPLOYMENT_CLIENT_SECRET: 用于函数部署的客户端密钥
6. INPUT_DEPLOYMENT_CLIENT_ID: 用于函数部署的客户端ID
7. INPUT_DEPLOYMENT_TENANT_ID: 用于函数部署的租户ID

附加调度时必填参数

1. INPUT_SCHEDULE_FILE: 位于function_folder内的调度文件路径，包含要附加到函数的调度列表。若文件存在，则以下参数为必填：
2. INPUT_SCHEDULES_CLIENT_SECRET: 函数调度运行时使用的客户端密钥（仅用于调度执行，正常调用仍使用调用者凭证）
3. INPUT_SCHEDULES_CLIENT_ID: 函数调度运行时使用的客户端ID
4. INPUT_SCHEDULES_TENANT_ID: 函数调度运行时使用的租户ID

可选参数

所有可选参数的默认值可在src/defaults.py中查看：

1. INPUT_REMOVE_ONLY: 仅删除函数及所有附加调度，忽略其他大部分参数
2. INPUT_COMMON_FOLDER: 包含函数间共享代码的文件夹路径
3. INPUT_FUNCTION_FILE: 主函数文件名称，默认为handler.py
4. INPUT_FUNCTION_SECRETS: 存储base64编码的JSON密钥字典的Github密钥名称
5. INPUT_FUNCTION_DEPLOY_TIMEOUT: 函数部署超时时间（秒），超时后将取消部署并尝试删除函数
6. INPUT_DATA_SET_ID: 用于CDF中上传文件（函数代码压缩包）的数据集ID，需额外部署权限：'dataset:READ'和'files:WRITE'（作用于指定数据集或'all'）；若数据集为写保护，还需'dataset:OWNER'权限
7. INPUT_POST_DEPLOY_CLEANUP: 部署成功后删除CDF Files中的代码文件对象，默认为true
8. INPUT_DESCRIPTION: 函数描述信息
9. INPUT_OWNER: 函数所有者信息
10. INPUT_CPU: 每个函数的CPU核心数（小数），Azure环境下忽略，允许值见API文档
11. INPUT_MEMORY: 每个函数的内存大小（GB），Azure环境下忽略，允许值见API文档

调度文件格式 [.yaml]

调度文件需为YAML格式，示例如下：

yaml
- name: 每日调度
  cron: "0 0 * * *"
  data:
    lovely-parameter: True
    something-else: 42
- name: 每小时调度
  cron: "0 * * * *"
  data:
    lovely-parameter: False
    something-else: 777
- name: 每小时调度  # 允许同名调度，也允许无data字段
  cron: "0 * * * *"

部署示例

Docker Run命令示例

bash
docker run -e INPUT_FUNCTION_EXTERNAL_ID="my-function" \
  -e INPUT_FUNCTION_FOLDER="/app/function" \
  -e INPUT_CDF_PROJECT="my-cdf-project" \
  -e INPUT_CDF_CLUSTER="westeurope-1" \
  -e INPUT_DEPLOYMENT_CLIENT_SECRET="deploy-secret" \
  -e INPUT_DEPLOYMENT_CLIENT_ID="deploy-id" \
  -e INPUT_DEPLOYMENT_TENANT_ID="deploy-tenant" \
  -v /local/function/folder:/app/function \
  cognite/functions-deploy:latest

带调度的部署示例

bash
docker run -e INPUT_FUNCTION_EXTERNAL_ID="scheduled-function" \
  -e INPUT_FUNCTION_FOLDER="/app/function" \
  -e INPUT_CDF_PROJECT="my-cdf-project" \
  -e INPUT_CDF_CLUSTER="westeurope-1" \
  -e INPUT_DEPLOYMENT_CLIENT_SECRET="deploy-secret" \
  -e INPUT_DEPLOYMENT_CLIENT_ID="deploy-id" \
  -e INPUT_DEPLOYMENT_TENANT_ID="deploy-tenant" \
  -e INPUT_SCHEDULE_FILE="schedules.yaml" \
  -e INPUT_SCHEDULES_CLIENT_SECRET="schedule-secret" \
  -e INPUT_SCHEDULES_CLIENT_ID="schedule-id" \
  -e INPUT_SCHEDULES_TENANT_ID="schedule-tenant" \
  -v /local/function/folder:/app/function \
  cognite/functions-deploy:latest