苍穹CI/CD流水线环境变量说明

栏目:云苍穹知识作者:金蝶来源:金蝶云社区发布:2024-09-23浏览:1

苍穹CI/CD流水线环境变量说明

1 概述

1.1 文档目的

帮助苍穹二开人员以苍穹CI/CD流水线模板为基础创建、配置自己的流水线。


1.2 适用范围

熟悉苍穹二开的开发人员、设计人员和部署人员。


2 环境准备

轻轨线(CI/CD)服务在流水线模块为用户提供了苍穹标准的CI和CD模板,用户可直接引用并创建流水线。流水线模板的使用方法可以参考文档:流水线-模板管理


创建好流水线后,就可以针对特定需求配置相应的变量值了。


操作路径:CICD服务首页左上角【流水线】→ 选择对应的流水线 全局变量 → 执行修改



3 注意事项

3.1 苍穹标准CI流水线模板的环境变量

参考名称参数含义样例
PATCH_PACKAGE_PREFIX_NAME补丁包名前缀及制品库目录名,用于标记相关的制品库由哪条流水线生成,需自定义。pipeline1
COSMIC_PATCH_VERSION苍穹中的补丁的版本号,默认值为4.0.016.0。4.0.016.0
COSMIC_CLOUD_NAME

苍穹中应用云的编码。

ICC
APPSTORE_URL苍穹应用仓库的访问地址。http://dev01-cosmic-devops.cosmic.cloudsz.kingdee.com/appstore/cosmic/
NEXUS_PROXYgPaaS中的third-api-server服务的对外访问路径,默认值为http://third-api-server.kce-system:8080,可不用修改,具体可参考CD模板变量说明。http://172.25.1.242:43763
NEXUS_REPO项目ID,系统会根据所选项目默认生成,无需修改,具体可参考CD模板变量说明。V2.9.11版本新建的流水线该变量会隐藏,系统自动获取,不用再进行填写。fd59ab9fa6f745a8b6aef525fb4d033d
ISV苍穹开发商标识。xouc
X_Console_UkeygPaaS控制台中的密钥,代表身份,目前只能是创建一个个人的密钥,系统会自动生成,如需手动添加,请参考CD流水线变量说明。6f933bfc493323e958d079daa9ebd3b1
COSMIC_BOSLIBS
苍穹bos依赖包,如bos.xml,无需加载请删除。bos.xml
COSMIC_BIZLIBS苍穹biz包依赖,如ai.xml,无需加载请删除。ai.xml
COSMIC_CUSLIBS苍穹客户包依赖,如cus.xml,无需加载请删除。cus.xml
COSMIC_TRDLIBS第三方依赖包,无需加载请删除。-
gradle_parallelgradle并行数,即同时能跑的gradle进程数量,根据机器性能进行设置2
PATCH_VERSION自定义补丁包版本v1.0
STATICFILE_PATH表示静态资源的路径,变量值为静态资源gitlab仓库名,如需进行静态资源构建,请加上该变量,默认值为staticfilesstaticfiles


说明:

⑴ ISV变量获取方式

开发商标识。自动生成流水线时默认映射为为租户ID,需修改成实际的值。

操作路径:登录开发者门户 → 点击右上角“工作台”



开发商标识界面:



⑵ 制品包格式

制品仓库格式是:【PATCH_PACKAGE_PREFIX_NAME】(前缀)_【PATCH_VERSION】(构建版本号)_时间戳.构建次数

注意:中间无空格



⑶ COSMIC_CLOUD_NAME

苍穹中应用云的编码。


3.2 CD流水线变量

参数名称

参数含义

样例

PATCH_PACKAGE_PREFIX_NAME补丁包名前缀及制品库目录名,CD时请填写与之相对应的CI变量值,否则可能导致部署错误。pipeline1
GPAAS_DOMAINgPaaS对外域名,要求cd时苍穹appstore可访问。https://demo.gpaas.kingdeetech.com

MC_TRD_KEY

mc中的第三方应用key。V2.8.10及以上版本可在苍穹环境管理中统一维护,后续直接引用,点击查看详情

Az+QANM9APem7VVeZjfYbg==

MC_TRD_APPID

mc中第三方应用ID。V2.8.10及以上版本可在苍穹环境管理中统一维护,后续直接引用,点击查看详情

unittest

COSMIC_CLUSTER_ID

mc中的集群id。V2.8.10及以上版本可在苍穹环境管理中统一维护,后续直接引用,点击查看详情

ierp

COSMIC_DATACENTER_ID

mc中的数据中心ID,多个数据中心用逗号隔开。

1155861116253897728

COSMIC_MC_URL

苍穹MC的外部访问地址。V2.8.10及以上版本可在苍穹环境管理中统一维护,后续直接引用,点击查看详情

http://dev01-cosmic-devops.cosmic.cloudsz.kingdee.com/mc

NEXUS_REPO

项目ID,系统会根据所选项目默认生成,无需修改。V2.9.11版本新建的流水线该变量会隐藏,系统自动获取,不用再进行填写。

cosmic02-fd59ab9fa6f745a8b6aef525fb4d033d

COSMIC_APPIDS

需要在MC中更新发布的应用ID列表,多个以逗号分隔。

jocl_webidetest

X_Console_Ukey

gPaaS控制台中的密钥,代表身份,目前只能是创建一个个人的密钥,系统会自动生成,也可以前往【密钥管理】进行获取。

6f934efc875543a985b845daa2ebd8b2

MS_NAMESPACE

苍穹mservice服务所在的k8s集群中的命名空间。V2.8.10及以上版本可在苍穹环境管理中统一维护,后续直接引用,点击查看详情

