检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
可提供链接 或者 文字--> # 许可证 使用说明文件中引用的文件或者文档链接尚未设计,作为后续规划。 父主题: 服务包规范
生命周期Lifecycle 生命周期文件:{OSC-Package}/lifecycle.yaml,描述当前OSC服务包的安装,升级方式信息。 lifecycle.yaml文件样例 ## 描述该OSC服务包的声明周期相关信息 install: strategy: deployment
基础控件 OSC console依据crd.yaml文件可以自动生成Operator的创建表单。crd.yaml文件中的properties(openAPIV3Schema.properties.spec.properties)对象会自动映射到对应的UI组件。 目前提供的基础类型
生成的服务包如果需要配置OSC平台运维功能,请参考对接运维能力(可选);如果不需要配置OSC平台运维功能,请直接查看《OSC服务使用者指南》了解如何上传服务包进行使用。 oscctl工具同样支持直接在windows平台上运行,需要使用windows终端进入,执行oscctl-22.8.18/win-amd64/oscctl
根据服务包格式类型,需补充说明内容如下: Helm Chart服务包 Chart服务包其主体描述信息存储在Chart.yaml文件中,其中Chart.yaml文件中有如下几个必填字段内容: version: 1.0.0 name: example-helm apiVersion: v1
元数据Metadata 元数据文件:{OSC-Package}/metadata.yaml,配置的是服务包的基本信息,包括名称、版本、描述等相关信息。 metadata.yaml样例: name: example-operator version: "1.0.0" appVersion:
路径 否 是 monitor_config.yaml 对接平台的指标采集能力,可配置指标采集的维度,指标名称,指标聚合规则等,详情参考如何配置监控。 文件 否 是 log_config.yaml 对接平台的日志采集能力,可配置日志采集路径对接配置日志。 文件 否 是 参考如下步骤可以进行扩展目录文件配置:
表单控件配置组合示例 csd.yaml文件中配置添加如下配置: # 配置表单控件 descriptors: spec: - displayName: Image description: The docker image name and version of
购买用户者下载使用时需要增加的步骤。 用户需要在用户部署的deployment.yaml、statefulset.yaml等包含镜像下载的文件中增加如下配置。 apiVersion: apps/v1 kind: Deployment metadata: name: example
logPaths 日志路径或文件 string数组 是 容器内日志路径,可填多个,但不允许存在包含关系。 日志内的路径支持目录和文件 目录:扫描此目录下的所有为log,out,trace结尾的日志并对接 文件:只对接指定的文件 在manifests/xxx_csd.yaml文件中增加引用日志能力的配置。
es相关资源的文件集合。chart包含: Chart.yaml values.yaml values.schema.json charts目录 templates目录 {Helm}/ ├─ Chart.yaml #【必选】包含了chart信息文件,包括api版本、名称、描述、图标、类型、注释
#【必选】生命周期文件 └─ README.md #【可选】使用说明文件 转换说明 新增第三方目录raw,将Helm原始包内容全部放到该目录中。 新增元数据文件metadata.yaml,该文件内容包含Chart.yaml,具体规范参见元数据Metadata。
#【必选】元数据文件 ├─ manifests/ #【必选】资源集合 ├─ raw/ #【可选】第三方目录 └─ lifecycle.yaml #【必选】生命周期文件 表1 目录结构 名称 目录/文件 描述 必选 元数据文件 metadata
yaml中的镜像地址,mapping.yaml文件确定OSC在values.yaml或者*.clusterserviceversion.yaml中哪些字段用于配置镜像地址。mapping.yaml有多种不同的字段替换方式,镜像根据实际情况选择对应字段,会将镜像分隔成不同内容回填到配置文件中。 instance:
名称:填写需要上传的服务包中的名称。 描述:用于描述此服务的相关功能描述等。 模板仓库:用于存储服务包中的operator、helm chart或者osc规范包的模板文件。 镜像仓库:用于存储服务包中的容器镜像。如果用户没有对应的仓库组织,可单击“新建组织”跳转到对应页面进行创建。可参考创建组织。 单击“确定”按钮,创建服务完成。
statusDescriptors statusDescriptor用于描述自定义资源中状态字段的属性,其配置在csd.yaml文件的status字段。statusDescriptors的结构与specDescriptors相似,包括相同的字段。 text x-descriptors:
存放服务包的镜像目录,当镜像是让用户从外部拉取,镜像目录可不要。 否 镜像文件 {images}.tar 镜像文件,tar格式结尾 镜像文件。 否 镜像地址索引文件 mapping.yaml 固定名称,不可修改 OSC通过这个文件判断Helm模板或者Operator包中配置镜像的字段,以便将
$ oscctl create --output "./NewOSCPackage" 此命令将在工作目录下创建文件夹NewOSCPackage,其中包含OSC服务包必要的文件。 服务包转换 在oscctl命令后添加子命令convert用以将开源helm或operator服务包,使用
yaml #【必选】生命周期文件 ├── manifests # 【必选】资源合计 │ ├─ hwfka_crd.yaml │ └─ hwfka_csd.yaml │ └─ vendor └── metadata.yaml #【必选】元数据文件 父主题: 制作服务包
在相关诉求而无法快速联系对应提供者,因此要求用户在软件包中进行描述。 操作步骤 上传服务包为helm服务包格式,需要在Chart.yaml文件中增加维护者信息,具体配置如下所示,参考更多。 version: A SemVer 2 version (required) kubeVersion: