tsuru/eviaas

eviaas

镜像概述和主要用途

eviaas是一个为tsuru平台设计的服务，用于环境变量注入。它允许通过在应用绑定后注入预定义的环境变量，轻松将外部服务暴露给tsuru应用，帮助遵循十二因素方法论中关于配置管理的原则，避免在应用中硬编码配置信息。

核心功能和特性

• 环境变量注入：绑定服务实例到应用后，自动注入预定义的环境变量
• 外部服务暴露：无需修改应用代码，即可将外部服务（如日志、数据库等）的配置通过环境变量提供给应用
• 简单集成：与tsuru平台无缝集成，通过标准tsuru服务命令进行管理
• 灵活配置：支持通过环境变量定义需要注入的键值对，适应不同外部服务的配置需求

使用场景和适用范围

适用于需要将外部服务配置（如日志服务地址、数据库连接信息、API密钥等）提供给tsuru应用，但希望避免在应用代码或配置文件中硬编码这些信息的场景。尤其适合遵循十二因素方法论的应用开发，确保配置与代码分离，提高应用的可移植性和安全性。

使用方法和配置说明

前提条件

• 已安装并配置tsuru客户端
• 具备tsuru平台的应用创建和服务管理权限

部署步骤

1. 克隆eviaas仓库并进入目录

bash
$ git clone https://github.com/tsuru/eviaas.git
$ cd eviaas

2. 创建tsuru服务应用

bash
$ tsuru app-create my-log-service-api python

3. 设置环境变量定义需要注入的配置

通过EVI_ENVIRONS环境变量（JSON格式）定义需要注入到应用的环境变量键值对：

bash
$ tsuru env-set -a my-log-service-api EVI_ENVIRONS='{"MYLOG_PROTOCOL": "udp", "MYLOG_ADDRESS": "my.log.service:9976"}'

4. 推送应用代码到tsuru

bash
$ git push git@192.168.50.4:my-log-service-api.git master

5. 创建服务描述符文件

创建service_descriptor.yaml文件，定义服务元信息：

yaml
id: my-log-service
password: 1234
team: my_team
endpoint:
  production: http://my-log-service-api.192.168.50.4.nip.io

6. 将服务添加到tsuru

bash
$ tsuru service-create service_descriptor.yaml

服务实例管理

创建服务实例

bash
$ tsuru service-instance-add my-log-service my-log-instance

查看服务和实例

bash
$ tsuru service-list
+----------------+-----------------+
| Services       | Instances       |
+----------------+-----------------+
| my-log-service | my-log-instance |
+----------------+-----------------+

应用绑定

将服务实例绑定到目标应用，使环境变量注入生效：

bash
$ tsuru service-instance-bind my-log-service my-log-instance -a my-app
Instance "my-log-instance" is now bound to the app "my-app".

The following environment variables are now available for use in your app:

- MYLOG_PROTOCOL
- MYLOG_ADDRESS

配置说明

• EVI_ENVIRONS：必需，JSON格式的环境变量键值对，定义需要注入到应用的配置。例如'{"KEY1": "value1", "KEY2": "value2"}'
• service_descriptor.yaml：服务描述符文件，包含服务ID、密码、团队和访问端点等信息，用于tsuru识别和管理服务

绑定原理

当服务实例绑定到应用时，eviaas服务会通过tsuru服务API将EVI_ENVIRONS中定义的环境变量注入到目标应用中。应用可以直接通过环境变量访问这些配置，无需额外代码修改。更多细节可参考tsuru服务绑定文档。