CoherencePlatform CNC 项目配置详解

CoherencePlatform CNC 项目配置详解

cnc CNC is the first framework for precision platform engineering 项目地址: https://gitcode.com/gh_mirrors/cnc2/cnc

概述

CoherencePlatform CNC 是一个基于 Docker Compose 扩展的配置系统，它通过添加特定的扩展字段来增强容器化应用的部署能力。本文将深入解析 CNC 配置文件的各项功能和使用方法，帮助开发者更好地理解和运用这一工具。

配置文件基础

CNC 配置文件是 Docker Compose 文件的超集，这意味着：

1. 完全兼容现有的 Docker Compose 文件
2. 通过 x-cnc 扩展字段添加 CNC 特有功能
3. 未添加 x-cnc 配置的服务将被 CNC 忽略

核心配置结构

配置文件主要包含两个层级的 x-cnc 扩展：

1. 全局配置 (root level)

位于文件根层级，与 services 同级，用于定义应用级别的资源配置。

2. 服务配置 (service level)

位于每个服务定义内部，通过 type 字段指定服务类型。

详细配置解析

全局资源配置

x-cnc:
  build_settings:
    platform_settings:
      # 指定构建机器的类型
      machine_type: "E2_HIGHCPU_8"
  resources:
  - name: bucket1
    type: object_storage

• build_settings: 控制构建环境的配置
• resources: 定义不绑定容器的云资源（如对象存储、消息队列等）

前端服务示例

frontend:
  x-cnc:
    type: frontend
    assets_path: dist       # 构建产物目录
    build: ["yarn", "build"] # 构建命令
    custom_headers:         # 自定义HTTP头
    - name: x-frame-options
      value: SAMEORIGIN
  build:
    dockerfile: frontend/Dockerfile
    context: frontend

关键点：

1. type: frontend 标识为前端服务
2. assets_path 指定构建产物位置
3. build 命令与开发命令通常不同

后端服务示例

backend:
  x-cnc:
    type: backend
    url_path: /api          # 路由路径
    migrate: ["prisma", "migrate"] # 数据库迁移命令
    seed: ["prisma", "seed"] # 数据种子命令
    system:
      health_check: /      # 健康检查端点
      platform_settings:
        min_scale: 1       # 最小实例数
        max_scale: 4       # 最大实例数
    workers:
    - name: default queue
      command: ["node", "worker.js", "default"]
      replicas: 1
      system:
        cpus: 2
        memory: 4g
    scheduled_tasks:
    - name: check task statuses
      command: ["node", "statuscheck.js"]
      schedule: "*/2 * * * *"
      system:
        memory: 2g

关键特性：

1. 支持定义后台工作进程(workers)
2. 支持定时任务(scheduled_tasks)
3. 自动伸缩配置
4. 数据库迁移和种子命令

数据库和缓存服务

redis:
  x-cnc:
    type: cache            # 缓存服务

db1:
  x-cnc:
    name: db1
    type: database
    version: 13           # 数据库版本
    adapter: postgresql   # 数据库适配器

注意：

1. 本地开发使用的镜像会被忽略
2. 生产环境将自动使用云服务（如AWS的RDS/Elasticache）

最佳实践建议

1. 资源规划：合理设置 min_scale 和 max_scale 以平衡成本和性能
2. 健康检查：确保健康检查端点简单高效
3. 种子命令：必须保证幂等性，可重复执行不产生副作用
4. 定时任务：注意执行频率对成本的影响
5. 资源配置：为不同类型的工作负载设置合适的CPU/内存限制

总结

CoherencePlatform CNC 通过扩展 Docker Compose 配置，提供了强大的云原生应用部署能力。理解并合理运用这些配置选项，可以显著简化从开发到生产的部署流程，同时保持对云资源的精细控制。

对于更详细的配置选项和特定云平台的限制，建议参考相关平台的文档说明。

cnc CNC is the first framework for precision platform engineering 项目地址: https://gitcode.com/gh_mirrors/cnc2/cnc