高级环境变量配置

Rainbond平台启动组件时默认注入以下环境变量信息以供应用使用:

变量名 变量值 说明
PORT 应用设置的第一个端口号 应用建立端口监听时尽量获取 PORT 环境变量值进行监听
PROTOCOL http\tcp\mysql 等 对应上诉端口的协议类型
TENANT_ID 租户 ID 租户 ID
SERVICE_ID 应用 ID 应用 ID
MEMORY_SIZE micro, small, medium, large, 2xlarge 等 表示当前应用实例的内存大小设置,一般用于应用内存相关设置的初始化,例如 JAVA_OPTS
SERVICE_POD_NUM 应用实例数量 应用实例的数量
DEPEND_SERVICE serviceAlias:serviceID, 依赖的应用
HOST_IP ip地址 组件运行时所在宿主机IP地址
POD_IP ip地址 组件运行时的IP地址
DISCOVER_URL http://xxxxxxx/v1/resources/xxx 配置发现接口地址,插件运行环境有效
DISCOVER_URL_NOHOST /v1/resources/xxx 不带IP地址的配置发现URL, 地址使用HOST_IP:6100

域名自动注入的环境变量说明:

应用默认注入当前组件的访问域名环境变量信息:DOMIAN和DOMAIN_PROTOCOL,如果组件具有多个端口,注入策略如下

  • 如果有多个端口, 则会在环境变量名后面加上_端口号, 即DOMAIN_端口号. 比如: DOMAIN_80, DOMAIN_8080

对应的域名协议则为 DOMAIN_PROTOCOL_80

  • DOMIAN变量的值为组件端口号从小到大,自定义域名优先的值。比如有端口80,8080,如果8080绑定了自定义域名,则DOMIAN的值为8080端口的自定义域名。如果都没有绑定自定义域名,则为80端口的默认域名。

使用以下高级环境变量可以解锁更多高级功能:

部署(构建)应用时使用的变量

变量名以BUILD_开头的环境变量在源码构建类应用构建阶段生效,比如下述变量:

变量名 变量值 说明
BUILD_REPARSE true 构建时重新识别代码语言类型
NO_CACHE true 构建时不使用缓存包
BUILD_MAVEN_CUSTOM_OPTS -DskipTests=true -Dmaven.wagon.http.ssl.insecure=true -Dmaven.wagon.http.ssl.allowall=true 用于 maven 构建,默认值如前
BUILD_MAVEN_CUSTOM_GOALS clean install 用于 maven 构建,默认值如前

更多组件构建环境设置,请参考 组件构建源配置

应用运行高级变量

ES_开头的环境变量将作为扩展功能变量,例如下面用例:

变量名 变量值 说明
ES_SELECTNODE 选择宿主机的ID 用于定点调度,指定调度到某台宿主机上,节点的ID通过grctl node list 可得
ES_HOSTNETWORK true 是否使用主机端口映射
ES_HOSTNAME 主机名 设置实例的主机名,适用于单实例组件
ES_CPULIMIT 1核=1000 自定义组件的CPU限制值 5.0.3及以后版本支持
ES_CPUREQUEST 1核=1000 自定义组件的CPU请求值 5.0.3及以后版本支持
ES_TCPUDP_MESH_MEMORY MB 自定义默认的MESH容器内存限制量,默认为128MB
ES_TCPUDP_MESH_CPU 1核=1000 自定义默认的MESH容器CPU限制量,默认为120, 最小为120

自定义环境变量

当你通过组件【设置】中的自定义环境变量,添加变量后组件更新或重启后生效。

通常情况下,我们将配置信息写到配置文件中供程序读取使用,在Rainbond平台中,我们极力推荐使用环境变量的方式来代替传统的配置文件的方式。

这样做的好处如下:

  • 将配置信息与组件绑定,与代码解耦,摆脱不同环境下切换配置文件的麻烦
  • 敏感信息与代码分离,避免程序漏洞造成数据丢失
  • 省去配置管理的工作

下面是一个生产环境的组件使用环境变量进行配置的截图:

高级环境变量配置 - 图1

以Python为例介绍在配置读取环境变量的方法:

  1. # -*- coding: utf8 -*-
  2. import os
  3. DEBUG = os.environ.get('DEBUG') or False
  4. TEMPLATE_DEBUG = os.environ.get('TEMPLATE_DEBUG') or False
  5. DEFAULT_HANDLERS = [os.environ.get('DEFAULT_HANDLERS') or 'zmq_handler']
  6. DATABASES = {
  7. 'default': {
  8. 'ENGINE': 'django.db.backends.mysql',
  9. 'NAME': 'goodrain',
  10. 'USER': os.environ.get('MYSQL_USER'),
  11. 'PASSWORD': os.environ.get('MYSQL_PASSWORD'),
  12. 'HOST': os.environ.get('MYSQL_HOST'),
  13. 'PORT': os.environ.get('MYSQL_PORT'),
  14. }
  15. }
  16. ...

基于环境变量除了可以定义上诉所述的用于应用运行的变量以外,还能作为组件编译、组件调度运行的参数指定方式,更多请查看 环境变量的高级用法

关于动态值环境变量:

环境变量的值可以基于已存在环境变量的值解析,如果环境变量的值中出现 ${XXX},平台将尝试查找XXX环境变量的值来替换此字符串,若无法找到具有值的XXX变量,将不做更改。

为防止出现无法被解析的情况,可以定义为${XXX:yy}的形式,:以后的将作为未成功解析的默认值。

例如有已存在环境变量 A=1,环境变量B需要使用A的值,直接定义B=${A}。