云原生应用开发平台 CAP通过变量管理,提供了跨服务管理配置和敏感字段托管的能力,支持定义项目级别的共享变量和服务级别的服务变量,并提供引用功能。每个服务部署完毕后,后台会生成结果变量,可以在其他服务的配置中引用结果变量,从而建立服务间的依赖关系。
变量类型
变量分为共享变量、服务变量和结果变量三种类型,其作用域和支持的数据类型如下所示:
变量类型 | 共享变量 | 服务变量 | 结果变量 |
作用域 | 本项目下的所有服务配置内 | 本服务配置内 | 本项目下其他服务配置内 |
数据类型 | String类型 | String类型 | String类型 |
引用方式 |
|
|
|
函数服务配置中的环境变量与以上三种变量类型不同,详情请参考函数计算配置环境变量。函数服务中环境变量的值可以引用共享变量、服务变量和结果变量中的值。推荐您在函数服务配置中的环境变量中引用上述的三种变量,在函数代码中通过在代码中使用环境变量的方式,获取相应的信息。
您定义共享变量后,可以在相关配置中以${shared.变量名}
形式引用变量;定义服务变量后,可以仅可在本服务中以${self.变量名}
形式引用变量。添加、更新或删除变量会导致项目的一系列变更,点击全量部署后,变量的变更方可生效。在服务部署完毕后,结果变量在后台生成并保存,您可以在其他服务的配置中通过${output.<service_name>.变量名}
引用结果变量。
各服务结果变量一览
以下枚举各服务类型的结果变量,暂不支持自定义结果变量:
服务类型 | 结果变量含义 | 引用方式 |
Web服务 | 函数名 |
|
函数资源描述符 |
| |
函数HTTP触发器内网访问地址 |
| |
函数HTTP触发器公网访问地址 |
| |
函数自定义域名 |
| |
异步任务服务 | 函数名 |
|
函数资源描述符 |
| |
函数服务 | 函数名 |
|
函数资源描述符 |
| |
数据库服务 | 数据库实例ID |
|
数据库实例访问地址 |
| |
模型服务 | 模型服务名 |
|
公网调用地址 |
| |
私网调用地址 |
| |
流程服务 | 流程服务名 |
|
例如:您可以在Web服务配置的环境变量中,引用数据库服务的数据库实例访问地址${output.<service_name>.host}
。这样在该Web服务的代码中,可以通过在代码中使用环境变量的方式,获取数据库实例的访问地址,从而在Web服务中连接该数据库实例。
加密变量
共享变量和服务变量均提供了加密功能,用于托管项目或服务的敏感信息字段(例如数据库账密、访问令牌等)。进入项目详情页,点击项目配置,可以查看该项目下的共享变量名和对应的值,以及该变量被哪些服务所引用。点击编辑链接,可以添加、删除或修改变量。
同样,进入服务详情界面,点击服务变量,可以对该服务的变量进行管理。
若打开加密开关,该变量将被CAP加密托管,点击保存并全量部署后在控制台和部署日志中均以密文的形式透出,不显示明文。
变量选择加密保存后不支持再次查看明文。若需修改,点击编辑,修改原有的值点击保存即可。此外,部署过程中,CAP会在部署链路自动解密,并保护明文不在日志或控制台中透出,用户不需要在控制台对加密变量进行额外的解密操作。
引用变量
项目中的共享变量,可以在该项目下的任何服务配置内以${shared.变量名}
的方式引用此共享变量的值。服务变量,可以在该服务的配置内以${self.变量名}
形式引用此服务变量的值。例如,可以在如下函数服务的环境变量中,引用此项目的共享变量,此服务的服务变量和其他服务的结果变量。
高级引用方式
拼接引用
变量管理支持多个变量或变量+字符串的拼接引用,即某一变量的值可以是多个变量引用的拼接,CAP支持对这样的拼接引用进行解析,具体如下图所示:
嵌套引用
变量管理支持字符串的嵌套引用。例如下图中url变量可以对domainName变量做引用,CAP支持对这样的嵌套引用进行解析。
查看真实值
配置变量,点击保存,并在上方点击全量部署按钮,变量的修改方可生效。在共享变量页面或服务变量页面,点击可以查看变量引用解析后的真实值。