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

整数 / 必需

自动缩放器可以扩展到的最大实例数。创建或更新自动缩放器时，这是必需的。最大副本数不应低于最小副本数。

min_num_replicas

别名：minReplicas

整数

自动缩放器可以缩减到的最小副本数。这不能小于 0。如果未提供，自动缩放器将根据允许的最大实例数选择默认值。

mode

字符串

定义此策略的操作模式。

一些有效的选项包括：“OFF”、“ONLY_UP”、“ON”

默认值： "ON"

scale_in_control

字典

定义缩减控制，以减少由于突然的缩减事件而导致的响应延迟和中断的风险。

max_scaled_in_replicas

字典

嵌套的对象资源。

fixed

整数

指定固定的虚拟机实例数。这必须是一个正整数。

percent

整数

指定介于 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

列表 / 元素=字符串

要使用的作用域数组

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 任务，然后将此 target 字段设置为“{{ name-of-resource }}”

zone

字符串 / 必填

实例组所在的区域的 URL。

注释

注意

  • 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 选项是互斥的。

示例

- 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

返回值

常用返回值已在 此处 记录，以下是此模块特有的字段

键

描述

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%（含）之间的实例百分比。

例如，指定 80 表示 80%。

返回：成功

timeWindowSec

整数

计算建议时，自动缩放应回溯多长时间，以包含关于较慢缩减的指令，如上所述。

返回：成功

creationTimestamp

字符串

RFC3339 文本格式的创建时间戳。

返回：成功

description

字符串

此资源的可选描述。

返回：成功

id

整数

资源的唯一标识符。

返回：成功

name

字符串

资源的名称。名称必须是 1-63 个字符长，并符合正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是连字符、小写字母或数字，最后一个字符不能是连字符。

返回：成功

target

字典

此自动缩放器将缩放的托管实例组的 URL。

返回：成功

zone

字符串

实例组所在的区域的 URL。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)