网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

IaC代码结构介绍

更新时间:2024-09-24 GMT+08:00
分享

单文件描述结构

单文件描述结构样例如下:

├── package.json                    # 包描述文件(必须)
└── specs                           # 规格总目录(必须)
      ├── cn_dev_default            # cn_dev_default规格目录,可用于描述一个开发用途的服务环境所使用的基础设施
      └── cn_product_default        # cn_product_default规格目录,可用于描述一个生产用途的服务环境所使用的基础设施
            └── meta.yaml           # IaC主体描述文件
IaC主体描述文件meta.yaml
type: WiseCloud::Environment                # 描述环境类型,当前仅支持 WiseCloud::Environment 
components:                                 # 定义服务环境所包含的组件列表,每个组件包含一个资源列表
- name: environment                         # 组件名称
  resources:                                # 资源列表
  - name: fgc_cloudmap                      # 资源名称,同类型的资源的名称在整个服务环境中唯一
    type: WiseCloud::Endpoint::CloudMap     # 资源类型
    properties:                             # 资源属性:具体包含哪些属性,由资源类型决定
      ...
- name: FGCActionInvokerService
  resources:
    ... 
- name: FGCAbilityCenterService
  resources:
    ...
applyPipeline: default                      # 默认选用名为default的组件编排流水线
pipelines:                                  # 定义可用的组件编排流水线
- name: default                             # 流水线的名称,作为流水线被引用的唯一标识
  action: Serial                            # 串行编排
  tasks:                                    # 串行编排的任务列表
  - name: apply-environment                 # 任务名称 
    action: Apply                           # 应用变更
    component:                              # 变更组件的相关约束
      name: environment                     # 变更的组件名称
  - name: parallel-others 
    action: Parallel                        # 并行编排
    tasks:                                  # 并行编排的任务列表
    - name: apply-FGCActionInvokerService   # 任务名称
      action: Apply                         # 应用变更
      component:                            # 变更组件的相关约束
        name: FGCActionInvokerService       # 变更的组件名称
    - name: apply-FGCAbilityCenterService   # 任务名称
      action: Apply                         # 应用变更
      component:                            # 变更组件的相关约束
        name: FGCAbilityCenterService       # 变更的组件名称

以上示例清晰地展示了IaC3.0的资源组织结构:

  • Nuwa,CloudMap等资源,依照业务需要,可划分到不同的组件中。
  • 一个组件可对应于一个微服务,或是服务内共享的中间件集合。
  • 全体组件的集合,则汇总描述了整个服务环境的期望部署状态。
  • 组件编排流水线,则是以组件为最小粒度来描述服务环境是如何做部署状态的迁移的。其可以处理组件间的升级依赖关系,以及通过多阶段方式提供灰度升级能力。

多文件描述结构

为了避免诸多资源的描述都集中于meta.yaml,而造成文件内容过长难以管理。通过引入resources.yaml和文件引用语法,可以将单文件结构改造为多文件描述目录结构,样例如下:

