google.cloud.gcp_compute_autoscaler 模块 – 创建一个 GCP 自动扩缩器

注意

此模块是 google.cloud 集合（版本 1.4.1）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。 您需要满足进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：google.cloud.gcp_compute_autoscaler。

注意

由于违反 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。 该集合有 未解决的健全性测试失败。 有关详细信息，请参阅 讨论主题。

概要

• 表示一个自动扩缩器资源。

• 自动扩缩器允许您根据您定义的自动扩缩策略自动扩缩托管实例组中的虚拟机实例。

要求

在执行此模块的主机上需要满足以下要求。

• python >= 2.6

• requests >= 2.18.4

• google-auth >= 1.3.0

参数

参数	注释
access_token 字符串	如果凭证类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭证类型。 选项 "application" "machineaccount" "serviceaccount" "accesstoken"
autoscaling_policy 字典 / 必需	自动扩缩算法的配置参数。 您可以为一个自动扩缩器定义一个或多个策略：cpuUtilization、customMetricUtilizations 和 loadBalancingUtilization。 如果未指定任何这些，则默认值将是基于 cpuUtilization 自动扩缩到 0.6 或 60%。
cool_down_period_sec 别名：cooldownPeriod 整数	自动扩缩器在开始从新实例收集信息之前应等待的秒数。 这可以防止自动扩缩器在实例初始化期间收集信息，在此期间收集的使用率不可靠。 自动扩缩器等待的默认时间为 60 秒。 虚拟机初始化时间可能会因多种因素而异。 我们建议您测试实例可能需要多长时间才能初始化。 为此，请创建一个实例并记录启动过程的时间。 默认值： 60
cpu_utilization 字典	定义 CPU 利用率策略，该策略允许自动扩缩器根据托管实例组的平均 CPU 利用率进行扩缩。
predictive_method 字符串	指示是否启用基于 CPU 指标的预测自动扩缩。 有效值为：- NONE（默认）。 不使用预测方法。 自动扩缩器会根据实时指标扩缩组以满足当前需求。 OPTIMIZE_AVAILABILITY。 预测自动扩缩通过监控每日和每周的负载模式，并在预计需求之前进行横向扩展来提高可用性。 默认值： "NONE"
utilization_target 别名：target 字符串	自动扩缩器应保持的目标 CPU 利用率。 必须是 (0, 1] 范围内的浮点值。 如果未指定，则默认值为 0.6。 如果 CPU 水平低于目标利用率，则自动扩缩器会缩减实例数量，直到达到您指定的最小实例数量，或直到实例的平均 CPU 达到目标利用率。 如果平均 CPU 高于目标利用率，则自动扩缩器会向上扩缩，直到达到您指定的最大实例数量，或直到平均利用率达到目标利用率。
custom_metric_utilizations 别名：metric 列表 / 元素=字典	基于自定义指标的自动扩缩的配置参数。
metric 别名：name 字符串 / 必需	Stackdriver Monitoring 指标的标识符（类型）。 该指标不能有负值。 该指标必须具有 INT64 或 DOUBLE 的值类型。
utilization_target 别名：target 字符串	自动扩缩器应维持的指标目标值。此值必须为正数。利用率指标会根据指标成比例地增加或减少处理请求的虚拟机数量。 例如，用作 utilizationTarget 的一个好的指标是 www.googleapis.com/compute/instance/network/received_bytes_count。 自动扩缩器将努力使每个实例的此值保持恒定。
utilization_target_type 别名: type 字符串	定义如何表示 Stackdriver Monitoring 指标的目标利用率值。 一些有效的选择包括：“GAUGE”、“DELTA_PER_SECOND”、“DELTA_PER_MINUTE”
load_balancing_utilization 字典	基于负载均衡的自动扩缩配置参数。
utilization_target 别名：target 字符串	自动扩缩器应维持的后端容量利用率（在 HTTP(s) 负载均衡配置中设置）的分数。必须为正浮点值。如果未定义，则默认值为 0.8。
max_num_replicas 别名: maxReplicas integer / required	自动扩缩器可以扩展到的最大实例数。创建或更新自动扩缩器时，这是必需的。最大副本数不应低于最小副本数。
min_num_replicas 别名: minReplicas 整数	自动扩缩器可以缩减到的最小副本数。此值不能小于 0。如果未提供，自动扩缩器将根据允许的最大实例数选择默认值。
mode 字符串	定义此策略的运行模式。 一些有效的选择包括：“OFF”、“ONLY_UP”、“ON” 默认值: "ON"
scale_in_control 字典	定义缩减控制，以减少由于突然缩减事件导致的响应延迟和中断的风险。
max_scaled_in_replicas 字典	一个嵌套的对象资源。
fixed 整数	指定固定数量的虚拟机实例。这必须是一个正整数。
percent 整数	指定 0 到 100%（包括 0 和 100%）之间的实例百分比。 例如，指定 80 表示 80%。
time_window_sec 整数	在计算建议时，自动扩缩应回溯多长时间，以包含有关较慢缩减的指令（如上所述）。
description 字符串	此资源的可选描述。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。
name 字符串 / 必需	资源的名称。名称的长度必须为 1-63 个字符，并与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，并且所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes list / elements=string	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 且用户不希望使用默认电子邮件，则可以使用可选的服务帐户电子邮件地址。
service_account_file path	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应存在于 GCP 中 选项 "present" ←（默认） "absent"
target 字典 / 必需	此自动扩缩器将缩放的托管实例组的 URL。 此字段表示指向 GCP 中 InstanceGroupManager 资源的链接。 可以通过两种方式指定它。首先，您可以放置一个带有键 'selfLink' 和资源 selfLink 值的字典。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_instance_group_manager 任务，然后将此目标字段设置为 “{{ name-of-resource }}”
zone 字符串 / 必需	实例组所在的区域的 URL。

