ansible-collections/google.cloud
1
0
Fork 0
mirror of https://github.com/ansible-collections/google.cloud.git synced 2025-04-06 10:50:28 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
google.cloud/plugins/modules/gcp_compute_node_template.py
The Magician fe79a8b1e1
Add generator information to generated resources (#5016) (#449) 
Signed-off-by: Modular Magician <magic-modules@google.com>
2021-07-29 18:41:37 -05:00

519 lines
17 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_node_template
description:
- Represents a NodeTemplate resource. Node templates specify properties for creating
sole-tenant nodes, such as node type, vCPU and memory requirements, node affinity
labels, and region.
short_description: Creates a GCP NodeTemplate
author: Google Inc. (@googlecloudplatform)
requirements:
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
options:
state:
description:
- Whether the given object should exist in GCP
choices:
- present
- absent
default: present
type: str
description:
description:
- An optional textual description of the resource.
required: false
type: str
name:
description:
- Name of the resource.
required: false
type: str
node_affinity_labels:
description:
- Labels to use for node affinity, which will be used in instance scheduling.
required: false
type: dict
node_type:
description:
- Node type to use for nodes group that are created from this template.
- Only one of nodeTypeFlexibility and nodeType can be specified.
required: false
type: str
node_type_flexibility:
description:
- Flexible properties for the desired node type. Node groups that use this node
template will create nodes of a type that matches these properties. Only one
of nodeTypeFlexibility and nodeType can be specified.
required: false
type: dict
suboptions:
cpus:
description:
- Number of virtual CPUs to use.
required: false
type: str
memory:
description:
- Physical memory available to the node, defined in MB.
required: false
type: str
server_binding:
description:
- The server binding policy for nodes using this template. Determines where the
nodes should restart following a maintenance event.
required: false
type: dict
suboptions:
type:
description:
- Type of server binding policy. If `RESTART_NODE_ON_ANY_SERVER`, nodes using
this template will restart on any physical server following a maintenance
event.
- If `RESTART_NODE_ON_MINIMAL_SERVER`, nodes using this template will restart
on the same physical server following a maintenance event, instead of being
live migrated to or restarted on a new physical server. This option may
be useful if you are using software licenses tied to the underlying server
characteristics such as physical sockets or cores, to avoid the need for
additional licenses when maintenance occurs. However, VMs on such nodes
will experience outages while maintenance is applied.
- 'Some valid choices include: "RESTART_NODE_ON_ANY_SERVER", "RESTART_NODE_ON_MINIMAL_SERVERS"'
required: true
type: str
cpu_overcommit_type:
description:
- CPU overcommit.
- 'Some valid choices include: "ENABLED", "NONE"'
required: false
default: NONE
type: str
region:
description:
- Region where nodes using the node template will be created .
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
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
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:
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/nodeTemplates)'
- 'Sole-Tenant Nodes: U(https://cloud.google.com/compute/docs/nodes/)'
- 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 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: create a node template
google.cloud.gcp_compute_node_template:
name: test_object
region: us-central1
node_type: n1-node-96-624
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
'''
RETURN = '''
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
returned: success
type: str
description:
description:
- An optional textual description of the resource.
returned: success
type: str
name:
description:
- Name of the resource.
returned: success
type: str
nodeAffinityLabels:
description:
- Labels to use for node affinity, which will be used in instance scheduling.
returned: success
type: dict
nodeType:
description:
- Node type to use for nodes group that are created from this template.
- Only one of nodeTypeFlexibility and nodeType can be specified.
returned: success
type: str
nodeTypeFlexibility:
description:
- Flexible properties for the desired node type. Node groups that use this node
template will create nodes of a type that matches these properties. Only one of
nodeTypeFlexibility and nodeType can be specified.
returned: success
type: complex
contains:
cpus:
description:
- Number of virtual CPUs to use.
returned: success
type: str
memory:
description:
- Physical memory available to the node, defined in MB.
returned: success
type: str
localSsd:
description:
- Use local SSD .
returned: success
type: str
serverBinding:
description:
- The server binding policy for nodes using this template. Determines where the
nodes should restart following a maintenance event.
returned: success
type: complex
contains:
type:
description:
- Type of server binding policy. If `RESTART_NODE_ON_ANY_SERVER`, nodes using
this template will restart on any physical server following a maintenance
event.
- If `RESTART_NODE_ON_MINIMAL_SERVER`, nodes using this template will restart
on the same physical server following a maintenance event, instead of being
live migrated to or restarted on a new physical server. This option may be
useful if you are using software licenses tied to the underlying server characteristics
such as physical sockets or cores, to avoid the need for additional licenses
when maintenance occurs. However, VMs on such nodes will experience outages
while maintenance is applied.
returned: success
type: str
cpuOvercommitType:
description:
- CPU overcommit.
returned: success
type: str
region:
description:
- Region where nodes using the node template will be created .
returned: success
type: str
'''
################################################################################
# Imports
################################################################################
from ansible_collections.google.cloud.plugins.module_utils.gcp_utils import (
navigate_hash,
GcpSession,
GcpModule,
GcpRequest,
remove_nones_from_dict,
replace_resource_dict,
)
import json
import re
import time
################################################################################
# Main
################################################################################
def main():
"""Main function"""
module = GcpModule(
argument_spec=dict(
state=dict(default='present', choices=['present', 'absent'], type='str'),
description=dict(type='str'),
name=dict(type='str'),
node_affinity_labels=dict(type='dict'),
node_type=dict(type='str'),
node_type_flexibility=dict(type='dict', options=dict(cpus=dict(type='str'), memory=dict(type='str'))),
server_binding=dict(type='dict', options=dict(type=dict(required=True, type='str'))),
cpu_overcommit_type=dict(default='NONE', type='str'),
region=dict(required=True, type='str'),
),
mutually_exclusive=[['node_type', 'node_type_flexibility']],
)
if not module.params['scopes']:
module.params['scopes'] = ['https://www.googleapis.com/auth/compute']
state = module.params['state']
kind = 'compute#nodeTemplate'
fetch = fetch_resource(module, self_link(module), kind)
changed = False
if fetch:
if state == 'present':
if is_different(module, fetch):
update(module, self_link(module), kind)
fetch = fetch_resource(module, self_link(module), kind)
changed = True
else:
delete(module, self_link(module), kind)
fetch = {}
changed = True
else:
if state == 'present':
fetch = create(module, collection(module), kind)
changed = True
else:
fetch = {}
fetch.update({'changed': changed})
module.exit_json(**fetch)
def create(module, link, kind):
auth = GcpSession(module, 'compute')
return wait_for_operation(module, auth.post(link, resource_to_request(module)))
def update(module, link, kind):
delete(module, self_link(module), kind)
create(module, collection(module), kind)
def delete(module, link, kind):
auth = GcpSession(module, 'compute')
return wait_for_operation(module, auth.delete(link))
def resource_to_request(module):
request = {
u'kind': 'compute#nodeTemplate',
u'description': module.params.get('description'),
u'name': module.params.get('name'),
u'nodeAffinityLabels': module.params.get('node_affinity_labels'),
u'nodeType': module.params.get('node_type'),
u'nodeTypeFlexibility': NodeTemplateNodetypeflexibility(module.params.get('node_type_flexibility', {}), module).to_request(),
u'serverBinding': NodeTemplateServerbinding(module.params.get('server_binding', {}), module).to_request(),
u'cpuOvercommitType': module.params.get('cpu_overcommit_type'),
}
return_vals = {}
for k, v in request.items():
if v or v is False:
return_vals[k] = v
return return_vals
def fetch_resource(module, link, kind, allow_not_found=True):
auth = GcpSession(module, 'compute')
return return_if_object(module, auth.get(link), kind, allow_not_found)
def self_link(module):
return "https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/nodeTemplates/{name}".format(**module.params)
def collection(module):
return "https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/nodeTemplates".format(**module.params)
def return_if_object(module, response, kind, allow_not_found=False):
# If not found, return nothing.
if allow_not_found and 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):
module.fail_json(msg="Invalid JSON response with error: %s" % response.text)
if navigate_hash(result, ['error', 'errors']):
module.fail_json(msg=navigate_hash(result, ['error', 'errors']))
return result
def is_different(module, response):
request = resource_to_request(module)
response = response_to_hash(module, response)
# Remove all output-only from response.
response_vals = {}
for k, v in response.items():
if k in request:
response_vals[k] = v
request_vals = {}
for k, v in request.items():
if k in response:
request_vals[k] = v
return GcpRequest(request_vals) != GcpRequest(response_vals)
# Remove unnecessary properties from the response.
# This is for doing comparisons with Ansible's current parameters.
def response_to_hash(module, response):
return {
u'creationTimestamp': response.get(u'creationTimestamp'),
u'description': response.get(u'description'),
u'name': response.get(u'name'),
u'nodeAffinityLabels': response.get(u'nodeAffinityLabels'),
u'nodeType': response.get(u'nodeType'),
u'nodeTypeFlexibility': NodeTemplateNodetypeflexibility(response.get(u'nodeTypeFlexibility', {}), module).from_response(),
u'serverBinding': NodeTemplateServerbinding(response.get(u'serverBinding', {}), module).from_response(),
u'cpuOvercommitType': response.get(u'cpuOvercommitType'),
}
def region_selflink(name, params):
if name is None:
return
url = r"https://compute.googleapis.com/compute/v1/projects/.*/regions/.*"
if not re.match(url, name):
name = "https://compute.googleapis.com/compute/v1/projects/{project}/regions/%s".format(**params) % name
return name
def async_op_url(module, extra_data=None):
if extra_data is None:
extra_data = {}
url = "https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/operations/{op_id}"
combined = extra_data.copy()
combined.update(module.params)
return url.format(**combined)
def wait_for_operation(module, response):
op_result = return_if_object(module, response, 'compute#operation')
if op_result is None:
return {}
status = navigate_hash(op_result, ['status'])
wait_done = wait_for_completion(status, op_result, module)
return fetch_resource(module, navigate_hash(wait_done, ['targetLink']), 'compute#nodeTemplate')
def wait_for_completion(status, op_result, module):
op_id = navigate_hash(op_result, ['name'])
op_uri = async_op_url(module, {'op_id': op_id})
while status != 'DONE':
raise_if_errors(op_result, ['error', 'errors'], module)
time.sleep(1.0)
op_result = fetch_resource(module, op_uri, 'compute#operation', False)
status = navigate_hash(op_result, ['status'])
return op_result
def raise_if_errors(response, err_path, module):
errors = navigate_hash(response, err_path)
if errors is not None:
module.fail_json(msg=errors)
class NodeTemplateNodetypeflexibility(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict({u'cpus': self.request.get('cpus'), u'memory': self.request.get('memory')})
def from_response(self):
return remove_nones_from_dict({u'cpus': self.request.get(u'cpus'), u'memory': self.request.get(u'memory')})
class NodeTemplateServerbinding(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict({u'type': self.request.get('type')})
def from_response(self):
return remove_nones_from_dict({u'type': self.request.get(u'type')})
if __name__ == '__main__':
main()
Reference in a new issue View git blame Copy permalink