自定义扩展服务

应用场景

  • 非平台部署的中间件服务(例如单独购置机器部署的 MySQL 等)
  • 公用的三方服务(例如短信渠道配置等)

设置入口

进入 DevOps 平台 > 项目 > 应用中心 > 环境部署 > Addons,点击右上角 添加服务,其中 三方服务 需选择 Custom

自定义扩展服务 - 图1

填写业务配置。

自定义扩展服务 - 图2

tip 提示

修改服务参数后需重启所有关联应用。此操作可能影响所有关联应用,请谨慎操作。

使用入口

进入 我的应用 > 代码,打开 dice.yml,进入编辑模式,选择此前创建的 Addon。

自定义扩展服务 - 图3

完成编辑后,重新构建和部署流水线,使配置生效。

使用方式

业务程序可通过系统环境变量的方式获取配置。以 Spring Boot 程序为例,可通过 application.yml 中 ${MYSQL_HOST} 的方式获取配置。

  1. server:
  2. port: 8080
  3. spring:
  4. datasource:
  5. driver-class-name: com.mysql.jdbc.Driver
  6. url: jdbc:mysql://${MYSQL_HOST:127.0.0.1}:${MYSQL_PORT:3306}/${MYSQL_DATABASE}?useUnicode=true&characterEncoding=UTF-8
  7. username: ${MYSQL_USERNAME:root}
  8. password: ${MYSQL_PASSWORD:}

导入导出

导出

进入 DevOps 平台 > 我的项目 > 选择项目 > 扩展服务,在 自定义 中点击 查看配置,可查看当前项目下所有自定义 Addon 的 JSON 形式配置。

导入

进入 DevOps 平台 > 我的项目 > 选择项目 > 扩展服务 > 添加服务,选择 Custom 类型服务,创建方式选择 配置导入,粘贴上文导出的 JSON(如有需要,可根据实际情况修改配置参数),即可将自定义 Addon 从其他项目导入至当前项目。

部署时平滑切换类似中间件

在开发阶段,开发者多使用便捷且低成本的 Erda 开箱即用中间件,在交付阶段则希望在不修改制品的情况下平滑切换至更稳定的第三方类似中间件,此时即可使用“部署时平滑切换类似中间件”的功能。

类似中间件是对同一功能中间件的不同实现。若您需使用 MySQL,可选择第三方 Addon Alicloud-RDS,也可选择 Erda 开箱即用的 erda mysql。此处的 Alicloud-RDS 和 erda mysql 均是对 MySQL 的实现,两者的关系即类似中间件。

在使用定义了 Erda 开箱即用的 Addon 部署制品时,若项目下存在同名的第三方实现的类似中间件,则被部署的服务将优先引用该类似中间件。

Erda 支持以下类似中间件:

中间件类型 第三方实现 Erda 实现
MySQL alicloud-rds erda mysql
Elasticsearch alicloud-es terminus-elasticsearch
RocketMQ alicloud-ons erda rocketmq
Redis alicloud-redis erda redis

示例

您可在 dice.yml 或制品中定义 Addon。dice.yml 的示例如下:

  1. addons:
  2. demo-mysql:
  3. plan: "mysql:basic"
  4. demo-es:
  5. plan: "terminus-elasticsearch:basic"
  6. demo-mq:
  7. plan: "rocketmq:basic"
  8. demo-redis:
  9. plan: "redis:basic"

在 Addons 页面则添加了同名的第三方实现的类似中间件。

**同名的**第三方实现的类似中间件

服务部署时将优先引用此类同名的类似中间件。

tip 提示 服务的 Runtime 已存在的情况下,如需从 Erda 中间件切换至第三方类似中间件(或从第三方类似中间件切换至 Erda 中间件),应先删除 Runtime,添加(或删除)同名的第三方类似中间件,再重新部署。