Notes

注意

• API 参考：https://cloud.google.com/compute/docs/reference/rest/v1/autoscalers

• 自动扩缩实例组：https://cloud.google.com/compute/docs/autoscaler/

• 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。

• 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。

• 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。

• 对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。

• 对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。

• 对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 scopes。

• 只有在未设置 playbook 值时，才会使用环境变量值。

• service_account_email 和 service_account_file 选项是互斥的。

Examples

- name: create a network
  google.cloud.gcp_compute_network:
    name: network-instancetemplate
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a address
  google.cloud.gcp_compute_address:
    name: address-instancetemplate
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: address

- name: create a instance template
  google.cloud.gcp_compute_instance_template:
    name: "{{ resource_name }}"
    properties:
      disks:
      - auto_delete: 'true'
        boot: 'true'
        initialize_params:
          source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts
      machine_type: n1-standard-1
      network_interfaces:
      - network: "{{ network }}"
        access_configs:
        - name: test-config
          type: ONE_TO_ONE_NAT
          nat_ip: "{{ address }}"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instancetemplate

- name: create a instance group manager
  google.cloud.gcp_compute_instance_group_manager:
    name: "{{ resource_name }}"
    base_instance_name: test1-child
    instance_template: "{{ instancetemplate }}"
    target_size: 3
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: igm

- name: create a autoscaler
  google.cloud.gcp_compute_autoscaler:
    name: test_object
    zone: us-central1-a
    target: "{{ igm }}"
    autoscaling_policy:
      max_num_replicas: 5
      min_num_replicas: 1
      cool_down_period_sec: 60
      cpu_utilization:
        utilization_target: 0.5
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Return Values

常见的返回值记录在 这里，以下是此模块独有的字段

