检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
服务包规范 本规范主要面向对象为初次开发的服务以及想要使用OSC平台提供的附加能力进行规范转换的服务。 如果开发者已有或仅想使用Helm/Operator-Framework规范的服务,可以直接参考章节开源服务包规范。 OSC服务包介绍 元数据Metadata 资源集合Manifests
k的规范服务,开发者可参考开源服务包规范确保服务包符合helm或者operator-framework规范,或参考制作服务包,生成符合OSC规范的服务包。 服务接入完成后,可以参考《OSC 服务使用者指南》了解如何登录OSC平台进行验证。 服务能力介绍 Helm服务接入OSC平台
表1 资源集合结构 目录或文件名称 描述 必选 xxx_crd.yaml 服务包的资源,例如kafka、redis,一个服务包可以包含一个或者多个具体资源目录。 是,至少一个 xxx_csd.yaml 自定义服务文件,每个csd文件对应于一个crd文件。 否 公共能力目录 公共能力目
服务包扩展目录 运维能力是在OSC服务规范基础上产生的能力,因此如果需要对接运维能力,需要先确保服务包的格式转换为OSC自身的规范才行,默认的开源规范当前只支持安装部署等基本功能。 运维能力扩展 为了保证适用OSC的服务规范,将使用oscctl工具作为创建、转换OSC服务包,并且统一服务包格式。使用oscctl
服务包镜像名称约束 镜像目录存放部署目录中需要使用到的镜像文件,镜像文件以tar格式存储。镜像文件命名规范只允许包含大小写字母、数字、下划线、中划线及点,且不能以下划线、中划线及点结尾。 images目录下存放服务运行所需的容器镜像,根据服务实际情况确定支持单CPU架构还是多CPU架构:
发布服务 OSC负责管理服务包,商品的正式发布需要到华为云云市场卖家中心发布,交付方式选择”容器”,其它信息请参见商品发布说明。 操作步骤 在服务发布页面单击“发布商品”链接进入云市场发布商品界面。 发布服务必须使用通过云市场认证的账号登录,如果没有通过云市场认证的账号,请申请账号,具体请参见云市场计划。
维护服务插件 登录OSC控制台。 单击"服务插件"导航栏,进入“服务插件”详情页,单击选择“系统插件”页签,选择对应的区域,可查看当前区域下所有的运维插件,也可以查看指定容器集群下的运维插件。 系统插件状态异常时,鼠标移动至异常状态上,可展示插件状态异常的原因。单击“日志”和“事
管理服务插件 登录OSC控制台。 进入“我的服务->我的订阅”页面,卡片模式下会展示当前所有服务的实例个数,单击某一服务查看服务详情。 单击“服务管理”页签,可查看当前服务管理插件的状态,包括插件所在的区域和容器集群。 服务插件状态异常时,可单击操作栏“事件”和“日志”选项,根据
自定义服务CSD 在不同业务环境下,服务对平台有着不同的诉求,Kubernetes提供自定义资源CRD的轻量化机制。而在实践过程中,发现对于服务能力如服务依赖、服务访问、服务部署、监控日志等公共能力欠缺。 因此围绕CRD自研CSD,通过声明式配置CRD的能力引用,增强服务治理能力。
前置检查 服务包发布到云市场中,需要提供病毒扫描报告,保证发布上架的服务中不存在任何病毒,并在发布商品时提供给云市场运营人员审核,审核通过后商品方可发布成功。 确保Helm模板中的镜像配置都引用values.yaml中的配置,如果不满足,请参见排查和编辑镜像地址排查和整改。 确保operator包中的镜像配置都引用*
制作流程 制作服务包目录 放置镜像到images目录 打包到package目录 替换镜像地址配置 父主题: 服务包制作
服务使用者通过已订阅服务创建服务实例。 服务使用者可对服务实例进行编辑、升级、监控等治理操作。 服务使用者可针对不需要的服务实例进行销毁。 图2 商品服务生命周期 私有服务生命周期 华为云租户将服务包上传为私有服务。 华为云租户使用私有服务创建服务实例。 华为云租户可对服务实例进行编辑、升级、监控等治理操作。
Helm服务接入OSC平台 前置条件 阅读本章节前,用户需要拥有一个符合Helm规范的服务包,Helm服务规范可以参考Helm规范,下面以helm开源服务grafana为例进行详细说明。 接入流程 用户参考附录oscctl工具使用中的链接下载oscctl工具oscctl-22.8
自定义资源CRD 自定义资源CRD是Kubernetes服务遵循,一个自定义资源对应一个目录,遵循Kubernetes CRD规范,详细介绍参考官方CustomResourceDefinition。 父主题: 资源集合Manifests
对接运维能力(可选) 服务包扩展目录 如何配置监控 对接配置日志 对接实例升级能力 父主题: 服务接入
v3的验证模式的能力。基于OpenAPI v3能力,可用于自动生成用于创建实例的表单。 控件类型 表单控件 表单控件配置组合示例 父主题: 服务接入
on集群服务版本文件,可多个。 └─ xxx_crd.yaml #【必选】CustomResourceDefinition自定义资源定义文件,可多个。 更多介绍参见官网Operator Framework。 接入规范说明 父主题: 开源服务包规范
实现Operator 定义API 实现Controller 生成代码和资源描述文件 父主题: 开发Operator
控件类型 表单控件类型 1. 使用默认crd.yaml文件自动生成表单 由CRD中定义的openAPIV3Schema字段规定CR中可配置的参数以及这些参数的类型、范围,应用在创建CR的时候通过YAML文件指定这些参数。 2. 使用自定义csd.yaml文件生成表单 自动生成的创
挂载存储 在Kubernetes中,通过PersistentVolume(PV)方式挂载存储,典型的步骤如下: 创建PV,为集群提供存储服务。 apiVersion: v1 kind: PersistentVolume metadata: name: mypv1 annotations: