应用管理

应用设置

成员管理

请进入 DevOps 平台 > 项目 > 应用 > 应用设置 > 通用设置 > 应用成员 操作。

应用管理 - 图1

应用角色分为:

  • 应用所有者
  • 应用主管
  • 开发工程师
  • 测试工程师
  • 运维
  • 访客

您可进入 DevOps 平台 > 项目 > 应用 > 应用设置 > 通用设置 > 应用成员 > 应用成员管理 > 角色权限说明 查看应用角色及对应权限。

通知管理

:::tip 提示 通知对象使用通知组管理,需要先建立通知组才能关联到通知。 :::

进入 DevOps 平台 > 我的项目 > 应用列表 > 应用设置 > 通知管理 操作。

应用管理 - 图2

应用下通知组与项目下类似, 通知的触发时机与应用相关,目前已经支持的事件有:

  • 代码推送
  • 流水线开始运行
  • 流水线运行成功
  • 流水线运行失败
  • 创建合并请求
  • 合并请求-创建
  • 合并请求-合并
  • 合并请求-关闭
  • 合并请求-评论

进入 DevOps 平台 > 项目 > 应用 > 应用设置 > 通知组

应用管理 - 图3

可以通过不同的通知成员类型选择对应配置,在关联通知时会根据成员类型列出合适的通知渠道,如图所示:

应用管理 - 图4

域名管理

企业下域名资源查看

请进入 多云管理平台 > 资源管理 > 域名管理 查看。

基于微服务网关实现域名路由(推荐)

通过 erda.yml 为服务指定 endpoints 即可实现微服务网关功能,将一个域名的不同路径转发给相同项目和环境下的不同服务。

具体示例如下:

  1. version: 2.0
  2. services:
  3. user-center:
  4. ports:
  5. - port: 8080
  6. endpoints:
  7. # 可以写成 .* 后缀,会根据集群泛域名自动补全
  8. - domain: hello.*
  9. path: /api/user
  10. backend_path: /api
  11. policies:
  12. # 允许跨域访问
  13. cors:
  14. allow_origins: any
  15. # 限制访问 QPS 为100
  16. rate_limit:
  17. qps: 100
  18. # 可以写完整域名
  19. - domain: uc.app.terminus.io
  20. # 如果后端路径一致,可以省略 backendPath
  21. path: /
  22. acl-center:
  23. ports:
  24. - port: 8080
  25. endpoints:
  26. - domain: hello.*
  27. path: /api/acl
  28. backend_path: /api

endpoints 由以下属性组成:

  • domain(必填):

    域名,可填写完整域名,也可仅填写最后一级域名(平台会基于集群泛域名自动补全)。

  • path(选填):

    域名路径,域名下基于 URL 前缀匹配到当前路径的请求都将转发给该服务,未填写时默认为 /。URL 前缀会根据路径长度匹配,路径精确度越高,则优先级越高。

  • backend_path(选填):

    转发给服务的路径,可理解为将 path 部分匹配到的 URL 路径抹除后,剩余部分拼接在 backend_path 上转发给服务,未填写时默认和 path 一致。

  • policies(选填):

    当前支持跨域策略和限流策略。

    • 跨域策略:关于跨域相关信息,请参见 跨域资源共享

      以允许跨域应答头 Access-Control-Allow-Origin 为例,allow_origins 配置的值将作为这个应答头的值。当值为 any 时,则直接获取请求头的 Orgin 字段作为值。

      Access-Control-Allow-MethodsAccess-Control-Allow-Headers 等同理。

      1. policies:
      2. cors:
      3. # 必填字段,当为 any 时,允许 origin 是任何域名进行跨域访问
      4. allow_origins: any
      5. # 非必填,默认是 any,允许 http method 是任何类型
      6. allow_methods: any
      7. # 非必填,默认是 any,允许 http header 是任何字段
      8. allow_headers: any
      9. # 非必填,默认是 true,允许 cookie 字段跨域传输
      10. allow_credentials: true
      11. # 非必填,默认是 86400,跨域预检请求一次成功后的有效时间
      12. max_age: 86400
    • 限流降级策略:若填写 deny_status302,此时 deny_content 可作为 HTTP 地址提供跳转,还可将该地址配置为一个降级接口(例如 CDN 页面),用于透出当前服务过载的信息。

      1. policies:
      2. rate_limit:
      3. # 必填字段,每秒最大请求速率
      4. qps: 100
      5. # 非必填字段,最大延后处理时间,默认是 500 毫秒,超过速率时不会立即拒绝,进行去峰填谷处理
      6. max_delay: 500
      7. # 非必填字段,默认是 429,延后处理后仍然超过速率,会进行拒绝,返回对应的状态码
      8. deny_status: 429
      9. # 非必填字段,默认是 server is busy,拒绝时返回的应答
      10. deny_content: "server is busy"