键	描述
autoscalingPolicy 复杂	自动扩缩算法的配置参数。 您可以为一个自动扩缩器定义一个或多个策略：cpuUtilization、customMetricUtilizations 和 loadBalancingUtilization。 如果未指定任何这些，则默认值将是基于 cpuUtilization 自动扩缩到 0.6 或 60%。 返回值: 成功
coolDownPeriodSec 整数	自动扩缩器在开始从新实例收集信息之前应等待的秒数。 这可以防止自动扩缩器在实例初始化期间收集信息，在此期间收集的使用率不可靠。 自动扩缩器等待的默认时间为 60 秒。 虚拟机初始化时间可能会因多种因素而异。 我们建议您测试实例可能需要多长时间才能初始化。 为此，请创建一个实例并记录启动过程的时间。 返回值: 成功
cpuUtilization 复杂	定义 CPU 利用率策略，该策略允许自动扩缩器根据托管实例组的平均 CPU 利用率进行扩缩。 返回值: 成功
predictiveMethod 字符串	指示是否启用基于 CPU 指标的预测自动扩缩。 有效值为：- NONE（默认）。 不使用预测方法。 自动扩缩器会根据实时指标扩缩组以满足当前需求。 OPTIMIZE_AVAILABILITY。 预测自动扩缩通过监控每日和每周的负载模式，并在预计需求之前进行横向扩展来提高可用性。 返回值: 成功
utilizationTarget 字符串	自动扩缩器应保持的目标 CPU 利用率。 必须是 (0, 1] 范围内的浮点值。 如果未指定，则默认值为 0.6。 如果 CPU 水平低于目标利用率，则自动扩缩器会缩减实例数量，直到达到您指定的最小实例数量，或直到实例的平均 CPU 达到目标利用率。 如果平均 CPU 高于目标利用率，则自动扩缩器会向上扩缩，直到达到您指定的最大实例数量，或直到平均利用率达到目标利用率。 返回值: 成功
customMetricUtilizations 复杂	基于自定义指标的自动扩缩的配置参数。 返回值: 成功
metric 字符串	Stackdriver Monitoring 指标的标识符（类型）。 该指标不能有负值。 该指标必须具有 INT64 或 DOUBLE 的值类型。 返回值: 成功
utilizationTarget 字符串	自动扩缩器应维持的指标目标值。此值必须为正数。利用率指标会根据指标成比例地增加或减少处理请求的虚拟机数量。 例如，用作 utilizationTarget 的一个好的指标是 www.googleapis.com/compute/instance/network/received_bytes_count。 自动扩缩器将努力使每个实例的此值保持恒定。 返回值: 成功
utilizationTargetType 字符串	定义如何表示 Stackdriver Monitoring 指标的目标利用率值。 返回值: 成功
loadBalancingUtilization 复杂	基于负载均衡的自动扩缩配置参数。 返回值: 成功
utilizationTarget 字符串	自动扩缩器应维持的后端容量利用率（在 HTTP(s) 负载均衡配置中设置）的分数。必须为正浮点值。如果未定义，则默认值为 0.8。 返回值: 成功
maxNumReplicas 整数	自动扩缩器可以扩展到的最大实例数。创建或更新自动扩缩器时，这是必需的。最大副本数不应低于最小副本数。 返回值: 成功
minNumReplicas 整数	自动扩缩器可以缩减到的最小副本数。此值不能小于 0。如果未提供，自动扩缩器将根据允许的最大实例数选择默认值。 返回值: 成功
mode 字符串	定义此策略的运行模式。 返回值: 成功
scaleInControl 复杂	定义缩减控制，以减少由于突然缩减事件导致的响应延迟和中断的风险。 返回值: 成功
maxScaledInReplicas 复杂	一个嵌套的对象资源。 返回值: 成功
fixed 整数	指定固定数量的虚拟机实例。这必须是一个正整数。 返回值: 成功
percent 整数	指定 0 到 100%（包括 0 和 100%）之间的实例百分比。 例如，指定 80 表示 80%。 返回值: 成功
timeWindowSec 整数	在计算建议时，自动扩缩应回溯多长时间，以包含有关较慢缩减的指令（如上所述）。 返回值: 成功
creationTimestamp 字符串	以 RFC3339 文本格式表示的创建时间戳。 返回值: 成功
description 字符串	此资源的可选描述。 返回值: 成功
id 整数	资源的唯一标识符。 返回值: 成功
name 字符串	资源的名称。名称的长度必须为 1-63 个字符，并与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，并且所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。 返回值: 成功
target 字典	此自动扩缩器将缩放的托管实例组的 URL。 返回值: 成功
zone 字符串	实例组所在的区域的 URL。 返回值: 成功

Authors

• Google Inc. (@googlecloudplatform)

Collection links

• 问题跟踪器
• 主页
• 存储库（源代码）