├── package.json                    # 包描述文件(必须)
└── specs                           # 规格总目录(必须)
      ├── cn_dev_default            # cn_dev_default规格目录,可用于描述一个开发用途的服务环境所使用的基础设施
      └── cn_product_default        # cn_product_default规格目录,可用于描述一个生产用途的服务环境所使用的基础设施
            └── meta.yaml
            └── VirtualAppManangerService
                  ├── config
                  │   └── business_config.yaml
                  │   └── nginx.conf
                  ├── db
                  │   └── schema.sql
                  ├── values.yaml
                  └── resources.yaml
  • 引入resources.yaml

    IaC3.0 支持当meta.yaml不编写components时,通过提取具体规格目录(如:cn_dev)的直接子目录(也称为组件目录)里的resources.yaml来自动构造出meta.yaml的components。

    引入resources.yaml后目录结构样例如下:

    ├── meta.yaml                       # IaC主体描述文件,内容不包含components
    ├── WiseEyeChaosMonkeyMgrService    # 组件一:ChaosMonkey管理服务
    │    └── resources.yaml            # 组件一的资源列表
    ├── WiseEyeChaosMonkeyPortal        # 组件二:ChaosMonkey网页服务
    │    └── resources.yaml            # 组件二的资源列表
    ├── environment                     # 组件三:环境
    │    └── resources.yaml            # 组件三的资源列表
    └── functions                       # 组件四:函数
          └── resources.yaml            # 组件四的资源列表
  • 使用文件引用语法

    尽管meta.yaml已支持分散到诸多的组件目录中,但是每个组件仍然存在更新频率不同的配置。例如:微服务所用的镜像版本号更新频率较高。IaC3.0支持使用文件引用语法:允许YAML通过$ref键值对跨文档引用其他文本文件的内容。应用$ref语法,可以自由实现将资源、属性分散到更多文件中去。建议将更新频率较高的属性分散到被引用文件中,保持主体文件的结构稳定。

    • YAML文档整体引用

      resources.yaml原始内容:

      # resources.yaml
      - name: virtualapp
        type: Wisecloud::Nuwa::Runtime::MicroService
        properties:
          configs:
            - name: common.java.http.ssl_protocols
              value: TLSv1.2
              sensitive: false
            - name: common.java.http.enabled_cipher_suites
              value: aes_128_gcm|aes_256_gcm
              sensitive: false
          globalConf: |-        
            #user  slb slb;
            worker_processes auto;
            #worker_cpu_affinity 0001 0010 0100 1000;
            pid        logs/nginx.pid;
            ......
           #  yaml 文件中多行字符串可以使用|保留换行符,如:globalConf
           # |:文中自动换行,默认仅保留一行空行
           # |+:文中自动换行,保留字符串后面所有的空行
           # |-:文中自动换行,删除字符串后面所有的空行

      将 properties > configs下的内容,放置于business_config.yaml。

      # business_config.yaml
      - name: common.java.http.ssl_protocols
        value: TLSv1.2
        sensitive: false
      - name: common.java.http.enabled_cipher_suites
        value: aes_128_gcm|aes_256_gcm
        sensitive: false

      则resources.yaml 可修改为:

      # resources.yaml
      - name: virtualapp
        type: Wisecloud::Nuwa::Runtime::MicroService
        properties:
          configs:
            $ref: 'config/business_config.yaml#' # 运行时,会将config/business_config.yaml的整个YAML文档对象,替换掉整个$ref键值对

      将properties > globalConf下的内容,放置于nginx.conf

      # nginx.conf
      #user  slb slb;
      worker_processes auto;
      #worker_cpu_affinity 0001 0010 0100 1000;
      pid        logs/nginx.pid;
      ......

      则 resources.yaml 可修改为:

      # resources.yaml
      - name: virtualapp
        type: Wisecloud::Nuwa::Runtime::MicroService
        properties:
          configs:
            $ref: 'config/business_config.yaml#' # 运行时,会将config/business_config.yaml的整个YAML文档对象,替换掉整个$ref键值对
          globalConf:
            $ref: 'config/nginx.conf' # 运行时,引用的是config/nginx.conf这个配置文件内容所构成的字符串
    • YAML文档片段引用

      若values.yaml存在以下内容:

      values:
        example_name:
          peak_tps: 200000

      则在resources.yaml,可按照如下方式进行引用200000。

      $ref: 'values.yaml#/values/example_name/peak_tps'
    • 文本内容字符串引用
      $ref: 'db/schema.sql'    #引用的是schema.sql这个文本文件内容所构成的字符串

带global的多文件描述结构

Spec包通过不同规格目录来描述同一个服务在不同用途环境下所需的基础设施。但是,同一服务的不同的规格仍然存在大量相同的配置,需要一种机制来完成不同规格间配置的复用。因此,IaC支持放置一个global目录,其与specs目录同级,用于放置被所有规格目录所复用的配置文件。而各具体规格目录,只需包含与 global 目录的增量差异文件即可。

当某个规格被选用于部署时,会先将该规格目录下所有文件与global目录进行合并,得到该规格目录最终的所有配置文件,再进行部署动作。

合并策略:若文件的相对路径相同,则规格目录下的文件保留, global目录下的文件被覆盖,其他文件则共存。

带global的多文件描述结构样例如下:

├── package.json                           # 包描述文件(必须)
├── global                                 # global目录:放置所有规格目录所复用的配置文件
│     │
│     ├── meta.yaml                       # IaC 主体描述文件,内容不包含 components
│     ├── WiseEyeChaosMonkeyMgrService    # 组件一:ChaosMonkey 管理服务,名称需要为该服务下的微服务名称。
│     │    └── resources.yaml            # 组件一的资源列表
│     ├── WiseEyeChaosMonkeyPortal        # 组件二:ChaosMonkey 网页服务
│     │    └── resources.yaml            # 组件二的资源列表
│     ├── environment                     # 组件三:环境
│     │    └── resources.yaml            # 组件三的资源列表
│     └── functions                       # 组件四:函数
│           ├── resources.yaml            # 组件四的资源列表
│           └── values.yaml               # 组件四的values.yaml
│
└── specs                                  # 规格总目录(必须)
      ├── cn_dev_default                   # cn_dev_default 规格目录,一般可用于描述一个开发用途的服务环境所使用的基础设施  
      └── cn_product_default               # cn_product_default 规格目录,一般可用于描述一个生产用途的服务环境所使用的基础设施
            └── functions                  # 与global下functions目录的相对路径一致
                  └── values.yaml          # 用于覆盖global下functions目录的values.yaml
提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容