给单个服务绑定域名

确保服务通过对指定端口设定了 expose,开启了端口暴露,只有开启了端口暴露的服务,才能够配置域名,进而对外提供服务(用户通过公网访问域名)。

:::tip 提示 需要注意的是,这种模式下域名完全绑定在单个服务上,无法再将不同的路径转发给不同服务。

这种模式的好处是,端口协议除了 HTTP 之外,还可以支持 HTTPS/gRPC/gRPCs/FastCGI,通过 Port 的 Protocol 指定协议即可。 :::

通过调整 erda.yml 配置,可以将服务端口暴露。

  1. services:
  2. # serviceA 是自定义的服务 A 的名字,不是 dice.yml 的配置项。
  3. serviceA:
  4. resources:
  5. cpu: 0.1
  6. max_cpu: 0.5
  7. mem: 256
  8. deployments:
  9. replicas: 1
  10. ports:
  11. - port: 8080
  12. expose: true
  13. # 对于非 http 的场景,需要显示指定 https/grpc/grpcs/fastcgi
  14. protocol: grpc
  15. # serviceB 是自定义的服务 B 的名字,不是 dice.yml 的配置项。
  16. serviceB:
  17. ...

一切就绪后,执行源码部署以生效这个配置。平台默认不会直接生成域名,部署成功后需要配置域名,进入DevOps 平台 > 项目 > 应用 > 部署中心 > 部署总览 操作。

应用管理 - 图5

可直接使用集群提供的泛域名,或者配置自定义域名:

应用管理 - 图6

扩缩容

通过调整 erda.yml 配置,可以对服务进行扩缩容。

修改 services.serviceA.deployments.replicas,调整服务的实例个数,然后需要执行源码部署以生效这个配置。

  1. services:
  2. # serviceA 是自定义的服务 A 的名字,不是 dice.yml 的配置项。
  3. serviceA:
  4. resources:
  5. cpu: 0.1
  6. max_cpu: 0.5
  7. mem: 256
  8. deployments:
  9. replicas: 2
  10. labels:
  11. GROUP: erda
  12. ports:
  13. - port: 9093
  14. expose: false
  15. envs:
  16. ADDON_PLATFORM_ADDR: addon
  17. # serviceB 是自定义的服务 B 的名字,不是 dice.yml 的配置项。
  18. serviceB:
  19. ...

若希望临时扩缩容(即不经过源码部署),可进入 DevOps 平台 > 项目 > 应用 > 部署中心 > 部署总览 调整。

应用管理 - 图7

部署变化后将提示重启 Runtime。

重启

重启只会重新拉取 配置,并不会改变运行程序的逻辑。若代码有变更,请使用 源码部署

版本回滚

:::tip 提示 可配置回滚点功能正在建设中,暂不支持。 :::

进入 DevOps 平台 > 我的项目 > 应用列表 > 部署中心 > 部署总览

应用管理 - 图8

若无法回滚到记录点,则会提示具体原因:

应用管理 - 图9

回滚记录

默认策略:

  • 生产环境 (PROD) 保留最近 10 次成功记录可回滚。
  • 其他环境只保留当前记录点(即无法进行回滚)。

策略可自定义,请进入 管理中心 > 项目管理 > 项目 > 回滚点设置 操作。

回滚过程

回滚即是一次部署,与普通的构建部署并无差异,区别在于回滚是部署一份早期的软件版本。

::: warning 警告 由于回滚即是部署,而若回滚的版本与当前版本差异过大(如 Addon 改动巨大),则会导致 Addon 配置丢失。 :::

健康检查

平台会在服务运行的整个生命周期进行健康检查探测,过长时间不健康的服务,会被 Kill 后重新拉起。

健康检查会运行一个指定的命令,通过命令执行的退出码是否为 0 来判断服务的健康情况, 比如调用服务的health API。

服务有过多次重启的情况可以在 Runtime 详情页的错误信息中看到.

服务健康检查未通过被kill产生的历史容器的容器状态为 Error,exit-code为 137、143 等。

健康检查配置入口:

代码仓库 -> erda.yml -> health_check 的配置内容

健康检查的配置具体写法,请参见 erda.yml