在CCE控制台上,您可以上传Helm模板包,然后在控制台安装部署,并对部署的实例进行管理。
注意云容器引擎各region将逐步切换至Helm v3。模板管理未来将不再支持Helm v2版本的模板,若您在短期内不能切换至Helm v3,可通过Helm v2 客户端在后台管理v2版本的模板。
约束与限制
- 单个用户可以上传模板的个数有限制,请以各个Region控制台界面中提示的实际值为准。
- CCE使用的Helm版本为v3.8.2,支持上传Helm v3版本语法的模板包。
- 模板若存在多个版本,则消耗对应数量的模板配额。
- 由于模板的操作权限同时具有较高的集群操作权限,因此租户应当谨慎授予用户对于模板生命周期管理的权限,包括上传模板的权限,以及创建、删除和更新模板实例的权限。
模板包规范
以下以redis为例,在准备redis模板包时根据模板包规范制作模板包。
- 命名要求
模板包命名格式为: {name}-{version} .tgz,其中 {version} 为版本号,格式为“主版本号.次版本号.修订号”,如redis-0.4.2.tgz。
说明模板名称{name}的长度不能超过64个字符。
版本号需遵循语义化版本规则。
- 主版本号、次版本号为必选,修订号为可选。
- 主版本号、次版本号、修订号的数值为整数,均需要≥0,且≤99。
- 目录结构
模板包的目录结构如下所示:
redis/
templates/
values.yaml
README.md
Chart.yaml
.helmignore
目录说明如下表所示,带*的为必选项:
表 模板包目录说明
参数 | 参数说明 |
---|---|
* templates | 用于存放所有的template(模板)文件。 |
* values.yaml | 用于描述template文件所需的配置参数。 须知 定义template文件配置参数时,请注意此处定义的“镜像地址”务必和容器镜像仓库中对应的镜像地址保持一致。否则创建工作负载会异常,提示镜像拉取失败。 镜像地址获取方法如下:在CCE控制台,单击左侧导航栏的“镜像仓库”,进入容器镜像服务控制台。在“我的镜像 > 自有镜像”中,单击已上传镜像的名称,在“镜像版本 ”页签的“下载指令”栏中即可获取镜像地址,单击 |
按钮即可复制该指令。 | |
README.md | 一个markdown文件,包括: 描述Chart提供的工作负载或服务。 运行Chart的前提。 解释values.yaml文件中的配置 安装和配置Chart的相关信息。 |
* Chart.yaml | 模板的基本信息说明。注:Helm v3版本apiVersion从v1切换到了v2。 |
.helmignore | 设定在工作负载安装时不需要读取templates的某些文件或数据。 |
上传模板
步骤 1 登录CCE控制台,单击集群名称进入集群,在左侧导航栏中选择“模板管理”,在右上角单击“上传模板”。
步骤 2 单击“添加文件”,选中待上传的工作负载包后,单击“上传”。
图 上传模板包
说明由于上传模板时创建OBS桶的命名规则由cce-charts-{region}- **{domain_name}** 变为cce-charts-{region}- **{domain_id}** ,其中旧命名规则中的domain_name系统会做base64转化并取前63位,如果您在现有命名规则的OBS桶中找不到模板,请在旧命名规则的桶中进行查找。
创建模板实例
步骤 1 登录CCE控制台,单击集群名称进入集群,在左侧导航栏中选择“模板管理”。
步骤 2 在已上传的模板中,单击“安装”。
步骤 3 参照下表设置安装工作负载参数。
表 安装工作负载参数说明
参数 | 参数说明 |
---|---|
实例名称 | 新建模板实例名称,命名必须唯一。 |
命名空间 | 指定部署的命名空间。 |
选择版本 | 选择模板的版本。 |
配置文件 | 用户可以导入values.yaml文件,导入后可替换模板包中的values.yaml文件;也可直接在配置框中在线编辑模板参数。 说明 此处导入的values.yam 文件需符合yaml规范,即KEY:VALUE格式。对于文件中的字段不做任何限制。 导入的value.yaml的key值必须与所选的模板包的values.yaml保持一致,否则不会生效。 即key不能修改。单击“添加文件”。选择对应的values.yaml文件,单击“打开”。 |
步骤 4 配置完成后,单击“安装”。
在“模板实例”页签下可以查看模板实例的安装情况。
升级模板工作负载
步骤 1 登录CCE控制台,单击集群名称进入集群,在左侧导航栏中选择“模板管理”,在右侧选择“模板实例”页签。
步骤 2 单击待升级工作负载后的“升级”,设置升级模板工作负载的参数。
步骤 3 选择对应的模板版本。
步骤 4 参照界面提示修改模板参数。单击“升级”,再单击“提交”。
步骤 5 单击“返回模板实例列表”,模板状态为“升级成功”时,表明工作负载升级成功。
回退模板工作负载
步骤 1 登录CCE控制台,单击集群名称进入集群,在左侧导航栏中选择“模板管理”,在右侧选择“模板实例”页签。
步骤 2 单击待回退工作负载后的“回退”,选择要回退的工作负载版本,单击“回退”。
模板工作负载列表中,状态为“回退成功”时,表明工作负载回退成功。
卸载模板工作负载
步骤 1 登录CCE控制台,单击集群名称进入集群,在左侧导航栏中选择“模板管理”,在右侧选择“模板实例”页签。
步骤 2 单击待卸载模板实例后的“更多 > 卸载”,确认待卸载模板实例后,单击“是”。模板实例卸载后不能恢复,请谨慎操作。