Try SpotterCreates a GCP RegionAutoscaler
Authors: Google Inc. (@googlecloudplatform)
preview | supported by community
Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2
collections:
- name: delowan.googlecloud
version: 1.0.2Represents an Autoscaler resource.
Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define.
- 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 region instance group manager
google.cloud.gcp_compute_region_instance_group_manager:
name: "{{ resource_name }}"
base_instance_name: test1-child
region: us-central1
instance_template: "{{ instancetemplate }}"
target_size: 3
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: igrm
- name: create a region autoscaler
google.cloud.gcp_compute_region_autoscaler:
name: my-region-autoscaler
region: us-central1
autoscaling_policy:
min_num_replicas: 1
max_num_replicas: 5
cool_down_period_sec: 60
cpu_utilization:
utilization_target: 0.5
target: "{{igrm.selfLink}}"
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
name:
description:
- Name of the resource. The name must be 1-63 characters long and match the regular
expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be
a lowercase letter, and all following characters must be a dash, lowercase letter,
or digit, except the last character, which cannot be a dash.
required: true
type: str
state:
choices:
- present
- absent
default: present
description:
- Whether the given object should exist in GCP
type: str
region:
description:
- URL of the region where the instance group resides.
required: true
type: str
scopes:
description:
- Array of scopes to be used
elements: str
type: list
target:
description:
- URL of the managed instance group that this autoscaler will scale.
required: true
type: str
project:
description:
- The Google Cloud Platform project to use.
type: str
env_type:
description:
- Specifies which Ansible environment you're running this module within.
- This should not be set unless you know what you're doing.
- This only alters the User Agent string for any API requests.
type: str
auth_kind:
choices:
- application
- machineaccount
- serviceaccount
description:
- The type of credential used.
required: true
type: str
description:
description:
- An optional description of this resource.
required: false
type: str
autoscaling_policy:
description:
- 'The configuration parameters for the autoscaling algorithm. You can define one
or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations,
and loadBalancingUtilization.'
- If none of these are specified, the default will be to autoscale based on cpuUtilization
to 0.6 or 60%.
required: true
suboptions:
cool_down_period_sec:
default: '60'
description:
- The number of seconds that the autoscaler should wait before it starts collecting
information from a new instance. This prevents the autoscaler from collecting
information when the instance is initializing, during which the collected usage
would not be reliable. The default time autoscaler waits is 60 seconds.
- Virtual machine initialization times might vary because of numerous factors.
We recommend that you test how long an instance may take to initialize. To do
this, create an instance and time the startup process.
required: false
type: int
cpu_utilization:
description:
- Defines the CPU utilization policy that allows the autoscaler to scale based
on the average CPU utilization of a managed instance group.
required: false
suboptions:
predictive_method:
default: NONE
description:
- 'Indicates whether predictive autoscaling based on CPU metric is enabled.
Valid values are: - NONE (default). No predictive method is used. The autoscaler
scales the group to meet current demand based on real-time metrics.'
- '- OPTIMIZE_AVAILABILITY. Predictive autoscaling improves availability by
monitoring daily and weekly load patterns and scaling out ahead of anticipated
demand.'
required: false
type: str
utilization_target:
description:
- The target CPU utilization that the autoscaler should maintain.
- Must be a float value in the range (0, 1]. If not specified, the default
is 0.6.
- If the CPU level is below the target utilization, the autoscaler scales
down the number of instances until it reaches the minimum number of instances
you specified or until the average CPU of your instances reaches the target
utilization.
- If the average CPU is above the target utilization, the autoscaler scales
up until it reaches the maximum number of instances you specified or until
the average utilization reaches the target utilization.
required: false
type: str
type: dict
custom_metric_utilizations:
description:
- Configuration parameters of autoscaling based on a custom metric.
elements: dict
required: false
suboptions:
metric:
description:
- The identifier (type) of the Stackdriver Monitoring metric.
- The metric cannot have negative values.
- The metric must have a value type of INT64 or DOUBLE.
required: true
type: str
utilization_target:
description:
- The target value of the metric that autoscaler should maintain. This must
be a positive value. A utilization metric scales number of virtual machines
handling requests to increase or decrease proportionally to the metric.
- For example, a good metric to use as a utilizationTarget is U(www.googleapis.com/compute/instance/network/received_bytes_count).
- The autoscaler will work to keep this value constant for each of the instances.
required: false
type: str
utilization_target_type:
description:
- Defines how target utilization value is expressed for a Stackdriver Monitoring
metric.
- 'Some valid choices include: "GAUGE", "DELTA_PER_SECOND", "DELTA_PER_MINUTE"'
required: false
type: str
type: list
load_balancing_utilization:
description:
- Configuration parameters of autoscaling based on a load balancer.
required: false
suboptions:
utilization_target:
description:
- Fraction of backend capacity utilization (set in HTTP(s) load balancing
configuration) that autoscaler should maintain. Must be a positive float
value. If not defined, the default is 0.8.
required: false
type: str
type: dict
max_num_replicas:
description:
- The maximum number of instances that the autoscaler can scale up to. This is
required when creating or updating an autoscaler. The maximum number of replicas
should not be lower than minimal number of replicas.
required: true
type: int
min_num_replicas:
description:
- The minimum number of replicas that the autoscaler can scale down to. This cannot
be less than 0. If not provided, autoscaler will choose a default value depending
on maximum number of instances allowed.
required: false
type: int
mode:
default: 'ON'
description:
- Defines operating mode for this policy.
- 'Some valid choices include: "OFF", "ONLY_UP", "ON"'
required: false
type: str
scale_in_control:
description:
- Defines scale in controls to reduce the risk of response latency and outages
due to abrupt scale-in events .
required: false
suboptions:
max_scaled_in_replicas:
description:
- A nested object resource.
required: false
suboptions:
fixed:
description:
- Specifies a fixed number of VM instances. This must be a positive integer.
required: false
type: int
percent:
description:
- Specifies a percentage of instances between 0 to 100%, inclusive.
- For example, specify 80 for 80%.
required: false
type: int
type: dict
time_window_sec:
description:
- How long back autoscaling should look when computing recommendations to
include directives regarding slower scale down, as described above.
required: false
type: int
type: dict
type: dict
service_account_file:
description:
- The path of a Service Account JSON file if serviceaccount is selected as type.
type: path
service_account_email:
description:
- An optional service account email address if machineaccount is selected and the
user does not wish to use the default email.
type: str
service_account_contents:
description:
- The contents of a Service Account JSON file, either in a dictionary or as a JSON
string that represents it.
type: jsonarg
autoscalingPolicy:
contains:
coolDownPeriodSec:
description:
- The number of seconds that the autoscaler should wait before it starts collecting
information from a new instance. This prevents the autoscaler from collecting
information when the instance is initializing, during which the collected
usage would not be reliable. The default time autoscaler waits is 60 seconds.
- Virtual machine initialization times might vary because of numerous factors.
We recommend that you test how long an instance may take to initialize. To
do this, create an instance and time the startup process.
returned: success
type: int
cpuUtilization:
contains:
predictiveMethod:
description:
- 'Indicates whether predictive autoscaling based on CPU metric is enabled.
Valid values are: - NONE (default). No predictive method is used. The
autoscaler scales the group to meet current demand based on real-time
metrics.'
- '- OPTIMIZE_AVAILABILITY. Predictive autoscaling improves availability
by monitoring daily and weekly load patterns and scaling out ahead of
anticipated demand.'
returned: success
type: str
utilizationTarget:
description:
- The target CPU utilization that the autoscaler should maintain.
- Must be a float value in the range (0, 1]. If not specified, the default
is 0.6.
- If the CPU level is below the target utilization, the autoscaler scales
down the number of instances until it reaches the minimum number of instances
you specified or until the average CPU of your instances reaches the target
utilization.
- If the average CPU is above the target utilization, the autoscaler scales
up until it reaches the maximum number of instances you specified or until
the average utilization reaches the target utilization.
returned: success
type: str
description:
- Defines the CPU utilization policy that allows the autoscaler to scale based
on the average CPU utilization of a managed instance group.
returned: success
type: complex
customMetricUtilizations:
contains:
metric:
description:
- The identifier (type) of the Stackdriver Monitoring metric.
- The metric cannot have negative values.
- The metric must have a value type of INT64 or DOUBLE.
returned: success
type: str
utilizationTarget:
description:
- The target value of the metric that autoscaler should maintain. This must
be a positive value. A utilization metric scales number of virtual machines
handling requests to increase or decrease proportionally to the metric.
- For example, a good metric to use as a utilizationTarget is U(www.googleapis.com/compute/instance/network/received_bytes_count).
- The autoscaler will work to keep this value constant for each of the instances.
returned: success
type: str
utilizationTargetType:
description:
- Defines how target utilization value is expressed for a Stackdriver Monitoring
metric.
returned: success
type: str
description:
- Configuration parameters of autoscaling based on a custom metric.
returned: success
type: complex
loadBalancingUtilization:
contains:
utilizationTarget:
description:
- Fraction of backend capacity utilization (set in HTTP(s) load balancing
configuration) that autoscaler should maintain. Must be a positive float
value. If not defined, the default is 0.8.
returned: success
type: str
description:
- Configuration parameters of autoscaling based on a load balancer.
returned: success
type: complex
maxNumReplicas:
description:
- The maximum number of instances that the autoscaler can scale up to. This
is required when creating or updating an autoscaler. The maximum number of
replicas should not be lower than minimal number of replicas.
returned: success
type: int
minNumReplicas:
description:
- The minimum number of replicas that the autoscaler can scale down to. This
cannot be less than 0. If not provided, autoscaler will choose a default value
depending on maximum number of instances allowed.
returned: success
type: int
mode:
description:
- Defines operating mode for this policy.
returned: success
type: str
scaleInControl:
contains:
maxScaledInReplicas:
contains:
fixed:
description:
- Specifies a fixed number of VM instances. This must be a positive
integer.
returned: success
type: int
percent:
description:
- Specifies a percentage of instances between 0 to 100%, inclusive.
- For example, specify 80 for 80%.
returned: success
type: int
description:
- A nested object resource.
returned: success
type: complex
timeWindowSec:
description:
- How long back autoscaling should look when computing recommendations to
include directives regarding slower scale down, as described above.
returned: success
type: int
description:
- Defines scale in controls to reduce the risk of response latency and outages
due to abrupt scale-in events .
returned: success
type: complex
description:
- 'The configuration parameters for the autoscaling algorithm. You can define one
or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations,
and loadBalancingUtilization.'
- If none of these are specified, the default will be to autoscale based on cpuUtilization
to 0.6 or 60%.
returned: success
type: complex
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
returned: success
type: str
description:
description:
- An optional description of this resource.
returned: success
type: str
id:
description:
- Unique identifier for the resource.
returned: success
type: int
name:
description:
- Name of the resource. The name must be 1-63 characters long and match the regular
expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be
a lowercase letter, and all following characters must be a dash, lowercase letter,
or digit, except the last character, which cannot be a dash.
returned: success
type: str
region:
description:
- URL of the region where the instance group resides.
returned: success
type: str
target:
description:
- URL of the managed instance group that this autoscaler will scale.
returned: success
type: str