ansible-collections/google.cloud
1
0
Fork 0
mirror of https://github.com/ansible-collections/google.cloud.git synced 2025-04-05 02:10:27 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
google.cloud/plugins/modules/gcp_compute_autoscaler_info.py
Chris Hawk 1a7d4e3cda Add many no_log attributes
2024-11-05 14:06:56 -08:00

381 lines
14 KiB
Python
Raw Blame History

#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright (C) 2017 Google
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** Type: MMv1 ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file at
# https://www.github.com/GoogleCloudPlatform/magic-modules
#
# ----------------------------------------------------------------------------
from __future__ import absolute_import, division, print_function
__metaclass__ = type
################################################################################
# Documentation
################################################################################
ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ["preview"], 'supported_by': 'community'}
DOCUMENTATION = '''
---
module: gcp_compute_autoscaler_info
description:
- Gather info for GCP Autoscaler
short_description: Gather info for GCP Autoscaler
author: Google Inc. (@googlecloudplatform)
requirements:
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
options:
filters:
description:
- A list of filter value pairs. Available filters are listed here U(https://cloud.google.com/sdk/gcloud/reference/topic/filters).
- Each additional filter in the list will act be added as an AND condition (filter1
and filter2) .
type: list
elements: str
zone:
description:
- URL of the zone where the instance group resides.
required: true
type: str
project:
description:
- The Google Cloud Platform project to use.
type: str
auth_kind:
description:
- The type of credential used.
type: str
required: true
choices:
- application
- machineaccount
- serviceaccount
- accesstoken
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
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
access_token:
description:
- An OAuth2 access token if credential type is accesstoken.
type: str
scopes:
description:
- Array of scopes to be used
type: list
elements: 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
notes:
- for authentication, you can set service_account_file using the C(GCP_SERVICE_ACCOUNT_FILE)
env variable.
- for authentication, you can set service_account_contents using the C(GCP_SERVICE_ACCOUNT_CONTENTS)
env variable.
- For authentication, you can set service_account_email using the C(GCP_SERVICE_ACCOUNT_EMAIL)
env variable.
- For authentication, you can set access_token using the C(GCP_ACCESS_TOKEN)
env variable.
- For authentication, you can set auth_kind using the C(GCP_AUTH_KIND) env variable.
- For authentication, you can set scopes using the C(GCP_SCOPES) env variable.
- Environment variables values will only be used if the playbook values are not set.
- The I(service_account_email) and I(service_account_file) options are mutually exclusive.
'''
EXAMPLES = '''
- name: get info on an autoscaler
gcp_compute_autoscaler_info:
zone: us-central1-a
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
'''
RETURN = '''
resources:
description: List of resources
returned: always
type: complex
contains:
id:
description:
- Unique identifier for the resource.
returned: success
type: int
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
returned: success
type: str
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
description:
description:
- An optional description of this resource.
returned: success
type: str
autoscalingPolicy:
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
contains:
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
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
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
mode:
description:
- Defines operating mode for this policy.
returned: success
type: str
scaleInControl:
description:
- Defines scale in controls to reduce the risk of response latency and outages
due to abrupt scale-in events .
returned: success
type: complex
contains:
maxScaledInReplicas:
description:
- A nested object resource.
returned: success
type: complex
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
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
cpuUtilization:
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
contains:
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
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
customMetricUtilizations:
description:
- Configuration parameters of autoscaling based on a custom metric.
returned: success
type: complex
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
loadBalancingUtilization:
description:
- Configuration parameters of autoscaling based on a load balancer.
returned: success
type: complex
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
target:
description:
- URL of the managed instance group that this autoscaler will scale.
returned: success
type: dict
zone:
description:
- URL of the zone where the instance group resides.
returned: success
type: str
'''
################################################################################
# Imports
################################################################################
from ansible_collections.google.cloud.plugins.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule
import json
################################################################################
# Main
################################################################################
def main():
module = GcpModule(argument_spec=dict(filters=dict(type='list', elements='str'), zone=dict(required=True, type='str')), supports_check_mode=True)
if not module.params['scopes']:
module.params['scopes'] = ['https://www.googleapis.com/auth/compute']
return_value = {'resources': fetch_list(module, collection(module), query_options(module.params['filters']))}
module.exit_json(**return_value)
def collection(module):
return "https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/autoscalers".format(**module.params)
def fetch_list(module, link, query):
auth = GcpSession(module, 'compute')
return auth.list(link, return_if_object, array_name='items', params={'filter': query})
def query_options(filters):
if not filters:
return ''
if len(filters) == 1:
return filters[0]
else:
queries = []
for f in filters:
# For multiple queries, all queries should have ()
if f[0] != '(' and f[-1] != ')':
queries.append("(%s)" % ''.join(f))
else:
queries.append(f)
return ' '.join(queries)
def return_if_object(module, response):
# If not found, return nothing.
if response.status_code == 404:
return None
# If no content, return nothing.
if response.status_code == 204:
return None
try:
module.raise_for_status(response)
result = response.json()
except getattr(json.decoder, 'JSONDecodeError', ValueError) as inst:
module.fail_json(msg="Invalid JSON response with error: %s" % inst)
if navigate_hash(result, ['error', 'errors']):
module.fail_json(msg=navigate_hash(result, ['error', 'errors']))
return result
if __name__ == "__main__":
main()
Reference in a new issue View git blame Copy permalink