元数据Metadata
元数据文件:{OSC-Package}/metadata.yaml,配置的是服务包的基本信息,包括名称、版本、描述等相关信息。
metadata.yaml样例:
name: example-operator
version: "1.0.0"
appVersion: 2.1.2
alias: example-operator.v1.0.0
displayName: Example operator
briefDescription: example operator with an example instance and action
detail: |
example operator detail description.
source: OpenSource
type: operator
containerImage: swr.cn-east-3.myhuaweicloud.com/osc-official/example-operator:1.0.0
repository: swr.cn-east-3.myhuaweicloud.com
architecture:
- x86_64
- aarch64
capabilities:
- Basic Install
categories:
- Database
devices:
- CPU
- GPU
- NPU
industries:
- education
- media
logo:
base64data: iVBORw.....
mediatype: image/png
maintainers:
- email: test@test.com
name: test
provider:
name: Example provider
url: https://example.com/
scenes:
- CCE
- UCS
deployScenes:
CCE:
- self
UCS:
- self
- partnercloud
- onpremise
- multicloud
- attachedcluster
links:
- name: example link
url: http://github.com/3scale/prome 参数名称 | 参数描述 | 参数示例 | 必选 |
|---|---|---|---|
name | 名称,符合正则表达式 ^[a-z][a-z0-9\-]*[a-z0-9]$,如果服务名称为业界具有特殊含义的字符串,为了避免被转义,可使用引号引起来。 | example-operator | 是 |
version | 版本。建议使用引号,否则YAML会将类似2.0的版本号识别为浮点数。 | 1.0.0 | 是 |
appVersion | 应用版本信息,长度小于64 | 2.1.2 | 否 |
alias | 别名 | example operator | 否 |
displayName | 对外显示的名字 | Example operator | 否 |
briefDescription | 简要描述,长度小于64 | 参考样例 | 否 |
detail | 详细描述 | 参考样例 | 否 |
source | 包来源,取值范围:{ISV, OpenSource, HuaweiProvided},分别表示独立服务供应商、开源服务、华为自有服务,仅支持配置一个值。默认值为OpenSource | OpenSource | 否 |
type | 包类型,取值范围:{helm, operator},仅支持配置一个值,默认值为operator | operator | 否 |
containerImage | 容器镜像 | 参见样例 | 否 |
repository | 镜像仓库 | swr.huawei.com | 否 |
architecture | 支持架构列表,取值范围:{x86_64, aarch64},默认值为x86_64 | - x86_64 - aarch64 | 否 |
capabilities | 能力 | Basic Install | 否 |
categories | 分类列表,范围不限,如"AI, Database",注意,当前同一个服务不同版本须配置相同内容,一旦配置后当前不支持修改 | Database | 否 |
devices | 实例运行需要使用的硬件设备列表,取值范围:{CPU, GPU, NPU},默认值为CPU | - CPU - GPU | 否 |
industries | 行业列表,范围不限,如"education,media" | education | 否 |
logo | 图标,包含base64data和mediaType两个字段。如果不设置,则使用对应包类型的默认Logo | 参考样例 | 否 |
maintainers | 维护人员列表,包含name和email两个字段,注意,当前同一个服务不同版本仅支持配置相同内容,一旦配置后当前不支持修改 | 参考样例 | 否 |
provider | 提供者,包含name和url两个字段,注意,当前同一个服务不同版本须配置相同内容,一旦配置后当前不支持修改 | 参考样例 | 否 |
scenes | 部署平台列表,取值列表:{CCE,UCS},分别表示CCE平台和UCS平台,大小写敏感,默认值为CCE。 该字段作为兼容性字段,依赖deployScenes属性: 1)当deployScenes不为空,该字段不起作用 2)当deployScenes为空时,该字段起作用 | - CCE - UCS | 否 |
deployScenes | 部署场景deployScenes包含部署平台(CCE和UCS)和集群类型两部分:
当部署场景deployScenes未配置,默认只支持部署平台为CCE,且不限制集群类型。 | 方式一: CCE: - self UCS: - self - partnercloud - onpremise - multicloud - attachedcluster 方式二: CCE: [self] UCS: [self,partnercloud,onpremise, multicloud,attachedcluster] | 否 |
links | 附加说明链接列表,包含name和url两个字段,例如项目介绍链接 | 参考样例 | 否 |