cosmic-devops

MS_REGION

苍穹mservice服务所在的k8s集群中的集群编码。V2.8.10及以上版本可在苍穹环境管理中统一维护,后续直接引用,点击查看详情

cosmic-devops1

MS_PID

苍穹mservice服务所在的集群项目id,可在omp中在相应的租户下面查询项目获取。V2.8.10及以上版本可在苍穹环境管理中统一维护,后续直接引用,点击查看详情

476944

KCS_ADDRESS

容器服务(kcs)的外部访问地址。

https://cloud.kingdee.com/kcs

NEXUS_PROXY

gPaaS中的third-api-server服务的对外访问路径,默认值为http://third-api-server.kce-system:8080,可不用修改。

http://172.25.1.242:43763

RESTART_NODEPORT_ADDRESSES

苍穹服务的对外访问地址,用来检测是否存活,多个中间以空格分隔。从V2.9.11版本开始,新的流水线无需再填写该变量,系统会自动检查服务状态。

172.25.1.51/24841 

172.25.1.51/30807

RESTART_SERVICE_NAMES支持重启的多个servicename的名称,多个中间以空格分隔。mservice mservice_hr
COSMIC_PATCH_PACKAGE制品库中待升级的补丁包名称。默认值AUTO,此时会取最新生成的补丁包版本。如需指定补丁包版本,修改该变量。
10000-cicd_custom-default-202203071003.3.zip


部分环境变量获取方式:


⑴ MC_TRD_KEY

mc中的第三方应用key,首次进入时点击刷新图标即能看到数据;如果没有看到此界面,则需要更新mc的内核和版本。

注意:

1、点击[刷新]后,需要点击[保存]按钮,key才能保存成功;

2、MC第三方应用页面交互不同版本可能略微不一致,如果看到多种认证方式或者访问策略,请选择“摘要认证”获取相关的认证秘钥,点击查看配置详情


直接获取第三方应用key


选择摘要认证获取第三方应用key


    

选择摘要认证获取第三方应用key


⑵ MC_TRD_APPID

mc中第三方应用ID。



⑶ COSMIC_CLUSTER_ID

mc中的集群ID。



⑷ COSMIC_DATACENTER_ID

mc中的数据中心ID,通过mc系统查看,操作路径:【租户列表】→ 【租户】→ 【数据中心】。



⑸ NEXUS_REPO 

即项目ID。

说明:V2.9.11版本新建的流水线该变量会隐藏系统自动获取,不用再进行填写。



⑹ X_Console_Ukey

即gPaaS控制台中的密钥。操作路径:控制台右上角点击个人信息图标 → 点击“密钥管理”→ 新建密钥并在列表中复制。



⑺ MS_REGION

苍穹mservice服务所在的k8s集群中的集群编码。操作路径:进入【容器服务】→ 【集群管理】→【资源管理】



集群编码即为“区域英文标识”。



⑻ MS_NAMESPACE

苍穹mservice服务所在的k8s集群中的命名空间。操作路径:【容器服务】→【集群管理】→【项目管理】



选择部署了苍穹mservice服务的集群,并点击“项目管理”进入如下页面:



列表上选择苍穹mservice服务所在的项目,并点击操作列中的“配置”按钮,如下图:



示例图说明:苍穹mservice服务所在的项目为 “一体化PaaS项目”,所在的k8s集群为“融合平台集群”,所在的命名空间为“cosmic-devops”。


⑼ MS_PID

苍穹mservice服务所在的集群项目ID。可在【omp系统】中在相应的租户下面查询项目获取. 本示例中集群项目ID为“10272”。



⑽ NEXUS_PROXY

gPaaS中的部署在容器服务中的third-api-server服务的外部访问地址。




⑾ RESTART_SERVICE_NAMES

支持重启服务的多个servicename的名称,多个中间以空格分隔。



⑿ RESTART_NODEPORT_ADDRESSES

苍穹服务的对外访问地址,用来检测是否存活,多个中间以空格分隔,与RESTART_SERVICE_NAMES参数配套使用。操作路径:【容器服务】→ 【服务访问】→【外部访问】。

说明:从V2.9.11版本开始,新的流水线无需再填写该变量,系统会自动检查服务状态。



注意:如找不到对应服务的外部访问地址,可以点击【添加端口访问】,获取外部访问端口,然后对应服务的主机ip+端口就是你的外部访问地址。如以下mservice服务对应的主机ip为172.25.1.151,外部访问添加对应服务的端口为30639,则该变量值为:172.25.1.151:30639



⒀ KCS_ADDRESS

容器服务(kcs服务)的外部访问地址,以访问gPaaS为例,

如果gPaaS的访问的地址为https://10.0.0.145,则该值为https://10.0.0.145/kcs


⒁ COSMIC_MC_URL

访问苍穹的配置中心MC的外部访问地址。


⒂ COSMIC_APPIDS

需要在MC中更新发布的应用ID列表,多个以逗号分隔。应用ID可以 登录苍穹,在开发平台中可以看到具体的应用编码。



3.3 元数据更新

元数据更新的脚本是需要手工在git上进行维护的,需要执行的描述符文件格式为 {appid}.xml,如下图中的 jocl_webidetest.xml



描述符文件内容格式如下,建议使用全英文,使用ksql。




苍穹CI/CD流水线环境变量说明

1 概述1.1 文档目的帮助苍穹二开人员以苍穹CI/CD流水线模板为基础创建、配置自己的流水线。1.2 适用范围熟悉苍穹二开的开发人员、设计人...
点击下载文档
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息