6.1.0
This commit is contained in:
@@ -1,285 +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_osimage
|
||||
short_description: Locate OS image in DCORT cloud by its name and return image ID
|
||||
description: >
|
||||
This module can be used to obtain image ID of an OS image in DECORT cloud to use with subsequent calls to
|
||||
decort_vm module for batch VM provisioning. It will speed up VM creation and save a bunch of extra calls to
|
||||
DECORT cloud controller on each VM creation act.
|
||||
|
||||
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.'
|
||||
options:
|
||||
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 obtain OS image details.
|
||||
- 'This parameter is always required regardless of the specified I(authenticator) type.'
|
||||
required: yes
|
||||
image_name:
|
||||
description:
|
||||
- Name of the OS image to use. Module will return the ID of this image.
|
||||
- 'The specified image name will be looked up in the target DECORT controller and error will be generated
|
||||
- if no matching image is found.'
|
||||
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
|
||||
pool:
|
||||
description:
|
||||
- 'Name of the storage pool, where the image should be found.'
|
||||
- 'Omit this option if no matching by pool name is required. The first matching image will be returned."
|
||||
required: no
|
||||
sep_id:
|
||||
description:
|
||||
- 'ID of the SEP (Storage End-point Provider), where the image should be found.'
|
||||
- 'Omit this option if no matching by SEP ID is required. The first matching image will be returned."
|
||||
required: no
|
||||
account_name:
|
||||
description:
|
||||
- 'Name of the account for which the specified OS image will be looked up.'
|
||||
- 'This parameter is required for listing OS images.'
|
||||
required: yes
|
||||
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
|
||||
account_name:
|
||||
description:
|
||||
- 'Account name. Used to get a unique integer account ID.'
|
||||
required: no
|
||||
virt_id:
|
||||
description:
|
||||
- 'A unique integer identifier for the virtual image.'
|
||||
- 'Can be used to obtain information about a virtual image, as well as to create a virtual image and
|
||||
- bind another operating system image to it.'
|
||||
required: no
|
||||
virt_name:
|
||||
description:
|
||||
- 'Name of the virtual image. Used to get the `virt_id`, and later information about the virtual image,
|
||||
- as well as to create a virtual image and bind another operating system image to it.'
|
||||
required: no
|
||||
state:
|
||||
description:
|
||||
- 'The state of the images. If set to present, operating system images will be created to which
|
||||
- the account specified in `account_Id` or `account_name` is bound. If set to absent, they will be removed.
|
||||
required: no
|
||||
drivers:
|
||||
description:
|
||||
- 'A list of compute types (eg virtual servers) that are appropriate for the operating system image.
|
||||
- Note: `KVM_X86`. Used when creating an operating system image.'
|
||||
required: no
|
||||
architecture:
|
||||
description:
|
||||
- 'Binary architecture of the image. Note. `X86_64`. Used when creating
|
||||
-an operating system image.'
|
||||
required: no
|
||||
imagetype:
|
||||
description:
|
||||
- 'Image type. `linux`, `windows` or `other`. The default is `linux`. Used when creating
|
||||
- an operating system image.'
|
||||
required: no
|
||||
boottype:
|
||||
description:
|
||||
- 'Image upload type. `bios` or `uefi`. The default is `uefi`. Used when creating an operating
|
||||
-system image.'
|
||||
required: no
|
||||
url:
|
||||
description:
|
||||
- 'Uniform resource locator (URL) pointing to the iso image of the operating system. Used when
|
||||
-creating an operating system image.'
|
||||
required: no
|
||||
sepId:
|
||||
description:
|
||||
- 'The unique integer ID of the storage provider endpoint. Specified in pair with `poolName`.
|
||||
- Used when creating an operating system image.'
|
||||
required: no
|
||||
poolName:
|
||||
description:
|
||||
- 'The pool in which the image will be created. Specified in pair with `sepId`. Used when creating
|
||||
- an operating system image.'
|
||||
required: no
|
||||
hotresize:
|
||||
description:
|
||||
- 'Whether the image supports "hot" resizing. The default is `false`. Used when creating an operating
|
||||
- system image.'
|
||||
required: no
|
||||
image_username:
|
||||
description:
|
||||
- 'An optional username for the image. Used when creating an operating system image.'
|
||||
required: no
|
||||
image_password:
|
||||
description:
|
||||
- 'An optional password for the image. Used when creating an operating system image. Used when creating
|
||||
- an operating system image.'
|
||||
required: no
|
||||
usernameDL:
|
||||
description:
|
||||
- 'The username for loading the binary media. Used in conjunction with `passwordDL`. Used when creating
|
||||
- an operating system image'
|
||||
required: no
|
||||
passwordDL:
|
||||
description:
|
||||
- 'The password for loading the binary media. Used in conjunction with `usernameDL`. Used when creating
|
||||
- an operating system image.'
|
||||
required: no
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: create_osimage
|
||||
decort_osimage:
|
||||
authenticator: oauth2
|
||||
verify_ssl: False
|
||||
controller_url: "https://ds1.digitalenergy.online"
|
||||
state: present
|
||||
image_name: "alpine_linux3.14.0"
|
||||
account_Id: 12345
|
||||
url: "https://dl-cdn.alpinelinux.org/alpine/v3.14/releases/x86_64/alpine-virt-3.14.0-x86_64.iso"
|
||||
boottype: "uefi"
|
||||
imagetype: "linux"
|
||||
hotresize: False
|
||||
image_username: "test"
|
||||
image_password: "p@ssw0rd"
|
||||
usernameDL: "testDL"
|
||||
passwordDL: "p@ssw0rdDL"
|
||||
architecture: "X86_64"
|
||||
drivers: "KVM_X86"
|
||||
delegate_to: localhost
|
||||
register: osimage
|
||||
|
||||
- name: get_osimage
|
||||
decort_osimage:
|
||||
authenticator: oauth2
|
||||
controller_url: "https://ds1.digitalenergy.online"
|
||||
image_name: "alpine_linux_3.14.0"
|
||||
account_Id: 12345
|
||||
delegate_to: localhost
|
||||
register: osimage
|
||||
|
||||
- name: create_virtual_osimage
|
||||
decort_osimage:
|
||||
authenticator: oauth2
|
||||
controller_url: "https://ds1.digitalenergy.online"
|
||||
image_name: "alpine_linux_3.14.0"
|
||||
virt_name: "alpine_last"
|
||||
delegate_to: localhost
|
||||
register: osimage
|
||||
|
||||
- name: rename_osimage
|
||||
decort_osimage:
|
||||
authenticator: oauth2
|
||||
controller_url: "https://ds1.digitalenergy.online"
|
||||
image_name: "alpine_linux_3.14.0v2.0"
|
||||
image_id: 54321
|
||||
delegate_to: localhost
|
||||
register: osimage
|
||||
|
||||
|
||||
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
facts:
|
||||
description: facts about the specified OS image
|
||||
returned: always
|
||||
type: dict
|
||||
sample:
|
||||
facts:
|
||||
id: 100
|
||||
linkto: 80
|
||||
name: "Ubuntu 16.04 v1.0"
|
||||
size: 3
|
||||
sep_id: 1
|
||||
pool: "vmstore"
|
||||
type: Linux
|
||||
arch: x86_64
|
||||
state: CREATED
|
||||
description: See L(Module Documentation,https://repository.basistech.ru/BASIS/decort-ansible/wiki/Home).
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
@@ -287,6 +12,7 @@ from ansible.module_utils.basic import env_fallback
|
||||
|
||||
from ansible.module_utils.decort_utils import *
|
||||
|
||||
|
||||
class decort_osimage(DecortController):
|
||||
def __init__(self,amodule):
|
||||
super(decort_osimage, self).__init__(amodule)
|
||||
|
||||
Reference in New Issue
Block a user