Convert Helm Values

仅限Atlassian内部使用

该Docker镜像用于将原型描述符（archetype descriptor）或服务描述符（service descriptor）转换为KITT Helm值，并支持通过配置对生成的Helm值进行覆盖和移除操作。

配置文件

CONFIG变量应包含YAML格式的转换配置，可包含以下字段：

• kushi: [必填] atlas kushi migrate命令的所有可用参数（需通过本地运行atlas kushi migrate --help查看详细说明）
  • archetype-descriptor: [必填] 原型描述符文件路径
  • output-dir: [必填] Helm图表输出目录
  • ... 其他所需的kushi参数
• values-overrides: [可选] 参考values-overrides Schema，用于覆盖Helm值的配置列表
• values-removals: [可选] 参考values-removals Schema，用于从Helm值中移除字段的配置列表
• archetype-removals: [可选] [仅单体应用] 将服务描述符转换为原型描述符时需移除的原型字段列表
• archetype-overrides: [可选] [仅单体应用] 将服务描述符转换为原型描述符时需覆盖的原型字段

values-overrides schema

• file: [必填] 值覆盖文件路径，相对于kushi.output-dir，例如values.yaml、stg-east/values.yaml
• values: [必填] 需覆盖的Helm值映射，例如{"image.tag": "latest"}

values-removals schema

• file: [必填] 值移除文件路径，相对于kushi.output-dir，例如values.yaml、stg-east/values.yaml
• values: [必填] 需从Helm值中移除的字段列表

配置示例

kushi:
  service: confluence-dev-us-11
  environment: stg-east,649535320606
  archetype-descriptor: ./tests/fixtures/archetype-descriptor.yaml
  output-dir: ./helm/confluence-dev-us-11
  main-container: confluence
  request-cpu: 5000m
  request-memory: 16Gi
  limit-cpu: 5000m
  limit-memory: 16Gi
  worker:
    - AmqWorker,5000m,16Gi,5000m,16Gi
  sidecar:
    - cc-nginx-sidecar,500m,100Mi,500m,350Mi
    - hofund,500m,100Mi,500m,350Mi
  ignore-error:
    - multiple-load-***s
    - sidecar-poco
    - unsupported-characters
  debug: "" # 空字符串表示用作标志，类似CLI中的--debug
  skip-docker-distributor-generation: ""
  skip-kitt-descriptor-generation: ""
  values-overrides: config/values-overrides.yaml # 可使用文件覆盖值，但灵活性不足且无法完全移除字段，因此需要此镜像

values-removals:
  - file: values.yaml
    values:
      kitt-application:
        secrets:
          vault:
            static:
              shard-purpose: { } # 完全移除该字段

values-overrides:
  - file: blah/values.yaml # 若文件不存在则跳过
    values: { } # 若未提供值则不执行操作
  - file: stg-east/values.yaml
    values:
      kitt-application:
        global:
          kitt:
            v1alpha2:
              cluster:
                cloud_type: gcp # 若字段不存在则添加，若存在则修改值
  - file: values.yaml # 覆盖文件中的值
    values: { }

archetype-removals:
  definitions:
    serviceDescriptor:
      definitions:
        isolatedCloudServiceDescriptor: { } # 暂时完全移除该字段以避免IC转换错误

archetype-overrides:
  definitions:
    serviceDescriptor:
      compose:
        upp-sidecar:
          ports:
            - 8181:8484 # 原端口8181:8181与poco-sidecar冲突，此处修改

上述示例中，对values.yaml将完全移除kitt-application.secrets.vault字段；对stg-east/values.yaml将移除kitt-application.secrets.vault.static.shard-purpose字段，并添加/修改kitt-application.global.kitt.v1alpha2.cluster.cloud_type为gcp。

注意：若值为列表，将移除列表中匹配的项；若需完全移除字段，值必须设为空字符串、空对象或空列表，否则不会移除该字段。

工作流程

1. 镜像读取CONFIG变量中的转换配置
2. 若提供SERVICE_DESCRIPTOR变量，将服务描述符转换为原型描述符
3. 调用atlas kushi migrate命令将原型描述符转换为Helm图表
4. 根据配置中的覆盖规则对Helm值应用覆盖操作
5. 若GIT_ENABLED设为true，将变更提交至Git仓库（无变更则不提交）
6. 若PULL_REQUEST_ENABLED设为true，自动创建拉取请求

环境变量

Artifactory认证

Helm仓库认证需Artifactory凭据，可通过atlassian/artifactory-sidekick:v1镜像获取，该镜像会导出以下环境变量：

• ARTIFACTORY_USERNAME
• ARTIFACTORY_PASSWORD

Bitbucket访问令牌

若需使用Bitbucket进行Git操作，需提供具有相应权限的仓库访问令牌，并配置到GIT_PASSWORD变量中。创建步骤如下：

1. 进入Bitbucket仓库设置
2. 在左侧导航栏中选择"访问令牌"
3. 点击"创建访问令牌"，输入有意义的令牌名称
4. 设置过期时间（最长1年）
5. 授予以下权限：
   • 仓库：读取、写入
   • 拉取请求：读取、写入
   • 流水线：读取
6. 复制生成的令牌并配置到GIT_PASSWORD变量
7. 复制生成的邮箱配置到GIT_EMAIL变量
8. 用户名固定为x-token-auth，可使用默认值GIT_USERNAME

注意：Bitbucket访问令牌用户名为固定值x-token-auth，因此GIT_USERNAME可使用默认值。

配置仓库变量：

1. 进入Bitbucket仓库设置
2. 在左侧导航栏中选择"仓库变量"
3. 添加变量GIT_PASSWORD并粘贴访问令牌（设为保密）
4. 添加变量GIT_EMAIL并粘贴创建令牌时使用的邮箱

Bitbucket流水线配置

在bitbucket-pipelines.yml文件中使用该镜像的示例配置如下：

pipelines:
  custom:
    convert-helm-values:
      - step:
          name: 转换Helm值
          script:
            - pipe: atlassian/artifactory-sidekick:v1 # 必须先运行此步骤以准备Artifactory认证
            - source .artifactory/activate.sh
            - pipe: docker://atlassian/convert-helm-values:latest
              variables:
                CONFIG: 'convert-helm-values.yaml'
                SERVICE_DESCRIPTOR: 'path/to/service-descriptor.yaml' # 可选，仅单体应用需配置（需先将服务描述符转换为原型描述符）
                ARTIFACTORY_USERNAME: ${ARTIFACTORY_USERNAME} # Helm仓库认证必填，由artifactory-sidekick导出
                ARTIFACTORY_PASSWORD: ${ARTIFACTORY_PASSWORD} # Helm仓库认证必填，由artifactory-sidekick导出
                DEBUG_MODE: 'true' # 可选，设为true启用调试模式
                GIT_ENABLED: 'true' # 可选，设为true启用Git提交操作
                GIT_EMAIL: ${GIT_EMAIL} # 可选，在仓库变量中配置Git邮箱
                GIT_USERNAME: ${GIT_USERNAME} # 可选，在仓库变量中配置Git用户名
                GIT_PASSWORD: ${GIT_PASSWORD} # 可选，在仓库变量中配置Git访问令牌
                PULL_REQUEST_ENABLED: 'true' # 可选，设为true启用自动创建拉取请求