6.1.0
This commit is contained in:
@@ -1,207 +1,10 @@
|
||||
#!/usr/bin/python
|
||||
#
|
||||
# Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
|
||||
# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
|
||||
#
|
||||
# Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
|
||||
#
|
||||
|
||||
#
|
||||
# Author: Sergey Shubin (sergey.shubin@digitalenergy.online)
|
||||
#
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: decort_rg
|
||||
short_description: Manage resource groups (RGs) in DECORT cloud
|
||||
description: >
|
||||
This module can be used to create a new resource group in DECORT cloud platform, modify its
|
||||
characteristics, and delete it.
|
||||
version_added: "2.2"
|
||||
author:
|
||||
- Sergey Shubin <sergey.shubin@digitalenergy.online>
|
||||
requirements:
|
||||
- python >= 2.6
|
||||
- PyJWT Python module
|
||||
- requests Python module
|
||||
- netaddr Python module
|
||||
- decort_utils utility library (module)
|
||||
- DECORT cloud platform version 3.6.1 or higher
|
||||
notes:
|
||||
- Environment variables can be used to pass selected parameters to the module, see details below.
|
||||
- Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
|
||||
- 'Similarly, JWT supplied in I(authenticator=jwt) mode should be received from Oauth2 provider trusted by
|
||||
the DECORT cloud controller on which this JWT will be used.'
|
||||
- New RGs provisioned with this module will be deployed to the first location under specified DECORT
|
||||
controller (if there is more than one location).
|
||||
options:
|
||||
account_id:
|
||||
description:
|
||||
- ID of the account under which this RG will be created. This is the alternative to I(account_name)
|
||||
option. If both I(account_id) and I(account_name) specified, the latter is ignored.
|
||||
account_name:
|
||||
description:
|
||||
- 'Name of the account under which this RG will be created (for new RGs) or is located.'
|
||||
- 'This parameter is ignored if I(account_id) is specified.'
|
||||
required: no
|
||||
annotation:
|
||||
description:
|
||||
- Optional text description of this resource group.
|
||||
default: empty string
|
||||
required: no
|
||||
app_id:
|
||||
description:
|
||||
- 'Application ID for authenticating to the DECORT controller when I(authenticator=oauth2).'
|
||||
- 'Required if I(authenticator=oauth2).'
|
||||
- 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_ID
|
||||
environment variable.'
|
||||
required: no
|
||||
app_secret:
|
||||
description:
|
||||
- 'Application API secret used for authenticating to the DECORT controller when I(authenticator=oauth2).'
|
||||
- This parameter is required when I(authenticator=oauth2) and ignored in other modes.
|
||||
- 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_SECRET
|
||||
environment variable.'
|
||||
required: no
|
||||
authenticator:
|
||||
description:
|
||||
- Authentication mechanism to be used when accessing DECORT controller and authorizing API call.
|
||||
default: jwt
|
||||
choices: [ jwt, oauth2, legacy ]
|
||||
required: yes
|
||||
controller_url:
|
||||
description:
|
||||
- URL of the DECORT controller that will be contacted to manage the RG according to the specification.
|
||||
- 'This parameter is always required regardless of the specified I(authenticator) type.'
|
||||
required: yes
|
||||
jwt:
|
||||
description:
|
||||
- 'JWT (access token) for authenticating to the DECORT controller when I(authenticator=jwt).'
|
||||
- 'This parameter is required if I(authenticator=jwt) and ignored for other authentication modes.'
|
||||
- If not specified in the playbook, the value will be taken from DECORT_JWT environment variable.
|
||||
required: no
|
||||
oauth2_url:
|
||||
description:
|
||||
- 'URL of the oauth2 authentication provider to use when I(authenticator=oauth2).'
|
||||
- 'This parameter is required when when I(authenticator=oauth2).'
|
||||
- If not specified in the playbook, the value will be taken from DECORT_OAUTH2_URL environment variable.
|
||||
password:
|
||||
description:
|
||||
- 'Password for authenticating to the DECORT controller when I(authenticator=legacy).'
|
||||
- 'This parameter is required if I(authenticator=legacy) and ignored in other authentication modes.'
|
||||
- If not specified in the playbook, the value will be taken from DECORT_PASSWORD environment variable.
|
||||
required: no
|
||||
quotas:
|
||||
description:
|
||||
- Dictionary that defines resource quotas to be set on a newly created RG.
|
||||
- 'This parameter is optional and only used when creating new RG. It is ignored for any operations on an
|
||||
existing RG.'
|
||||
- 'The following keys are valid to set the resource quotas:'
|
||||
- ' - I(cpu) (integer) - limit on the total number of CPUs that can be consumed by all compute instances
|
||||
in this RG.'
|
||||
- ' - I(ram) (integer) - limit on the total amount of RAM in GB that can be consumed by compute instances
|
||||
in this RG.'
|
||||
- ' - I(disk) (integer) - limit on the total volume of disk space in GB that can be consumed by all
|
||||
compute instances in this RG.'
|
||||
- ' - I(ext_ips) (integer) - maximum number of external IP addresses that can be allocated to the compute
|
||||
instances and virtual network segments (ViNS) in this RG.'
|
||||
- 'Each of the above keys is optional. For example, you may specify I(cpu) and I(ram) while omitting the
|
||||
other two keys. Then the quotas will be set on RAM and CPU leaving disk volume and the number of external
|
||||
IP addresses unlimited.'
|
||||
required: no
|
||||
rg_name:
|
||||
description:
|
||||
- Name of the RG to manage.
|
||||
required: yes
|
||||
state:
|
||||
description:
|
||||
- Specify the desired state of the resource group at the exit of the module.
|
||||
- 'Regardless of I(state), if RG exists and is in one of [DEPLOYING, DESTROYING, MIGRATING, ] states,
|
||||
do nothing.'
|
||||
- 'If desired I(state=present):'
|
||||
- ' - RG does not exist or is in DESTROYED state, create new RG according to the specifications.'
|
||||
- ' - RG is in one of [CREATED, DISABLED] states, change quotas if necessary.'
|
||||
- ' - RG is in DELETED state, restore it and change quotas if necessary. RG will be left in DISABLED state.'
|
||||
- ' - RG in any other state, abort with an error.'
|
||||
- 'If desired I(state=enabled):'
|
||||
- ' - RG does not exist or is in DESTROYED state, create new RG according to the specifications.'
|
||||
- ' - RG is in CREATED state, change quotas if necessary.'
|
||||
- ' - RG is in DELETED state, restore it, change quotas if necessary and enable.'
|
||||
- ' - RG is in any other state, abort with an error.'
|
||||
- 'If desired I(state=absent):'
|
||||
- ' - RG is in one of [CREATED, DISABLED, DELETED] states, destroy it.'
|
||||
- ' - RG in DESTROYED state, do nothing.'
|
||||
- ' - RG in any other state, abort with an error.'
|
||||
- 'If desired I(state=disabled):'
|
||||
- ' - RG does not exist or is in one of [ENABLING, DISABLING, DELETING, DELETED, DESTROYING, DESTROYED]
|
||||
states, abort with an error.'
|
||||
- ' - RG is DISABLED state, change quotas if necessary.'
|
||||
- ' - RG is in CREATED state, change quotas if necessary and disable the RG.'
|
||||
default: present
|
||||
choices: [ absent, disabled, enabled, present ]
|
||||
user:
|
||||
description:
|
||||
- 'Name of the legacy user for authenticating to the DECORT controller when I(authenticator=legacy).'
|
||||
- 'This parameter is required when I(authenticator=legacy) and ignored for other authentication modes.'
|
||||
- If not specified in the playbook, the value will be taken from DECORT_USER environment variable.
|
||||
required: no
|
||||
verify_ssl:
|
||||
description:
|
||||
- 'Controls SSL verification mode when making API calls to DECORT controller. Set it to False if you
|
||||
want to disable SSL certificate verification. Intended use case is when you run module in a trusted
|
||||
environment that uses self-signed certificates. Note that disabling SSL verification in any other
|
||||
scenario can lead to security issues, so please know what you are doing.'
|
||||
default: True
|
||||
required: no
|
||||
workflow_callback:
|
||||
description:
|
||||
- 'Callback URL that represents an application, which invokes this module (e.g. up-level orchestrator or
|
||||
end-user portal) and may except out-of-band updates on progress / exit status of the module run.'
|
||||
- API call at this URL will be used to relay such information to the application.
|
||||
- 'API call payload will include module-specific details about this module run and I(workflow_context).'
|
||||
required: no
|
||||
workflow_context:
|
||||
description:
|
||||
- 'Context data that will be included into the payload of the API call directed at I(workflow_callback) URL.'
|
||||
- 'This context data is expected to uniquely identify the task carried out by this module invocation so
|
||||
that up-level orchestrator could match returned information to the its internal entities.'
|
||||
required: no
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: create a new RG named "MyFirstRG" if it does not exist yet, set quotas on CPU and the number of exteranl IPs.
|
||||
decort_rg:
|
||||
authenticator: oauth2
|
||||
app_id: "{{ MY_APP_ID }}"
|
||||
app_secret: "{{ MY_APP_SECRET }}"
|
||||
controller_url: "https://cloud.digitalenergy.online"
|
||||
rg_name: "MyFirstRG"
|
||||
account_name: "MyMainAccount"
|
||||
quotas:
|
||||
cpu: 16
|
||||
ext_ips: 4
|
||||
annotation: "My first RG created with Ansible module"
|
||||
state: present
|
||||
delegate_to: localhost
|
||||
register: my_rg
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
facts:
|
||||
description: facts about the resource group
|
||||
returned: always
|
||||
type: dict
|
||||
sample:
|
||||
facts:
|
||||
id: 100
|
||||
name: MyFirstRG
|
||||
state: CREATED
|
||||
account_id: 10
|
||||
gid: 1001
|
||||
description: See L(Module Documentation,https://repository.basistech.ru/BASIS/decort-ansible/wiki/Home).
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
@@ -209,6 +12,7 @@ from ansible.module_utils.basic import env_fallback
|
||||
|
||||
from ansible.module_utils.decort_utils import *
|
||||
|
||||
|
||||
class decort_rg(DecortController):
|
||||
def __init__(self,amodule):
|
||||
super(decort_rg, self).__init__(amodule)
|
||||
@@ -347,7 +151,7 @@ class decort_rg(DecortController):
|
||||
self.validated_rg_id = self.rg_provision(self.validated_acc_id,
|
||||
self.amodule.params['rg_name'],
|
||||
self.amodule.params['owner'],
|
||||
self.amodule.params['annotation'],
|
||||
self.amodule.params['description'],
|
||||
self.amodule.params['resType'],
|
||||
self.amodule.params['def_netType'],
|
||||
self.amodule.params['ipcidr'],
|
||||
@@ -441,7 +245,7 @@ class decort_rg(DecortController):
|
||||
account_id=dict(type='int', required=False),
|
||||
account_name=dict(type='str', required=False, default=''),
|
||||
access=dict(type='dict'),
|
||||
annotation=dict(type='str', required=False, default=''),
|
||||
description=dict(type='str', required=False, default=''),
|
||||
app_id=dict(type='str',
|
||||
required=False,
|
||||
fallback=(env_fallback, ['DECORT_APP_ID'])),
|
||||
|
||||
Reference in New Issue
Block a user