community.digitalocean.digital_ocean_load_balancer 模块 – 管理 DigitalOcean 负载均衡器
注意
此模块是 community.digitalocean 集合 (版本 1.27.0) 的一部分。
如果您使用的是 ansible
软件包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install community.digitalocean
。
要在 playbook 中使用它,请指定:community.digitalocean.digital_ocean_load_balancer
。
community.digitalocean 1.10.0 中的新增功能
概要
管理 DigitalOcean 负载均衡器
参数
参数 |
注释 |
---|---|
DigitalOcean API 基本 URL。 默认值: |
|
一个数组,包含分配给负载均衡器的 Droplet 的 ID。 创建负载均衡器时必填。 与 tag 互斥,您可以定义 tag 或 droplet_ids,但不能同时定义两者。 |
|
一个布尔值,指示是否维持到目标 Droplet 的 HTTP keepalive 连接。 选项
|
|
一个布尔值,指示是否使用 PROXY 协议。 选项
|
|
一个对象数组,指定负载均衡器的转发规则。 创建负载均衡器时必填。 默认值: |
|
证书 ID 默认值: |
|
入口端口 默认值: |
|
入口协议 默认值: |
|
目标端口 默认值: |
|
目标协议 默认值: |
|
TLS 直通 选项
|
|
一个对象,指定负载均衡器的健康检查设置。 默认值: |
|
检查间隔(秒) 默认值: |
|
健康阈值 默认值: |
|
路径 默认值: |
|
端口 默认值: |
|
协议 默认值: |
|
响应超时(秒) 默认值: |
|
不健康阈值 默认值: |
|
负载均衡器实例的可读名称。 必填且必须唯一(当前 API 文档对此参数的说明未更新)。 |
|
DigitalOcean OAuth 令牌。 可以使用其他几个环境变量来提供此值。 例如 - |
|
要将资源分配到的项目(项目名称,而不是 UUID)。 默认为帐户的默认项目(空字符串)。 目前仅在创建时支持。 默认值: |
|
一个布尔值,指示是否将对 80 端口上负载均衡器的 HTTP 请求重定向到 443 端口上的 HTTPS。 选项
|
|
资源最初可用的区域的 slug 标识符。 |
|
负载均衡器的规模。 可用的规模为 创建后,您可以每小时调整负载均衡器的规模一次。 您不能在创建后的第一个小时内调整负载均衡器的规模。 除了 每个可用的负载均衡器规模现在都等同于负载均衡器具有固定数量的节点。 公式为 选项
|
|
负载均衡器包含的节点数量。 每个额外的节点都会提高负载均衡器管理更多连接的能力。 负载均衡器可以进行扩展,并且您可以在创建后每小时最多更改一次节点数量。 此字段目前在 对于位于这些区域的负载均衡器,请使用 值必须在 1-100 范围内。 默认值: |
|
常用的, 选项
|
|
指定负载均衡器粘性会话设置的对象。 默认值: |
|
类型 默认值: |
|
与您要动态分配到负载均衡器的 Droplet 关联的标签。 创建负载均衡器时必填。 与 droplet_ids 互斥,您可以定义 tag 或 droplet_ids,但不能同时定义两者。 |
|
用于轮询 DigitalOcean API 的超时时间(秒)。 默认值: |
|
如果设置为 仅当在使用自签名证书的个人控制站点上使用时,才应将其设置为 选项
|
|
指定分配负载均衡器的 VPC 的 UUID 的字符串。 如果未指定,则使用该区域中的默认 VPC。 |
|
等待负载均衡器运行后再返回。 选项
|
|
创建负载均衡器时,等待超时的时间(秒)。 默认值: |
示例
- name: Create a Load Balancer
community.digitalocean.digital_ocean_load_balancer:
state: present
name: test-loadbalancer-1
droplet_ids:
- 12345678
region: nyc1
forwarding_rules:
- entry_protocol: http
entry_port: 8080
target_protocol: http
target_port: 8080
certificate_id: ""
tls_passthrough: false
- name: Create a Load Balancer (and assign to Project "test")
community.digitalocean.digital_ocean_load_balancer:
state: present
name: test-loadbalancer-1
droplet_ids:
- 12345678
region: nyc1
forwarding_rules:
- entry_protocol: http
entry_port: 8080
target_protocol: http
target_port: 8080
certificate_id: ""
tls_passthrough: false
project: test
- name: Create a Load Balancer and associate it with a tag
community.digitalocean.digital_ocean_load_balancer:
state: present
name: test-loadbalancer-1
tag: test-tag
region: tor1
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
分配状态 (ok, not_found, assigned, already_assigned, service_down) 返回: changed 示例: |
|
一个 DigitalOcean 负载均衡器 返回: changed 示例: |
|
执行过程中遇到的信息或错误消息 返回: changed 示例: |
|
项目分配中涉及的资源分配 返回: changed 示例: |