更新时间:2024-12-16 GMT+08:00

管理配置项

配置项(ConfigMap)是一种用于存储应用所需配置信息的资源类型,内容由用户决定。配置项创建完成后,可在应用中作为文件或者环境变量使用。

配置项允许您将配置文件从镜像中解耦,从而增强应用的可移植性。

配置项价值如下:

  • 使用配置项功能可以帮您管理不同环境、不同业务的配置。
  • 方便您部署相同应用的不同环境,配置文件支持多版本,方便您进行更新和回滚应用。
  • 方便您快速将配置以文件的形式导入到应用中。

由于1.11.7-r2及以上版本的CCE集群具备Kubernetes RBAC的授权能力,支持设置命名空间权限。命名空间权限是基于Kubernetes RBAC能力的授权,通过权限设置可以让不同的用户或用户组拥有操作不同Kubernetes资源的权限,详情请参考命名空间权限

如果当前环境下绑定的CCE集群为1.11.7-r2及以上版本且设置了命名空间权限,则您必须拥有集群全部命名空间的管理员权限(cluster-admin)或者待操作的单个命名空间的开发权限(admin),才能管理命名空间。

本章节指导您为Kubernetes类型环境绑定的CCE集群创建配置项查看、更新和删除配置项

前提条件

创建配置项

  1. 登录ServiceStage控制台。
  2. 选择“环境管理”,进入“环境管理”页面。
  3. 单击待操作环境名称,进入环境“概览”页面。
  4. 选择“计算”资源类型下的资源名称“云容器引擎 CCE”
  5. 进入“配置项”列表页面。

    • 非高可用环境:选择“配置项”页签。
    • 高可用环境:单击已绑定CCE集群名称,选择“配置项”页签。

  6. 单击“创建配置项”

    ServiceStage支持“可视化”和“YAML”两种创建方式来创建配置项。
    • 方式一:可视化。
      参照表1设置配置项参数,其中带“*”标志的参数为必填参数。
      表1 可视化方式创建配置项参数设置说明

      参数

      说明

      *配置名称

      新建的配置项名称,同一个命名空间里必须唯一。

      长度为4到24个字符,可以包含英文小写字母、数字或中划线(-),以英文小写字母开头、英文小写字母或者数字结尾。

      *所属集群

      使用新建配置项的集群。

      *命名空间

      新建配置项所在的命名空间。

      描述

      配置项的描述信息,长度范围为0到255个字符。

      配置数据

      应用配置的数据可以在应用中使用,或被用来存储配置数据。其中,“键”代表文件名;“值”代表文件中的内容。

      1. 单击“添加更多配置数据”。
      2. 输入键、值。
        • 配置数据的键必须由数字、字母、点号(.)、中划线(-)或下划线(_)组成,长度为1到63个字符。
        • 配置数据的值长度为0到1,048,576个字符。

      配置标签

      标签以键值对的形式附加到各种对象上(如应用、节点、服务等)。标签定义了这些对象的可识别属性,用来对它们进行管理和选择。

      1. 单击“添加标签” 。
      2. 输入键、值。
        • 标签的键由数字、字母、点号(.)、中划线(-)、下划线(_)或斜杠(/)组成,必须以字母或者数字开头和结尾,长度为1到63个字符。
        • 标签的值由数字、字母、点号(.)、中划线(-)或下划线(_)组成,必须以字母或者数字开头和结尾,长度为1到63个字符。
      图1 可视化方式设置配置项参数
    • 方式二:YAML。

      若需要通过上传文件的方式创建配置项,请确保已创建格式为YAML的ConfigMap资源文件,且文件小于1MB。详情请参考ConfigMap资源文件要求

      1. 在“所属集群”下拉框中,选择相应的集群。
      2. 选择以下任一方式设置ConfigMap资源文件。
        • 单击“上传文件”,选择本地已创建的ConfigMap资源文件后,单击“打开”,等待文件上传成功。
        • 在“编排内容”中写作或者修改ConfigMap资源文件。
      图2 YAML方式设置配置项参数

  7. 单击“创建配置项”。

    配置项创建完成后,应用配置列表中会出现新创建的应用配置。

后续操作

配置项创建完成后,您可参考表2查找、查看、更新和删除配置项。

  • 配置项删除后可能会导致挂载此配置项或在环境变量中引用此配置项的组件升级后无法正常启动。
  • 系统配置项资源不可更新,也不能删除,只能查看。
表2 配置项管理操作说明

操作项

操作说明

查找配置项

  1. 在命名空间下拉列表选择配置项所在命名空间。
  2. 在搜索框输入配置项名称。

查看配置项

单击目标配置项“操作”列的“查看YAML”,查看配置项YAML格式文件内容。

编辑配置项

如果需要使用YAML方式更新配置项中的“data”(配置数据)、“labels”(配置标签)、“description”(描述)参数,请执行以下操作:

  1. 单击目标配置项“操作”列的“编辑YAML”。
    配置项YAML格式文件内容详情,请参考ConfigMap资源文件要求。您可以使用以下任意一种方式编辑配置项YAML格式文件内容:
    • 直接在编辑栏编辑待操作配置项的YAML格式文件内容。
    • 单击“导入YAML文件”,导入已经编辑好的待操作配置项的YAML配置文件。
  2. 单击“保存”

更新配置项

  1. 选择目标配置项“操作”列的“更多 > 更新”。
  2. 根据表1更改配置项的“描述”“配置数据”“配置标签”信息。
  3. 单击“更新配置项”。

删除配置项

  • 删除单个配置项
    1. 选择目标配置项“操作”列的“更多 > 删除”。
    2. 在弹出的对话框,单击“确定”
  • 删除多个配置项
    1. 勾选需要删除的配置项。
    2. 单击“删除配置项”。
    3. 在弹出的对话框,单击“确定”

ConfigMap资源文件要求

ConfigMap资源文件支持YAML文件格式,且文件大小不得超过1MB。

文件配置示例如下:

apiVersion: v1
data: {}
kind: ConfigMap
metadata:
  annotations:
    description: ''
  labels: {}
  name: configmap-ww8qkl
  namespace: cse

配置项关键参数说明请参考表3

表3 配置项关键参数说明

参数名称

参数说明

apiVersion

固定值:v1。

kind

固定值:ConfigMap。

metadata.name

配置项名称,可自定义。

data

键值对形式配置项数据。