管理环境级环境变量
环境级环境变量是描述环境相关信息和环境资源信息的环境级别的环境变量,例如中间件凭证、连接信息、环境作用等。通过环境变量可以屏蔽环境或资源的差异,组件可以无需修改即可切换到不同的环境或者使用不同的云服务资源运行。
如果环境中存在如表1所示的资源(DCS、RDS、ServiceComb、Nacos、CSS),ServiceStage会在环境中写入对应资源的内置环境级环境变量和自定义环境级环境变量供使用。
| 资源类型 | 变量名称 | 变量描述 | 变量来源 | 变量/变量引用取值示例 |
|---|---|---|---|---|
| DCS | DISTRIBUTED_CACHE_TYPE | 分布式缓存类型 | 内置 | Redis |
| DISTRIBUTED_CACHE_NAME | 分布式缓存实例名称 | 内置 | dcs-test | |
| DISTRIBUTED_CACHE_VERSION | 分布式缓存版本 | 内置 | 5.0 | |
| DISTRIBUTED_CACHE_CLUSTER | 分布式缓存集群类型 | 内置 | false | |
| DISTRIBUTED_CACHE_HOST | 分布式缓存地址 | 内置 | 192.168.0.136 | |
| DISTRIBUTED_CACHE_PORT | 分布式缓存端口 | 内置 | 6379 | |
| DISTRIBUTED_SESSION_CLUSTER | 分布式会话集群类型 | 内置 | false | |
| DISTRIBUTED_SESSION_HOST | 分布式会话地址 | 内置 | 192.168.0.136 | |
| DISTRIBUTED_SESSION_VERSION | 分布式会话版本 | 内置 | 5.0 | |
| DISTRIBUTED_SESSION_TYPE | 分布式会话类型 | 内置 | Redis | |
| DISTRIBUTED_CACHE_PASSWORD | 分布式缓存密码 | 自定义 | ******** | |
| RDS | RELATIONAL_DATABASE_DB_TYPE | 云数据库类型 | 内置 | MySQL |
| RELATIONAL_DATABASE_HOST | 云数据库地址 | 内置 | 172.16.0.185 | |
| RELATIONAL_DATABASE_CONNECTION_TYPE | 云数据库连接类型 | 内置 | JNDI | |
| RELATIONAL_DATABASE_PORT | 云数据库端口 | 内置 | 3306 | |
| RELATIONAL_DATABASE_NAME | 云数据库名称 | 内置 | rds-pro | |
| RELATIONAL_DATABASE_VERSION | 云数据库版本 | 内置 | 8.0 | |
| RELATIONAL_DATABASE_JNDI_NAME | 云数据库JNDI名称 | 自定义 | jndi-u1 | |
| RELATIONAL_DATABASE_DB_USER | 云数据库账号名称 | 自定义 | rds-u1 | |
| RELATIONAL_DATABASE_PASSWORD | 云数据库密码 | 自定义 | ******** | |
| ServiceComb | PAAS_CSE_CC_ENDPOINT | ServiceComb引擎配置中心地址 | 内置 | https://192.168.0.31:30110,https://192.168.0.36:30110 |
| PAAS_CSE_SC_ENDPOINT | ServiceComb引擎服务注册发现地址 | 内置 | https://192.168.0.31:30100,https://192.168.0.36:30100 | |
| SERVICECOMB_SERVICE_PARAMETERS | ServiceComb引擎服务配置 | 内置 | cas-instance-id:c3bee2c1-5174-4ed4-b4e0-2cfdd5b47357 | |
| PAAS_CSE_ENGINE_MGR_ENDPOINT | ServiceComb引擎管理节点地址 | 内置 | 即ServiceComb的终端节点。 您可以从地区和终端节点处查询。 | |
| SERVICECOMB_SERVICE_PROPS | ServiceComb引擎服务配置 | 内置 | cas-instance-id:c3bee2c1-5174-4ed4-b4e0-2cfdd5b47357 | |
| SERVICECOMB_ENGINE_NAME | ServiceComb引擎名称 | 内置 | cse-izq6rg | |
| SERVICECOMB_INSTANCE_PROPS | ServiceComb引擎实例配置 | 内置 | affinity-tag:base,cas-instance-id:c3bee2c1-5174-4ed4-b4e0-2cfdd5b47357,cas_lane_tag:base | |
| PAAS_CSE_DS_ENDPOINT | ServiceComb引擎仪表盘中心地址 | 内置 | https://192.168.0.31:30109,https://192.168.0.36:30109 | |
| DYNAMIC_CONFIG_DYNAMICCONFIGTYPE | ServiceComb引擎配置中心类型 | 内置 | KIE | |
| DYNAMIC_CONFIG_SERVERADDRESS | ServiceComb引擎配置中心地址 | 内置 | https://192.168.0.31:30110,https://192.168.0.36:30110 | |
| Nacos | REGISTER_SERVICE_REGISTERTYPE | Nacos引擎服务注册发现类型 | 内置 | NACOS |
| REGISTER_SERVICE_ADDRESS | Nacos引擎服务注册发现地址 | 内置 | https://192.168.0.31:30100,https://192.168.0.36:30100 | |
| SPRING_CLOUD_NACOS_CONFIG_SERVERADDR | Nacos引擎服务注册发现地址 | 内置 | https://192.168.0.31:30100,https://192.168.0.36:30100 | |
| SPRING_CLOUD_NACOS_DISCOVERY_SERVERADDR | Nacos引擎服务注册发现地址 | 内置 | https://192.168.0.31:30100,https://192.168.0.36:30100 | |
| EUREKA_CLIENT_SERVICEURL_DEFAULTZONE | Eureka服务器注册地址 | 内置 | https://192.168.1.30:8761/eureka/ | |
| DYNAMIC_CONFIG_DYNAMICCONFIGTYPE | Nacos引擎配置中心类型 | 内置 | NACOS | |
| DYNAMIC_CONFIG_SERVERADDRESS | Nacos引擎配置中心地址 | 内置 | https://192.168.0.31:30100,https://192.168.0.36:30100 | |
| GaussDB | PAAS_GAUSSDB_VERSION | 版本 | 内置 | 8.200.0 |
| PAAS_GAUSSDB_NAME | 名称 | 内置 | gauss-ss | |
| PAAS_GAUSSDB_ADDRESS | 连接地址 | 内置 | 192.168.0.178:8000,192.168.0.47:8000,192.168.0.166:8000 | |
| PAAS_GAUSSDB_DB_NAME | 数据库名 | 自定义 | cas | |
| PAAS_GAUSSDB_DB_USER | 用户名 | 自定义 | root | |
| PAAS_GAUSSDB_PASSWORD | 密码 | 自定义 | ****** | |
| RocketMQ | DISTRIBUTED_MESSAGE_ROCKETMQ_VERSION | 版本 | 内置 | 5.x |
| DISTRIBUTED_MESSAGE_ROCKETMQ_NAME | 名称 | 内置 | rocketmq-ss | |
| DISTRIBUTED_MESSAGE_ROCKETMQ_ADDRESS | 连接地址 | 内置 | 192.168.0.84:9093,192.168.0.212:9093,192.168.0.174:9093 | |
| DISTRIBUTED_MESSAGE_ROCKETMQ_USER | 用户名 | 自定义 | root | |
| DISTRIBUTED_MESSAGE_ROCKETMQ_PASSWORD | 密码 | 自定义 | ****** | |
| CSS | PAAS_ELASTIC_SEARCH_VERSION | 版本 | 内置 | 7.10.2 |
| PAAS_ELASTIC_SEARCH_NAME | 名称 | 内置 | css_es | |
| PAAS_ELASTIC_SEARCH_ADDRESS | 连接地址 | 内置 | 21.108.0.218:9200,21.108.0.88:9200,21.108.0.231:9200 | |
| PAAS_ELASTIC_SEARCH_HTTPS_ENABLE | 是否启用HTTPS | 内置 | true | |
| PAAS_ELASTIC_SEARCH_USER | 用户名 | 自定义 | admin | |
| PAAS_ELASTIC_SEARCH_PASSWORD | 密码 | 自定义 | ****** |
您也可以根据实际业务需要新增、编辑和删除自定义环境级环境变量。
应用级环境变量、组件级环境变量和环境级环境变量相比,环境级环境变量的优先级小于应用级环境变量,应用级环境变量的优先级小于组件级环境变量。
新增环境级环境变量
- 登录ServiceStage控制台。
- 选择“环境管理”,进入“环境管理”页面。
- 单击待操作的环境名称,进入“概览”页面。
- 选择,参考下表设置变量参数。 请您在配置环境变量时慎用敏感信息或者加密敏感信息,以免造成信息泄露。
参数名称
参数说明
变量名称
环境变量的名称。
长度1到64个字符,可以包含英文字母、数字、下划线(_)、中划线(-)或点(.),以英文字母、下划线(_)或中划线(-)开头。
变量/变量引用
变量名称对应的值。
- 单击新增环境变量“操作”列的“确定”。
新增环境变量的“变量类型”为“自定义变量”,“关联对象”为当前环境。环境级别的环境变量发生变化后,您可以:
- 通过使用单批发布方式升级组件版本配置使变化后的环境级环境变量对部署在该环境下的指定的单个组件生效。
- 通过批量升级组件版本配置使变化后的环境级环境变量对部署在该环境下的指定的多个或者全部组件生效。
编辑环境级环境变量
- 登录ServiceStage控制台。
- 选择“环境管理”,进入“环境管理”页面。
- 单击待操作的环境名称,进入“概览”页面。
- 单击“环境变量”。
- 单击待编辑的自定义环境变量“操作”列的“编辑”,参考下表设置变量参数。 请您在配置环境变量时慎用敏感信息或者加密敏感信息,以免造成信息泄露。
参数名称
参数说明
变量名称
环境变量的名称。
长度1到64个字符,可以包含英文字母、数字、下划线(_)、中划线(-)或点(.),以英文字母、下划线(_)或中划线(-)开头。
变量/变量引用
变量名称对应的值。
- 单击该环境变量“操作”列的“确定”。
环境级别的环境变量发生变化后,您可以:
- 通过使用单批发布方式升级组件版本配置使变化后的环境级环境变量对部署在该环境下的指定的单个组件生效。
- 通过批量升级组件版本配置使变化后的环境级环境变量对部署在该环境下的指定的多个或者全部组件生效。
删除环境级环境变量
- 登录ServiceStage控制台。
- 选择“环境管理”。
- 单击待操作的环境名称,进入“概览”页面。
- 单击“环境变量”,删除自定义环境变量。
- 删除单个环境级环境变量:单击待删除自定义环境变量“操作”列的“删除”。
- 批量删除环境级环境变量:勾选待删除的自定义变量,单击“批量删除”。
- 单击“确定”。
请根据您的实际业务需要删除环境变量,防止由于环境变量缺失导致升级单个组件版本配置、批量升级组件版本配置时组件启动失败。
环境级别的环境变量发生变化后,您可以:
- 通过使用单批发布方式升级组件版本配置使变化后的环境级环境变量对部署在该环境下的指定的单个组件生效。
- 通过批量升级组件版本配置使变化后的环境级环境变量对部署在该环境下的指定的多个或者全部组件生效。