diff --git a/CHANGELOG.md b/CHANGELOG.md index 479c63e..2afc3cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,37 @@ -# Список изменений в версии 6.1.2 +# Список изменений в версии 7.0.0 ## Добавлено +### Глобально +| Идентификатор
задачи | Описание | +| --- | --- | +| BANS-649 | Добавлен модуль `decort_snapshot` для управления снимками виртуальных машин. | +| BANS-670 | Добавлена возможность авторизации с помощью BVS . Добавлены новые параметры: `domain`, `username` и `password`. В параметре `authenticator` добавлены значения `decs3o` и `bvs`. | + +### Модуль decort_kvmvm +| Идентификатор
задачи | Описание | +| --- | --- | +| BANS-667 | Добавлено возвращаемое значение `vnc_password`. | +| BANS-673 | Добавлен параметр `auto_start`. | +| BANS-621 | Добавлен параметр `networks.mtu` (только для DPDK-сетей). | + +### Модуль decort_jwt +| Идентификатор
задачи | Описание | +| --- | --- | +| BANS-681 | Добавлена возможность получения JWT-токена с помощью BVS. Добавлены новые параметры: `authenticator`, `domain`, `username` и `password`. | ## Удалено +### Модуль decort_kvmvm +| Идентификатор
задачи | Описание | +| --- | --- | +| BANS-630 | Удалено значение `check` параметра `state`. Теперь для получения информации от виртуальной машины достаточно передать параметр `id`. | + +### Модуль decort_jwt +| Идентификатор
задачи | Описание | +| --- | --- | +| BANS-681 | Удален параметр `validity`. | ## Исправлено -### Модуль decort_k8s +### Модуль decort_kvmvm | Идентификатор
задачи | Описание | | --- | --- | -| BANS-682 | При создании кластера k8s, модуль завершал свою работу ошибкой запроса к API. | +| BANS-630 | Скорректирована логика параметра целевого состояния `present`. Теперь состояние `present` соответствует тому, что виртуальная машина существует, и не приводит к изменению состояния существующей виртуальной машины. Также для параметра `state` значение по умолчанию `present` теперь только при создании виртуальной машины. | diff --git a/README.md b/README.md index ea148fd..20922ff 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ | Версия платформы | Версия модулей Ansible | |:----------------:|:--------------------------:| +| 4.2.0 | 7.0.x | | 4.1.0 | 6.0.x, 6.1.x | | 4.0.0 | 5.6.x, 5.5.x, 5.4.x, 5.3.x | | 3.8.8, 3.8.9 | 5.2.6 | diff --git a/examples/affinity.yaml b/examples/affinity.yaml deleted file mode 100644 index 724fcb5..0000000 --- a/examples/affinity.yaml +++ /dev/null @@ -1,36 +0,0 @@ ---- -# -# DECORT kvmvm module example -# -- hosts: ansible_master - tasks: - - name: create a VM named cloud-init_example - decort_kvmvm: - name: affinity_example - annotation: "VM managed by decort_kvmvm module" - authenticator: oauth2 - app_id: "" # Application id from SSO Digital Energy - app_secret: "" # API key from SSO Digital Energy - controller_url: "" #"https://mr4.digitalenergy.online" - rg_id: # Resource group id - cpu: 2 - ram: 2048 - boot_disk: 10 - image_name: "DECS Ubuntu 18.04 v1.2.3" # Name of OS image - networks: - - type: VINS - id: # VINS id - tags: "Ansible cloud init example" - aff_lable: "Affinity lable" - tag: - - key: bd - value: main - aff_rule: - - key: app - value: main - topology: compute - policy: REQUIRED - mode: EQ - state: present - delegate_to: localhost - register: simple_vm \ No newline at end of file diff --git a/examples/anti_affinity.yaml b/examples/anti_affinity.yaml deleted file mode 100644 index 0baa8a2..0000000 --- a/examples/anti_affinity.yaml +++ /dev/null @@ -1,36 +0,0 @@ ---- -# -# DECORT kvmvm module example -# -- hosts: ansible_master - tasks: - - name: create a VM named cloud-init_example - decort_kvmvm: - name: anti-affinity_example - annotation: "VM managed by decort_kvmvm module" - authenticator: oauth2 - app_id: "" # Application id from SSO Digital Energy - app_secret: "" # API key from SSO Digital Energy - controller_url: "" #"https://mr4.digitalenergy.online" - rg_id: # Resource group id - cpu: 2 - ram: 2048 - boot_disk: 10 - image_name: "DECS Ubuntu 18.04 v1.2.3" #Name of OS image - networks: - - type: VINS - id: #VINS id - tags: "Ansible cloud init example" - aff_lable: "Anti affinity lable" - tag: - - key: bd - value: main - aaff_rule: - - key: app - value: main - topology: compute - policy: REQUIRED - mode: ANY - state: present - delegate_to: localhost - register: simple_vm \ No newline at end of file diff --git a/examples/cloud_init.yaml b/examples/cloud_init.yaml deleted file mode 100644 index d3f5289..0000000 --- a/examples/cloud_init.yaml +++ /dev/null @@ -1,38 +0,0 @@ -# -# DECORT kvmvm module example -# -- hosts: ansible_master - tasks: - - name: create a VM named cloud-init_example - decort_kvmvm: - annotation: "VM managed by decort_kvmvm module" - authenticator: oauth2 - app_id: "" # Application id from SSO Digital Energy - app_secret: "" # API key from SSO Digital Energy - controller_url: "" #"https://mr4.digitalenergy.online" - name: cloud-init_example - cpu: 2 - ram: 2048 - boot_disk: 10 - image_name: "DECS Ubuntu 18.04 v1.2.3" #Name of OS image - networks: - - type: VINS - id: #VINS id - tags: "Ansible cloud init example" - state: present - rg_id: #Resource group id - ci_user_data: - packages: - - apache2 - write_files: - - content: | -
- Hello World! -
- owner: user:user - path: /var/www/html/index.html - hostname: test-apache - ssh_keys: - - rsa_public: ssh-rsa AAAAOasDmLxnD= user@pc - delegate_to: localhost - register: simple_vm diff --git a/library/decort_bservice.py b/library/decort_bservice.py index ce791c8..aa62b79 100644 --- a/library/decort_bservice.py +++ b/library/decort_bservice.py @@ -13,8 +13,9 @@ from ansible.module_utils.decort_utils import * class decort_bservice(DecortController): - def __init__(self,arg_amodule): - super(decort_bservice, self).__init__(arg_amodule) + def __init__(self): + super(decort_bservice, self).__init__(AnsibleModule(**self.amodule_init_args)) + arg_amodule = self.amodule validated_acc_id = 0 validated_rg_id = 0 @@ -147,70 +148,66 @@ class decort_bservice(DecortController): ret_dict['account_id'] = self.bservice_info['accountId'] ret_dict['groups'] = self.bservice_info['groups'] return ret_dict - @staticmethod - def build_parameters(): - return dict( - account_id=dict(type='int', required=False), - account_name=dict(type='str', required=False, default=''), - app_id=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_ID'])), - app_secret=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_SECRET']), - no_log=True), - authenticator=dict(type='str', - required=True, - choices=['legacy', 'oauth2', 'jwt']), - controller_url=dict(type='str', required=True), - jwt=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_JWT']), - no_log=True), - oauth2_url=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_OAUTH2_URL'])), - password=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_PASSWORD']), - no_log=True), - state=dict(type='str', - default='present', - choices=['absent', 'disabled', 'enabled', 'present','check']), - started=dict(type='bool', required=False, default=True), - user=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_USER'])), - name=dict(type='str', required=False, default=''), - sshuser=dict(type='str', required=False,default=None), - sshkey=dict(type='str', required=False,default=None), - id=dict(type='int', required=False, default=0), - rg_id=dict(type='int', default=0), - rg_name=dict(type='str',default=""), - verify_ssl=dict(type='bool', required=False, default=True), - workflow_callback=dict(type='str', required=False), - workflow_context=dict(type='str', required=False),) -def main(): - module_parameters = decort_bservice.build_parameters() - amodule = AnsibleModule(argument_spec=module_parameters, - supports_check_mode=True, - mutually_exclusive=[ - ['oauth2', 'password'], - ['password', 'jwt'], - ['jwt', 'oauth2'], - ], - required_together=[ - ['app_id', 'app_secret'], - ['user', 'password'], - ], - required_one_of=[ - ['id', 'name'], - ['rg_id','rg_name'] - ], - ) + @property + def amodule_init_args(self) -> dict: + return self.pack_amodule_init_args( + argument_spec=dict( + account_id=dict( + type='int', + ), + account_name=dict( + type='str', + default='', + ), + state=dict( + type='str', + default='present', + choices=[ + 'absent', + 'disabled', + 'enabled', + 'present', + 'check', + ], + ), + started=dict( + type='bool', + default=True, + ), + name=dict( + type='str', + default='', + ), + sshuser=dict( + type='str', + ), + sshkey=dict( + type='str', + ), + id=dict( + type='int', + default=0, + ), + rg_id=dict( + type='int', + default=0, + ), + rg_name=dict( + type='str', + default='', + ), + ), + supports_check_mode=True, + required_one_of=[ + ('id', 'name'), + ('rg_id', 'rg_name'), + ], + ) - subj = decort_bservice(amodule) +def main(): + subj = decort_bservice() + amodule = subj.amodule if amodule.params['state'] == 'check': subj.result['changed'] = False diff --git a/library/decort_disk.py b/library/decort_disk.py index c910972..775dea1 100644 --- a/library/decort_disk.py +++ b/library/decort_disk.py @@ -14,8 +14,9 @@ from ansible.module_utils.decort_utils import * class decort_disk(DecortController): - def __init__(self,arg_amodule): - super(decort_disk, self).__init__(arg_amodule) + def __init__(self): + super(decort_disk, self).__init__(AnsibleModule(**self.amodule_init_args)) + arg_amodule = self.amodule validated_acc_id = 0 validated_acc_info = None @@ -176,98 +177,136 @@ class decort_disk(DecortController): ret_dict['iotune'] = self.disk_info['iotune'] return ret_dict - @staticmethod - def build_parameters(): - """Build and return a dictionary of parameters expected by decort_disk module in a form accepted - by AnsibleModule utility class.""" - return dict( - account_id=dict(type='int', required=False, default=0), - account_name=dict(type='str', required=False, default=''), - description=dict(type='str', required=False, default='Disk by decort_disk'), - app_id=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_ID'])), - app_secret=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_SECRET']), - no_log=True), - authenticator=dict(type='str', - required=True, - choices=['legacy', 'oauth2', 'jwt']), - controller_url=dict(type='str', required=True), - id=dict(type='int', required=False, default=0), - name=dict(type='str', required=False), - force_detach=dict(type='bool', required=False, default=False), - jwt=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_JWT']), - no_log=True), - oauth2_url=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_OAUTH2_URL'])), - password=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_PASSWORD']), - no_log=True), - place_with=dict(type='int', default=0), - pool=dict(type='str', default=''), - sep_id=dict(type='int', default=0), - size=dict(type='int'), - type=dict(type='str', - required=False, - default="D", - choices=['B', 'D', 'T']), - iops=dict(type='int',required=False,default=2000), - limitIO=dict(type='dict', - options=dict( - total_bytes_sec=dict(required=False,type='int'), - read_bytes_sec=dict(required=False,type='int'), - write_bytes_sec=dict(required=False,type='int'), - total_iops_sec=dict(required=False,type='int'), - read_iops_sec=dict(required=False,type='int'), - write_iops_sec=dict(required=False,type='int'), - total_bytes_sec_max=dict(required=False,type='int'), - read_bytes_sec_max=dict(required=False,type='int'), - write_bytes_sec_max=dict(required=False,type='int'), - total_iops_sec_max=dict(required=False,type='int'), - read_iops_sec_max=dict(required=False,type='int'), - write_iops_sec_max=dict(required=False,type='int'), - size_iops_sec=dict(required=False,type='int'),)), - permanently=dict(type='bool', required=False, default=False), - shareable=dict(type='bool', required=False, default=False), - reason=dict(type='str', required=False,default='Managed by Ansible decort_disk'), - state=dict(type='str', - default='present', - choices=['absent', 'present']), - user=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_USER'])), - verify_ssl=dict(type='bool', required=False, default=True), - workflow_callback=dict(type='str', required=False), - workflow_context=dict(type='str', required=False), + @property + def amodule_init_args(self) -> dict: + return self.pack_amodule_init_args( + argument_spec=dict( + account_id=dict( + type='int', + default=0, + ), + account_name=dict( + type='str', + default='', + ), + description=dict( + type='str', + default='Disk by decort_disk', + ), + id=dict( + type='int', + default=0, + ), + name=dict( + type='str', + ), + force_detach=dict( + type='bool', + default=False, + ), + place_with=dict( + type='int', + default=0, + ), + pool=dict( + type='str', + default='', + ), + sep_id=dict( + type='int', + default=0, + ), + size=dict( + type='int', + ), + type=dict( + type='str', + default='D', + choices=[ + 'B', + 'D', + 'T', + ], + ), + iops=dict( + type='int', + default=2000, + ), + limitIO=dict( + type='dict', + options=dict( + total_bytes_sec=dict( + type='int', + ), + read_bytes_sec=dict( + type='int', + ), + write_bytes_sec=dict( + type='int', + ), + total_iops_sec=dict( + type='int', + ), + read_iops_sec=dict( + type='int', + ), + write_iops_sec=dict( + type='int', + ), + total_bytes_sec_max=dict( + type='int', + ), + read_bytes_sec_max=dict( + type='int', + ), + write_bytes_sec_max=dict( + type='int', + ), + total_iops_sec_max=dict( + type='int', + ), + read_iops_sec_max=dict( + type='int', + ), + write_iops_sec_max=dict( + type='int', + ), + size_iops_sec=dict( + type='int', + ), + ), + ), + permanently=dict( + type='bool', + default=False, + ), + shareable=dict( + type='bool', + default=False, + ), + reason=dict( + type='str', + default='Managed by Ansible decort_disk', + ), + state=dict( + type='str', + default='present', + choices=[ + 'absent', + 'present', + ], + ), + ), + supports_check_mode=True, + required_one_of=[ + ('id', 'name'), + ], ) def main(): - module_parameters = decort_disk.build_parameters() - - amodule = AnsibleModule(argument_spec=module_parameters, - supports_check_mode=True, - mutually_exclusive=[ - ['oauth2', 'password'], - ['password', 'jwt'], - ['jwt', 'oauth2'], - ], - required_together=[ - ['app_id', 'app_secret'], - ['user', 'password'], - ], - required_one_of=[ - ['id', 'name'], - ], - ) - - decon = decort_disk(amodule) + decon = decort_disk() + amodule = decon.amodule # #Full range of Disk status is as follows: # diff --git a/library/decort_group.py b/library/decort_group.py index 7126e8a..7c7a24a 100644 --- a/library/decort_group.py +++ b/library/decort_group.py @@ -13,8 +13,10 @@ from ansible.module_utils.decort_utils import * class decort_group(DecortController): - def __init__(self,arg_amodule): - super(decort_group, self).__init__(arg_amodule) + def __init__(self): + super(decort_group, self).__init__(AnsibleModule(**self.amodule_init_args)) + arg_amodule = self.amodule + self.group_should_exist = False validated_bservice_id = None #find and validate B-Service @@ -169,95 +171,106 @@ class decort_group(DecortController): ret_dict['state'] = self.group_info['status'] ret_dict['Computes'] = self.group_info['computes'] return ret_dict - @staticmethod - def build_parameters(): - return dict( - account_id=dict(type='int', required=False), - account_name=dict(type='str', required=False, default=''), - app_id=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_ID'])), - app_secret=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_SECRET']), - no_log=True), - authenticator=dict(type='str', - required=True, - choices=['legacy', 'oauth2', 'jwt']), - controller_url=dict(type='str', required=True), - jwt=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_JWT']), - no_log=True), - oauth2_url=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_OAUTH2_URL'])), - password=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_PASSWORD']), - no_log=True), - state=dict(type='str', + + @property + def amodule_init_args(self) -> dict: + return self.pack_amodule_init_args( + argument_spec=dict( + account_id=dict( + type='int', + ), + account_name=dict( + type='str', + default='', + ), + state=dict( + type='str', default='present', - choices=['absent', 'started', 'stopped', 'present','check']), - user=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_USER'])), - name=dict(type='str'), - id=dict(type='int', required=False), - image_id=dict(type='int', required=False), - image_name=dict(type='str', required=False), - driver=dict(type='str', required=False, choices=['KVM_X86', 'SVA_KVM_X86'], default="KVM_X86"), - boot_disk=dict(type='int', required=False), - bservice_id=dict(type='int', required=True), - count=dict(type='int'), - timeoutStart=dict(type='int', required=False), - role=dict(type='str', required=False), - cpu=dict(type='int', required=False), - ram=dict(type='int', required=False), - networks=dict( - type='list', elements='dict', - options=dict( - type=dict( - type='str', - required=True, - choices=['VINS', 'EXTNET'] - ), - id=dict( - type='int', - required=True + choices=[ + 'absent', + 'started', + 'stopped', + 'present', + 'check', + ], + ), + name=dict( + type='str', + ), + id=dict( + type='int', + ), + image_id=dict( + type='int', + ), + image_name=dict( + type='str', + ), + driver=dict( + type='str', + choices=[ + 'KVM_X86', + 'SVA_KVM_X86', + ], + default='KVM_X86', + ), + boot_disk=dict( + type='int', + ), + bservice_id=dict( + type='int', + required=True, + ), + count=dict( + type='int', + ), + timeoutStart=dict( + type='int', + ), + role=dict( + type='str', + ), + cpu=dict( + type='int', + ), + ram=dict( + type='int', + ), + networks=dict( + type='list', + elements='dict', + options=dict( + type=dict( + type='str', + required=True, + choices=[ + 'VINS', + 'EXTNET', + ] + ), + id=dict( + type='int', + required=True, + ) ) - ) + ), ), - verify_ssl=dict(type='bool', required=False, default=True), - workflow_callback=dict(type='str', required=False), - workflow_context=dict(type='str', required=False),) -def main(): - module_parameters = decort_group.build_parameters() - - amodule = AnsibleModule(argument_spec=module_parameters, - supports_check_mode=True, - mutually_exclusive=[ - ['oauth2', 'password'], - ['password', 'jwt'], - ['jwt', 'oauth2'], - ], - required_together=[ - ['app_id', 'app_secret'], - ['user', 'password'], - ], - required_one_of=[ - ['id', 'name'], - ['id', 'networks'], - ['id', 'count'], - ['id', 'cpu'], - ['id', 'ram'], - ['id', 'boot_disk'], - ['id', 'image_id'], - ['id', 'driver'], - ], - ) + supports_check_mode=True, + required_one_of=[ + ('id', 'name'), + ('id', 'networks'), + ('id', 'count'), + ('id', 'cpu'), + ('id', 'ram'), + ('id', 'boot_disk'), + ('id', 'image_id'), + ('id', 'driver'), + ], + ) - subj = decort_group(amodule) +def main(): + subj = decort_group() + amodule = subj.amodule if amodule.params['state'] == 'check': subj.result['changed'] = False diff --git a/library/decort_jwt.py b/library/decort_jwt.py index 23b7713..30c3099 100644 --- a/library/decort_jwt.py +++ b/library/decort_jwt.py @@ -7,76 +7,32 @@ module: decort_jwt description: See L(Module Documentation,https://repository.basistech.ru/BASIS/decort-ansible/wiki/Home). ''' -import requests - from ansible.module_utils.basic import AnsibleModule -from ansible.module_utils.basic import env_fallback - +from ansible.module_utils.decort_utils import DecortController -def decort_jwt_parameters(): - """Build and return a dictionary of parameters expected by decort_jwt module in a form accepted - by AnsibleModule utility class""" - return dict( - app_id=dict(type='str', - required=True, - fallback=(env_fallback, ['DECORT_APP_ID'])), - app_secret=dict(type='str', - required=True, - fallback=(env_fallback, ['DECORT_APP_SECRET']), - no_log=True), - oauth2_url=dict(type='str', - required=True, - fallback=(env_fallback, ['DECORT_OAUTH2_URL'])), - validity=dict(type='int', - required=False, - default=3600), - verify_ssl=dict(type='bool', required=False, default=True), - workflow_callback=dict(type='str', required=False), - workflow_context=dict(type='str', required=False), - ) +class DecortJWT(DecortController): + def __init__(self): + super().__init__(AnsibleModule(**self.amodule_init_args)) -def main(): - module_parameters = decort_jwt_parameters() + @property + def amodule_init_args(self) -> dict: + amodule_init_args = self.common_amodule_init_args + amodule_argument_spec = amodule_init_args['argument_spec'] + del amodule_argument_spec['controller_url'] + del amodule_argument_spec['jwt'] + amodule_argument_spec['authenticator']['choices'].remove('jwt') - amodule = AnsibleModule(argument_spec=module_parameters, - supports_check_mode=True,) + return amodule_init_args - result = {'failed': False, 'changed': False} + def run(self): + self.result['jwt'] = self.jwt + self.amodule.exit_json(**self.result) - token_get_url = amodule.params['oauth2_url'] + "/v1/oauth/access_token" - req_data = dict(grant_type="client_credentials", - client_id=amodule.params['app_id'], - client_secret=amodule.params['app_secret'], - response_type="id_token", - validity=amodule.params['validity'],) - # TODO: Need standard code snippet to handle server timeouts gracefully - # Consider a few retries before giving up or use requests.Session & requests.HTTPAdapter - # see https://stackoverflow.com/questions/15431044/can-i-set-max-retries-for-requests-request - # catch requests.exceptions.ConnectionError to handle incorrect oauth2_url case - try: - token_get_resp = requests.post(token_get_url, data=req_data, verify=amodule.params['verify_ssl']) - except requests.exceptions.ConnectionError as errco: - result.update(failed=True) - result['msg'] = "Failed to connect to {}: {}".format(token_get_url, errco) - amodule.fail_json(**result) - except requests.exceptions.Timeout as errti: - result.update(failed=True) - result['msg'] = "Timeout when trying to connect to {}: {}".format(token_get_url, errti) - amodule.fail_json(**result) - - # alternative -- if resp == requests.codes.ok - if token_get_resp.status_code != 200: - result.update(failed=True) - result['msg'] = "Failed to obtain JWT access token from oauth2_url {} for app_id {}: {} {}".format( - token_get_url, amodule.params['app_id'], - token_get_resp.status_code, token_get_resp.reason) - amodule.fail_json(**result) +def main(): + DecortJWT().run() - # Common return values: https://docs.ansible.com/ansible/2.3/common_return_values.html - result['jwt'] = token_get_resp.content.decode('utf8') - amodule.exit_json(**result) if __name__ == '__main__': main() diff --git a/library/decort_k8s.py b/library/decort_k8s.py index 5aeafeb..b4cd6e6 100644 --- a/library/decort_k8s.py +++ b/library/decort_k8s.py @@ -14,8 +14,9 @@ from copy import deepcopy class decort_k8s(DecortController): - def __init__(self,arg_amodule): - super(decort_k8s, self).__init__(arg_amodule) + def __init__(self): + super(decort_k8s, self).__init__(AnsibleModule(**self.amodule_init_args)) + arg_amodule = self.amodule validated_acc_id = 0 validated_rg_id = 0 @@ -253,146 +254,196 @@ class decort_k8s(DecortController): return - @staticmethod - def build_parameters(): - return dict( - account_id=dict(type='int', required=False), - account_name=dict(type='str', required=False, default=''), - app_id=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_ID'])), - app_secret=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_SECRET']), - no_log=True), - authenticator=dict(type='str', - required=True, - choices=['legacy', 'oauth2', 'jwt']), - controller_url=dict(type='str', required=True), - # datacenter=dict(type='str', required=False, default=''), - jwt=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_JWT']), - no_log=True), - oauth2_url=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_OAUTH2_URL'])), - password=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_PASSWORD']), - no_log=True), - quotas=dict(type='dict', required=False), - state=dict(type='str', + @property + def amodule_init_args(self) -> dict: + return self.pack_amodule_init_args( + argument_spec=dict( + account_id=dict( + type='int', + ), + account_name=dict( + type='str', + default='', + ), + quotas=dict( + type='dict', + ), + state=dict( + type='str', default='present', - choices=['absent', 'disabled', 'enabled', 'present','check']), - permanent=dict(type='bool', default=False), - started=dict(type='bool', default=True), - user=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_USER'])), - name=dict(type='str', required=False, default=""), - id=dict(type='int', required=False), - getConfig=dict(type='bool',required=False, default=False), - rg_id=dict(type='int', default=0), - rg_name=dict(type='str',default=""), - vins_id=dict(type='int', required=False,default=None), - k8ci_id=dict(type='int'), - network_plugin=dict(type='str',required=False,default="flannel"), - master_count=dict(type='int', default=1), - master_cpu=dict(type='int', default=2), - master_ram=dict(type='int', default=2048), - master_disk=dict(type='int', default=10), - master_sepid=dict(type='int', required=False, default=None), - master_pool=dict(type='str', required=False, default=None), - workers=dict( - type='list', - elements='dict', - options=dict( - name=dict( - type='str', - required=True, - ), - num=dict( - type='int', - ), - cpu=dict( - type='int', - ), - ram=dict( - type='int', - ), - disk=dict( - type='int', - ), - sep_id=dict( - type='int', - ), - pool=dict( - type='str', - ), - annotations=dict( - type='list', - elements='str', - ), - ci_user_data=dict( - type='dict', - ), - labels=dict( - type='list', - elements='str', - ), - taints=dict( - type='list', - elements='str', - ), - chipset=dict( - type='str', - choices=['Q35', 'i440fx'], + choices=[ + 'absent', + 'disabled', + 'enabled', + 'present', + 'check', + ], + ), + permanent=dict( + type='bool', + default=False, + ), + started=dict( + type='bool', + default=True, + ), + name=dict( + type='str', + default='', + ), + id=dict( + type='int', + ), + getConfig=dict( + type='bool', + default=False, + ), + rg_id=dict( + type='int', + default=0, + ), + rg_name=dict( + type='str', + default='', + ), + vins_id=dict( + type='int', + ), + k8ci_id=dict( + type='int', + ), + network_plugin=dict( + type='str', + default='flannel', + ), + master_count=dict( + type='int', + default=1, + ), + master_cpu=dict( + type='int', + default=2, + ), + master_ram=dict( + type='int', + default=2048, + ), + master_disk=dict( + type='int', + default=10, + ), + master_sepid=dict( + type='int', + ), + master_pool=dict( + type='str', + ), + workers=dict( + type='list', + elements='dict', + options=dict( + name=dict( + type='str', + required=True, + ), + num=dict( + type='int', + ), + cpu=dict( + type='int', + ), + ram=dict( + type='int', + ), + disk=dict( + type='int', + ), + sep_id=dict( + type='int', + ), + pool=dict( + type='str', + ), + annotations=dict( + type='list', + elements='str', + ), + ci_user_data=dict( + type='dict', + ), + labels=dict( + type='list', + elements='str', + ), + taints=dict( + type='list', + elements='str', + ), + chipset=dict( + type='str', + choices=['Q35', 'i440fx'], + ), ), ), + workers_metadata=dict( + type='bool', + default=False, + ), + extnet_id=dict( + type='int', + default=0, + ), + description=dict( + type='str', + default='Created by decort ansible module', + ), + with_lb=dict( + type='bool', + default=True, + ), + ha_lb=dict( + type='bool', + default=False, + ), + extnet_only=dict( + type='bool', + default=False, + ), + additionalSANs=dict( + type='list', + ), + init_conf=dict( + type='dict', + ), + cluster_conf=dict( + type='dict', + ), + kublet_conf=dict( + type='dict', + ), + kubeproxy_conf=dict( + type='dict', + ), + join_conf=dict( + type='dict', + ), + oidc_cert=dict( + type='raw', + ), + master_chipset=dict( + type='str', + choices=['Q35', 'i440fx'], + ), ), - workers_metadata=dict(type='bool',required=False,default=False), - extnet_id=dict(type='int', default=0), - description=dict(type='str', default="Created by decort ansible module"), - with_lb=dict(type='bool', default=True), - ha_lb=dict(type='bool', default=False), - extnet_only=dict(type='bool', default=False), - additionalSANs=dict(type='list',required=False, default=None), - init_conf=dict(type='dict', required=False, default=None), - cluster_conf=dict(type='dict', required=False, default=None), - kublet_conf=dict(type='dict', required=False, default=None), - kubeproxy_conf=dict(type='dict', required=False, default=None), - join_conf=dict(type='dict', required=False, default=None), - oidc_cert=dict(type='raw',required=False,default=None), - verify_ssl=dict(type='bool', required=False, default=True), - workflow_callback=dict(type='str', required=False), - workflow_context=dict(type='str', required=False), - master_chipset=dict( - type='str', - choices=['Q35', 'i440fx'], - ), + supports_check_mode=True, + required_one_of=[ + ('id', 'name'), + ], ) def main(): - module_parameters = decort_k8s.build_parameters() - - amodule = AnsibleModule(argument_spec=module_parameters, - supports_check_mode=True, - mutually_exclusive=[ - ['oauth2', 'password'], - ['password', 'jwt'], - ['jwt', 'oauth2'], - ], - required_together=[ - ['app_id', 'app_secret'], - ['user', 'password'], - ], - required_one_of=[ - ['id', 'name'], - ], - ) - - subj = decort_k8s(amodule) + subj = decort_k8s() + amodule = subj.amodule if amodule.params['state'] == 'check': subj.result['changed'] = False diff --git a/library/decort_kvmvm.py b/library/decort_kvmvm.py index fe421ab..697e268 100644 --- a/library/decort_kvmvm.py +++ b/library/decort_kvmvm.py @@ -13,9 +13,10 @@ from ansible.module_utils.decort_utils import * class decort_kvmvm(DecortController): - def __init__(self, arg_amodule): + def __init__(self): # call superclass constructor first - super(decort_kvmvm, self).__init__(arg_amodule) + super(decort_kvmvm, self).__init__(AnsibleModule(**self.amodule_init_args)) + arg_amodule = self.amodule self.check_amodule_args() @@ -27,6 +28,7 @@ class decort_kvmvm(DecortController): self.comp_info = None self.acc_id = 0 self.rg_id = 0 + self.aparam_image = None validated_acc_id =0 validated_rg_id = 0 @@ -122,17 +124,36 @@ class decort_kvmvm(DecortController): cannot be implemented using Ansible Argument spec. """ - # Check parameter "networks" for DPDK type + # Check parameter "networks" aparam_nets = self.aparams['networks'] if aparam_nets: + check_error = False net_types = {net['type'] for net in aparam_nets} - DPDK = 'DPDK' - if DPDK in net_types and not net_types.issubset({'DPDK', 'EMPTY'}): - self.message( - 'Check for parameter "networks" failed: a compute cannot' - ' be connected to a DPDK network and a network of another' - ' type at the same time.' - ) + # DPDK and other networks + if self.VMNetType.DPDK.value in net_types: + if not net_types.issubset( + {self.VMNetType.DPDK.value, self.VMNetType.EMPTY.value} + ): + check_error = True + self.message( + 'Check for parameter "networks" failed:' + ' a compute cannot be connected to a DPDK network and' + ' a network of another type at the same time.' + ) + # MTU for non-DPDK networks + for net in aparam_nets: + if ( + net['type'] != self.VMNetType.DPDK.value + and net['mtu'] is not None + ): + check_error = True + self.message( + 'Check for parameter "networks" failed:' + ' MTU can be specifed only for DPDK network' + ' (remove parameter "mtu" for network' + f' {net["type"]} with ID {net["id"]}).' + ) + if check_error: self.exit(fail=True) aparam_custom_fields = self.aparams['custom_fields'] @@ -197,17 +218,7 @@ class decort_kvmvm(DecortController): validated_bdisk_size = self.amodule.params['boot_disk'] or 0 image_id, image_facts = None, None - if ( - self.amodule.params['image_id'] is None - and self.amodule.params['image_name'] is None - ): - if self.amodule.params['state'] not in ('poweredoff', 'halted'): - self.result['msg'] = ( - '"state" parameter for a blank Compute must be either ' - '"poweredoff" or "halted".' - ) - self.exit(fail=True) - else: + if self.aparam_image: # either image_name or image_id must be present if ( self.check_amodule_argument('image_id', abort=False) @@ -242,7 +253,7 @@ class decort_kvmvm(DecortController): # # Once this "feature" is fixed, make sure VM is created according to the actual desired state # - start_compute = False # change this once a workaround for the aforementioned libvirt "feature" is implemented + start_compute = False # change this once a workaround for the aforementioned libvirt "feature" is implemented if self.amodule.params['state'] in ('halted', 'poweredoff'): start_compute = False @@ -331,8 +342,9 @@ class decort_kvmvm(DecortController): self.amodule.params['aaff_rule'], label=self.amodule.params['affinity_label'],) # NOTE: see NOTE above regarding libvirt "feature" and new VMs created in HALTED state - if self.amodule.params['state'] not in ('halted', 'poweredoff'): - self.compute_powerstate(self.comp_info, 'started') + if self.aparam_image: + if self.amodule.params['state'] not in ('halted', 'poweredoff'): + self.compute_powerstate(self.comp_info, 'started') if self.aparams['custom_fields'] is None: custom_fields_disable = True @@ -352,7 +364,13 @@ class decort_kvmvm(DecortController): need_custom_fields=True, ) - self.skip_final_get = True + if self.compute_update_args: + self.compute_update( + compute_id=self.comp_info['id'], + **self.compute_update_args, + ) + else: + self.skip_final_get = True return @@ -446,6 +464,7 @@ class decort_kvmvm(DecortController): 'hp_backed': 'hpBacked', 'numa_affinity': 'numaAffinity', 'description': 'desc', + 'auto_start': 'autoStart', } for param_name, comp_field_name in params_to_check.items(): aparam_value = self.amodule.params[param_name] @@ -457,7 +476,6 @@ class decort_kvmvm(DecortController): return result_args - def package_facts(self, check_mode=False): """Package a dictionary of KVM VM facts according to the decort_kvmvm module specification. This dictionary will be returned to the upstream Ansible engine at the completion of decort_kvmvm @@ -492,6 +510,7 @@ class decort_kvmvm(DecortController): hp_backed="", numa_affinity="", custom_fields={}, + vnc_password="", ) if check_mode or self.comp_info is None: @@ -554,14 +573,36 @@ class decort_kvmvm(DecortController): ret_dict['custom_fields'] = self.comp_info['custom_fields'] + ret_dict['vnc_password'] = self.comp_info['vncPasswd'] + + ret_dict['auto_start'] = self.comp_info['autoStart'] + return ret_dict def check_amodule_args_for_create(self): # Check for unacceptable parameters for a blank Compute if ( - self.aparams['image_id'] is None - and self.aparams['image_name'] is None + self.aparams['image_id'] is not None + or self.aparams['image_name'] is not None ): + self.aparam_image = True + else: + self.aparam_image = False + if ( + self.aparams['state'] is not None + and self.aparams['state'] not in ( + 'present', + 'poweredoff', + 'halted', + ) + ): + self.message( + 'Check for parameter "state" failed: ' + 'state for a blank Compute must be either ' + '"present", "poweredoff" or "halted".' + ) + self.exit(fail=True) + for parameter in ( 'ssh_key', 'ssh_key_user', @@ -586,130 +627,175 @@ class decort_kvmvm(DecortController): ) self.exit(fail=True) - @staticmethod - def build_parameters(): - """Build and return a dictionary of parameters expected by decort_kvmvm module in a form - accepted by AnsibleModule utility class. - This dictionary is then used y AnsibleModule class instance to parse and validate parameters - passed to the module from the playbook. - """ - - return dict( - account_id=dict(type='int', required=False, default=0), - account_name=dict(type='str', required=False, default=''), - description=dict(type='str', required=False), - app_id=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_ID'])), - app_secret=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_SECRET']), - no_log=True), - authenticator=dict(type='str', - required=True, - choices=['legacy', 'oauth2', 'jwt']), - boot_disk=dict(type='int', required=False), - sep_id=dict(type='int', required=False), - pool=dict(type='str', required=False), - controller_url=dict(type='str', required=True), - # count=dict(type='int', required=False, default=1), - cpu=dict(type='int', required=False), - # datacenter=dict(type='str', required=False, default=''), - data_disks=dict(type='list', required=False), # list of integer disk IDs - id=dict(type='int', required=False, default=0), - image_id=dict(type='int', required=False), - image_name=dict(type='str', required=False), - jwt=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_JWT']), - no_log=True), - name=dict(type='str'), - networks=dict( - type='list', - elements='dict', - options=dict( - type=dict( - type='str', - required=True, - choices=[ - 'VINS', - 'EXTNET', - 'VFNIC', - 'DPDK', - 'EMPTY', - ], - ), - id=dict( - type='int', - ), - ip_addr=dict( - type='str', - ), + @property + def amodule_init_args(self) -> dict: + return self.pack_amodule_init_args( + argument_spec=dict( + account_id=dict( + type='int', + default=0, ), - required_if=[ - ('type', 'VINS', ('id',)), - ('type', 'EXTNET', ('id',)), - ('type', 'VFNIC', ('id',)), - ('type', 'DPDK', ('id',)), - ], - ), - network_order_changing=dict( - type='bool', - default=False, - ), - oauth2_url=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_OAUTH2_URL'])), - password=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_PASSWORD']), - no_log=True), - ram=dict(type='int', required=False), - rg_id=dict(type='int', default=0), - rg_name=dict(type='str', default=""), - ssh_key=dict(type='str', required=False), - ssh_key_user=dict(type='str', required=False), - tag=dict(type='dict', required=False), - affinity_label=dict(type='str', required=False), - aff_rule=dict(type='list', required=False), - aaff_rule=dict(type='list', required=False), - ci_user_data=dict(type='dict', required=False), - state=dict(type='str', - default='present', - choices=['absent', 'paused', 'poweredoff', 'halted', 'poweredon', 'present', 'check']), - tags=dict(type='str', required=False), - user=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_USER'])), - verify_ssl=dict(type='bool', required=False, default=True), - # wait_for_ip_address=dict(type='bool', required=False, default=False), - workflow_callback=dict(type='str', required=False), - workflow_context=dict(type='str', required=False), - chipset=dict( - type='str', - choices=['Q35', 'i440fx'] - ), - cpu_pin=dict( - type='bool', - ), - hp_backed=dict( - type='bool', - ), - numa_affinity=dict( - type='str', - choices=['strict', 'loose', 'none'], - ), - custom_fields=dict( - type='dict', - options=dict( - fields=dict( - type='dict', + account_name=dict( + type='str', + default='', + ), + description=dict( + type='str', + ), + boot_disk=dict( + type='int', + ), + sep_id=dict( + type='int', + ), + pool=dict( + type='str', + ), + controller_url=dict( + type='str', + required=True, + ), + cpu=dict( + type='int', + ), + data_disks=dict( # list of integer disk IDs + type='list', + ), + id=dict( + type='int', + default=0, + ), + image_id=dict( + type='int', + ), + image_name=dict( + type='str', + ), + name=dict( + type='str', + ), + networks=dict( + type='list', + elements='dict', + options=dict( + type=dict( + type='str', + required=True, + choices=[ + 'VINS', + 'EXTNET', + 'VFNIC', + 'DPDK', + 'EMPTY', + ], + ), + id=dict( + type='int', + ), + ip_addr=dict( + type='str', + ), + mtu=dict( + type='int', + ), ), - disable=dict( - type='bool', + required_if=[ + ('type', 'VINS', ('id',)), + ('type', 'EXTNET', ('id',)), + ('type', 'VFNIC', ('id',)), + ('type', 'DPDK', ('id',)), + ], + ), + network_order_changing=dict( + type='bool', + default=False, + ), + ram=dict( + type='int', + ), + rg_id=dict( + type='int', + default=0, + ), + rg_name=dict( + type='str', + default='', + ), + ssh_key=dict( + type='str', + ), + ssh_key_user=dict( + type='str', + ), + tag=dict( + type='dict', + ), + affinity_label=dict( + type='str', + ), + aff_rule=dict( + type='list', + ), + aaff_rule=dict( + type='list', + ), + ci_user_data=dict( + type='dict', + ), + state=dict( + type='str', + choices=[ + 'absent', + 'paused', + 'poweredoff', + 'halted', + 'poweredon', + 'present', + ], + ), + tags=dict( + type='str', + ), + chipset=dict( + type='str', + choices=[ + 'Q35', + 'i440fx', + ] + ), + cpu_pin=dict( + type='bool', + ), + hp_backed=dict( + type='bool', + ), + numa_affinity=dict( + type='str', + choices=[ + 'strict', + 'loose', + 'none', + ], + ), + custom_fields=dict( + type='dict', + options=dict( + fields=dict( + type='dict', + ), + disable=dict( + type='bool', + ), ), ), + auto_start=dict( + type='bool', + ) ), + supports_check_mode=True, + required_one_of=[ + ('id', 'name'), + ], ) def check_amodule_args_for_change(self): @@ -734,6 +820,17 @@ class decort_kvmvm(DecortController): ) self.exit(fail=True) + if ( + not self.comp_info['imageId'] + and self.amodule.params['state'] in ('poweredon', 'paused') + ): + self.message( + 'Check for parameter "state" failed: ' + 'state for a blank Compute can not be "poweredon" or "paused".' + ) + self.exit(fail=True) + + # Workflow digest: # 1) authenticate to DECORT controller & validate authentication by issuing API call - done when creating DECSController # 2) check if the VM with the specified id or rg_name:name exists @@ -747,49 +844,10 @@ class decort_kvmvm(DecortController): # 6) report result to Ansible def main(): - module_parameters = decort_kvmvm.build_parameters() - - amodule = AnsibleModule(argument_spec=module_parameters, - supports_check_mode=True, - mutually_exclusive=[ - ['oauth2', 'password'], - ['password', 'jwt'], - ['jwt', 'oauth2'], - ], - required_together=[ - ['app_id', 'app_secret'], - ['user', 'password'], - ], - required_one_of=[ - ['id', 'name'], - ], - ) - # Initialize DECORT KVM VM instance object # This object does not necessarily represent an existing KVM VM - subj = decort_kvmvm(amodule) - - # handle state=check before any other logic - if amodule.params['state'] == 'check': - subj.result['changed'] = False - if subj.comp_id: - # Compute is found - package facts and report success to Ansible - subj.result['failed'] = False - # _, subj.comp_info, _ = subj.compute_find(comp_id=subj.comp_id) - # _, rg_facts = subj.rg_find(arg_account_id=0, arg_rg_id=subj.rg_id) - subj.result['facts'] = subj.package_facts(amodule.check_mode) - amodule.exit_json(**subj.result) - # we exit the module at this point - else: - subj.result['failed'] = True - subj.result['msg'] = ("Cannot locate Compute name '{}'. Other arguments are: Compute ID {}, " - "RG name '{}', RG ID {}, Account '{}'.").format(amodule.params['name'], - amodule.params['id'], - amodule.params['rg_name'], - amodule.params['rg_id'], - amodule.params['account_name']) - amodule.fail_json(**subj.result) - pass + subj = decort_kvmvm() + amodule = subj.amodule if subj.comp_id: subj.check_amodule_args_for_change() @@ -800,8 +858,14 @@ def main(): elif subj.comp_info['status'] in ("ENABLED", "DISABLED"): if amodule.params['state'] == 'absent': subj.destroy() - elif amodule.params['state'] in ('present', 'paused', 'poweredon', 'poweredoff', 'halted'): - subj.compute_powerstate(subj.comp_info, amodule.params['state']) + else: + if amodule.params['state'] in ( + 'paused', 'poweredon', 'poweredoff', 'halted' + ): + subj.compute_powerstate( + comp_facts=subj.comp_info, + target_state=amodule.params['state'], + ) subj.modify(arg_wait_cycles=7) elif subj.comp_info['status'] == "DELETED": if amodule.params['state'] in ('present', 'poweredon'): @@ -830,13 +894,16 @@ def main(): else: subj.check_amodule_args_for_create() + state = amodule.params['state'] + if state is None: + state = 'present' # Preexisting Compute of specified identity was not found. # If requested state is 'absent' - nothing to do - if amodule.params['state'] == 'absent': + if state == 'absent': subj.nop() - elif amodule.params['state'] in ('present', 'poweredon', 'poweredoff', 'halted'): + elif state in ('present', 'poweredon', 'poweredoff', 'halted'): subj.create() # this call will also handle data disk & network connection - elif amodule.params['state'] == 'paused': + elif state == 'paused': subj.error() if subj.result['failed']: diff --git a/library/decort_lb.py b/library/decort_lb.py index dced4a6..f114820 100644 --- a/library/decort_lb.py +++ b/library/decort_lb.py @@ -13,8 +13,9 @@ from ansible.module_utils.decort_utils import * class decort_lb(DecortController): - def __init__(self,arg_amodule) -> None: - super(decort_lb,self).__init__(arg_amodule) + def __init__(self) -> None: + super(decort_lb,self).__init__(AnsibleModule(**self.amodule_init_args)) + arg_amodule = self.amodule self.lb_id = 0 self.lb_facts = None @@ -216,83 +217,93 @@ class decort_lb(DecortController): ret_dict['backends'] = self.lb_facts['backends'] ret_dict['frontends'] = self.lb_facts['frontends'] return ret_dict - @staticmethod - def build_parameters(): - """Build and return a dictionary of parameters expected by decort_vins module in a form accepted - by AnsibleModule utility class.""" - return dict( - account_id=dict(type='int', required=False), - account_name=dict(type='str', required=False, default=''), - description=dict(type='str', required=False, default='Managed by Ansible module decort_lb'), - app_id=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_ID'])), - app_secret=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_SECRET']), - no_log=True), - authenticator=dict(type='str', - required=True, - choices=['legacy', 'oauth2', 'jwt']), - controller_url=dict(type='str', required=True), - # datacenter=dict(type='str', required=False, default=''), - ext_net_id=dict(type='int', required=False, default=-1), - ext_ip_addr=dict(type='str', required=False, default=''), - jwt=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_JWT']), - no_log=True), - oauth2_url=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_OAUTH2_URL'])), - password=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_PASSWORD']), - no_log=True), - state=dict(type='str', + @property + def amodule_init_args(self) -> dict: + return self.pack_amodule_init_args( + argument_spec=dict( + account_id=dict( + type='int', + ), + account_name=dict( + type='str', + default='', + ), + description=dict( + type='str', + default='Managed by Ansible module decort_lb', + ), + ext_net_id=dict( + type='int', + default=-1, + ), + ext_ip_addr=dict( + type='str', + default='', + ), + state=dict( + type='str', default='present', - choices=['absent', 'disabled', 'enabled', 'present','restart']), - user=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_USER'])), - rg_id=dict(type='int', required=False, default=0), - rg_name=dict(type='str', required=False, default=''), - vins_name=dict(type='str', required=False, default=''), - vins_id=dict(type='int', required=False, default=0), - verify_ssl=dict(type='bool', required=False, default=True), - lb_id=dict(type='int', required=False, default=0), - lb_name=dict(type='str'), - ha_lb=dict(type='bool', required=False, default=False), - backends=dict(type='list',required=False), - frontends=dict(type='list',required=False), - servers=dict(type='list',required=False), - permanently=dict(type='bool', required=False, default=False), - workflow_callback=dict(type='str', required=False), - workflow_context=dict(type='str', required=False), + choices=[ + 'absent', + 'disabled', + 'enabled', + 'present', + 'restart', + ], + ), + rg_id=dict( + type='int', + default=0, + ), + rg_name=dict( + type='str', + default='', + ), + vins_name=dict( + type='str', + default='', + ), + vins_id=dict( + type='int', + default=0, + ), + lb_id=dict( + type='int', + default=0, + ), + lb_name=dict( + type='str', + ), + ha_lb=dict( + type='bool', + default=False, + ), + backends=dict( + type='list', + ), + frontends=dict( + type='list', + ), + servers=dict( + type='list', + ), + permanently=dict( + type='bool', + default=False, + ), + ), + supports_check_mode=True, + required_one_of=[ + ('rg_id', 'rg_name'), + ('lb_id', 'lb_name'), + ('vins_id', 'vins_name'), + ], ) def main(): - module_parameters = decort_lb.build_parameters() - - amodule = AnsibleModule(argument_spec=module_parameters, - supports_check_mode=True, - mutually_exclusive=[ - ['oauth2', 'password'], - ['password', 'jwt'], - ['jwt', 'oauth2'], - ], - required_together=[ - ['app_id', 'app_secret'], - ['user', 'password'] - ], - required_one_of=[ - ['rg_id','rg_name'], - ['lb_id','lb_name'], - ['vins_id','vins_name'] - ] - ) - decon = decort_lb(amodule) + decon = decort_lb() + amodule = decon.amodule if decon.lb_id: if decon.lb_facts['status'] in ["MODELED", "DISABLING", "ENABLING", "DELETING","DESTROYING","RESTORING"]: decon.result['failed'] = True diff --git a/library/decort_osimage.py b/library/decort_osimage.py index 6fa7704..2b1a67f 100644 --- a/library/decort_osimage.py +++ b/library/decort_osimage.py @@ -14,8 +14,9 @@ from ansible.module_utils.decort_utils import * class decort_osimage(DecortController): - def __init__(self,amodule): - super(decort_osimage, self).__init__(amodule) + def __init__(self): + super(decort_osimage, self).__init__(AnsibleModule(**self.amodule_init_args)) + amodule = self.amodule self.validated_image_id = 0 self.validated_virt_image_id = 0 @@ -26,7 +27,7 @@ class decort_osimage(DecortController): self.validated_account_id, _ = self.account_find(amodule.params['account_name']) else: self.validated_account_id = amodule.params['account_Id'] - + if self.validated_account_id == 0: # we failed either to find or access the specified account - fail the module self.result['failed'] = True @@ -72,9 +73,9 @@ class decort_osimage(DecortController): def decort_image_create(self,amodule): # function that creates OS image - image_facts = self.image_create(img_name=self.validated_image_name, - url=amodule.params['url'], - gid=amodule.params['gid'], + image_facts = self.image_create(img_name=self.validated_image_name, + url=amodule.params['url'], + gid=amodule.params['gid'], boottype=amodule.params['boottype'], imagetype=amodule.params['imagetype'], hotresize=amodule.params['hotresize'], @@ -97,7 +98,7 @@ class decort_osimage(DecortController): self.result['msg'] = ("Image '{}' linked to virtual image '{}'").format(self.target_image_id, decort_osimage.decort_osimage_package_facts(image_facts)['id'],) return image_id, image_facts - + def decort_image_delete(self,amodule): # function that removes an image self.image_delete(imageId=amodule.image_id_delete) @@ -110,7 +111,7 @@ class decort_osimage(DecortController): image_id, image_facts = decort_osimage.decort_virt_image_find(self, amodule) self.result['facts'] = decort_osimage.decort_osimage_package_facts(image_facts, amodule.check_mode) return image_id, image_facts - + def decort_image_rename(self,amodule): # image renaming function image_facts = self.image_rename(imageId=self.validated_image_id, name=amodule.params['image_name']) @@ -149,7 +150,7 @@ class decort_osimage(DecortController): # if void facts provided - change state value to ABSENT and return ret_dict['state'] = "ABSENT" return ret_dict - + ret_dict['id'] = arg_osimage_facts['id'] ret_dict['name'] = arg_osimage_facts['name'] ret_dict['size'] = arg_osimage_facts['size'] @@ -162,84 +163,95 @@ class decort_osimage(DecortController): ret_dict['accountId'] = arg_osimage_facts['accountId'] return ret_dict - - def decort_osimage_parameters(): - """Build and return a dictionary of parameters expected by decort_osimage module in a form accepted - by AnsibleModule utility class.""" - - return dict( - app_id=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_ID'])), - app_secret=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_SECRET']), - no_log=True), - authenticator=dict(type='str', - required=True, - choices=['legacy', 'oauth2', 'jwt']), - controller_url=dict(type='str', required=True), - jwt=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_JWT']), - no_log=True), - oauth2_url=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_OAUTH2_URL'])), - password=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_PASSWORD']), - no_log=True), - pool=dict(type='str', required=False, default=""), - sep_id=dict(type='int', required=False, default=0), - account_name=dict(type='str', required=False), - account_Id=dict(type='int', required=False), - user=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_USER'])), - verify_ssl=dict(type='bool', required=False, default=True), - workflow_callback=dict(type='str', required=False), - workflow_context=dict(type='str', required=False), - image_name=dict(type='str', required=False), - image_id=dict(type='int', required=False,default=0), - virt_id=dict(type='int', required=False, default=0), - virt_name=dict(type='str', required=False), - state=dict(type='str', - default='present', - choices=['absent', 'present']), - drivers=dict(type='str', required=False, default="KVM_X86"), - imagetype=dict(type='str', required=False, default="linux"), - boottype=dict(type='str', required=False, default="uefi"), - url=dict(type='str', required=False), - gid=dict(type='int', required=False, default=0), - sepId=dict(type='int', required=False, default=0), - poolName=dict(type='str', required=False), - hotresize=dict(type='bool', required=False, default=False), - image_username=dict(type='str', required=False), - image_password=dict(type='str', required=False), - usernameDL=dict(type='str', required=False), - passwordDL=dict(type='str', required=False), + @property + def amodule_init_args(self) -> dict: + return self.pack_amodule_init_args( + argument_spec=dict( + pool=dict( + type='str', + default='', + ), + sep_id=dict( + type='int', + default=0, + ), + account_name=dict( + type='str', + ), + account_Id=dict( + type='int', + ), + image_name=dict( + type='str', + ), + image_id=dict( + type='int', + default=0, + ), + virt_id=dict( + type='int', + default=0, + ), + virt_name=dict( + type='str', + ), + state=dict( + type='str', + default='present', + choices=[ + 'absent', + 'present', + ], + ), + drivers=dict( + type='str', + default='KVM_X86', + ), + imagetype=dict( + type='str', + default='linux', + ), + boottype=dict( + type='str', + default='uefi', + ), + url=dict( + type='str', + ), + gid=dict( + type='int', + default=0, + ), + sepId=dict( + type='int', + default=0, + ), + poolName=dict( + type='str', + ), + hotresize=dict( + type='bool', + default=False, + ), + image_username=dict( + type='str', + ), + image_password=dict( + type='str', + ), + usernameDL=dict( + type='str', + ), + passwordDL=dict( + type='str', + ), + ), + supports_check_mode=True, ) - def main(): - module_parameters = decort_osimage.decort_osimage_parameters() - - amodule = AnsibleModule(argument_spec=module_parameters, - supports_check_mode=True, - mutually_exclusive=[ - ['oauth2', 'password'], - ['password', 'jwt'], - ['jwt', 'oauth2'], - ], - required_together=[ - ['app_id', 'app_secret'], - ['user', 'password'], - ], - ) - - decon = decort_osimage(amodule) - + decon = decort_osimage() + amodule = decon.amodule if amodule.params['virt_name'] or amodule.params['virt_id']: image_id, image_facts = decort_osimage.decort_virt_image_find(decon, amodule) diff --git a/library/decort_pfw.py b/library/decort_pfw.py index 3028fcf..34b7f03 100644 --- a/library/decort_pfw.py +++ b/library/decort_pfw.py @@ -8,106 +8,87 @@ description: See L(Module Documentation,https://repository.basistech.ru/BASIS/de ''' from ansible.module_utils.basic import AnsibleModule -from ansible.module_utils.basic import env_fallback from ansible.module_utils.decort_utils import * -def decort_pfw_package_facts(comp_facts, vins_facts, pfw_facts, check_mode=False): - """Package a dictionary of PFW rules facts according to the decort_pfw module specification. - This dictionary will be returned to the upstream Ansible engine at the completion of - the module run. +class decort_pfw(DecortController): + def __init__(self): + super(decort_pfw, self).__init__(AnsibleModule(**self.amodule_init_args)) + + @property + def amodule_init_args(self) -> dict: + return self.pack_amodule_init_args( + argument_spec=dict( + compute_id=dict( + type='int', + required=True, + ), + rules=dict( + type='list', + ), + state=dict( + type='str', + default='present', + choices=[ + 'absent', + 'present', + ], + ), + vins_id=dict( + type='int', + required=True, + ), + ), + supports_check_mode=True, + ) + + def decort_pfw_package_facts(self, comp_facts, vins_facts, pfw_facts, check_mode=False): + """Package a dictionary of PFW rules facts according to the decort_pfw module specification. + This dictionary will be returned to the upstream Ansible engine at the completion of + the module run. + + @param (dict) pfw_facts: dictionary with PFW facts as returned by API call to .../???/get + @param (bool) check_mode: boolean that tells if this Ansible module is run in check mode + """ + + ret_dict = dict(state="CHECK_MODE", + compute_id=0, + public_ip="", + rules=[], + vins_id=0, + ) + + if check_mode: + # in check mode return immediately with the default values + return ret_dict + + if pfw_facts is None: + # if void facts provided - change state value to ABSENT and return + ret_dict['state'] = "ABSENT" + return ret_dict + + ret_dict['compute_id'] = comp_facts['id'] + ret_dict['vins_id'] = vins_facts['id'] + ret_dict['public_ip'] = vins_facts['vnfs']['GW']['config']['ext_net_ip'] + + if len(pfw_facts) != 0: + ret_dict['state'] = 'PRESENT' + ret_dict['rules'] = pfw_facts + else: + ret_dict['state'] = 'ABSENT' - @param (dict) pfw_facts: dictionary with PFW facts as returned by API call to .../???/get - @param (bool) check_mode: boolean that tells if this Ansible module is run in check mode - """ - - ret_dict = dict(state="CHECK_MODE", - compute_id=0, - public_ip="", - rules=[], - vins_id=0, - ) - - if check_mode: - # in check mode return immediately with the default values return ret_dict - if pfw_facts is None: - # if void facts provided - change state value to ABSENT and return - ret_dict['state'] = "ABSENT" - return ret_dict + def decort_pfw_parameters(self): + """Build and return a dictionary of parameters expected by decort_pfw module in a form accepted + by AnsibleModule utility class.""" - ret_dict['compute_id'] = comp_facts['id'] - ret_dict['vins_id'] = vins_facts['id'] - ret_dict['public_ip'] = vins_facts['vnfs']['GW']['config']['ext_net_ip'] - - if len(pfw_facts) != 0: - ret_dict['state'] = 'PRESENT' - ret_dict['rules'] = pfw_facts - else: - ret_dict['state'] = 'ABSENT' - - return ret_dict - -def decort_pfw_parameters(): - """Build and return a dictionary of parameters expected by decort_pfw module in a form accepted - by AnsibleModule utility class.""" - - return dict( - app_id=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_ID'])), - app_secret=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_SECRET']), - no_log=True), - authenticator=dict(type='str', - required=True, - choices=['legacy', 'oauth2', 'jwt']), - compute_id=dict(type='int', required=True), - controller_url=dict(type='str', required=True), - jwt=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_JWT']), - no_log=True), - oauth2_url=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_OAUTH2_URL'])), - password=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_PASSWORD']), - no_log=True), - rules=dict(type='list', required=False), - state=dict(type='str', - default='present', - choices=['absent', 'present']), - user=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_USER'])), - verify_ssl=dict(type='bool', required=False, default=True), - vins_id=dict(type='int', required=True), - workflow_callback=dict(type='str', required=False), - workflow_context=dict(type='str', required=False), - ) + return def main(): - module_parameters = decort_pfw_parameters() - - amodule = AnsibleModule(argument_spec=module_parameters, - supports_check_mode=True, - mutually_exclusive=[ - ['oauth2', 'password'], - ['password', 'jwt'], - ['jwt', 'oauth2'], - ], - required_together=[ - ['app_id', 'app_secret'], - ['user', 'password'], - ], - ) - - decon = DecortController(amodule) + decon = decort_pfw() + amodule = decon.amodule pfw_facts = None # will hold PFW facts as returned by pfw_configure @@ -157,7 +138,7 @@ def main(): amodule.fail_json(**decon.result) else: # prepare PFW facts to be returned as part of decon.result and then call exit_json(...) - decon.result['facts'] = decort_pfw_package_facts(comp_facts, vins_facts, pfw_facts, amodule.check_mode) + decon.result['facts'] = decon.decort_pfw_package_facts(comp_facts, vins_facts, pfw_facts, amodule.check_mode) amodule.exit_json(**decon.result) if __name__ == "__main__": diff --git a/library/decort_rg.py b/library/decort_rg.py index 04dd72e..a961e0d 100644 --- a/library/decort_rg.py +++ b/library/decort_rg.py @@ -14,8 +14,9 @@ from ansible.module_utils.decort_utils import * class decort_rg(DecortController): - def __init__(self,amodule): - super(decort_rg, self).__init__(amodule) + def __init__(self): + super(decort_rg, self).__init__(AnsibleModule(**self.amodule_init_args)) + amodule = self.amodule self.validated_acc_id = 0 self.validated_rg_id = 0 @@ -237,81 +238,105 @@ class decort_rg(DecortController): return ret_dict - def parameters(): - """Build and return a dictionary of parameters expected by decort_rg module in a form accepted - by AnsibleModule utility class.""" - - return dict( - account_id=dict(type='int', required=False), - account_name=dict(type='str', required=False, default=''), - access=dict(type='dict'), - description=dict(type='str', required=False, default=''), - app_id=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_ID'])), - app_secret=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_SECRET']), - no_log=True), - authenticator=dict(type='str', - required=True, - choices=['legacy', 'oauth2', 'jwt']), - controller_url=dict(type='str', required=True), - # datacenter=dict(type='str', required=False, default=''), - def_netType=dict(type='str', choices=['PRIVATE','PUBLIC', 'NONE'], default='PRIVATE'), - def_netId=dict(type='int'), - extNetId=dict(type='int', default=0), - extNetIp=dict(type='str', default=""), - owner=dict(type='str', default=""), - ipcidr=dict(type='str', default=""), - jwt=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_JWT']), - no_log=True), - oauth2_url=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_OAUTH2_URL'])), - rename=dict(type='str', default=""), - password=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_PASSWORD']), - no_log=True), - quotas=dict(type='dict', required=False), - resType=dict(type='list'), - state=dict(type='str', - default='present', - choices=['absent', 'disabled', 'enabled', 'present']), - permanently=dict(type='bool', - default='False'), - user=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_USER'])), - rg_name=dict(type='str', required=False,), - rg_id=dict(type='int', required=False), - verify_ssl=dict(type='bool', required=False, default=True), - workflow_callback=dict(type='str', required=False), - workflow_context=dict(type='str', required=False), - sep_pools=dict( - type='list', - elements='dict', - options=dict( - sep_id=dict( - type='int', - required=True, - ), - pool_names=dict( - type='list', - required=True, - elements='str', + @property + def amodule_init_args(self) -> dict: + return self.pack_amodule_init_args( + argument_spec=dict( + account_id=dict( + type='int', + ), + account_name=dict( + type='str', + default='', + ), + access=dict( + type='dict', + ), + description=dict( + type='str', + default='', + ), + def_netType=dict( + type='str', + choices=[ + 'PRIVATE', + 'PUBLIC', + 'NONE', + ], + default='PRIVATE', + ), + def_netId=dict( + type='int', + ), + extNetId=dict( + type='int', + default=0, + ), + extNetIp=dict( + type='str', + default='', + ), + owner=dict( + type='str', + default='', + ), + ipcidr=dict( + type='str', + default='', + ), + rename=dict( + type='str', + default='', + ), + quotas=dict( + type='dict', + ), + resType=dict( + type='list', + ), + state=dict( + type='str', + default='present', + choices=[ + 'absent', + 'disabled', + 'enabled', + 'present', + ], + ), + permanently=dict( + type='bool', + default='False', + ), + rg_name=dict( + type='str', + ), + rg_id=dict( + type='int', + ), + sep_pools=dict( + type='list', + elements='dict', + options=dict( + sep_id=dict( + type='int', + required=True, + ), + pool_names=dict( + type='list', + required=True, + elements='str', + ), ), ), + recursive_deletion=dict( + type='bool', + default=False, + ) ), - recursive_deletion=dict( - type='bool', - default=False, - ) + supports_check_mode=True, ) - + # Workflow digest: # 1) authenticate to DECORT controller & validate authentication by issuing API call - done when creating DECORTController # 2) check if the RG with the specified id or rg_name:name exists @@ -320,22 +345,8 @@ class decort_rg(DecortController): # 5) report result to Ansible def main(): - module_parameters = decort_rg.parameters() - - amodule = AnsibleModule(argument_spec=module_parameters, - supports_check_mode=True, - mutually_exclusive=[ - ['oauth2', 'password'], - ['password', 'jwt'], - ['jwt', 'oauth2'], - ], - required_together=[ - ['app_id', 'app_secret'], - ['user', 'password'], - ], - ) - - decon = decort_rg(amodule) + decon = decort_rg() + amodule = decon.amodule #amodule.check_mode=True if decon.validated_rg_id > 0: if decon.rg_facts['status'] in ["MODELED", "DISABLING", "ENABLING", "DELETING", "DESTROYING", "CONFIRMED"]: diff --git a/library/decort_snapshot.py b/library/decort_snapshot.py new file mode 100644 index 0000000..01233c8 --- /dev/null +++ b/library/decort_snapshot.py @@ -0,0 +1,157 @@ +#!/usr/bin/python + +DOCUMENTATION = r''' +--- +module: decort_snapshot + +description: See L(Module Documentation,https://repository.basistech.ru/BASIS/decort-ansible/wiki/Home). +''' + +import time +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.decort_utils import DecortController + + +class DecortSnapshot(DecortController): + def __init__(self): + super().__init__(AnsibleModule(**self.amodule_init_args)) + self.check_amodule_args() + + self.aparams_label = self.aparams['label'] + self.aparams_vm_id = self.aparams['vm_id'] + + vm_id, vm_facts, _ = self._compute_get_by_id( + comp_id=self.aparams_vm_id, + ) + if not vm_id: + self.message(f'VM {self.aparams_vm_id} not found') + self.exit(fail=True) + + self.vm_name = vm_facts['name'] + self.vm_snapshots = vm_facts['snapSets'] + self.vm_snapshot_labels = [ + snapshot['label'] for snapshot in self.vm_snapshots + ] + + if ( + self.aparams_label is not None + and self.aparams_label not in self.vm_snapshot_labels + and self.aparams['state'] is None + ): + self.message( + f'Snapshot {self.aparams_label} ' + f'not found for VM {self.aparams_vm_id}' + ) + self.exit(fail=True) + + self.new_snapshot_label = None + if self.aparams['state'] == 'present': + if self.aparams_label is None: + self.new_snapshot_label = ( + f'{self.vm_name}_{self.sec_to_dt_str(time.time())}' + ) + elif self.aparams_label not in self.vm_snapshot_labels: + self.new_snapshot_label = self.aparams_label + + @property + def amodule_init_args(self) -> dict: + return self.pack_amodule_init_args( + argument_spec=dict( + label=dict( + type='str', + ), + state=dict( + type='str', + choices=( + 'absent', + 'present', + ), + ), + usage=dict( + type='bool', + default=False, + ), + vm_id=dict( + type='int', + required=True, + ), + ), + supports_check_mode=True, + required_if=[ + ('state', 'absent', ('label',)), + ], + required_one_of=[ + ('label', 'state'), + ], + ) + + def check_amodule_args(self): + check_error = False + if ( + self.aparams['state'] == 'absent' + and self.aparams['usage'] + ): + self.message( + 'Parameter "usage" is not supported when deleting snapshot' + ) + check_error = True + + if check_error: + self.exit(fail=True) + + def run(self): + self.get_info(first_run=True) + self.change() + self.exit() + + def get_info(self, first_run: bool = False): + if not first_run: + self.vm_snapshots = self.snapshot_list( + compute_id=self.aparams_vm_id, + ) + label = self.new_snapshot_label or self.aparams_label + for snapshot in self.vm_snapshots: + if snapshot['label'] == label: + self.facts = snapshot + if self.aparams['usage']: + self.facts['stored'] = self.get_snapshot_usage() + self.facts['vm_id'] = self.aparams_vm_id + break + + def change(self): + match self.aparams['state']: + case 'present': + if self.new_snapshot_label: + self.create() + case 'absent': + if self.aparams_label in self.vm_snapshot_labels: + self.delete() + + def create(self): + self.snapshot_create( + compute_id=self.aparams_vm_id, + label=self.new_snapshot_label, + ) + self.get_info() + + def delete(self): + self.snapshot_delete( + compute_id=self.aparams_vm_id, + label=self.aparams_label, + ) + self.facts = {} + + def get_snapshot_usage(self) -> int: + label = self.new_snapshot_label or self.aparams_label + common_snapshots_usage_info, _ = self.snapshot_usage( + compute_id=self.aparams_vm_id, + label=label, + ) + return common_snapshots_usage_info['stored'] + +def main(): + DecortSnapshot().run() + + +if __name__ == '__main__': + main() diff --git a/library/decort_vins.py b/library/decort_vins.py index 224b9d7..6a02c47 100644 --- a/library/decort_vins.py +++ b/library/decort_vins.py @@ -14,8 +14,9 @@ from ansible.module_utils.decort_utils import * class decort_vins(DecortController): - def __init__(self,arg_amodule): - super(decort_vins, self).__init__(arg_amodule) + def __init__(self): + super(decort_vins, self).__init__(AnsibleModule(**self.amodule_init_args)) + arg_amodule = self.amodule self.vins_id = 0 self.vins_level = "" # "ID" if specified by ID, "RG" - at resource group, "ACC" - at account level @@ -237,61 +238,84 @@ class decort_vins(DecortController): return ret_dict - @staticmethod - def build_parameters(): - """Build and return a dictionary of parameters expected by decort_vins module in a form accepted - by AnsibleModule utility class.""" - return dict( - account_id=dict(type='int', required=False,default=0), - account_name=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'])), - app_secret=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_APP_SECRET']), - no_log=True), - authenticator=dict(type='str', - required=True, - choices=['legacy', 'oauth2', 'jwt']), - controller_url=dict(type='str', required=True), - # datacenter=dict(type='str', required=False, default=''), - ext_net_id=dict(type='int', required=False, default=-1), - ext_ip_addr=dict(type='str', required=False, default=''), - ipcidr=dict(type='str', required=False, default=''), - mgmtaddr=dict(type='list',required=False, default=[]), - custom_config=dict(type='bool',required=False, default=False), - config_save=dict(type='bool',required=False, default=False), - connect_to=dict(type='list', default=[], required=False), - jwt=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_JWT']), - no_log=True), - oauth2_url=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_OAUTH2_URL'])), - password=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_PASSWORD']), - no_log=True), - state=dict(type='str', + @property + def amodule_init_args(self) -> dict: + return self.pack_amodule_init_args( + argument_spec=dict( + account_id=dict( + type='int', + default=0, + ), + account_name=dict( + type='str', + default='', + ), + description=dict( + type='str', + default='', + ), + ext_net_id=dict( + type='int', + default=-1, + ), + ext_ip_addr=dict( + type='str', + default='', + ), + ipcidr=dict( + type='str', + default='', + ), + mgmtaddr=dict( + type='list', + default=[], + ), + custom_config=dict( + type='bool', + default=False, + ), + config_save=dict( + type='bool', + default=False, + ), + connect_to=dict( + type='list', + default=[], + ), + state=dict( + type='str', default='present', - choices=['absent', 'disabled', 'enabled', 'present']), - user=dict(type='str', - required=False, - fallback=(env_fallback, ['DECORT_USER'])), - rg_id=dict(type='int', required=False, default=0), - rg_name=dict(type='str', required=False, default=''), - verify_ssl=dict(type='bool', required=False, default=True), - vins_id=dict(type='int', required=False, default=0), - vins_name=dict(type='str', required=False,default=""), - workflow_callback=dict(type='str', required=False), - workflow_context=dict(type='str', required=False), + choices=[ + 'absent', + 'disabled', + 'enabled', + 'present', + ], + ), + rg_id=dict( + type='int', + default=0, + ), + rg_name=dict( + type='str', + default='', + ), + vins_id=dict( + type='int', + default=0, + ), + vins_name=dict( + type='str', + default='', + ), + ), + supports_check_mode=True, + required_one_of=[ + ('vins_id', 'vins_name'), + ], ) - # Workflow digest: # 1) authenticate to DECORT controller & validate authentication by issuing API call - done when creating DECORTController # 2) check if the ViNS with this id or name exists under specified account / resource group @@ -300,25 +324,8 @@ class decort_vins(DecortController): # 5) report result to Ansible def main(): - module_parameters = decort_vins.build_parameters() - - amodule = AnsibleModule(argument_spec=module_parameters, - supports_check_mode=True, - mutually_exclusive=[ - ['oauth2', 'password'], - ['password', 'jwt'], - ['jwt', 'oauth2'], - ], - required_together=[ - ['app_id', 'app_secret'], - ['user', 'password'], - ], - required_one_of=[ - ['vins_id', 'vins_name'], - ], - ) - - decon = decort_vins(amodule) + decon = decort_vins() + amodule = decon.amodule # # Initial validation of module arguments is complete # diff --git a/module_utils/decort_utils.py b/module_utils/decort_utils.py index 57f4446..a485bd2 100644 --- a/module_utils/decort_utils.py +++ b/module_utils/decort_utils.py @@ -3,7 +3,7 @@ from datetime import datetime from enum import Enum import json import re -from typing import Any, Callable, Iterable, Literal, Optional +from typing import Any, Callable, Iterable, Literal, Optional, Tuple import time import jwt @@ -156,6 +156,15 @@ class DecortController(object): ARCXDU = 'ARCXDU' CXDRAU = 'CXDRAU' + + class VMNetType(Enum): + VINS = 'VINS' + EXTNET = 'EXTNET' + VFNIC = 'VFNIC' + EMPTY = 'EMPTY' + DPDK = 'DPDK' + + class MESSAGES: @staticmethod def ssl_error(url: None | str = None): @@ -298,14 +307,15 @@ class DecortController(object): self.result = {'failed': False, 'changed': False, 'waypoints': "Init"} self.authenticator = arg_amodule.params['authenticator'] - self.controller_url = arg_amodule.params['controller_url'] + self.controller_url = arg_amodule.params.get('controller_url') - self.jwt = arg_amodule.params['jwt'] + self.jwt = arg_amodule.params.get('jwt') self.app_id = arg_amodule.params['app_id'] self.app_secret = arg_amodule.params['app_secret'] self.oauth2_url = arg_amodule.params['oauth2_url'] - # self.password = arg_amodule.params['password'] - # self.user = arg_amodule.params['user'] + self.domain = arg_amodule.params['domain'] + self.password = arg_amodule.params['password'] + self.username = arg_amodule.params['username'] self.session_key = '' # self.iconf = arg_iconf self.verify_ssl = arg_amodule.params['verify_ssl'] @@ -328,18 +338,12 @@ class DecortController(object): self.result['msg'] = ("JWT based authentication requested, but no JWT specified. " "Use 'jwt' parameter or set 'DECORT_JWT' environment variable") self.amodule.fail_json(**self.result) - elif self.authenticator == "legacy": - if not self.password: - self.result['failed'] = True - self.result['msg'] = ("Legacy user authentication requested, but no password specified. " - "Use 'password' parameter or set 'DECORT_PASSWORD' environment variable.") - self.amodule.fail_json(**self.result) - if not self.user: - self.result['failed'] = True - self.result['msg'] = ("Legacy user authentication requested, but no user specified. " - "Use 'user' parameter or set 'DECORT_USER' environment variable.") - self.amodule.fail_json(**self.result) - elif self.authenticator == "oauth2": + elif self.authenticator in ('oauth2', 'decs3o', 'bvs'): + if self.authenticator == 'oauth2': + self.result['warning'] = ( + '"oauth2" authenticator type is deprecated and might be ' + 'removed in newer versions. Please use "decs3o" instead.' + ) if not self.app_id: self.result['failed'] = True self.result['msg'] = ("Oauth2 based authentication requested, but no application ID specified. " @@ -355,6 +359,28 @@ class DecortController(object): self.result['msg'] = ("Oauth2 base authentication requested, but no Oauth2 provider URL specified. " "Use 'oauth2_url' parameter or set 'DECORT_OAUTH2_URL' environment variable.") self.amodule.fail_json(**self.result) + if self.authenticator == 'bvs': + if not self.domain: + self.message( + 'BVS authentication requested, but no domain ' + 'specified. Use "domain" parameter or set ' + '"DECORT_DOMAIN" environment variable.' + ) + self.exit(fail=True) + if not self.password: + self.message( + 'BVS authentication requested, but no password ' + 'specified. Use "password" parameter or set ' + '"DECORT_PASSWORD" environment variable.' + ) + self.exit(fail=True) + if not self.username: + self.message( + 'BVS authentication requested, but no user specified. ' + 'Use "user" parameter or set "DECORT_USER" ' + 'environment variable.' + ) + self.exit(fail=True) else: # Unknown authenticator type specified - notify and exit self.result['failed'] = True @@ -368,15 +394,12 @@ class DecortController(object): self.validate_jwt() # this call will abort the script if validation fails jwt_decoded = jwt.decode(self.jwt, algorithms=["ES384"], options={"verify_signature": False}) self.decort_username = jwt_decoded['username'] + "@" + jwt_decoded['iss'] - elif self.authenticator == "legacy": - # obtain session id from the DECORT controller and thus validate the the legacy user - self.validate_legacy_user() # this call will abort the script if validation fails - self.decort_username = self.user else: - # self.authenticator == "oauth2" - Oauth2 based authorization mode + # Oauth2 based authorization mode # obtain JWT from Oauth2 provider and validate on the DECORT controller - self.obtain_oauth2_jwt() - self.validate_jwt() # this call will abort the script if validation fails + self.obtain_jwt() + if self.controller_url is not None: + self.validate_jwt() # this call will abort the script if validation fails jwt_decoded = jwt.decode(self.jwt, algorithms=["ES384"], options={"verify_signature": False}) self.decort_username = jwt_decoded['username'] + "@" + jwt_decoded['iss'] @@ -441,7 +464,7 @@ class DecortController(object): return int(datetime(**datetime_args).timestamp()) @staticmethod - def sec_to_dt_str(sec: int, str_format: str = '%Y-%m-%d_%H-%M-%S') -> str: + def sec_to_dt_str(sec: float, str_format: str = '%Y-%m-%d_%H-%M-%S') -> str: """ Convert the Unix-time int to the datetime string of the format from `str_format`. @@ -466,13 +489,17 @@ class DecortController(object): ), authenticator=dict( type='str', - required=True, - choices=['oauth2', 'jwt'] + choices=['oauth2', 'jwt', 'bvs', 'decs3o'], + default='decs3o', ), controller_url=dict( type='str', required=True ), + domain=dict( + type='str', + fallback=(env_fallback, ['DECORT_DOMAIN']), + ), jwt=dict( type='str', fallback=(env_fallback, ['DECORT_JWT']), @@ -482,14 +509,35 @@ class DecortController(object): type='str', fallback=(env_fallback, ['DECORT_OAUTH2_URL']) ), + password=dict( + type='str', + fallback=(env_fallback, ['DECORT_PASSWORD']), + ), + username=dict( + type='str', + fallback=(env_fallback, ['DECORT_USERNAME']), + ), verify_ssl=dict( type='bool', default=True ), ), required_if=[ - ('authenticator', 'oauth2', - ('oauth2_url', 'app_id', 'app_secret')), + ( + 'authenticator', 'oauth2', + ('oauth2_url', 'app_id', 'app_secret'), + ), + ( + 'authenticator', 'decs3o', + ('oauth2_url', 'app_id', 'app_secret'), + ), + ( + 'authenticator', 'bvs', + ( + 'oauth2_url', 'app_id', 'app_secret', + 'domain', 'username', 'password', + ), + ), ('authenticator', 'jwt', ('jwt',)) ], ) @@ -570,8 +618,14 @@ class DecortController(object): else: return True - def obtain_oauth2_jwt(self): - """Obtain JWT from the Oauth2 provider using application ID and application secret provided , as specified at + def obtain_jwt(self): + if self.authenticator in ('oauth2', 'decs3o'): + self.jwt = self.obtain_decs3o_jwt() + elif self.authenticator == 'bvs': + self.jwt = self.obtain_bvs_jwt() + + def obtain_decs3o_jwt(self): + """Obtain JWT from the Oauth2 DECS3O provider using application ID and application secret provided , as specified at class instance init method. If method fails to obtain JWT it will abort the execution of the script by calling AnsibleModule.fail_json() @@ -620,6 +674,64 @@ class DecortController(object): self.jwt = token_get_resp.content.decode('utf8') return self.jwt + def obtain_bvs_jwt(self): + """ + Obtain JWT from the Oauth2 BVS provider using + application ID, application secret, username and password provided + + If method fails to obtain JWT it will abort the execution of the script + by calling self.exit(fail=True). + + @return: JWT as string. + """ + token_get_url = ( + f'{self.oauth2_url}/realms/{self.domain}/' + f'protocol/openid-connect/token' + ) + request_data = { + 'grant_type': 'password', + 'client_id': self.app_id, + 'client_secret': self.app_secret, + 'username': self.username, + 'password': self.password, + 'response_type': 'token', + 'scope': 'openid', + } + + token_get_resp = None + try: + token_get_resp = requests.post( + url=token_get_url, + data=request_data, + verify=self.verify_ssl, + ) + except requests.exceptions.SSLError: + self.message(self.MESSAGES.ssl_error(url=token_get_url)) + self.exit(fail=True) + except requests.exceptions.ConnectionError as con_error: + self.message( + f'Failed to connect to "{token_get_url}" ' + f'to obtain JWT access token: {con_error}' + ) + self.exit(fail=True) + except requests.exceptions.Timeout as timeout_error: + self.message( + f'Timeout when trying to connect to "{token_get_url}" ' + f'to obtain JWT access token: {timeout_error}' + ) + self.exit(fail=True) + if token_get_resp.status_code != 200: + self.message( + f'Failed to obtain JWT access token from ' + f'oauth2_url "{token_get_url}" ' + f'for app_id "{self.amodule.params["app_id"]}": ' + f'HTTP status code {token_get_resp.status_code}, ' + f'reason "{token_get_resp.reason}"' + ) + self.exit(fail=True) + self.jwt = token_get_resp.json()['access_token'] + return self.jwt + def validate_jwt(self, arg_jwt=None): """Validate JWT against DECORT controller. JWT can be supplied as argument to this method. If None supplied as argument, JWT will be taken from class attribute. DECORT controller URL will always be taken from the class @@ -632,15 +744,6 @@ class DecortController(object): AnsibleModule.fail_json() method. """ - if self.authenticator not in ('oauth2', 'jwt'): - # sanity check - JWT is relevant in oauth2 or jwt authentication modes only - self.result['msg'] = "Cannot validate JWT for incompatible authentication mode '{}'".format( - self.authenticator) - self.amodule.fail_json(**self.result) - # The above call to fail_json will abort the script, so the following return statement will - # never be executed - return False - if not arg_jwt: # If no JWT is passed as argument to this method, we will validate JWT stored in the class # instance (if any) @@ -686,58 +789,6 @@ class DecortController(object): # If we fall through here, then everything went well. return True - def validate_legacy_user(self): - """Validate legacy user by obtaining a session key, which will be used for authenticating subsequent API calls - to DECORT controller. - If successful, the session key is stored in self.session_key and True is returned. If unsuccessful for any - reason, the method will abort. - - @return: True on successful validation of the legacy user. - """ - - if self.authenticator != 'legacy': - self.result['failed'] = True - self.result['msg'] = "Cannot validate legacy user for incompatible authentication mode '{}'".format( - self.authenticator) - self.amodule.fail_json(**self.result) - return False - - req_url = self.controller_url + "/restmachine/cloudapi/user/authenticate" - req_data = dict(username=self.user, - password=self.password, ) - - try: - api_resp = requests.post(req_url, data=req_data, verify=self.verify_ssl) - except requests.exceptions.SSLError: - self.message(self.MESSAGES.ssl_error(url=req_url)) - self.exit(fail=True) - except requests.exceptions.ConnectionError: - self.result['failed'] = True - self.result['msg'] = "Failed to connect to '{}' while validating legacy user".format(req_url) - self.amodule.fail_json(**self.result) - return False # actually, this directive will never be executed as fail_json exits the script - except requests.exceptions.Timeout: - self.result['failed'] = True - self.result['msg'] = "Timeout when trying to connect to '{}' while validating legacy user".format(req_url) - self.amodule.fail_json(**self.result) - return False - - if api_resp.status_code != 200: - self.result['failed'] = True - self.result['msg'] = ("Failed to validate legacy user access to DECORT controller URL '{}': " - "HTTP status code {}, reason '{}'").format(req_url, - api_resp.status_code, - api_resp.reason) - self.amodule.fail_json(**self.result) - return False - - # Assign session key to the corresponding class attribute. - # Note that the above API call returns session key as a string with double quotes, which we need to - # remove before it can be used as 'session=...' parameter to DECORT controller API calls - self.session_key = api_resp.content.decode('utf8').replace('"', '') - - return True - def decort_api_call( self, arg_req_function, @@ -779,10 +830,7 @@ class DecortController(object): req_url = self.controller_url + arg_api_name - if self.authenticator == 'legacy': - arg_params['authkey'] = self.session_key - elif self.authenticator in ('jwt', 'oauth2'): - http_headers['Authorization'] = 'bearer {}'.format(self.jwt) + http_headers['Authorization'] = 'bearer {}'.format(self.jwt) while retry_counter > 0: try: @@ -1479,15 +1527,14 @@ class DecortController(object): ifaces_for_delete = ifaces nets_for_attach = new_networks else: - EMPTY = 'EMPTY' - # Creating dictionaries in which the key is a net type + a net id + # + (optional) postfix # For empty networks a net id is the number of the empty network ifaces_dict = {} empty_ifaces_count = 0 for iface in ifaces: net_type = iface['netType'] - if net_type == EMPTY: + if net_type == self.VMNetType.EMPTY.value: empty_ifaces_count += 1 net_id = empty_ifaces_count else: @@ -1497,13 +1544,22 @@ class DecortController(object): new_nets_dict = {} empty_new_nets_count = 0 for net in new_networks: - net_type = net["type"] - if net_type == EMPTY: + net_type = net['type'] + if net_type == self.VMNetType.EMPTY.value: empty_new_nets_count += 1 net_id = empty_new_nets_count else: net_id = net['id'] net_key = f'{net_type}{net_id}' + + # If DPDK iface MTU is new then add postfix + if net_type == self.VMNetType.DPDK.value: + net_mtu = net['mtu'] + if net_mtu is not None: + iface = ifaces_dict.get(net_key) + if iface and net_mtu != iface['mtu']: + net_key = f'{net_key}_new-mtu' + new_nets_dict[net_key] = net # The networks that no need to be disconnected or reconnected @@ -1569,6 +1625,7 @@ class DecortController(object): 'netType': net['type'], 'netId': net.get('id') or 0, 'ipAddr': net.get('ip_addr'), + 'mtu': net.get('mtu'), }, ) self.set_changed() @@ -1925,6 +1982,7 @@ class DecortController(object): hp_backed: Optional[bool] = None, numa_affinity: Optional[str] = None, description: Optional[str] = None, + auto_start: Optional[bool] = None, ): OBJ = 'compute' @@ -1939,6 +1997,7 @@ class DecortController(object): 'hpBacked': hp_backed, 'numaAffinity': numa_affinity, 'desc': description, + 'autoStart': auto_start, }, ) @@ -1951,6 +2010,7 @@ class DecortController(object): 'hp_backed': hp_backed, 'numa_affinity': numa_affinity, 'description': description, + 'auto_start': auto_start, } for param, value in params_to_check.items(): if value is not None: @@ -6474,3 +6534,136 @@ class DecortController(object): self.result['changed'] = True return + + @waypoint + @checkmode + def snapshot_create(self, compute_id: int, label: str): + """ + Implementation of functionality of the API method + `/cloudapi/compute/snapshotCreate`. + """ + self.decort_api_call( + arg_req_function=requests.post, + arg_api_name='/restmachine/cloudapi/compute/snapshotCreate', + arg_params={ + 'computeId': compute_id, + 'label': label, + }, + ) + self.set_changed() + self.message( + f'Snapshot {label} for VM ID {compute_id} created successfully.' + ) + + @waypoint + @checkmode + def snapshot_delete( + self, + compute_id: int, + label: str, + ): + """ + Implementation of functionality of the API method + `/cloudapi/compute/snapshotDelete`. + + The method `self.exit(fail=True)` will be + called if the time for scheduling or for deleting a snapshot + is exceeded, or if an error occurs during deletion. + """ + snapshot_delete_response = self.decort_api_call( + arg_req_function=requests.post, + arg_api_name='/restmachine/cloudapi/compute/snapshotDelete', + arg_params={ + 'computeId': compute_id, + 'label': label, + 'asyncMode': True, + }, + ) + self.set_changed() + audit_id = snapshot_delete_response.text.strip('"') + task_link = ( + f'{self.controller_url}/portal/#/system/tasks/{audit_id}' + ) + params = {'auditId': audit_id} + + task_schedule_timeout = 600 + snapshot_delete_timeout = 120 + sleep_interval = 5 + while True: + task_response = self.decort_api_call( + arg_req_function=requests.post, + arg_api_name='/restmachine/cloudapi/tasks/get', + arg_params=params, + ) + response_data = task_response.json() + match response_data['status']: + case 'SCHEDULED': + if task_schedule_timeout <= 0: + self.message( + f'Time to schedule task to delete snapshot for ' + f'VM ID {compute_id} has been exceeded.' + f'\nTask details: {task_link}' + ) + self.exit(fail=True) + task_schedule_timeout -= sleep_interval + case 'PROCESSING': + if snapshot_delete_timeout <= 0: + self.message( + f'Time to delete snapshot for VM ID {compute_id} ' + f'has been exceeded.' + f'\nTask details: {task_link}' + ) + self.exit(fail=True) + snapshot_delete_timeout -= sleep_interval + case 'ERROR': + self.result['msg'] = ( + f'Deleting snapshot for VM ID {compute_id} failed:' + f'{response_data["error"]}.' + f'\nTask details: {task_link}' + ) + self.exit(fail=True) + case 'OK': + self.message( + f'Snapshot {label} for VM ID {compute_id} ' + f'deleted successfully.' + ) + break + time.sleep(sleep_interval) + + @waypoint + def snapshot_list(self, compute_id: int) -> list: + """ + Implementation of functionality of the API method + `/cloudapi/compute/snapshotList`. + """ + snapshots_list_response = self.decort_api_call( + arg_req_function=requests.post, + arg_api_name='/restmachine/cloudapi/compute/snapshotList', + arg_params={ + 'computeId': compute_id, + } + ) + return snapshots_list_response.json()['data'] + + @waypoint + def snapshot_usage( + self, + compute_id: int, + label: Optional[str], + ) -> tuple[dict, list[dict]]: + """ + Implementation of functionality of the API method + `/cloudapi/compute/snapshotUsage`. + """ + snapshot_usage_response = self.decort_api_call( + arg_req_function=requests.post, + arg_api_name='/restmachine/cloudapi/compute/snapshotUsage', + arg_params={ + 'computeId': compute_id, + 'label': label, + } + ) + snapshot_usage = snapshot_usage_response.json() + common_snapshot_usage_info = snapshot_usage[0] + snapshots_usage = snapshot_usage[1:] + return common_snapshot_usage_info, snapshots_usage diff --git a/wiki/7.0.0/Home.md b/wiki/7.0.0/Home.md new file mode 100644 index 0000000..31004d8 --- /dev/null +++ b/wiki/7.0.0/Home.md @@ -0,0 +1,25 @@ +1. [Введение](./введение.md) + - [Введение](./введение.md#введение) + - [Системные требования](./введение.md#системные-требования) + - [Подготовка к работе](./введение.md#подготовка-к-работе) + - [Авторизация](./введение.md#авторизация) + - [Общие параметры модулей для авторизации](./введение.md#общие-параметры-модулей-для-авторизации) + - [Пример авторизации с помощью DECS3O](./введение.md#пример-авторизации-с-помощью-decs3o) + - [Пример авторизации с помощью BVS](./введение.md#пример-авторизации-с-помощью-bvs) + - [Пример авторизации с помощью JSON Web Token](./введение.md#пример-авторизации-с-помощью-json-web-token) +1. Ansible модули DECORT: + - [Модуль decort_kvmvm](./модуль-decort_kvmvm.md) - управление виртуальными машинами + - [Модуль decort_osimage](./модуль-decort_osimage.md) - управление образами + - [Модуль decort_disk](./модуль-decort_disk.md) - управление дисками + - [Модуль decort_pfw](./модуль-decort_pfw.md) - управление правилами переадресации портов + - [Модуль decort_rg](./модуль-decort_rg.md) - управление ресурсными группами + - [Модуль decort_vins](./модуль-decort_vins.md) - управление внутренними сетями + - [Модуль decort_jwt](./модуль-decort_jwt.md) - получение авторизационного токена + - [Модуль decort_bservice](./модуль-decort_bservice.md) - управление базовыми службами + - [Модуль decort_group](./модуль-decort_group.md)- управление группами базовой службы + - [Модуль decort_k8s](./модуль-decort_k8s.md) - управление кластерами Kubernetes + - [Модуль decort_lb](./модуль-decort_lb.md) - управление балансировщиками нагрузки + - [Модуль decort_account_info](./модуль-decort_account_info.md) - получение информации об аккаунте + - [Модуль decort_account](./модуль-decort_account.md) - управление аккаунтами + - [Модуль decort_user_info](./модуль-decort_user_info.md) - получение информации о пользователе + - [Модуль decort_snapshot](./модуль-decort_snapshot.md) - управление снимками виртуальной машины diff --git a/wiki/7.0.0/введение.md b/wiki/7.0.0/введение.md new file mode 100644 index 0000000..261da07 --- /dev/null +++ b/wiki/7.0.0/введение.md @@ -0,0 +1,250 @@ +# Модули Ansible для управления облачными ресурсами в платформе DECORT +## Введение + +Настоящая документация содержит руководство пользователя по библиотеке модулей decort для Ansible. С помощью этих модулей Вы сможете управлять созданием и конфигурированием облачных ресурсов в платформе DECORT (Digital Energy Cloud Orchestration Technology). + +По каждому модулю есть своя документация, в которой вы можете найти список доступных действий, подробную информацию о входных параметрах и возвращаемых данных, а также примеры использования. + +## Системные требования +Убедитесь, что Ваша система соответствует требованиям для работы модуля DECORT. +Системные требования для работы модуля: +- Ansible 10.6.0 +- Python 3.10.12 +- PyJWT 2.10.1 Python module +- requests 2.32.3 Python module +- DynamiX Enterprise 4.2.0 + +## Подготовка к работе + +Для начала работы необходимо, чтобы Ansible было известно местоположение файлов модулей. Для этого необходимо: +- либо разместить директории **library** и **module_utils** в одной директории с плейбуками +- либо в рабочей директории, из которой будет запускаться Ansible, разместить файл **ansible.cfg**, в котором задать пути к файлам модулей, например: +``` +[defaults] +library=./library +module_utils=./module_utils +``` + +## Авторизация + +### Общие параметры модулей для авторизации + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ПараметрТипОписание
+ app_id + + (str) + + Идентификатор приложения, использующийся для получения токена в режимах + authenticator: bvs или authenticator: decs3o. + Данный параметр является обязательным для указанных режимов. Если + параметр не задан в playbook, модуль будет использовать значение + переменной окружения DECORT_APP_ID. +
+ app_secret + + (str) + + Секретный ключ приложения, использующийся для получения токена в режимах + authenticator: bvs или authenticator: decs3o. + Данный параметр является обязательным для указанных режимов. + Так как он содержит секретную информацию, то его не рекомендуется + задавать непосредственно в playbook. Если параметр не задан в playbook, + то модуль будет использовать значение переменной окружения + DECORT_APP_SECRET. +
+ authenticator + + (str) +
Значения: +
bvs +
decs3o +
oauth2 +
jwt +
Default: decs3o + 		+ Режим аутентификации для получения токена. + Значение oauth2 является устаревшим и равнозначным + decs3o. +
+ controller_url + + (str) + + URL контроллера, соответствующего экземпляру облачной платформы + DECORT. Данный параметр является обязательным. +
+ domain + + (str) + + Домен BVS, использующийся для получения токена в режиме + authenticator: bvs. Данный параметр является + обязательным для указанного режима. Если параметр не задан в playbook, + модуль будет использовать значение переменной окружения + DECORT_DOMAIN. +
+ jwt + + (str) + + JSON Web Token (JWT), который будет использоваться для подключения + к контроллеру облачной платформы DECORT в режиме + authenticator: jwt. Данный параметр является + обязательным для указанного режима. Так как он содержит + потенциально секретную информацию, а сам JWT, как правило, + имеет ограниченное время жизни, то его не рекомендуется задавать + непосредственно в playbook. Если этот параметр не определен в + playbook, то модуль будет использовать значение переменной + окружения DECORT_JWT. +
+ oauth2_url + + (str) + + URL авторизационного сервера, работающего по протоколу Oauth2, + который должен использоваться в режимах + authenticator: bvs + или authenticator: decs3o. Данный параметр является + обязательным для указанных режимов. Если параметр не задан в + playbook, модуль будет использовать значение переменной + окружения DECORT_OAUTH2_URL. +
+ password + + (str) + + Пароль пользователя, который должен использоваться в режиме + authenticator: bvs. Данный параметр является + обязательным для указанного режима. Так как он содержит секретную + информацию, то его не рекомендуется задавать непосредственно + в playbook. Если параметр не задан в playbook, модуль будет + использовать значение переменной окружения + DECORT_PASSWORD. +
+ username + + (str) + + Логин пользователя, который должен использоваться в режиме + authenticator: bvs. Данный параметр является + обязательным для указанного режима. Если параметр не задан в playbook, + модуль будет использовать значение переменной окружения + DECORT_USERNAME. +
+ verify_ssl + + (bool) +
Default: true + 		+ Позволяет отключить проверку SSL сертификатов при выполнении API + вызовов в адрес контроллера облачной инфраструктуры, например, + при работе с изолированной облачной инфраструктурой, использующей + самоподписанные сертификаты. Применяйте данный параметр с + осторожностью, предпочтительно в защищенных средах. +
+ +### Пример авторизации с помощью DECS3O +``` +- name: Example + hosts: localhost + tasks: + - name: DECS3O auth + decort_module_name: + # Специфичные для модулей параметры упущены + # Пример демонстрирует только параметры для авторизации + app_id: "{{ app_id }}" + app_secret: "{{ app_secret }}" + authenticator: decs3o + controller_url: https://dynamix.local + oauth2_url: https://sso-dynamix.local +``` + +### Пример авторизации с помощью BVS +``` +- name: Example + hosts: localhost + tasks: + - name: BVS auth + decort_module_name: + # Специфичные для модулей параметры упущены + # Пример демонстрирует только параметры для авторизации + app_id: "{{ app_id }}" + app_secret: "{{ app_secret }}" + authenticator: bvs + controller_url: https://dynamix.local + oauth2_url: https://bvs.local + domain: dynamix + username: "{{ username }}" + password: "{{ password }}" +``` + +### Пример авторизации с помощью JSON Web Token + +``` +- name: Example + hosts: localhost + tasks: + - name: Auth with JWT + decort_module_name: + # Специфичные для модулей параметры упущены + # Пример демонстрирует только параметры для авторизации + authenticator: jwt + controller_url: "{{ controller_url }}" + jwt: "{{ jwt }}" +``` \ No newline at end of file diff --git a/wiki/7.0.0/модуль-decort_account.md b/wiki/7.0.0/модуль-decort_account.md new file mode 100644 index 0000000..528e5ce --- /dev/null +++ b/wiki/7.0.0/модуль-decort_account.md @@ -0,0 +1,992 @@ +# Модуль decort_account +## Обзор модуля + +Модуль **decort_account** предназначен для выполнения следующих действий над аккаунтом: +- **удалить в корзину** (см. [параметр state](#state) и [примеры](#в-корзину)) +- **удалить безвозвратно** (см. [параметр state](#state) и [примеры](#безвозвратно)) +- **восстановить из корзины** (см. [параметр state](#state) и [примеры](#восстановить-из-корзины)) +- **выключить/включить** (см. [параметр state](#state) и [примеры](#выключитьвключить)) +- **изменить права доступа** (см. [параметр acl](#acl) и [примеры](#изменить-права-доступа)) +- **изменить имя** (см. [параметр name](#name) и [примеры](#переименовать)) +- **изменить квоты** (см. [параметр quotas](#quotas) и [примеры](#изменить-квоты)) +- **выключить/включить отправку уведомлений о предоставлении доступа к ресурсам** (см. [параметр access_emails](#access_emails) и [примеры](#выключитьвключить-отправку-уведомлений-о-предоставлении-доступа-к-ресурсам)) +- **изменить доступные пулы СХД** (см. [параметр sep_pools](#sep_pools) и [примеры](#изменить-доступные-пулы-схд)) + +## Параметры модуля +Ниже приведен список параметров для модуля **decort_account** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ПараметрТипОписание
+ + access_emails + + + (bool) + + Выключение/включение отправки пользователям на эл. почту уведомлений о предоставлении доступа к ресурсам. +
+ + acl + + + (dict) + + Целевые права доступа. +
+ mode + + (str) +
Значения: +
match +
revoke +
update +
Default: update + 		+ Режим изменения прав доступа для указанных пользователей. +
match - привести в соответствие для указанных + пользователей, удалить предоставленные для других. +
revoke - отозвать для указанных пользователей, + если предоставлены. +
update - привести в соответствие для указанных + пользователей, оставить без изменения предоставленные для + других. +
+ users + + (list) + + Список словарей, описывающих права доступа пользователей. +
Обязательный параметр. +
+ rights + + (str) +
Значения: +
R +
RCX +
ARCXDU +
Default: R + 		+ Права доступа. +
При mode: revoke не используется. +
При mode: match и mode: update + права ARCXDU считаются соответствующими + правам CXDRAU. +
+ id + + (str) + + Идентификатор пользователя. +
Обязательный параметр. +
+ id + + (int) + + Идентификатор целевого аккаунта. +
Обязательный параметр, если не задан параметр + name. +
+ + name + + + (str) + + Имя целевого аккаунта. +
Может быть альтернативой параметру id, + за исключением случая, когда необходимо получить + информацию о безвозвратно удалённом объекте. +
Если задан совместно с параметром id, + то используется для переименования (целевое имя). +
+ + quotas + + + (dict) + + Целевые квоты. +
+ cpu + + (int) + + Количество виртуальных процессоров. +
-1 - удалить квоту. +
+ disks_size + + (int) + + Объём дисков в ГБ. +
-1 - удалить квоту. +
+ ext_traffic + + (int) + + Объём трафика внешних сетей. +
-1 - удалить квоту. +
+ gpu + + (int) + + Количество графических процессоров. +
-1 - удалить квоту. +
+ public_ip + + (int) + + Количество внешних IP-адресов. +
-1 - удалить квоту. +
+ ram + + (int) + + Объём оперативной памяти в МБ. +
-1 - удалить квоту. +
+ + sep_pools + + + (list) + + Список словарей, описывающих доступные пулы СХД. +
+ sep_id + + (int) + + Идентификатор системы хранения данных. +
+ pool_names + + (list) + + Список названий пулов системы хранения данных. +
+ + state + + + (str) +
Значения: +
absent +
absent_permanently +
confirmed +
disabled +
present +
Default: present + 		+ Целевое состояние. +
absent - удалён в корзину, безвозвратно удалён + или не существует. Если существует и не удалён, то будет удалён + в корзину. +
absent_permanently - безвозвратно удалён или + не существует. Если существует и не удалён или удалён в корзину, + то будет безвозвратно удалён. +
При значениях absent и absent_permanently + использование других параметров модуля, вызывающих изменение объекта, + не допускается. +
confirmed - включён. Если выключен, то будет включён. + Если удалён в корзину, то будет восстановлен из корзины. +
disabled - выключен. Если включён, то будет выключен. + Если удалён в корзину, то будет восстановлен из корзины и выключен. +
present - существует и не удалён. Если удалён в + корзину, то будет восстановлен из корзины. +
+ +## Возвращаемые значения + +Модуль **decort_account** возвращает информацию об аккаунте в виде словаря `facts` со следующими ключами: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ acl + + list + + Список словарей, описывающих доступы пользователей. +
+ canBeDeleted + + bool + + Может ли быть удалён. +
+ right + + str + + Права. +
+ status + + str + + Статус. +
+ type + + str + + Тип. +
+ userGroupId + + str + + Идентификатор пользователя или группы пользователей. +
+ company + + str + + Название компании. +
+ companyurl + + str + + URL компании. +
+ computeFeatures + + list + + Список дополнительных возможностей гипервизора, доступных ВМ. +
+ computes_amount + + dict + + Количество ВМ по состоянию. +
+ started + + int + + Количество запущенных ВМ. +
+ stopped + + int + + Количество остановленных ВМ. +
+ cpu_allocation_parameter + + str + + Режим выделения ЦП. +
+ cpu_allocation_ratio + + str + + Коэффициент для режима выделения ЦП. +
+ createdBy + + str + + Идентификатор пользователя, который создал. +
+ createdTime + + int + + Unix-время создания. +
+ createdTime_readable + + str + + Дата и время создания. +
+ deactivationTime + + int + + Unix-время выключения. +
+ deactivationTime_readable + + str + + Дата и время выключения. +
+ deletedBy + + str + + Идентификатор пользователя, который удалил. +
+ deletedTime + + int + + Unix-время удаления. +
+ deletedTime_readable + + str + + Дата и время удаления. +
+ displayname + + str + + Отображаемое имя. +
+ id + + int + + Идентификатор. +
+ name + + str + + Имя. +
+ resourceLimits + + dict + + Квоты на ресурсы. +
+ CU_C + + int + + Количество виртуальных процессоров. +
+ CU_D + + int + + Объём диска в ГБ. +
+ CU_DM + + int + + Объём дисков в ГБ. +
+ CU_I + + int + + Количество внешних IP-адресов. +
+ CU_M + + float + + Объём оперативной памяти в МБ. +
+ CU_NP + + int + + Объём трафика внешних сетей. +
+ gpu_units + + int + + Количество графических процессоров. +
+ sendAccessEmails + + bool + + Отправка пользователям на эл. почту уведомлений о предоставлении доступа. +
+ status + + str + + Статус. +
+ uniqPools + + list + + Список доступных пулов СХД. +
+ updatedTime + + int + + Unix-время обновления. +
+ updatedTime_readable + + str + + Дата и время обновления. +
+ vins + + list + + Список идентификаторов внутренних сетей на уровне аккаунта. +
+ vinses_amount + + int + + Количество внутренних сетей. +
+ +## Примеры использования + +### Удалить + +#### В корзину +``` +- name: Example + hosts: localhost + tasks: + - name: Delete account + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + state: absent +``` + +#### Безвозвратно +``` +- name: Example + hosts: localhost + tasks: + - name: Delete account + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + state: absent_permanently +``` + +### Восстановить из корзины +``` +- name: Example + hosts: localhost + tasks: + - name: Restore account from recycle bin + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + state: present +``` + +### Выключить/включить + +#### Выключить +``` +- name: Example + hosts: localhost + tasks: + - name: Disable account + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + state: disabled +``` + +#### Включить +``` +- name: Example + hosts: localhost + tasks: + - name: Enable account + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + state: confirmed +``` + +### Изменить права доступа + +#### Отозвать +``` +- name: Example + hosts: localhost + tasks: + - name: Revoke user access rights + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + acl: + mode: revoke + users: + - id: "{{ user1_id }}" + - id: "{{ user2_id }}" +``` + +#### Обновить +``` +- name: Example + hosts: localhost + tasks: + - name: Update user access rights + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + acl: + mode: update + users: + - id: "{{ user1_id }}" + rights: R + - id: "{{ user2_id }}" + rights: RCX +``` + +#### Привести в соответствие +``` +- name: Example + hosts: localhost + tasks: + - name: Match user access rights + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + acl: + mode: match + users: + - id: "{{ user1_id }}" + rights: ARCXDU + - id: "{{ user2_id }}" + rights: RCX +``` + +### Переименовать +``` +- name: Example + hosts: localhost + tasks: + - name: Rename account + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + name: "{{ account_new_name }}" +``` + +### Изменить квоты + +#### На объём дисков +``` +- name: Example + hosts: localhost + tasks: + - name: Update account quota of disks size + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + quotas: + disks_size: 500 +``` + +#### На количество внешних IP-адресов +``` +- name: Example + hosts: localhost + tasks: + - name: Update account quota of public IP amount + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + quotas: + public_ip: 10 +``` + +### Выключить/включить отправку уведомлений о предоставлении доступа к ресурсам + +#### Выключить +``` +- name: Example + hosts: localhost + tasks: + - name: Disable sending access emails + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + access_emails: false +``` + +#### Включить +``` +- name: Example + hosts: localhost + tasks: + - name: Enable sending access emails + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + access_emails: true +``` + +### Изменить доступные пулы СХД +``` +- name: Example + hosts: localhost + tasks: + - name: Change available sep pools + decort_account: + # Параметры для авторизации упущены + id: "{{ account_id }}" + sep_pools: + - sep_id: 1 + pool_names: + - pool1 +``` diff --git a/wiki/7.0.0/модуль-decort_account_info.md b/wiki/7.0.0/модуль-decort_account_info.md new file mode 100644 index 0000000..ff5563d --- /dev/null +++ b/wiki/7.0.0/модуль-decort_account_info.md @@ -0,0 +1,3805 @@ +# Модуль decort_account_info +## Обзор модуля + +Модуль **decort_account_info** предназначен для получения следующей информации об аккаунте: +- **основная информация** (см. [возвращаемые значения](#основная-информация) и [примеры](#получение-основной-информации-об-аккаунте)) +- **используемые и зарезервированные ресурсы** (см. [параметр resource_consumption](#resource_consumption), [возвращаемые значения](#используемые-и-зарезервированные-ресурсы) и [примеры](#получение-информации-об-используемых-и-зарезервированных-ресурсах-аккаунта)) +- **ресурсные группы** (см. [параметр resource_groups](#resource_groups), [возвращаемые значения](#ресурсные-группы) и [примеры](#получение-информации-о-ресурсных-группах)) +- **виртуальные машины** (см. [параметр computes](#computes), [возвращаемые значения](#виртуальные-машины) и [примеры](#получение-информации-о-виртуальных-машинах)) +- **внутренние сети** (см. [параметр vinses](#vinses), [возвращаемые значения](#внутренние-сети) и [примеры](#получение-информации-о-внутренних-сетях)) +- **диски** (см. [параметр disks](#disks), [возвращаемые значения](#диски) и [примеры](#получение-информации-о-дисках)) +- **доступные образы** (см. [параметр images](#param_images), [возвращаемые значения](#образы) и [примеры](#получение-информации-об-образах)) +- **группы с плавающим IP-адресом** (см. [параметр flip_groups](#flip_groups), [возвращаемые значения](#группы-с-плавающим-ip-адресом) и [примеры](#получение-информации-о-группах-с-плавающим-ip-адресом)) +- **аудиты** (см. [параметр audits](#audits), [возвращаемые значения](#аудиты) и [примеры](#получение-информации-об-аудитах)) + +## Параметры модуля +Ниже приведен список параметров для модуля **decort_account_info** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ПараметрТипОписание
+ + audits + + + (bool) +
Default: false + 		+ Получить информацию об аудитах. +
+ + computes + + + (dict) + + Получить информацию о виртуальных машинах, к которым имеет доступ пользователь, + с учётом заданных параметров вывода. +
Чтобы получить информацию без использования параметров вывода, + необходимо задать пустой словарь {}. +
+ filter + + (dict) + + Фильтр. +
+ ext_net_id + + (int) + + По идентификатору внешней сети. +
+ ext_net_name + + (str) + + По имени внешней сети. +
+ id + + (int) + + По идентификатору. +
+ ip + + (str) + + По IP-адресу. +
+ name + + (str) + + По имени. +
+ rg_id + + (int) + + По идентификатору ресурсной группы. +
+ rg_name + + (str) + + По имени ресурсной группы. +
+ tech_status + + (str) +
Значения: +
BACKUP_RUNNING +
BACKUP_STOPPED +
DOWN +
MIGRATING +
PAUSED +
PAUSING +
SCHEDULED +
STARTED +
STARTING +
STOPPED +
STOPPING + 		+ По техническому статусу. +
+ pagination + + (dict) + + Постраничный вывод. +
+ number + + (int) +
Default: 1 + 		+ Номер страницы. +
+ size + + (int) + + Размер страниц. +
Обязательный параметр. +
+ sorting + + (dict) + + Сортировка. +
+ asc + + (bool) +
Default: true + 		+ Сортировать по возрастанию. +
true - по возрастанию. +
false - по убыванию. +
+ field + + (str) +
Значения: +
cpus +
createdBy +
createdTime +
deletedBy +
deletedTime +
id +
name +
ram +
registered +
rgId +
rgName +
status +
techStatus +
totalDisksSize +
updatedBy +
updatedTime +
userManaged +
vinsConnected + 		+ Название поля, по которому сортировать. +
Обязательный параметр. +
+ + disks + + + (dict) + + Получить информацию о неподключённых дисках, к которым имеет доступ пользователь, + с учётом заданных параметров вывода. +
Чтобы получить информацию без использования параметров вывода, + необходимо задать пустой словарь {}. +
+ filter + + (dict) + + Фильтр. +
+ id + + (int) + + По идентификатору. +
+ name + + (str) + + По имени. +
+ size + + (int) + + По объёму. +
+ type + + (str) +
Значения: +
B +
D + 		+ По типу. +
+ pagination + + (dict) + + Постраничный вывод. +
+ number + + (int) +
Default: 1 + 		+ Номер страницы. +
+ size + + (int) + + Размер страниц. +
Обязательный параметр. +
+ sorting + + (dict) + + Сортировка. +
+ asc + + (bool) +
Default: true + 		+ Сортировать по возрастанию. +
true - по возрастанию. +
false - по убыванию. +
+ field + + (str) +
Значения: +
id +
name +
pool +
sepId +
shareable +
sizeMax +
type + 		+ Название поля, по которому сортировать. +
Обязательный параметр. +
+ + flip_groups + + + (dict) + + Получить информацию о группах с плавающим IP-адресом, к которым имеет + доступ пользователь, с учётом заданных параметров вывода. +
Чтобы получить информацию без использования параметров вывода, + необходимо задать пустой словарь {}. +
+ filter + + (dict) + + Фильтр. +
+ ext_net_id + + (int) + + По идентификатору внешней сети. +
+ id + + (int) + + По идентификатору. +
+ ip + + (str) + + По IP-адресу. +
+ name + + (str) + + По имени. +
+ vins_id + + (int) + + По идентификатору внутренней сети. +
+ vins_name + + (str) + + По имени внутренней сети. +
+ pagination + + (dict) + + Постраничный вывод. +
+ number + + (int) +
Default: 1 + 		+ Номер страницы. +
+ size + + (int) + + Размер страниц. +
Обязательный параметр. +
+ id + + (int) + + Идентификатор целевого аккаунта. +
Обязательный параметр, если не задан параметр + name. +
+ + images + + + (dict) + + Получить информацию об образах, которые доступны к использованию + в аккаунте, с учётом заданных параметров вывода. +
Чтобы получить информацию без использования параметров вывода, + необходимо задать пустой словарь {}. +
+ filter + + (dict) + + Фильтр. +
+ id + + (int) + + По идентификатору. +
+ name + + (str) + + По имени. +
+ type + + (str) +
Значения: +
cdrom +
linux +
other +
virtual +
windows + 		+ По типу. +
+ pagination + + (dict) + + Постраничный вывод. +
+ number + + (int) +
Default: 1 + 		+ Номер страницы. +
+ size + + (int) + + Размер страниц. +
Обязательный параметр. +
+ sorting + + (dict) + + Сортировка. +
+ asc + + (bool) +
Default: true + 		+ Сортировать по возрастанию. +
true - по возрастанию. +
false - по убыванию. +
+ field + + (str) +
Значения: +
UNCPath +
desc +
id +
name +
public +
size +
status +
type +
username + 		+ Название поля, по которому сортировать. +
Обязательный параметр. +
+ name + + (str) + + Имя целевого аккаунта. +
Может быть альтернативой параметру id, + за исключением случая, когда необходимо получить + информацию о безвозвратно удалённом объекте. +
+ + resource_groups + + + (dict) + + Получить информацию о ресурсных группах, к которым имеет доступ пользователь, + с учётом заданных параметров вывода. +
Чтобы получить информацию без использования параметров вывода, + необходимо задать пустой словарь {}. +
+ filter + + (dict) + + Фильтр. +
+ id + + (int) + + По идентификатору. +
+ name + + (str) + + По имени. +
+ status + + (str) +
Значения: +
CREATED +
DELETED +
DELETING +
DESTROYED +
DESTROYING +
DISABLED +
DISABLING +
ENABLED +
ENABLING +
MODELED +
RESTORING + 		+ По статусу. +
+ vins_id + + (int) + + По идентификатору внутренней сети. +
+ vm_id + + (int) + + По идентификатору виртуальной машины. +
+ pagination + + (dict) + + Постраничный вывод. +
+ number + + (int) +
Default: 1 + 		+ Номер страницы. +
+ size + + (int) + + Размер страниц. +
Обязательный параметр. +
+ sorting + + (dict) + + Сортировка. +
+ asc + + (bool) +
Default: true + 		+ Сортировать по возрастанию. +
true - по возрастанию. +
false - по убыванию. +
+ field + + (str) +
Значения: +
createdBy +
createdTime +
deletedBy +
deletedTime +
id +
milestones +
name +
status +
updatedBy +
updatedTime +
vinses + 		+ Название поля, по которому сортировать. +
Обязательный параметр. +
+ + resource_consumption + + + (bool) +
Default: false + 		+ Получить информацию об используемых и зарезервированных ресурсах. +
+ + vinses + + + (dict) + + Получить информацию о внутренних сетях, к которым имеет доступ пользователь, + с учётом заданных параметров вывода. +
Чтобы получить информацию без использования параметров вывода, + необходимо задать пустой словарь {}. +
+ filter + + (dict) + + Фильтр. +
+ ext_ip + + (str) + + По внешнему IP-адресу. +
+ id + + (int) + + По идентификатору. +
+ name + + (str) + + По имени. +
+ rg_id + + (int) + + По идентификатору ресурсной группы. +
+ pagination + + (dict) + + Постраничный вывод. +
+ number + + (int) +
Default: 1 + 		+ Номер страницы. +
+ size + + (int) + + Размер страниц. +
Обязательный параметр. +
+ sorting + + (dict) + + Сортировка. +
+ asc + + (bool) +
Default: true + 		+ Сортировать по возрастанию. +
true - по возрастанию. +
false - по убыванию. +
+ field + + (str) +
Значения: +
computes +
createdBy +
createdTime +
deletedBy +
deletedTime +
externalIP +
extnetId +
freeIPs +
id +
name +
network +
priVnfDevId +
rgId +
rgName +
status +
updatedBy +
updatedTime + 		+ Название поля, по которому сортировать. +
Обязательный параметр. +
+ +## Возвращаемые значения + +Модуль **decort_account_info** возвращает информацию об аккаунте в виде словаря `facts` со следующими ключами: + +### Основная информация + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ acl + + list + + Список словарей, описывающих доступы пользователей. +
+ canBeDeleted + + bool + + Может ли быть удалён. +
+ right + + str + + Права. +
+ status + + str + + Статус. +
+ type + + str + + Тип. +
+ userGroupId + + str + + Идентификатор пользователя или группы пользователей. +
+ company + + str + + Название компании. +
+ companyurl + + str + + URL компании. +
+ computeFeatures + + list + + Список дополнительных возможностей гипервизора, доступных ВМ. +
+ computes_amount + + dict + + Количество ВМ по состоянию. +
+ started + + int + + Количество запущенных ВМ. +
+ stopped + + int + + Количество остановленных ВМ. +
+ cpu_allocation_parameter + + str + + Режим выделения ЦП. +
+ cpu_allocation_ratio + + str + + Коэффициент для режима выделения ЦП. +
+ createdBy + + str + + Идентификатор пользователя, который создал. +
+ createdTime + + int + + Unix-время создания. +
+ createdTime_readable + + str + + Дата и время создания. +
+ deactivationTime + + int + + Unix-время выключения. +
+ deactivationTime_readable + + str + + Дата и время выключения. +
+ deletedBy + + str + + Идентификатор пользователя, который удалил. +
+ deletedTime + + int + + Unix-время удаления. +
+ deletedTime_readable + + str + + Дата и время удаления. +
+ displayname + + str + + Отображаемое имя. +
+ id + + int + + Идентификатор. +
+ name + + str + + Имя. +
+ resourceLimits + + dict + + Квоты на ресурсы. +
+ CU_C + + int + + Количество виртуальных процессоров. +
+ CU_D + + int + + Объём диска в ГБ. +
+ CU_DM + + int + + Объём дисков в ГБ. +
+ CU_I + + int + + Количество внешних IP-адресов. +
+ CU_M + + float + + Объём оперативной памяти в МБ. +
+ CU_NP + + int + + Объём трафика внешних сетей. +
+ gpu_units + + int + + Количество графических процессоров. +
+ sendAccessEmails + + bool + + Отправка пользователям на эл. почту уведомлений о предоставлении доступа. +
+ status + + str + + Статус. +
+ uniqPools + + list + + Список доступных пулов СХД. +
+ updatedTime + + int + + Unix-время обновления. +
+ updatedTime_readable + + str + + Дата и время обновления. +
+ vins + + list + + Список идентификаторов внутренних сетей на уровне аккаунта. +
+ vinses_amount + + int + + Количество внутренних сетей. +
+ +### Используемые и зарезервированные ресурсы + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ + resource_consumed + + + dict + + Используемые ресурсы. +
+ cpu + + int + + Количество виртуальных процессоров. +
+ disksize + + int + + Объём дисков в ГБ. +
+ extips + + int + + Количество внешних IP-адресов. +
+ exttraffic + + int + + Объём трафика внешних сетей. +
+ gpu + + int + + Количество графических процессоров. +
+ ram + + int + + Объём оперативной памяти в МБ. +
+ seps + + dict + + Объём дисков по пулам СХД. +
+ (идентификатор СХД) + + dict + + Пулы СХД. +
+ (название пула) + + dict + + Словарь пула СХД. +
+ disksize + + int + + Объём дисков в ГБ. +
+ resource_reserved + + dict + + Зарезервированные ресурсы. +
Структура словаря аналогична словарю + + resource_consumed + . +
+ +### Ресурсные группы + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ resource_groups + + list + + Список словарей, описывающих ресурсные группы. +
+ Computes + + dict + + Количество ВМ по состоянию. +
+ Started + + int + + Количество запущенных ВМ. +
+ Stopped + + int + + Количество остановленных ВМ. +
+ Resources + + dict + + Используемые и зарезервированные ресурсы. +
+ Consumed + + dict + + Используемые ресурсы. +
Структура словаря аналогична словарю + + resource_consumed + . +
+ Limits + + dict + + Квоты на ресурсы. +
+ cpu + + int + + Количество виртуальных процессоров. +
+ disksize + + int + + Объём дисков в ГБ. +
+ disksizemax + + int + + Объём диска в ГБ. +
+ extips + + int + + Количество внешних IP-адресов. +
+ exttraffic + + int + + Объём трафика внешних сетей. +
+ gpu + + int + + Количество графических процессоров. +
+ ram + + float + + Объём оперативной памяти в МБ. +
+ Reserved + + dict + + Зарезервированные ресурсы. +
Структура словаря аналогична словарю + + resource_consumed + . +
+ createdBy + + str + + Идентификатор пользователя, который создал. +
+ createdTime + + int + + Unix-время создания. +
+ createdTime_readable + + str + + Дата и время создания. +
+ deletedBy + + str + + Идентификатор пользователя, который удалил. +
+ deletedTime + + int + + Unix-время удаления. +
+ deletedTime_readable + + str + + Дата и время удаления. +
+ id + + int + + Идентификатор. +
+ milestones + + int + + Количество событий. +
+ name + + str + + Имя. +
+ status + + str + + Статус. +
+ updatedBy + + str + + Идентификатор пользователя, который обновил. +
+ updatedTime + + int + + Unix-время обновления. +
+ updatedTime_readable + + str + + Дата и время обновления. +
+ vinses + + int + + Количество внутренних сетей. +
+ +### Виртуальные машины + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ computes + + list + + Список словарей, описывающих виртуальные машины. +
+ accountId + + int + + Идентификатор аккаунта. +
+ accountName + + str + + Имя аккаунта. +
+ cpus + + int + + Количество виртуальных процессоров. +
+ createdBy + + str + + Идентификатор пользователя, который создал. +
+ createdTime + + int + + Unix-время создания. +
+ createdTime_readable + + str + + Дата и время создания. +
+ deletedBy + + str + + Идентификатор пользователя, который удалил. +
+ deletedTime + + int + + Unix-время удаления. +
+ deletedTime_readable + + str + + Дата и время удаления. +
+ id + + int + + Идентификатор. +
+ name + + str + + Имя. +
+ ram + + int + + Объём оперативной памяти в МБ. +
+ registered + + bool + + Зарегистрирована ли ВМ как используемая. +
+ rgId + + int + + Идентификатор ресурсной группы. +
+ rgName + + str + + Имя ресурсной группы. +
+ status + + str + + Статус. +
+ techStatus + + str + + Технический статус. +
+ totalDisksSize + + int + + Общий объём дисков. +
+ updatedBy + + str + + Идентификатор пользователя, который обновил. +
+ updatedTime + + int + + Unix-время обновления. +
+ updatedTime_readable + + str + + Дата и время обновления. +
+ vinsConnected + + int + + Количество подключенных внутренних сетей. +
+ +### Внутренние сети + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ vinses + + list + + Список словарей, описывающих внутренние сети. +
+ accountId + + int + + Идентификатор аккаунта. +
+ accountName + + str + + Имя аккаунта. +
+ computes + + int + + Количество виртуальных машин. +
+ createdBy + + str + + Идентификатор пользователя, который создал. +
+ createdTime + + int + + Unix-время создания. +
+ createdTime_readable + + str + + Дата и время создания. +
+ deletedBy + + str + + Идентификатор пользователя, который удалил. +
+ deletedTime + + int + + Unix-время удаления. +
+ deletedTime_readable + + str + + Дата и время удаления. +
+ externalIP + + str + + Внешний IP-адрес. +
+ extnetId + + int + + Идентификатор внешней сети. +
+ freeIPs + + int + + Количество свободных IP-адресов. +
+ id + + int + + Идентификатор. +
+ name + + str + + Имя. +
+ network + + str + + Адрес сети. +
+ priVnfDevId + + int + + Идентификатор виртуального маршрутизатора. +
+ rgId + + int + + Идентификатор ресурсной группы. +
+ rgName + + str + + Имя ресурсной группы. +
+ status + + str + + Статус. +
+ updatedBy + + str + + Идентификатор пользователя, который обновил. +
+ updatedTime + + int + + Unix-время обновления. +
+ updatedTime_readable + + str + + Дата и время обновления. +
+ +### Диски + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ disks + + list + + Список словарей, описывающих диски. +
+ id + + int + + Идентификатор. +
+ name + + str + + Имя. +
+ pool + + str + + Пул СХД. +
+ sepId + + int + + Идентификатор СХД. +
+ shareable + + bool + + Общий доступ. +
+ sizeMax + + int + + Объём. +
+ type + + str + + Тип. +
+ +### Образы + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ images + + list + + Список словарей, описывающих образы. +
+ UNCPath + + str + + Путь к файлу. +
+ desc + + str + + Описание. +
+ id + + int + + Идентификатор. +
+ name + + str + + Имя. +
+ public + + bool + + Общий доступ. +
+ size + + int + + Размер в ГБ. +
+ status + + str + + Статус. +
+ type + + str + + Тип. +
+ username + + str + + Имя пользователя. +
+ +### Группы с плавающим IP-адресом + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ flip_groups + + list + + Список словарей, описывающих группы с плавающим IP-адресом. +
+ clientType + + str + + Тип клиентов. +
+ connType + + str + + Тип соединения. +
+ createdBy + + str + + Идентификатор пользователя, который создал. +
+ createdTime + + int + + Unix-время создания. +
+ createdTime_readable + + str + + Дата и время создания. +
+ deletedBy + + str + + Идентификатор пользователя, который удалил. +
+ deletedTime + + int + + Unix-время удаления. +
+ deletedTime_readable + + str + + Дата и время удаления. +
+ desc + + str + + Описание. +
+ gid + + int + + Идентификатор ЦОД. +
+ id + + int + + Идентификатор. +
+ ip + + str + + IP-адрес. +
+ milestones + + int + + Количество событий. +
+ name + + str + + Имя. +
+ netId + + int + + Идентификатор сети. +
+ netType + + str + + Тип сети. +
+ netmask + + int + + Маска подсети (длина префикса). +
+ status + + str + + Статус. +
+ updatedBy + + str + + Идентификатор пользователя, который обновил. +
+ updatedTime + + int + + Unix-время обновления. +
+ updatedTime_readable + + str + + Дата и время обновления. +
+ +### Аудиты + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ audits + + list + + Список словарей, описывающих аудиты. +
+ call + + str + + Метод API. +
+ responsetime + + float + + Время отклика в секундах. +
+ statuscode + + int + + Код ответа. +
+ timestamp + + float + + Unix-время. +
+ timestamp_readable + + str + + Дата и время. +
+ user + + str + + Идентификатор пользователя. +
+ +## Примеры использования + +### Получение основной информации об аккаунте + +#### По идентификатору +``` +- name: Example + hosts: localhost + tasks: + - name: Get basic account info by ID + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" +``` + +#### По имени +``` +- name: Example + hosts: localhost + tasks: + - name: Get basic account info by name + decort_account_info: + # Параметры для авторизации упущены + name: "{{ account_name }}" +``` + +### Получение информации об используемых и зарезервированных ресурсах аккаунта +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with resource consumption + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + resource_consumption: true +``` + +### Получение информации о ресурсных группах + +#### Без использования параметров вывода +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with resource groups + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + resource_groups: {} +``` + +#### С фильтрацией по статусу +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with resource groups + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + resource_groups: + filter: + status: CREATED +``` + +#### С сортировкой по имени +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with resource groups + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + resource_groups: + sorting: + field: name +``` + +#### С постраничным выводом +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with resource groups + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + resource_groups: + pagination: + size: 2 +``` + +### Получение информации о виртуальных машинах + +#### Без использования параметров вывода +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with computes + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + computes: {} +``` + +#### С фильтрацией по IP-адресу +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with computes + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + computes: + filter: + ip: 192.168.1.2 +``` + +#### С сортировкой по имени +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with computes + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + computes: + sorting: + field: name +``` + +#### С постраничным выводом +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with computes + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + computes: + pagination: + size: 2 +``` + +### Получение информации о внутренних сетях + +#### Без использования параметров вывода +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with vinses + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + vinses: {} +``` + +#### С фильтрацией по идентификатору ресурсной группы +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with vinses + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + vinses: + filter: + rg_id: "{{ rg_id }}" +``` + +#### С сортировкой по времени создания +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with vinses + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + vinses: + sorting: + field: createdTime +``` + +#### С постраничным выводом +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with vinses + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + vinses: + pagination: + size: 2 +``` + +### Получение информации о дисках + +#### Без использования параметров вывода +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with disks + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + disks: {} +``` + +#### С фильтрацией по типу +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with disks + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + disks: + filter: + type: D +``` + +#### С сортировкой по объёму +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with disks + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + disks: + sorting: + field: sizeMax +``` + +#### С постраничным выводом +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with disks + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + disks: + pagination: + size: 2 +``` + +### Получение информации об образах + +#### Без использования параметров вывода +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with images + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + images: {} +``` + +#### С фильтрацией по типу +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with images + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + images: + filter: + type: linux +``` + +#### С сортировкой по статусу +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with images + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + images: + sorting: + field: status +``` + +#### С постраничным выводом +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with images + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + images: + pagination: + size: 2 +``` + +### Получение информации о группах с плавающим IP-адресом + +#### Без использования параметров вывода +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with flip groups + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + flip_groups: {} +``` + +#### С фильтрацией по IP-адресу +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with flip groups + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + flip_groups: + filter: + ip: 192.168.1.5 +``` + +#### С постраничным выводом +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with flip groups + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + flip_groups: + pagination: + size: 2 +``` + +### Получение информации об аудитах +``` +- name: Example + hosts: localhost + tasks: + - name: Get account info with audits + decort_account_info: + # Параметры для авторизации упущены + id: "{{ account_id }}" + audits: true +``` diff --git a/wiki/7.0.0/модуль-decort_bservice.md b/wiki/7.0.0/модуль-decort_bservice.md new file mode 100644 index 0000000..96a66aa --- /dev/null +++ b/wiki/7.0.0/модуль-decort_bservice.md @@ -0,0 +1,82 @@ +# Модуль decort_bservice + +## Обзор модуля decort_bservice + +Базовая служба (Basic Service) это несколько групп виртуальных серверов (compute), создаваемых и управляемых как единое целое. + +Все compute(s) в группе имеют одни и те же характеристики (cpu/ram/boot disk size/OS image + сетевые подключения). Для разных групп эти характеристики могут быть разными. + +Группы в составе Basic Service могут иметь отношения parent-child с другими группами. Наличие таких отношений определяет последовательность запуска групп ("сначала parents"). + +На основе ресурсов, предоставляемых и управляемых через Basic Service, могут создаваться другие сервисы. + +`Для взаимодействия с группами виртуальных серверов используется модуль decort_group.` + +Модуль decort_bservice предназначен для управления базовыми службами, в которых находятся группы виртуальных серверов. +Данный модуль позволяет: +- Создавать Basic Service +- Удалять Basic Service (безвозвратно). +- Включать/выключать Basic Service +- Запускать Basic Service +- Запрашивать информацию о Basic Service. + + +## Параметры модуля decort_bservice +Ниже приведен список параметров для модуля **decort_bservice** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + +| Параметр | Тип, допустимые значения | Описание | +| ------ | ------ | ------ | +| account_id | (int) | Уникальный целочисленный идентификатор аккаунта, которому принадлежит ресурсная группа. При идентификации базовой службы и ресурсной группы по именам (см. параметры `name` и `rg_name`) должен быть задан либо идентификатор, либо имя аккаунта (см. параметр `account_name`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется.| +|account_name | (string) | Имя аккаунта, которому принадлежит ресурсная группа. При идентификации базовой службы и ресурсной группы по именам (см. параметры `name` и `rg_name`) должен быть задан либо идентификатор (см. `account_id`), либо имя аккаунта. Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется. | +|state | Значения: `absent`, `disabled`, `enabled`, `present`, `check`.
Default: `present`| Целевое состояние базовой службы. Значения `present` и `enabled` равнозначны.| +| started | (bool)
Default: `true` | Параметр, определяющий состояние добавленных виртуальных серверов в Basic Service. Запускать их, или нет. | +| name | (string) | Имя базовой службы. Данный параметр является обязательным при создании базовой службы и при изменении если не задан `id`. | +| sshuser | (string) | Имя пользователя, который будет создан на всех виртуальных серверах базовой службы. Используется в паре с `sshkey`. | +| sshkey | (string) | SSH ключ, который будет загружен на все виртуальные сервера базовой службы. Используется в паре с `sshuser`. | +| id | (int) | Уникальный целочисленный идентификатор базовой службы. Используется для поиска, изменения и удаления базовой службы. | +| rg_id | (int) | Уникальный целочисленный идентификатор ресурсной группы базовой службы. | +| rg_name | (string) | Имя ресурсной группы базовой службы. | + +## Возвращаемые значения модуля decort_bservice + +Модуль decort_bservice возвращает информацию о базовой службе в виде словаря facts со следующими ключами: + + +|Ключ | Тип данных | Описание| +| ------ | ------ | ------ | +|id | int | Уникальный целочисленный идентификатор базовой службы.| +|name | string | Имя базовой службы.| +| techStatus | string | Технический статус базовой службы. | +|state | string | Статус базовой службы.| +| rg_id | int | Уникальный целочисленный идентификатор ресурсной группы, в которой находится базовая служба.| +| account_id | int | Уникальный целочисленный идентификатор аккаунта, в котором находится ресурсная группа.| +| groups | list | Список словарей с информацией о группах базовой службы.| + + +## Пример использования модуля decort_bservice + +Данный пример создаёт базовую службу с именем databases. + +``` + - name: Create Basic Service + decort_bservice: + authenticator: jwt + controller_url: "{{ controller_url }}" + jwt: "{{ auth_token }}" + name: databases + rg_id: "{{ rg_id }}" + register: db_bservice +``` + +Данный пример удаляет базовую службу с названием databases. +``` + - name: Delete Basic Service + decort_bservice: + authenticator: jwt + controller_url: "{{ controller_url }}" + jwt: "{{ auth_token }}" + state: absent + name: databases + rg_id: "{{ rg_id }}" + register: db_bservice +``` \ No newline at end of file diff --git a/wiki/7.0.0/модуль-decort_disk.md b/wiki/7.0.0/модуль-decort_disk.md new file mode 100644 index 0000000..551178c --- /dev/null +++ b/wiki/7.0.0/модуль-decort_disk.md @@ -0,0 +1,167 @@ +# Модуль decort_disk +## Обзор модуля decort_disk + +Модуль decort_disk предназначен для управления дисками и позволяет производить с ними следующие действия: +- создавать +- удалять (в корзину или безвозвратно) +- восстановливать из корзины +- изменять: + - имя + - размер + - лимиты ввода/вывода + - включать/отключать общий доступ + + +Обратите внимание: + +- Загрузочный диск для виртуальной машины создаётся и подключается автоматически в процессе создания этой машины. +- Модуль decort_disk служит для управления дополнительными дисками (т.н. data-дисками); +- Подключение дополнительных дисков, созданных посредством decort_disk, к виртуальным машинам выполняется с помощью модуля управления виртуальными машинами (см. модуль decort_kvmvm). + +## Параметры модуля decort_disk +Ниже приведен список параметров для модуля **decort_disk** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + +| Параметр | Тип, допустимые значения | Описание | +| ------ | ------ | ------ | +| account_id | (int) | Уникальный целочисленный идентификатор аккаунта, которому принадлежит данный диск. При идентификации диска по имени (см. параметр `name`) должно быть задан либо идентификатор, либо имя аккаунта (см. параметр `account_name`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется.| +|account_name | (string) | Имя аккаунта, которому принадлежит данный диск. При идентификации диска по имени (см. параметр name) должно быть задано либо имя, либо идентификатор учётной записи (см. параметр `account_id`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется. | +| description | (string)
Default: `Disk by decort_disk` | Текстовое описание диска. Данный параметр является опциональным и учитывается только при создании диска, а при всех прочих операциях игнорируется.| +|id | (int) | Уникальный целочисленный идентификатор диска. Соответствующий диск должен существовать (таким образом, с помощью id нельзя создать новый диск, а только управлять уже имеющимися). Если задан данный параметр, то параметры `name`, `account_name` и `account_id` игнорируются.| +| iops | (int)
Default: `2000` | Ограничение ввода/вывода диска. Используется при создании диска. | +| force_detach | (bool)
Default: `false` | Задаёт поведение платформы при попытке удалить диск, подключённый к виртуальной машине.
По умолчанию, удаление подключённых дисков не разрешается, и попытка удалить такой диск приведёт к аварийному завершению модуля. Чтобы изменить это поведение, явно установите `force_detach: true`. | +| limitIO | (dict) | Параметр, позволяющий ограничить скорость ввода/вывода диска как в iops, так и в байтах в секунду. Обратите внимание, что параметры с total не задаются вместе с read/write. Все возможные подпараметры можно увидеть в примерах. | +| name | (string) | Имя диска. Для идентификации диска требуется либо его `name` и информация об аккаунте (`account_id` или `account_name`), которому принадлежит диск, либо его `id`.| +| permanently | (bool)
Default: `false` | Параметр, использующийся при удалении диска, при значении `true` - диск удалится навсегда, а при `false` - попадёт в корзину. | +| place_with | (int) | Идентификатор образа диска, из которого следует взять параметр `sep_id`, чтобы разместить данный диск на той же системе хранения данных, что и указанный образ диска. Данный параметр является опциональным и используется только на стадии создания диска. Если задан `place_with`, то `sep_id` игнорируется.| +| pool | (string) | Название пула на системе хранения данных, в рамках которой следует создать данный диск. Этот параметр используется только на стадии создания диска и игнорируется при операциях над уже существующими дисками. Параметр является опциональным, если не задан, то платформа будет использовать пул, который сконфигурирован на целевой системе хранения как пул по умолчанию. | +| reason | (string)
Default: `Managed by Ansible decort_disk` | Причина, по которой было выполнено какое-либо действие. В данном модуле используется только при удалении диска. | +| sep_id | (int) | Идентификатор системы хранения данных (Storage End-point). Данный параметр определяет систему хранения данных, на ресурсах которой создаётся диск. Используется только при создании диска и игнорируется при прочих операциях. Альтернативой данному параметру является `place_with`, позволяющий разместить диск на той же системе хранения, что и указанный образ диска, на базе которого создаётся виртуальная машина.| +| shareable | (bool)
Default: `false` | Включение/отключение общего доступа к диску. +| size | (int) | Размер диска в ГБ. Этот параметр является обязательным при создании диска. Если он задан для уже существующего диска, а текущий размер диска меньше заданного, то будет предпринята попытка увеличить размер диска. При прочих операциях данный параметр игнорируется.| +| state | (str)
Значения:
`present`
`absent`
Default: `present` | Целевое состояние диска. | +| type | (string)
Значения:
`B`
`D`
Default: `D` | Тип создаваемого диска. `B` - Boot/загрузочный, `D` - Data/с данными. | + +## Возвращаемые значения модуля decort_disk + +Модуль decort_disk возвращает информацию о диске в виде словаря facts со следующими ключами: + + +|Ключ | Тип данных | Описание| +| ------ | ------ | ------ | +| account_id | int | Уникальный целочисленный идентификатор аккаунта, которому принадлежит диск.| +| computes | dict | Словарь, в котором ключ - идентификатор, а значение - имя виртуальной машины, к которой в настоящий момент подключён диск. Если диск не подключён, то возвращается пустой словарь.| +| gid | int | Идентификатор физического кластера (Grid ID), на ресурсах которого создан диск.| +| id | int | Уникальный целочисленный идентификатор данного диска.| +| iotune | dict | Текущие ограничения ввода/вывода диска. | +| name | string | Имя диска. Обратите внимание, что имя диска не является уникальным с точки зрения системы хранения данных, на которой этот диск расположен.| +| pool | string | Имя пула на системе хранения данных, в котором размещаются ресурсы диска.| +|sep_id | int | Идентификатор системы хранения данных (Storage Endpoint), на которой размещаются ресурсы данного диска.| +| size | int | Размер диска в ГБ.| +| state | string | Текущий статус диска. | + + +## Пример использования модуля decort_disk + +В данном примере создаётся диск размером 50ГБ (`size: 50`), с ограничением ввода/вывода в 2000 iops, на ресурсах системы хранения данных под номером 1 (`sep_id: 1`) в пуле "data01". + +``` +- name: Manage disk + decort_disk: + authenticator: oauth2 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + oauth2_url: "https://sso.digitalenergy.online" + controller_url: "https://cloud.digitalenergy.online" + name: "DataDisk01" + size: 50 + account_name: "MyAccount" + sep_id: 1 + iops: 2000 + description: "Disk example" + pool: data01 + register: my_data_disk01 +``` +В следующих двух примерах для существующего диска с именем "DataDisk01" задаются все доступные лимиты на операции ввода/вывода. + +``` +- name: Manage disk + decort_disk: + authenticator: oauth2 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + oauth2_url: "https://sso.digitalenergy.online" + controller_url: "https://cloud.digitalenergy.online" + name: "DataDisk01" + account_name: "MyAccount" + limitIO: + read_bytes_sec: 10000 + write_bytes_sec: 5000 + read_iops_sec и write_iops_sec + read_iops_sec: 2500 + write_iops_sec: 1000 + read_bytes_sec_max: 11000 + write_bytes_sec_max: 6000 + read_iops_sec_max: 3000 + write_iops_sec_max: 1500 + size_iops_sec: 1000 + register: my_data_disk01 + +- name: Manage disk + decort_disk: + authenticator: oauth2 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + oauth2_url: "https://sso.digitalenergy.online" + controller_url: "https://cloud.digitalenergy.online" + name: "DataDisk01" + account_name: "MyAccount" + limitIO: + total_bytes_sec: 15000 + total_iops_sec: 3500 + total_bytes_sec_max: 17000 + total_iops_sec_max: 4500 + size_iops_sec: 1000 + register: my_data_disk01 +``` + +В данном примере выполняется восстановление удаленного диска с id 111 из корзины. + +``` +- name: Manage disk + decort_disk: + authenticator: oauth2 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + oauth2_url: "https://sso.digitalenergy.online" + controller_url: "https://cloud.digitalenergy.online" + id: 111 + size: 10 + register: my_data_disk01 +``` + +В данном примере выполняется переименование диска с id 111 на новое имя "NewExampleDisk". + +``` +- name: Manage disk + decort_disk: + authenticator: oauth2 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + oauth2_url: "https://sso.digitalenergy.online" + controller_url: "https://cloud.digitalenergy.online" + id: 111 + name: "NewExampleDisk" + size: 10 + register: my_data_disk01 +``` + +Здесь результат работы модуля decort_disk записывается в переменную my_data_disk01. Для получения идентификатора диска, например, при подключении его к виртуальной машине, следует воспользоваться показанной ниже конструкцией: + +``` +- name: Manage compute + decort_kvmvm: + << для краткости фрагмент опущен >> + data_disks: + - "{{ my_data_disk01.facts.id }}" + << для краткости фрагмент опущен >> +``` \ No newline at end of file diff --git a/wiki/7.0.0/модуль-decort_group.md b/wiki/7.0.0/модуль-decort_group.md new file mode 100644 index 0000000..cc4a638 --- /dev/null +++ b/wiki/7.0.0/модуль-decort_group.md @@ -0,0 +1,97 @@ +# Модуль decort_group +## Обзор модуля decort_group +Модуль **decort_group** позволяет производить следующие действия над группами базовой службы: +- создать +- получить информацию +- запустить/остановить +- подключить/отключить сети (для существующей группы только внутренние сети) +- изменить + - имя + - объём загрузочного диска + - количество ВМ + - роль + - количество виртуальных процессоров + - объём ОЗУ +- удалить (безвозвратно) + +## Параметры модуля decort_group +Ниже приведен список параметров для модуля **decort_group** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + +| Параметр | Тип, допустимые значения | Описание | +| ------ | ------ | ------ | +| account_id | (int) | Идентификатор аккаунта. При идентификации диска по имени (см. параметр `name`) должен быть задан либо идентификатор, либо имя аккаунта (см. параметр `account_name`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется. | +| account_name | (string) | Имя аккаунта. При идентификации диска по имени (см. параметр `name`) должно быть задано либо имя, либо идентификатор аккаунта (см. параметр `account_id`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется. | +| boot_disk | (int) | Обьём загрузочного диска. | +| bservice_id | (int) | Идентификатор базовой службы. Обязательный параметр. | +| count | (int) | Количество виртуальных машин. | +| cpu | (int) | Количество виртуальных процессоров. | +| driver | (string)
Значения:
`KVM_X86`
`SVA_KVM_X86`
Default: `KVM_X86` | Драйвер. | +| id | (int) | Идентификатор группы. | +| image_id | (int) | Идентификатор образа. | +| name | (str) | Имя группы.
Используется для идентификации группы, если не задан параметр `id`, а также для переименования группы, если параметр `id` задан. | +| networks | (list) | Список словарей, описывающих сети, которые должны быть подключены.
Ключи словаря:
• `type` (string) (обязательный) - тип сети; значения: `VINS` (внутренняя) или `EXTNET` (внешняя)
• `id` (int) (обязательный) - идентификатор сети | +| ram | (int) | Объём оперативной памяти. | +| role | (string) | Тег роли. | +| state | (str)
Значения:
`present`
`absent`
`started`
`stopped`
`check`
Default: `present` | +| timeoutStart | (int) | Время отсрочки запуска группы после создания в секундах. | + +## Возвращаемые значения модуля decort_group + +Модуль **decort_group** возвращает информацию о диске в виде словаря facts со следующими ключами: + + +|Ключ | Тип данных | Описание| +| ------ | ------ | ------ | +| account_id | int | Идентификатор аккаунта. | +| Computes | list | Список словарей, содержащих информацию о виртуальных машинах группы.
Ключи словаря:
• `id` (int) - идентификатор ВМ
• `ipAddresses` (list) - список IP-адресов ВМ
• `name` (str) - имя ВМ
• `osUsers` (list) - список словарей, содержащих учётные данные пользователей ОС ВМ по умолчанию; ключи: `login` (str) и `password` (str) | +| id | int | Идентификатор группы.| +| name | string | Имя группы.| +| rg_id | int | Идентификатор ресурсной группы. | +| state | string | Состояние группы. | +| techStatus | string | Технический статус группы. | + +## Пример использования модуля decort_group + +Данный пример создаёт группу с именем `test_group`. +``` +- hosts: localhost + tasks: + - name: Create BS group + decort_group: + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + authenticator: oauth2 + boot_disk: 10 + bservice_id: 1823 + controller_url: "https://ds1.digitalenergy.online" + count: 2 + cpu: 2 + image_id: 518 + name: test_group + networks: + - type: VINS + id: 1987 + oauth2_url: "https://sso.digitalenergy.online" + ram: 2 + verify_ssl: false + register: group_test +``` + +Данный пример удаляет группу с именем `test_group`. + +``` +- hosts: localhost + tasks: + - name: Delete BS group + decort_group: + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + authenticator: oauth2 + bservice_id: 1823 + controller_url: "https://ds1.digitalenergy.online" + name: test_group + oauth2_url: "https://sso.digitalenergy.online" + state: absent + verify_ssl: False + register: group_test +``` \ No newline at end of file diff --git a/wiki/7.0.0/модуль-decort_jwt.md b/wiki/7.0.0/модуль-decort_jwt.md new file mode 100644 index 0000000..a38b9f3 --- /dev/null +++ b/wiki/7.0.0/модуль-decort_jwt.md @@ -0,0 +1,48 @@ +# Модуль decort_jwt +## Обзор модуля +Модуль **decort_jwt** предназначен для получения авторизационного токена JWT (JSON Web Token). Данный модуль может быть полезен при массовом создании ресурсов (например, виртуальных машин), так как позволяет оптимизировать количество API вызовов для получения токена. + +По сути, данный модуль является провайдером информации и не управляет облачными ресурсами (всегда возвращает `changed: False`). + +## Параметры модуля decort_jwt +Список параметров для модуля **decort_jwt** почти полностью совпадает с [общими параметрами модулей для авторизации](./введение.md#общие-параметры-модулей-для-авторизации). + +Отличия от общих параметров: +- Параметр `controller_url` не используется. +- Параметр `jwt` не используется. +- В параметре `authenticator` не используется значение `jwt`. + +## Возвращаемые значения модуля decort_jwt +| Ключ | Тип данных | Описание | +|---| ------ | ------ | +| jwt | str | JWT токен. | + +## Примеры использования +### Пример получения JWT токена с помощью DECS3O +``` +- name: Example + hosts: localhost + tasks: + - name: Obtain JWT from DECS3O + decort_jwt: + app_id: "{{ app_id }}" + app_secret: "{{ app_secret }}" + authenticator: decs3o + oauth2_url: https://sso-dynamix.local +``` + +### Пример получения JWT токена с помощью BVS +``` +- name: Example + hosts: localhost + tasks: + - name: Obtain JWT from BVS + decort_jwt: + app_id: "{{ app_id }}" + app_secret: "{{ app_secret }}" + authenticator: bvs + oauth2_url: https://bvs.local + domain: dynamix + username: "{{ username }}" + password: "{{ password }}" +``` diff --git a/wiki/7.0.0/модуль-decort_k8s.md b/wiki/7.0.0/модуль-decort_k8s.md new file mode 100644 index 0000000..12fcd3e --- /dev/null +++ b/wiki/7.0.0/модуль-decort_k8s.md @@ -0,0 +1,112 @@ +# Модуль decort_k8s +## Обзор модуля decort_k8s + +Модуль **decort_k8s** предназначен для выполнения следующих действий над кластерами Kubernetes: +- создать +- получить информацию +- отключить/включить/запустить +- изменить группы Worker-узлов +- удалить (в корзину или безвозвратно) +- восстановить из корзины + +## Параметры модуля decort_k8s +Ниже приведен список параметров для модуля **decort_k8s** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + +| Параметр | Тип, допустимые значения | Описание | +| ------ | ------ | ------ | +| account_id | (int) | Идентификатор аккаунта. | +| account_name | (string) | Имя аккаунта. | +| additionalSANs | (list) | Список дополнительных SAN (Subject Alternative Names) для использования в процессе автоматического выписывания сертификата Кластера Kubernetes. Можно использовать IP-адреса и доменные имена. +| cluster_conf | (dict) | Словарь с глобальными настройками и конфигурацией для всего кластера. Включает в себя такие настройки, как имя кластера, настройки DNS, методы аутентификации и другие конфигурации всего кластера. | +| description | (string)
Default: `Created by decort ansible module` | Описание кластера. | +| extnet_id | (int)
Default: `0` | Идентификатор внешней сети. Если задан `0`, то внешняя сеть выбирается автоматически. Если задан параметр `vins_id`, то значение данного параметра будет проигнорировано. Если задан `extnet_only: false`, то внешняя сеть будет подключена к создаваемой внутренней сети, а если `extnet_only: true`, то либо напрямую к каждому узлу кластера (если `with_lb: false`), либо напрямую к балансировщику нагрузки (если `with_lb: true`). | +| extnet_only | (bool)
Default: `false` | Не использовать внутреннюю сеть, подключать напрямую к внешней. | +| getConfig | (bool)
Default: `false` | Получить данные конфигурации для доступа к кластеру Kubernetes. | +| ha_lb | (bool)
Default: `false` | Использовать схему высокой доступности для создаваемого балансировщика нагрузки (если `with_lb: true`). | +| id | (int) | Идентификатор кластера Kubernetes. | +| init_conf | (dict) | Словарь для определения настроек и действий, которые должны быть выполнены перед запуском любого другого компонента в кластере. Позволяет настраивать такие процессы, как регистрация узла, настройка сети и другие задачи инициализации. +| join_conf | (dict) | Словарь для настройки поведения и параметров присоединения узла к кластеру. Включает в себя такие параметры, как control-plane-endpoint кластера, токен и certificate-key. | +| k8ci_id | (int) | Идентификатор конфигурации кластера Kubernetes. | +| kubeproxy_conf | (dict) | Словарь для настройки поведения и настроек Kube-proxy, отвечающего за сетевое проксирование и балансировку нагрузки внутри кластера. Включает в себя такие параметры, как режим прокси, диапазоны IP-адресов кластера и другие конфигурации, специфичные для Kube-proxy. | +| kublet_conf | (dict) | Словарь для настройки поведения и настроек Kubelet, который является агентом основного узла, работающим на каждом узле кластера. Включает в себя такие параметры, как IP-адрес узла, распределение ресурсов, политики вытеснения модулей и другие конфигурации, специфичные для Kubelet. | +| master_chipset | (string)
Значения:
`Q35`
`i440fx` | Эмулируемый чипсет master-узлов. Не применим при изменении существующего кластера.
Значение по умолчанию при создании: `i440fx`. | +| master_count | (int)
Default: `1` | Количество Master-узлов. | +| master_cpu | (int)
Default: `2` | Количество виртуальных процессоров на Master-узле. | +| master_disk | (int)
Default: `10` | Объём загрузочного диска на Master-узле. | +| master_pool | (str) | Пул СХД, заданной параметром `master_sepid`. | +| master_ram | (int)
Default: `2048` | Объём оперативной памяти на Master-узле. | +| master_sepid | (int) | Идентификатор СХД для Master-узла. Если не задан, то используется СХД образа Master-узла. | +| name | (string) | Имя кластера Kubernetes. | +| network_plugin | (str)
Значения:
`flannel`
`calico`
`weavenet`
Default: `flannel` | CNI plugin (модуль для управления сетевыми интерфейсами контейнера). Возможные значения могут быть ограничены в используемой конфигурации кластера Kubernetes (параметр `k8ci_id`) | +| oidc_cert | (raw) | Сертификат X.509 для OIDC-провайдера. +| permanent | (bool)
Default: `false` | Если выполняется удаление, то выполнить безвозвратное удаление (минуя корзину). | +| rg_id | (int) | Идентификатор ресурсной группы. | +| rg_name | (str) | Имя ресурсной группы. | +| started | (bool)
Default: `true` | Запустить кластер.
Используется только для существующего кластера. | +| state | (string)
Значения:
`present`
`absent`
`enabled`
`disabled`
`check`
Default: `present` | Целевое состояние кластера. | +| vins_id | (int) | Идентификатор внутренней сети. Если не задан, то будет создана новая внутренняя сеть. Если задан, то заданная внутренняя сеть должна иметь подключение к внешней сети. Если задано `extnet_only: true`, то параметр игнорируется. +| with_lb | (bool)
Default: `true` | Создание кластера Kubernetes с размещением Master-узлов за балансировщиком нагрузки. В ином случае каждый узел получит отдельный адрес из внешней сети. +| workers | (list) | Список словарей, описывающих группы Worker-узлов.
Ключи словаря:
• `annotations` (list) (необязательный) - список строк с annotations в формате: `key1=value1`; значение по умолчанию при создании: `[]`
• `chipset` (str) (необязательный) - эмулируемый чипсет. Допустимые значения: `Q35`, `i440fx`; значение по умолчанию при создании: `i440fx`
• `ci_user_data` (dict) (необязательный) - конфигурация для cloud-init; значение по умолчанию при создании: `{}`
• `cpu` (int) (необязательный) - количество виртуальных процессоров на узле; значение по умолчанию при создании: `1`
• `disk` (int) (необязательный) - объём загрузочного диска на узле; если не задан при создании, размер диска будет равен размеру используемого образа
• `labels` (list) (необязательный) - список строк с labels в формате: `label1=value1`; значение по умолчанию при создании: `[]`. Метка `workersGroupName` является служебной в платформе и игнорируется при сравнении переданных меток с существующими
• `name` (string) (обязательный) - имя группы Worker-узлов
• `num` (int) (необязательный) - количество узлов; значение по умолчанию при создании: `1`
• `pool` (str) (необязательный) - пул СХД, заданной ключом `sep_id`; если не задан при создании, то пул будет выбран платформой
• `ram` (int) (необязательный) - объём оперативной памяти на узле; значение по умолчанию при создании: `1024`
• `sep_id` (int) (необязательный) - идентификатор СХД; если не задан при создании, то используется СХД образа узла
• `taints` (list) (необязательный) - список строк с taints в формате: `key1=value1:NoSchedule`; значение по умолчанию при создании: `[]`. | + +## Возвращаемые значения модуля decort_k8s + +Модуль **decort_k8s** возвращает информацию о кластере в виде словаря `facts` со следующими ключами: + + +| Ключ | Тип данных | Описание | +| ------ | ------ | ------ | +| account_id | int | Идентификатор аккаунта. | +| config | str | Kuber config кластера. +| id | int | Идентификатор кластера. | +| k8s_Masters | dict | Словарь с информацией о группе Master-узлов.
Ключи словаря:
• `cpu` (int) - количество виртуальных процессоров
• `detailedInfo` (list) - список словарей с информацией об узлах; ключи словаря: `id` (int) - идентификатор ВМ, `name` (str) - имя ВМ, `status` (str) - статус ВМ, `techStatus` (str) - технический статус ВМ
• `disk` (int) - объём загрузочного диска
• `id` (int) - идентификатор группы
• `name` (str) - имя группы
• `num` (int) - количество узлов
• `ram` (int) - объём оперативной памяти +| k8s_Workers | dict | Список словарей с информацией о группах Worker-узлов.
Ключи словаря:
• `cpu` (int) - количество виртуальных процессоров
• `detailedInfo` (list) - список словарей с информацией об узлах; ключи словаря: `id` (int) - идентификатор ВМ, `name` (str) - имя ВМ, `status` (str) - статус ВМ, `techStatus` (str) - технический статус ВМ
• `disk` (int) - объём загрузочного диска
• `id` (int) - идентификатор группы
• `labels` (list) - список строк с labels
• `name` (str) - имя группы
• `num` (int) - количество узлов
• `ram` (int) - объём оперативной памяти
• `taints` (list) - список строк с taints +| name | string | Имя кластера. | +| rg_id | int | Идентификатор ресурсной группы. | +| state | string | Статус кластера. | +| techStatus | string | Технический статус кластера. | +| vins_id | int | Идентификатор внутренней сети кластера. | + + +## Пример использования модуля decort_k8s + + +Пример создания кластера Kubernetes с именем `cluster-test` с получением Kuber config. +``` + - name: Create a k8s cluster named cluster-test + decort_k8s: + authenticator: jwt + controller_url: "https://ds1.digitalenergy.online" + getConfig: true + jwt: "{{ token.jwt }}" + k8ci_id: 18 + name: cluster-test + rg_id: 125 + workers: + - cpu: 10 + disk: 10 + name: wg1 + num: 1 + ram: 1024 + chipset: i440fx + ci_user_data: {} + taints: + - key=value:NoSchedule + annotations: + - key=value + labels: + - label=value + - cpu: 10 + disk: 10 + name: wg2 + num: 2 + ram: 1024 + chipset: Q35 + ci_user_data: {} + taints: + - key=value:NoSchedule + annotations: + - key=value + labels: + - label=value + register: k8s_cluster +``` \ No newline at end of file diff --git a/wiki/7.0.0/модуль-decort_kvmvm.md b/wiki/7.0.0/модуль-decort_kvmvm.md new file mode 100644 index 0000000..aaf611b --- /dev/null +++ b/wiki/7.0.0/модуль-decort_kvmvm.md @@ -0,0 +1,887 @@ +# Модуль decort_kvmvm +## Обзор модуля decort_kvmvm + +Модуль **decort_kvmvm** предназначен для выполнения следующих действий над виртуальными машинами: +- **создать** (см. [примеры](#создать)) + - **с указанием описания** (см. параметр **description** и [примеры](#с-указанием-описания)) + - **с указанием объёма загрузочного диска** (см. параметр **boot_disk** и [примеры](#с-указанием-объёма-загрузочного-диска)) + - **с указанием СХД** (см. параметры **sep_id** и **pool** и [примеры](#с-указанием-схд)) + - **с указанием Cloud-init user data** (см. параметр **ci_user_data** и [примеры](#с-указанием-cloud-init-user-data)) + - **с указанием SSH-ключа** (см. параметры **ssh_key** и **ssh_key_user** и [примеры](#с-указанием-ssh-ключа)) + - **с указанием NUMA Affinity** (см. параметр **numa_affinity** и [примеры](#с-указанием-numa-affinity)) + - **с указанием запуска на выделенных процессорах** (см. параметр **cpu_pin** и [примеры](#с-указанием-запуска-на-выделенных-процессорах)) + - **с использованием Huge Pages** (см. параметр **hp_backed** и [примеры](#с-использованием-huge-pages)) + - **с указанием custom_fields** (см. параметр **custom_fields** и [примеры](#с-указанием-custom_fields)) + - **с указанием affinity-метки** (см. параметр **affinity_label** и [примеры](#с-указанием-affinity-метки)) + - **с указанием affinity правил** (см. параметр **aff_rule** и [примеры](#с-указанием-affinity-правил)) + - **с указанием anti-affinity правил** (см. параметр **aaff_rule** и [примеры](#с-указанием-anti-affinity-правил)) + - **с указанием тэгов** (см. параметр **tag** и [примеры](#с-указанием-тэгов)) + - **с образом** (см. параметры **image_id** и **image_name** и [примеры](#с-образом)) + - **без образа** (см. параметры **image_id** и **image_name** и [примеры](#без-образа)) + - **с загрузочным диском** (см. параметр **boot_disk** и [примеры](#с-загрузочным-диском)) + - **без загрузочного диска** (см. параметр **boot_disk** и [примеры](#без-загрузочного-диска)) + - **с включением автоматического запуска ВМ после перезапуска вычислительного узла, за которым она закреплена** (см. параметр **auto_start** и [примеры](#с-включением-автоматического-запуска-вм-после-перезапуска-вычислительного-узла-за-которым-она-закреплена)) +- **получить информацию** (см. [возвращаемые значения](#возвращаемые-значения-модуля-decort_kvmvm) и [примеры](#получение-основной-информации-о-виртуальной-машине)) +- **остановить/приостановить/запустить** (см. параметр **state** и [примеры](#остановитьприостановитьзапустить)) +- **подключить/отключить диски с данными** (см. параметр **data_disks** и [примеры](#подключитьотключить-диски-с-данными)) +- **подключить/отключить сети** (см. параметры **networks** и **network_order_changing** и [примеры](#подключитьотключить-сети)) +- **изменить** (см. [примеры](#изменить)) + - **объём загрузочного диска в большую сторону** (см. параметр **boot_disk** и [примеры](#объём-загрузочного-диска-в-большую-сторону)) + - **количество CPU** (см. параметр **cpu** и [примеры](#количество-cpu)) + - **объём ОЗУ** (см. параметр **ram** и [примеры](#объём-озу)) + - **тэги** (см. параметр **tag** и [примеры](#тэги)) + - **affinity метку** (см. параметр **affinity_label** и [примеры](#affinity-метку)) + - **affinity правила** (см. параметр **aff_rule** и [примеры](#affinity-правила)) + - **anti-affinity правила** (см. параметр **aaff_rule** и [примеры](#anti-affinity-правила)) + - **описание** (см. параметр **description** и [примеры](#описание)) + - **чипсет** (см. параметр **chipset** и [примеры](#чипсет)) + - **правило NUMA Affinity** (см. параметр **numa_affinity** и [примеры](#правило-numa-affinity)) + - **использование CPU Pinning** (см. параметр **cpu_pin** и [примеры](#использование-cpu-pinning)) + - **использование Huge Pages** (см. параметр **hp_backed** и [примеры](#использование-huge-pages)) + - **имя** (см. параметр **name** и [примеры](#имя)) + - **XML виртуальной машины** (см. параметр **custom_fields** и [примеры](#xml-виртуальной-машины)) + - **автоматический запуск ВМ после перезапуска вычислительного узла, за которым она закреплена** (см. параметр **auto_start** и [примеры](#автоматический-запуск-вм-после-перезапуска-вычислительного-узла-за-которым-она-закреплена)) +- **удалить (безвозвратно)** (см. параметр **state** и [примеры](#безвозвратно)) + +## Параметры модуля decort_kvmvm +Ниже приведен список параметров для модуля **decort_kvmvm** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + +| Параметр | Тип, допустимые значения | Описание | +| ------ | ------ | ------ | +| aaff_rule | (list) | Список словарей, описывающих anti-affinity правила.
Ключи словаря:
• `topology` (string) (обязательный) - назначение правила; значения: `node` (узел) или `compute` (ВМ)
• `policy` (string) (обязательный) - степень "необходимости" этого правила; значения: `RECOMMENDED` или `REQUIRED`
• `mode` (string) (обязательный) - режим сравнения; значения: `EQ` (должно соответствовать), `NE` (не должно соответствовать), `ANY` (любое)
• `key` (string) (обязательный) - ключ, который учитывается при анализе данного правила
• `value` (string) (обязательный) - значение ключа, учитываемого при анализе данного правила (зависит от ключа `mode`).
Чтобы очистить anti-affinity правила, нужно указать пустой список `[]`. | +| account_id | (int) | Идентификатор аккаунта. Этот параметр является опциональным и используется в сценариях, когда уже существующая ресурсная группа задается комбинацией `account_id` и `rg_name`. Если задан `account_id`, то `account_name` игнорируется.| +| account_name | (string) | Имя аккаунта. Этот параметр является опциональным и используется в сценариях, когда уже существующая ресурсная группа задается комбинацией `account_name` и `rg_name`. Если задан `account_id`, то `account_name` игнорируется. | +| aff_rule | (list) | Список словарей, описывающих affinity правила.
Ключи словаря:
• `topology` (string) (обязательный) - назначение правила; значения: `node` (узел) или `compute` (ВМ)
• `policy` (string) (обязательный) - степень "необходимости" этого правила; значения: `RECOMMENDED` или `REQUIRED`
• `mode` (string) (обязательный) - режим сравнения; значения: `EQ` (должно соответствовать), `NE` (не должно соответствовать), `ANY` (любое)
• `key` (string) (обязательный) - ключ, который учитывается при анализе данного правила
• `value` (string) (обязательный) - значение ключа, учитываемого при анализе данного правила (зависит от ключа `mode`).
Чтобы очистить affinity правила, нужно указать пустой список `[]`. | +| affinity_label | (str) | Метка affinity.
Чтобы очистить метку affinity, нужно указать пустую строку `""`. | +| auto_start | (bool) | Включить/выключить автоматический запуск ВМ после перезапуска вычислительного узла, за которым она закреплена.
Если параметр не задан при создании ВМ, то значение будет выбрано платформой. | +| boot_disk | (int) | Объём загрузочного диска виртуальной машины в ГБ. | +| chipset | (string)
Значения:
`Q35`
`i440fx` | Эмулируемый чипсет. | +| ci_user_data | (dict) | конфигурация для cloud-init +| cpu | (int) | Количество виртуальных процессоров, выделяемых виртуальной машине. | +| cpu_pin | (bool) | Запуск виртуальной машины на выделенных процессорах. Чтобы использовать эту функцию, система должна быть предварительно сконфигурирована путем выделения процессоров на физическом узле.
Значение по умолчанию при создании: `false`. | +| custom_fields | (dict) | Словарь, управляющий XML виртуальной машины.
Ключи словаря:
• `disable` (bool) - отключение управления виртуальной машиной через XML. Значение по умолчанию при создании: `true`
• `fields` (dict) - поля для управления XML виртуальной машины. | +| data_disks | (list) | Список идентификаторов дисков, которые следует подключить к данной виртуальной машине как дополнительные.
Чтобы отключить все диски, нужно указать пустой список `[]`.| +| description | (string) | Опциональное описание виртуальной машины. | +| hp_backed | (bool) | Использовать Huge Pages для выделения оперативной памяти виртуальной машины. Система должна быть предварительно сконфигурирована путем выделения Huge Pages на физическом узле.
Значение по умолчанию при создании: `false`. | +| id | (int) | Уникальный цифровой идентификатор виртуальной машины. Этот параметр используется как один из методов идентификации существующей ВМ (альтернатива – по комбинации `name`, `rg_name` и `account_name`). Если при вызове модуля **decort_kvmvm** существующая ВМ идентифицируется по `id`, то параметры `account_id`, `account_name`, `rg_id` и `rg_name` игнорируются. | +| image_id | (int) | Уникальный цифровой идентификатор образа, на базе которого следует создать виртуальную машину. При создании задать этот параметр или параметр `image_name`. При любых других операциях данные параметры игнорируются. Если заданы оба этих параметра (`image_id` и `image_name`), то `image_name` игнорируется. | +| image_name | (string) | Название образа, на базе которого следует создать ВМ. При создании требуется задать этот параметр или параметр `image_id`. При любых других операциях данные параметры игнорируются. | +| name | (string) | Имя ВМ. Чтобы модуль **decort_kvmvm** мог управлять сервером по его названию, также необходимо задать комбинацию `account_name` и `rg_name` или `rg_id`. Если для существующей ВМ указаны и `name`, и `id`, то параметр `name` игнорируется и идентификация сервера выполняется по `id`.| +| network_order_changing | (bool)
Default:
`false` | Соблюдение очерёдности сетей при их изменении.
Если `true`, то сравнение списка уже подключённых к ВМ сетей со списком из параметра `networks` будет производится с учётом очерёдности сетей и, при выявлении несоответствия, сначала будет произведено отключение всех сетей от ВМ, а затем подключение сетей в соответствии с параметром `networks`.
Если `false`, то очерёдность при сравнении учитываться не будет. Соответственно, сети, которые имеются в списке параметра `networks` и уже подключены к ВМ, переподключаться не будут, что может кратно уменьшить время выполнения изменения сетей. | +| networks | (list) | Список словарей, описывающих сети ВМ.
Ключи словаря:
• `type` (string) (обязательный) - тип сети; значения: `VINS` (внутренняя), `EXTNET` (внешняя), `VFNIC` (вирт. функция), `DPDK`, `EMPTY` (без подключения к сети)
• `id` (int) (необязательный) - идентификатор внутренней/внешней/DPDK сети или пула вирт. функций
• `ip_addr` (string) (необязательный) - IP-адрес, используемый для подключения к данной сети; применимо только для `VINS` и `EXTNET`
• `mtu` (int) (необязательный) - MTU интерфейса; применимо только для `DPDK`.
ВМ не может одновременно быть подключена к сети DPDK и к сети другого типа.
Чтобы отключить все сети, нужно указать пустой список `[]`. | +| numa_affinity | (str)
Значения:
`strict`
`loose`
`none` | Правило применения NUMA affinity к виртуальной машине.
`strict` - строго с NUMA affinity, `loose` - использовать NUMA affinity, если возможно, `none` - отменить применение NUMA affinity.
Значение по умолчанию при создании: `none`. | +| pool | (str) | Пул СХД, заданной параметром `sep_id`. Если пул не задан, то он будет выбран платформой. +| ram | (int) | Объем оперативной памяти в МБ, выделенной данной ВМ. Параметр является обязательным при создании. Если указать его для уже существующей ВМ, то будет выполнена попытка изменить объем выделенной памяти. | +| rg_id | (int) | Уникальный цифровой идентификатор уже существующей ресурсной группы, в которой будет создана новая или находится уже существующая ВМ. Данный параметр является одним из методов идентификации существующей РГ (альтернативой является задание комбинации `account_name` и `rg_name`).| +| rg_name | (string) | Имя уже существующей ресурсной группы, в которой будет создаа новая или находится уже существующая ВМ. Данный параметр является одним из методов идентификации существующей РГ, когда задается пара `account_name` и `rg_name` (альтернативой является задание `rg_id`). Если заданы и `rg_id`, и `rg_name`, то параметр `rg_name` игнорируется.| +| sep_id | (int) | Идентификатор СХД для загрузочного диска ВМ. Если не задан, то будет использоваться СХД образа. +| ssh_key | (string) | Открытая часть SSH-ключа, который необходимо добавить на создаваемую ВМ для пользователя, заданного параметром `ssh_key_user`. Данный параметр применим только для ОС Linux, используется только при создании и игнорируется при других операциях. | +| ssh_key_user | (string) | Имя пользователя в гостевой ОС (только для Linux), для которого добавляется SSH-ключ, заданный параметром `ssh_key`. Данный параметр является обязательным, если задан `ssh_key`. Используется только при создании и игнорируется при других операциях. | +| state | (str)
Значения:
`present`
`absent`
`poweredon`
`poweredoff`
`halted`
`paused` | Целевое состояние ВМ.
`present` - виртуальная машина существует и не удалена. Если удалена в корзину, то будет восстановлена из корзины.
`absent` - виртуальная машина безвозвратно удалена.
`poweredon` - виртуальная машина запущена. Если остановлена, то будет запущена. Если удалена в корзину, то будет восстановлена из корзины.
`poweredoff` - виртуальная машина остановлена. Если запущена, то будет остановлена.
`halted` - аналогично `poweredoff`.
`paused` - виртуальная машина приостановлена.
Значение по умолчанию при создании: `present`. | +| tag | (dict) | Словарь, пары ключ-значение которого, описывают тэги для ВМ.
Чтобы очистить теги, нужно указать пустой словарь `{}`.| + +## Возвращаемые значения модуля decort_kvmvm + +Модуль **decort_kvmvm** возвращает информацию о виртуальной машине в виде словаря `facts` со следующими ключами: + + +| Ключ | Тип данных | Описание | +| ------ | ------ | ------ | +| account_id | int | Идентификатор аккаунта. | +| arch | string | Архитектура ВМ. | +| auto_start | bool | Автоматический запуск ВМ после перезапуска вычислительного узла, за которым она закреплена. | +| chipset | string | Эмулируемый чипсет. | +| cpu | int | Количество виртуальных процессоров. | +| cpu_pin | bool | Запуск виртуальной машины на выделенных процессорах. | +| custom_fields | dict | Словарь, управляющий XML виртуальной машины. Если `null`, то управление виртуальной машиной через XML отключено, иначе - управление через XML включено. | +| data_disks | list | Список идентификаторов дисков с данными, подключенных к ВМ. | +| disk_size | int | Размер загрузочного диска в ГБ. | +| hp_backed | bool | Использовать Huge Pages для выделения оперативной памяти виртуальной машины. | +| id | int | Идентификатор ВМ. | +| image_id | id | Идентификатор образа. +| interfaces | list | Список словарей, описывающих сетевые интерфейсы ВМ. | +| name | string | Имя ВМ. | +| numa_affinity | str | Правило применения NUMA affinity к виртуальной машине. | +| password | string | Пароль пользователя ОС по умолчанию. | +| private_ips | list | Список IP-адресов на сетевых интерфейсах ВМ, которые подключены к внутренним сетям. | +| public_ips | list | Список IP адресов на сетевых интерфейсах ВМ, которые подключены к внешним сетям. | +| ram | int | Объём ОЗУ ВМ в МБ. | +| rg_id | int | Идентификатор ресурсной группы, которой принадлежит данная ВМ. | +| state | string | Состояние ВМ.| +| tags | dict | Словарь, пары ключ-значение которого, описывают тэги ВМ. +| tech_status | str | Технический статус ВМ. +| username | string | Имя пользователя ОС по умолчанию. | +| vnc_password | string | Пароль, используемый для подключения к ВМ через VNC. | + +## Примеры использования + +### Создать + +#### С указанием описания +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with image + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + description: vm description + state: present +``` + +#### С указанием объёма загрузочного диска +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with image + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + boot_disk: 10 + state: present +``` + +#### С указанием СХД +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with image + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + sep_id: "{{ sep_id }}" + pool: "{{ sep_pool_name }}" + state: present +``` + +#### С указанием Cloud-init user data +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with image + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + ci_user_data: + packages: + - apache2 + write_files: + - content: | +
+ Hello World! +
+ owner: user:user + path: /var/www/html/index.html + hostname: test-apache + ssh_keys: + - rsa_public: ssh-rsa AAAAOasDmLxnD= user@pc + state: present +``` + +#### С указанием SSH-ключа +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with image + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA... + ssh_key_user: user + state: present +``` + +#### С указанием NUMA Affinity +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with image + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + numa_affinity: strict + state: present +``` + +#### С указанием запуска на выделенных процессорах +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with image + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + cpu_pin: true + state: present +``` + +#### С использованием Huge Pages +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with image + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + hp_backed: true + state: present +``` + +#### С указанием custom_fields +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with image + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + custom_fields: + fields: + title: Title + cpu: + mode: custom + vendor: Intel + cache: + mode: disable + topology: + sockets: 1 + cores: 14 + threads: 1 + match: minimum + check: partial + state: present +``` + +#### С указанием affinity-метки +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with affinity-label + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + affinity_label: label + state: present +``` + +#### С указанием affinity правил +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with affinity rules + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + aff_rule: + - topology: compute + policy: RECOMMENDED + mode: EQ + key: key + value: value + state: present +``` + +#### С указанием anti-affinity правил +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with anti-affinity rules + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + aaff_rule: + - topology: node + policy: REQUIRED + mode: ANY + key: key + value: value + state: present +``` + +#### С указанием тэгов +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with tags + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + tag: + tag1_key: tag1_value + tag2_key: tag2_value + state: present +``` + +#### С образом +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM with image + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + image_id: "{{ image_id }}" + chipset: Q35 + state: present +``` + +#### Без образа + +##### С загрузочным диском +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM without image and with boot disk + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + chipset: Q35 + boot_disk: 10 + state: present +``` + +##### Без загрузочного диска +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM without image and without boot disk + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + chipset: Q35 + state: present +``` + +#### С включением автоматического запуска ВМ после перезапуска вычислительного узла, за которым она закреплена +``` +- name: Example + hosts: localhost + tasks: + - name: Create VM + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" + cpu: 1 + ram: 512 + chipset: Q35 + auto_start: true + state: present +``` + +### Получение основной информации о виртуальной машине + +#### По идентификатору +``` +- name: Example + hosts: localhost + tasks: + - name: Get basic VM info by ID + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" +``` + +#### По имени +``` +- name: Example + hosts: localhost + tasks: + - name: Get basic VM info by name + decort_kvmvm: + # Параметры для авторизации упущены + rg_id: "{{ rg_id }}" + name: "{{ vm_name }}" +``` + +### Остановить/приостановить/запустить + +#### Остановить +``` +- name: Example + hosts: localhost + tasks: + - name: Stop VM + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + state: poweredoff +``` + +#### Запустить +``` +- name: Example + hosts: localhost + tasks: + - name: Start VM + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + state: poweredon +``` + +#### Приостановить +``` +- name: Example + hosts: localhost + tasks: + - name: Pause VM + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + state: paused +``` + +### Подключить/отключить диски с данными + +#### Подключить +``` +- name: Example + hosts: localhost + tasks: + - name: Connect data disks to VM + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + data_disks: + - "{{ datadisk1_id }}" + - "{{ datadisk2_id }}" +``` + +#### Отключить +``` +- name: Example + hosts: localhost + tasks: + - name: Disconnect data disks from VM + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + data_disks: [] +``` + +### Подключить/отключить сети + +#### Подключить не-DPDK сети +``` +- name: Example + hosts: localhost + tasks: + - name: Connect networks to VM + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + networks: + - type: VINS + id: "{{ vins_id }}" + ip_addr: 192.168.4.0 + - type: EMPTY + - type: EXTNET + id: "{{ extnet_id }}" + ip_addr: 35.21.230.0 + - type: VFNIC + id: "{{ vfpool_id }}" + state: poweredoff +``` + +#### Подключить не-DPDK сети с соблюдением очередности +``` +- name: Example + hosts: localhost + tasks: + - name: Connect networks to VM without network order changing + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + networks: + - type: VINS + id: "{{ vins_id }}" + ip_addr: 192.168.4.0 + - type: EMPTY + - type: EXTNET + id: "{{ extnet_id }}" + ip_addr: 35.21.230.0 + - type: VFNIC + id: "{{ vfpool_id }}" + network_order_changing: true + state: poweredoff +``` + +#### Подключить DPDK сети +``` +- name: Example + hosts: localhost + tasks: + - name: Connect DPDK networks to VM + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + networks: + - type: DPDK + id: "{{ dpdk1_id }}" + - type: EMPTY + - type: DPDK + id: "{{ dpdk2_id }}" + mtu: 1500 + state: poweredoff +``` + +#### Отключить +``` +- name: Example + hosts: localhost + tasks: + - name: Disconnect networks from VM + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + networks: [] + state: poweredoff +``` + +### Изменить + +#### Объём загрузочного диска в большую сторону +``` +- name: Example + hosts: localhost + tasks: + - name: Increase boot disk size + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + boot_disk: 15 + state: poweredoff +``` + +#### Количество CPU +``` +- name: Example + hosts: localhost + tasks: + - name: Change CPU amount + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + cpu: 1 + state: poweredoff +``` + +#### Объём ОЗУ +``` +- name: Example + hosts: localhost + tasks: + - name: Change RAM size + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + ram: 512 + state: poweredoff +``` + +#### Тэги +``` +- name: Example + hosts: localhost + tasks: + - name: Change tags + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + tag: + tag1_key: tag1_value + tag2_key: tag2_value +``` + +#### Affinity метку +``` +- name: Example + hosts: localhost + tasks: + - name: Change affinity label + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + affinity_label: Affinity label 1 +``` + +#### Affinity правила +``` +- name: Example + hosts: localhost + tasks: + - name: Change affinity rules + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + aff_rule: + - topology: compute + policy: REQUIRED + mode: EQ + key: app + value: main + - topology: node + policy: RECOMMENDED + mode: NE + key: state + value: started +``` + +#### Anti-affinity правила +``` +- name: Example + hosts: localhost + tasks: + - name: Change anti-affinity rules + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + aaff_rule: + - topology: compute + policy: REQUIRED + mode: ANY + key: app + value: main +``` + +#### Описание +``` +- name: Example + hosts: localhost + tasks: + - name: Change description + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + description: vm description +``` + +#### Чипсет +``` +- name: Example + hosts: localhost + tasks: + - name: Change chipset + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + chipset: i440fx + state: poweredoff +``` + +#### Правило NUMA Affinity +``` +- name: Example + hosts: localhost + tasks: + - name: Change NUMA affinity rule + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + numa_affinity: loose + state: poweredoff +``` + +#### Использование CPU Pinning +``` +- name: Example + hosts: localhost + tasks: + - name: Change CPU Pinning usage + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + cpu_pin: true + state: poweredoff +``` + +#### Использование Huge Pages +``` +- name: Example + hosts: localhost + tasks: + - name: Change Huge Pages usage + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + hp_backed: true + state: poweredoff +``` + +#### Имя +``` +- name: Example + hosts: localhost + tasks: + - name: Rename VM + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + name: "{{ new_vm_name }}" +``` + +#### XML виртуальной машины + +##### Изменение +``` +- name: Example + hosts: localhost + tasks: + - name: Change XML management + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + custom_fields: + fields: + cpu: + mode: custom + vendor: Intel + cache: + mode: enable + os: + type: + machine: pc-i440fx-artful +``` + +##### Отключение управления ВМ через XML +``` +- name: Example + hosts: localhost + tasks: + - name: Disable XML management + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + custom_fields: + disable: true +``` + +#### Автоматический запуск ВМ после перезапуска вычислительного узла, за которым она закреплена + +##### Включить +``` +- name: Example + hosts: localhost + tasks: + - name: Enable auto starting pinned VM + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + auto_start: true +``` + +##### Выключить +``` +- name: Example + hosts: localhost + tasks: + - name: Disable auto starting of pinned VM + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + auto_start: false +``` + +### Удалить + +#### Безвозвратно +``` +- name: Example + hosts: localhost + tasks: + - name: Delete VM + decort_kvmvm: + # Параметры для авторизации упущены + id: "{{ vm_id }}" + state: absent +``` diff --git a/wiki/7.0.0/модуль-decort_lb.md b/wiki/7.0.0/модуль-decort_lb.md new file mode 100644 index 0000000..61b5b91 --- /dev/null +++ b/wiki/7.0.0/модуль-decort_lb.md @@ -0,0 +1,782 @@ +# Модуль decort_lb +## Обзор модуля decort_lb + +Модуль **decort_lb** предназначен для выполнения следующих действий над балансировщиками нагрузки: +- создать +- получить информацию +- отключить/включить/запустить/перезапустить +- изменить конфигурации backend и frontend +- удалить (в корзину или безвозвратно) +- восстановить из корзины + +## Параметры модуля decort_lb +Ниже приведен список параметров для модуля **decort_lb** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ПараметрТипОписание
+ account_id + + (int) + + Идентификатор аккаунта. +
+ account_name + + (str) + + Имя аккаунта. +
Может быть альтернативой параметру account_id. +
+ description + + (str) +
Default: Managed by Ansible module decort_lb + 		+ Описание балансировщика. +
+ backends + + (list) + + Список словарей, описывающих конфигурации backend. +
+ algorithm + + (str) +
Значения: +
leastconn +
roundrobin +
static-rr +
Default: roundrobin + 		+ Используемый алгоритм. +
+ + default_settings + + + (dict) + + Cловарь, описывающий параметры по умолчанию для backend-серверов. +
+ downinter + + (int) +
Default: 1000 + 		+ Интервал в миллисекундах между двумя последовательными проверками + доступности сервера, который считается недоступным. +
+ fall + + (int) +
Default: 2 + 		+ Количество последовательных неудачных проверок доступности, после + которых сервер, ранее считавшийся доступным, начинает считаться + недоступным и временно исключается из схемы балансировки. +
+ inter + + (int) +
Default: 5000 + 		+ Интервал в миллисекундах между двумя последовательными проверками + доступности сервера, который считается доступным. +
+ maxconn + + (int) +
Default: 250 + 		+ Лимит одновременных подключений к серверу. При достижении этого лимита + сервер временно исключается из схемы балансировки. +
+ maxqueue + + (int) +
Default: 256 + 		+ Лимит соединений, ожидающих в очереди. Когда этот предел будет + достигнут, все последующие подключения будут перенаправлены + на другие серверы. +
+ rise + + (int) +
Default: 2 + 		+ Количество проверок, которые должен пройти сервер, считавшийся + недоступным, чтобы начать считаться доступным и снова быть + включенным в схему балансировки. +
+ slowstart + + (int) +
Default: 60000 + 		+ Интервал в миллисекундах с момента когда сервер начинает считаться + доступным, по истечении которого количество фактически разрешенных + подключений к этому серверу будет возвращено до 100% от + установленного лимита. +
+ weight + + (int) +
Default: 100 + 		+ Вес сервера для использования в алгоритмах балансировки. +
+ name + + (str) + + Название backend. Обязательный параметр. +
+ ext_net_id + + (int) + + Идентификатор внешней сети. +
Может быть не задан, если задан vins_id - + в таком случае балансировщик будет подключён только к + внутренней сети. +
+ + frontends + + + (list) + + Список словарей, описывающих конфигурации frontend. +
+ backend + + (str) + + Название используемого backend. Обязательный параметр. +
+ bindings + + (list) + + Список словарей, описывающих конфигурации binding. +
+ address + + (str) + + IP-адрес. +
Если не задан, то будет использоваться основной IP-адрес + балансировщика во внешней сети или, если подключена только + внутренняя сеть, основной IP-адрес балансировщика во внутренней сети. +
+ name + + (str) + + Название. Обязательный параметр. +
+ port + + (int) +
Значения: +
1-65535 + 		+ Порт. Обязательный параметр. +
+ ha_lb + + bool +
Default: false + 		+ Использовать схему высокой доступности для создаваемого балансировщика. +
+ lb_id + + (int) + + Идентификатор балансировщика нагрузки. +
+ lb_name + + (str) + + Имя балансировщика. +
+ permanently + + (bool) +
Default: false + 		+ Если выполняется удаление, то выполнить безвозвратное удаление + (минуя корзину). +
+ rg_id + + (int) + + Идентификатор ресурсной группы. +
+ rg_name + + (str) + + Имя ресурсной группы. +
В комбинации с заданным аккаунтов может быть альтернативой + параметру rg_id +
+ servers + + (list) + + Список словарей, описывающих конфигурации backend-серверов. +
+ address + + (str) + + IP-адрес. Обязательный параметр. +
+ backends + + (list) + + Список словарей, описывающих параметры backend-сервера для разных + конфигураций backend. +
Обязательный параметр. +
+ check + + (str) +
Значения: +
enabled +
disabled +
Default: enabled + 		+ Проверка доступности сервера. +
+ name + + (str) + + Название конфигурации backend. Обязательный параметр. +
+ port + + (int) +
Значения: +
1-65535 + 		+ Порт. Обязательный параметр. +
+ server_settings + + (dict) + + Словарь, описывающий параметры backend-сервера. +
Ключи данного словаря аналогичны ключам словаря + + default_settings + . +
+ name + + (str) + + Название. Обязательный параметр. +
+ state + + (str) +
Значения: +
present +
absent +
enabled +
disabled +
restart +
Default: present + 		+ Целевое состояние балансировщика нагрузки. +
Выполнение с state=restart позволяет выполнить + перезапуск балансировщика, соответственно, всегда возвращает + changed: true. +
Значения present и enabled равнозначны + и соответствуют включённому и запущенному балансировщику. +
+ vins_id + + (int) + + Идентификатор внутренней сети. +
Может быть не задан, если задан ext_net_id - + в таком случае балансировщик будет подключён только к + внешней сети. +
+ vins_name + + (str) + + Имя внутренней сети. +
В комбинации с заданной РГ может быть альтернативой для + параметра vins_id. +
+ +## Возвращаемые значения модуля decort_lb + +Модуль **decort_lb** возвращает информацию о балансировщике в виде словаря `facts` со следующими ключами: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ backends + + list + + Список словарей, описывающих конфигурации backend. +
+ algorithm + + str + + Используемый алгоритм. +
+ name + + str + + Название конфигурации backend. +
+ serverDefaultSettings + + dict + + Cловарь, описывающий параметры по умолчанию для backend-серверов. +
Ключи данного словаря аналогичны ключам словаря + + default_settings + . +
+ servers + + list + + Список словарей, описывающих конфигурации backend-серверов. +
+ address + + str + + IP-адрес. +
+ check + + str + + Проверка доступности сервера. +
+ name + + str + + Название. +
+ port + + int + + Порт. +
+ serverSettings + + dict + + Cловарь, описывающий параметры backend-сервера. +
Ключи данного словаря аналогичны ключам словаря + + default_settings + . +
+ frontends + + list + + Список словарей, описывающих конфигурации frontend. +
Ключи данного словаря аналогичны ключам словарей списка + + frontends + . +
+ gid + + int + + Идентификатор физического кластера (Grid ID). +
+ id + + int + + Идентификатор балансировщика. +
+ name + + str + + Имя балансировщика. +
+ rg_id + + int + + Идентификатор ресурсной группы. +
+ state + + str + + Статус балансировщика. +
diff --git a/wiki/7.0.0/модуль-decort_osimage.md b/wiki/7.0.0/модуль-decort_osimage.md new file mode 100644 index 0000000..6f6dca4 --- /dev/null +++ b/wiki/7.0.0/модуль-decort_osimage.md @@ -0,0 +1,124 @@ +# Модуль decort_osimage +## Обзор модуля decort_osimage + +Модуль decort_osimage предназначен для выполнения следующих действий над образами, созданными в облачной платформе DECORT: +- шаблонные образы: + - создать + - получить информацию + - изменить имя + - удалить +- виртуальные образы + - создать + - получить информацию + - изменить + - имя + - целевой образ + +## Параметры модуля decort_osimage +Ниже приведен список параметров для модуля **decort_osimage** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + +| Параметр | Тип, допустимые значения | Описание | +| ------ | ------ | ------ | +| account_Id | (int) | Уникальный целочисленный идентификатор аккаунта. Используется для поиска образов, а тажке для их создания. | +| account_name | (string) | Имя аккаунта. Используется для получения уникального целочисленного идентификатора аккаунта. | +| boottype | (string)
Default: `uefi` | Тип загрузки образа. Используется при создании образа.| +| drivers | (string)
Default: `KVM_X86` | Тип виртуальных машин, подходящих для образа. Используется при создании образа.| +| hotresize | (bool)
Default: `false` | Поддерживает ли образ "горячее" изменение размера. По умолчанию установлено `false`. Используется при создании образа операционной системы. | +| image_id | (int) | Идентификатор шаблонного образа. +| image_name | (str) | Имя шаблонного образа. +| image_password | (string) | Опциональный пароль для образа. Используется при создании образа.| +| image_username | (string) | Опциональное имя пользователя для образа. Используется при создании образа. | +| imagetype | (string)
Default: `linux` | Тип образа. Используется при создании образа.| +| passwordDL | (string) | Пароль для скачивания по URL-адресу. Используется при создании образа. | +| pool | (str) | Имя пула СХД. Используется для поиска существующего образа. +| poolName | (string) | Имя пула СХД. Используется при создании образа. | +| sepId | (integer) | Уникальный целочисленный идентификатор СХД. Используется при создании образа. | +| sep_id | (int) | Идентификатор СХД. Используется для поиска существующего образа. +| state | (string)
Значения:
`present`
`absent`
Default: `present` | Целевое состояние образа. `present` - существует, `absent` - удалён. | +| url | (string) | URL-адрес, с которого будет загружен образ. Используется при создании образа.| +| usernameDL | (string) | Имя пользователя для загрузки образа с заданного URL-адреса. Используется при создании образа. | +| virt_id | (integer) | Уникальный целочисленный идентификатор виртуального образа. Может использоваться для получения информации о виртуальном образе, а также для привязки к нему другого образа.| +| virt_name | (string) | Имя виртуального образа. Используется для получения `virt_id`, а в последствии информации о виртуальном образе, а также для создания виртуального образа и привязки к нему другого образа.| + + +## Возвращаемые значения модуля decort_osimage + +Модуль decort_osimage возвращает информацию об образе в виде словаря facts со следующими ключами: + + +| Ключ | Тип данных | Описание | +| ------ | ------ | ------ | +| accountId | int | Идентификатор аккаунта. +| id | int | Уникальный целочисленный идентификатор данного образа. | +| linkto | int | Уникальный целочисленный идентификатор образа, который привязан к данному виртуальному. | +| name | string | Имя образа. | +| pool | string | Имя пула на системе хранения данных, в котором находится данный образ.| +| sep_id | int | Идентификатор системы хранения данных, на которой хранится данный образ. | +| size | int | Размер образа в ГБ. | +| state | string | Текущий статус образа. | +| type | string | Тип образа. | + + + +## Пример использования модуля decort_osimage + + +Пример создания шаблонного образа с операционной системой Alpine Linux. +``` + - name: Create template image + decort_osimage: + account_Id: 12345 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + authenticator: oauth2 + controller_url: "https://ds1.digitalenergy.online" + image_name: alpine_linux_3.19.1 + url: https://dl-cdn.alpinelinux.org/alpine/v3.19/releases/cloud/nocloud_alpine-3.19.1-x86_64-uefi-cloudinit-r0.qcow2 + verify_ssl: false + register: osimage +``` + +Пример получения информации о существующем шаблонном образе по его имени. + +``` + - name: Get template image + decort_osimage: + account_Id: 12345 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + authenticator: oauth2 + controller_url: "https://ds1.digitalenergy.online" + image_name: alpine_linux_3.19.1 + verify_ssl: false + register: osimage +``` + +Пример создания виртуального образа. Также в случае, если виртуальный образ уже существует, но к нему привязан другой шаблонный образ, он привяжет к себе указанный в примере шаблонный образ. + +``` + - name: Create virtual image + decort_osimage: + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + authenticator: oauth2 + controller_url: "https://ds1.digitalenergy.online" + image_name: alpine_linux_3.19.1 + virt_name: alpine_last + register: osimage +``` +Обратите внимание, что в данном примере можно использовать как `image_name`, так и `image_id`. Также можно использовать либо `virt_name`, либо `virt_id`. + +Пример переименования образа. + +``` + - name: Rename template image + decort_osimage: + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + authenticator: oauth2 + controller_url: "https://ds1.digitalenergy.online" + image_name: alpine_linux_3.19.1_new_name + image_id: 54321 + register: osimage +``` + diff --git a/wiki/7.0.0/модуль-decort_pfw.md b/wiki/7.0.0/модуль-decort_pfw.md new file mode 100644 index 0000000..45dd2ad --- /dev/null +++ b/wiki/7.0.0/модуль-decort_pfw.md @@ -0,0 +1,66 @@ +# Модуль decort_pfw +## Обзор модуля decort_pfw + +Модуль **decort_pfw** предназначен для настройки правил переадресации портов (port forwarding, destination NAT) на виртуальном маршрутизаторе заданной внутренней сети для заданной виртуальной машины. +Модуль поддерживает выполнение следующих действий над правилами: +- добавить +- получить информацию +- удалить + +## Параметры модуля decort_pfw +Ниже приведен список параметров для модуля **decort_pfw** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + +| Параметр | Тип, допустимые значения | Описание| +| ------ | ------ | ------ | +| compute_id | (int) | Идентификатор виртуальной машины. IP-адрес, который данная ВМ имеет во внутренней сети, заданной параметром `vins_id`, будет использоваться как внутренний IP-адрес в правилах. Обязательный параметр. | +| rules | (list) | Список словарей, описывающих правила переадресации портов для заданной ВМ (параметр `compute_id`) на виртуальном маршрутизаторе заданной внутренней сети (параметр `vins_id`).
Ключи словаря:
• `local_port` (int) (обязательный) - внутренний порт; значения: от `1` до `65535`
• `proto` (str) (обязательный) - протокол; значения: `tcp` или `udp`
• `public_port_end` (int) (необязательный) - верхняя граница диапазона внешних портов; значения: от значения ключа `public_port_start` до `65535`;
• `public_port_start` (int) (обязательный) - нижняя граница диапазона внешних портов; значения: от `1` до `65535` | +| state | (str)
Значения:
`present`
`absent`
Default: `present` | Целевое состояние правил.
Если `state=absent`, то, независимо от содержания параметра `rules`, будут удалены все правила для заданной ВМ (параметр `compute_id`) на виртуальном маршрутизаторе заданной внутренней сети (параметр `vins_id`). | +| vins_id | (int) | Идентификатор внутренней сети, на виртуальном маршрутизаторе которой настраиваются правила переадресации портов. Заданная ВМ (параметр `compute_id`) должна быть подключена к этой сети. Обязательный параметр. | + + +## Возвращаемые значения модуля decort_pfw + +Модуль **decort_pfw** возвращает информацию о правилах переадресации портов и сопутствующую информацию в виде словаря `facts` со следующими ключами: + + +|Ключ | Тип данных | Описание| +| ------ | ------ | ------ | +| compute_id | int | Идентификатор ВМ. | +| public_ip | string | IP-адрес во внешней сети, настроенный на виртуальном маршрутизаторе внутренней сети. | +| rules | list | Список словарей, описывающих правила переадресации портов.
Ключи словаря:
• `id` (int) - идентификатор правила
• `localIp` (str) - IP-адрес ВМ
• `localPort` (int) - внутренний порт
• `protocol` (str) - протокол
• `publicPortEnd` (int) - верхняя граница диапазона внешних портов
• `publicPortStart` (int) - нижняя граница диапазона внешних портов
• `vmId` (int) - идентификатор ВМ
• `vmName` (str) - имя ВМ | +| state | string | Статус правил. Значения: `PRESENT` или `ABSENT`. | +| vins_id | int | Идентификатор внутренней сети. | + +## Пример использования модуля decort_pfw + +В данном примере для существующей ВМ (параметр `compute_id`), подключённой к внутренней сети (параметр `vins_id`), настраиваются два правила переадресации портов: + +- Правило для одного порта: внешний порт `30022` на внутренний порт `22` по протоколу `tcp`. +- Правило для диапазона портов: внешние порты с `30080` по `30085` на внутренние порты с `30080` по протоколу `udp`. + +``` +- name: Add port forwarding rules + decort_pfw: + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + authenticator: oauth2 + compute_id: "{{ my_vm.facts.id }}" + controller_url: "https://cloud.digitalenergy.online" + oauth2_url: "https://sso.digitalenergy.online" + rules: + - local_port: 22 + proto: tcp + public_port_start: 30022 + - local_port: 30080 + proto: udp + public_port_end: 30085 + public_port_start: 30080 + vins_id: "{{ my_vins.facts.id }}" + register: my_pfw_rules +``` + +В данном примере результат выполнения модуля **decort_pfw** записывается в переменную `my_pfw_rules`. Для доступа к списку правил используйте следующую конструкцию: + +``` +"{{ my_pfw_rules.facts.rules }}" +``` diff --git a/wiki/7.0.0/модуль-decort_rg.md b/wiki/7.0.0/модуль-decort_rg.md new file mode 100644 index 0000000..697ea1b --- /dev/null +++ b/wiki/7.0.0/модуль-decort_rg.md @@ -0,0 +1,220 @@ +# Модуль decort_rg + +## Обзор модуля decort_rg + +Модуль decort_rg предназначен для создания, редактирования и удаления ресурсных групп (Resource Group, RG) в облачной платформе DECORT, а также для получения информации об уже существующей ресурсной группе. Модуль decort_rg позволяет: + +- создавать ресурсные группы +- удалять ресурсные группы (в корзину или безвозвратно) +- восстанавливать ресурсные группы из корзины +- включать/отключать ресурсные группы +- запрашивать информацию об уже существующих ресурсных группах +- изменять ресурсные группы: + - переименовывать + - настраивать квоты + - задавать стандартную сеть + - настраивать права доступа для пользователей + - изменять доступные пулы СХД + +## Параметры модуля decort_rg +Ниже приведен список параметров для модуля **decort_rg** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + +| Параметр | Тип, допустимые значения | Описание | +|----------|--------------------------|----------| +| account_id | (int) | Уникальный целочисленный идентификатор аккаунта, в рамках которого создаётся или уже существует данная ресурсная группа. Должен быть задан либо идентификатор, либо имя аккаунта (см. параметр `account_name`). Если одновременно заданы и `account_id`, и `account_name`, то account_name игнорируется. | +| account_name | (string) | Имя аккаунта, в рамках которого создаётся или уже существует данная ресурсная группа. Должно быть задано либо имя, либо идентификатор учётной записи (см. параметр `account_id`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется. | +| access | (dict) | Параметр, позволяющий выдать, забрать или изменить права у пользователя в ресурсной группе. | +| description | (string) | Текстовое описание ресурсной группы. Данный параметр является опциональным и учитывается только при создании ресурсной группы, а при всех прочих операциях игнорируется. | +| def_netId | (int) | Уникальный целочисленный идентификатор внутренней или внешней сети. Используется для изменения сети по умолчанию в ресурсной группе. | +| def_netType | (string)
Значения:
`PRIVATE`
`PUBLIC`
`NONE`
Default: `PRIVATE` | Тип сети по умолчанию в ресурсной группе. Используется при создании ресурсной группы, а также при изменении. | +| extNetId | (int) | Уникальный целочисленный идентификатор внешней сети.
Если `def_netType: PRIVATE`, то указывает какую внешнюю сеть подключить к создаваемой внутренней сети, которая будет задана как сеть по умолчанию для создаваемой РГ.
Если `def_netType: PUBLIC`, то указывает какую внешнюю сеть задать как сеть по умолчанию для создаваемой РГ. | +| extNetIp | (string) | IP-адрес для внешней сети, которая задана в параметре `extNetId`. | +| ipcidr | (string) | IP-адрес внутренней сети. Используется при создании ресурсной группы, чтобы задать IP-адрес сети для создаваемой внутренней сети, которая создастся вместе с ресурсной группой. Используется при параметре `def_netType` в значении `PRIVATE`. | +| owner | (string) | Владелец ресурсной группы. Задаётся при создании ресурсной группы, не обязателен. Если оставить пустое значение - владельцем ресурсной группы будет пользователь, создавший ресурсную группу. | +| permanently | (bool)
Default: `false` | Параметр, использующийся при удалении ресурсной группы. При значении `true` - ресурсная группа удалится безвозвратно, а при `false` - попадёт в корзину. | +| quotas | (dict) | Предназначено для задания или изменения квоты на ресурсы в составе данной ресурсной группы. | +| rename | (string) | Новое имя ресурсной группы.
Возможно переименование только включенной ресурсной группы. | +| rg_id | (int) | Уникальный целочисленный идентификатор ресурсной группы. Является обязательным при изменении РГ если не заданы `rg_name` и `account_id`/`account_name` | +| rg_name | (string) | Имя ресурсной группы. Данный параметр является обязательным при создании. | +| sep_pools| (list) | Список словарей, описывающих доступные пулы СХД.
Ключи словаря:
• `sep_id` (int) - идентификатор системы хранения данных.
• `pool_names` (list) - список названий пулов системы хранения данных.
Чтобы очистить список доступных пулов, нужно указать пустой список `[]`.| +| state | Значения:
`present`
`absent`
`enabled`
`disabled`
Default: `present` | Целевое состояние ресурсной группы. | + +## Возвращаемые значения модуля decort_rg + +Модуль decort_rg возвращает информацию о ресурсной группе в виде словаря facts со следующими ключами: +| Ключ | Тип данных | Описание | +|------|------------|----------| +| account_id | int | Уникальный целочисленный идентификатор аккаунта, которому принадлежит данная ресурсная группа. | +| gid | int | Идентификатор физического кластера (Grid ID), на базе которого развёрнута ресурсная группа. | +| id | int | Уникальный целочисленный идентификатор ресурсной группы. | +| name | string | Имя ресурсной группы. Обратите внимание, что это имя уникально только в рамках аккаунта, которому принадлежит данная ресурсная группа. | +| state | string | Текущее состояние ресурсной группы. | +| quota | dict | Текущие квоты ресурсной группы. | +| resTypes | list | Список типов ресурсов, разрешенных к созданию в данной ресурсной группе. | +| defNetId | int | Уникальный целочисленный идентификатор сети по умолчанию в данной ресурсной группе. | +| defNetType | string | Тип сети по умолчанию в данной ресурсной группе. | +| ViNS | list | Список идентификаторов внутренних сетей ресурсной группы. | +| computes | list | Список идентификаторов виртуальных машин ресурсной группы. | +| uniqPools | list | Список доступных пулов СХД. | + +## Пример использования модуля decort_rg + +В данном примере показано, как создать ресурсную группу по имени MyRG в аккаунте MyAccount. + +``` +- name: manage resource group + decort_rg: + authenticator: oauth2 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + oauth2_url: "https://sso.digitalenergy.online" + controller_url: "https://cloud.digitalenergy.online" + account_name: "MyAccount" + rg_name: "MyRG" + state: present + register: my_rg + delegate_to: localhost +``` + +В данном примере показано, как создать ресурсную группу по имени MyRG в аккаунте MyAccount, также задать квоты и выдать права на чтение пользователю MyUser. + +``` +- name: manage resource group + decort_rg: + authenticator: oauth2 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + oauth2_url: "https://sso.digitalenergy.online" + controller_url: "https://cloud.digitalenergy.online" + account_name: "MyAccount" + rg_name: "MyRG" + access: + action: "grant" + user: "MyUser" + right: "R" + quotas: + cpu: 16 + ram: 16384 + disk: 100 + ext_ips: 20 + net_transfer: 1000 + state: present + register: my_rg + delegate_to: localhost +``` + +В данном примере показано, как выдать доступ на чтение и запись пользователю MyUser в ресурсной группе по имени MyRG в аккаунте MyAccount. + +``` +- name: manage resource group + decort_rg: + authenticator: oauth2 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + oauth2_url: "https://sso.digitalenergy.online" + controller_url: "https://cloud.digitalenergy.online" + account_name: "MyAccount" + rg_name: "MyRG" + access: + action: "grant" + user: "MyUser" + right: "RCX" + state: present + register: my_rg + delegate_to: localhost +``` + +В данном примере показано, как сменить квоту в ресурсной группе по имени MyRG в аккаунте MyAccount. + +``` +- name: manage resource group + decort_rg: + authenticator: oauth2 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + oauth2_url: "https://sso.digitalenergy.online" + controller_url: "https://cloud.digitalenergy.online" + account_name: "MyAccount" + rg_name: "MyRG" + quotas: + cpu: 16 + ram: 16384 + disk: 100 + ext_ips: 20 + net_transfer: 1000 + state: present + register: my_rg + delegate_to: localhost +``` + +В данном примере показано, как изменить сеть по умолчанию в ресурсной группе по имени MyRG в аккаунте MyAccount. + +``` +- name: manage resource group + decort_rg: + authenticator: oauth2 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + oauth2_url: "https://sso.digitalenergy.online" + controller_url: "https://cloud.digitalenergy.online" + account_name: "MyAccount" + rg_name: "MyRG" + def_netType: "PRIVATE" + def_netId: 99 + state: present + register: my_rg + delegate_to: localhost +``` + +В данном примере показано, как переименовать ресурсную группу по имени MyRG на новое имя "NewRg" в аккаунте MyAccount. + +``` +- name: manage resource group + decort_rg: + authenticator: oauth2 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + oauth2_url: "https://sso.digitalenergy.online" + controller_url: "https://cloud.digitalenergy.online" + account_name: "MyAccount" + rg_name: "MyRG" + rename: "NewRg" + rg_id: 27 + state: present + register: my_rg + delegate_to: localhost +``` + +В данном примере результат работы модуля decort_rg записывается в переменную my_rg. + +Модули DECORT, которым для работы требуется ресурсная группа, в качестве одного из параметров, как правило, принимают идентификатор `rg_id`. Так, например, используя модуль `decort_kvmvm` для создания виртуального сервера необходимо указать ресурсную группу, к которой будет принадлежать этот виртуальный сервер. Сделать это можно следующим образом: + +``` + <прочие детали опущены> + rg_id: "{{ my_rg.facts.id }}" +``` + +В данном примере показано, как изменить доступные пулы СХД в ресурсной группе по имени MyRG в аккаунте MyAccount. + +``` +- name: change available sep pools + decort_rg: + authenticator: oauth2 + app_id: "{{ my_app_id }}" + app_secret: "{{ my_app_secret }}" + oauth2_url: "https://sso.digitalenergy.online" + controller_url: "https://cloud.digitalenergy.online" + account_name: "MyAccount" + rg_name: "MyRG" + sep_pools: + - sep_id: 1 + pool_names: + - sep1_pool1 + - sep1_pool2 + - sep_id: 2 + pool_names: + - sep2_pool1 + state: present + register: my_rg + delegate_to: localhost +``` diff --git a/wiki/7.0.0/модуль-decort_snapshot.md b/wiki/7.0.0/модуль-decort_snapshot.md new file mode 100644 index 0000000..9021585 --- /dev/null +++ b/wiki/7.0.0/модуль-decort_snapshot.md @@ -0,0 +1,248 @@ +# Модуль decort_snapshot +## Обзор модуля + +Модуль **decort_snapshot** предназначен для выполнения следующих действий над снимками виртуальных машин: +- **создать** (см. [параметр state](#state) и [примеры](#создать)) +- **удалить** (см. [параметр state](#state) и [примеры](#удалить)) +- **получить основную информацию о снимке** (см. [возвращаемые значения](#основная-информация) и [примеры](#получить-основную-информацию-о-снимке)) +- **получить информацию о размере снимка** (см. [параметр usage](#usage), [возвращаемые значения](#размер-снимка) и [примеры](#получить-информацию-о-размере-снимка)) + +## Параметры модуля +Ниже приведен список параметров для модуля **decort_snapshot** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ПараметрТипОписание
+ + label + + + (str) + + Метка снимка виртуальной машины. Если метка не указана при создании, она будет сгенерирована автоматически на основе даты и времени - vm_name_2024-12-10_16-40-52. +
+ + state + + + (str) +
Значения: +
absent +
present + 		+ Целевое состояние. +
absent - снимок удален. +
present - снимок существует. +
+ + usage + + + (bool) +
Default:false + 		+ Получить информацию о реальном размере снимка виртуальной машины. +
+ + vm_id + + + (int) + + Идентификатор виртуальной машины. +
Обязательный параметр. +
+ +## Возвращаемые значения + +Модуль **decort_snapshot** возвращает информацию о снимке виртуальной машины в виде словаря `facts` со следующими ключами: + +### Основная информация + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ disks + + list + + Диски +
+ guid + + str + + Идентификатор снимка +
+ label + + str + + Метка снимка +
+ timestamp + + int + + Временная метка создания снимка +
+ vm_id + + int + + Идентификатор виртуальной машины +
+ +### Размер снимка + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ stored + + float + + Размер снимка +
+ +## Примеры использования + +### Создать + +#### С указанием метки +``` +- name: Example + hosts: localhost + tasks: + - name: Create snapshot + decort_snapshot: + # Параметры для авторизации упущены + vm_id: "{{ vm_id }}" + label: "{{ snapshot_label }}" + state: present +``` + +#### Без указания метки +``` +- name: Example + hosts: localhost + tasks: + - name: Create snapshot + decort_snapshot: + # Параметры для авторизации упущены + vm_id: "{{ vm_id }}" + state: present +``` + +### Удалить +``` +- name: Example + hosts: localhost + tasks: + - name: Delete snapshot + decort_snapshot: + # Параметры для авторизации упущены + vm_id: "{{ vm_id }}" + label: "{{ snapshot_label }}" + state: absent +``` + +### Получить основную информацию о снимке +``` +- name: Example + hosts: localhost + tasks: + - name: Get basic snapshot info + decort_snapshot: + # Параметры для авторизации упущены + vm_id: "{{ vm_id }}" + label: "{{ snapshot_label }}" +``` + +### Получить информацию о размере снимка +``` +- name: Example + hosts: localhost + tasks: + - name: Get snapshot usage + decort_snapshot: + # Параметры для авторизации упущены + vm_id: "{{ vm_id }}" + label: "{{ snapshot_label }}" + usage: true +``` diff --git a/wiki/7.0.0/модуль-decort_user_info.md b/wiki/7.0.0/модуль-decort_user_info.md new file mode 100644 index 0000000..c463324 --- /dev/null +++ b/wiki/7.0.0/модуль-decort_user_info.md @@ -0,0 +1,1338 @@ +# Модуль decort_user_info +## Обзор модуля + +Модуль **decort_user_info** предназначен для получения следующей информации о пользователе: +- **основная информация** (см. [возвращаемые значения](#основная-информация) и [примеры](#получение-основной-информации-о-пользователе)) +- **используемые и зарезервированные ресурсы** (см. [параметр resource_consumption](#resource_consumption), [возвращаемые значения](#используемые-и-зарезервированные-ресурсы) и [примеры](#получение-информации-об-используемых-и-зарезервируемых-ресурсах)) +- **доступные аккаунты** (см. [параметр accounts](#accounts), [возвращаемые значения](#доступные-аккаунты) и [примеры](#получение-информации-о-доступных-аккаунтах)) +- **аудиты** (см. [параметр audits](#audits), [возвращаемые значения](#аудиты) и [примеры](#получение-информации-об-аудитах)) +- **доступные методы API** (см. [параметр api_methods](#api_methods), [возвращаемые значения](#доступные-методы-api) и [примеры](#получение-доступных-методов-api)) +- **поиск доступных объектов по строке** (см. [параметр objects_search](#objects_search), [возвращаемые значения](#найденные-объекты) и [примеры](#поиск-доступных-объектов)) + +## Параметры модуля +Ниже приведен список параметров для модуля **decort_user_info** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ПараметрТипОписание
+ + accounts + + + (dict) + + Получить информацию об аккаунтах, к которым имеет доступ пользователь, + с учётом заданных параметров вывода. +
Чтобы получить информацию без указания параметров вывода, + необходимо задать пустой словарь {}. +
+ deleted + + (bool) +
Default: false + 		+
false - вывод только неудалённых объектов. +
true - вывод только удалённых в корзину объектов. +
+ filter + + (dict) + + Фильтр. +
+ rights + + (str) +
Значения: +
R +
RCX +
ARCXDU +
CXDRAU + 		+ По предоставленным правам доступа. +
+ id + + (int) + + По идентификатору. +
+ name + + (str) + + По имени. +
+ status + + (str) +
Значения: +
CONFIRMED +
DELETED +
DESTROYED +
DESTROYING +
DISABLED + 		+ По статусу. +
+ pagination + + (dict) + + Постраничный вывод. +
+ number + + (int) +
Default: 1 + 		+ Номер страницы. +
+ size + + (int) + + Размер страниц. +
Обязательный параметр. +
+ resource_consumption + + (bool) +
Default: false + 		+ Получить информацию об используемых и зарезервированных ресурсах. +
+ sorting + + (dict) + + Сортировка. +
+ asc + + (bool) +
Default: true + 		+ Сортировать по возрастанию. +
true - по возрастанию. +
false - по убыванию. +
+ field + + (str) +
Значения: +
createdTime +
deletedTime +
id +
name +
status +
updatedTime + 		+ Название поля, по которому сортировать. +
Обязательный параметр. +
+ + api_methods + + + (bool) +
Default: false + 		+ Получить методы API, к которым имеет доступ пользователь. +
+ + audits + + + (dict) + + Получить информацию об аудитах пользователя, с учётом + заданных параметров вывода. +
Чтобы получить информацию с параметрами вывода по умолчанию, + необходимо задать пустой словарь {}. +
+ filter + + (dict) + + Фильтр. +
+ api_method + + (str) + + По методу API. +
+ status_code + + (dict) + + По коду ответа HTTP. +
+ min + + (int) + + По минимальному коду ответа HTTP. +
+ max + + (int) + + По максимальному коду ответа HTTP. +
+ time + + (dict) + + По временному периоду. +
+ start + + (dict) + + Начало периода. +
+ unix + + (int) + + Unix-время. +
+ date_time + + (str) + + Дата и время в формате ггггммддччммсс. + Альтернатива параметру unix. +
Допустимо использовать любой разделитель между + группами цифр для повышения читаемости. Например, + гггг-мм-дд чч:мм:сс. +
+ end + + (dict) + + Конец периода. +
Структура словаря аналогична параметру + start. +
+ pagination + + (dict) + + Постраничный вывод. +
+ number + + (int) +
Default: 1 + 		+ Номер страницы. +
+ size + + (int) +
Default: 50 + 		+ Размер страниц. +
+ + objects_search + + + (str) + + Получить информацию о доступных пользователю объектах, + найденных по строчному значению данного параметра. +
+ + resource_consumption + + + (bool) +
Default: false + 		+ Получить информацию об используемых и зарезервированных ресурсах, + к которым имеет доступ пользователь. +
+ +## Возвращаемые значения + +Модуль **decort_user_info** возвращает информацию о пользователе в виде словаря `facts` со следующими ключами: + +### Основная информация + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ admin + + bool + + Наличие административных прав. +
+ data + + dict + + Дополнительные данные. +
+ emailaddresses + + list + + Адреса эл. почты. +
+ name + + str + + Имя/идентификатор. +
+ roles + + list + + Группы доступа. +
+ +### Используемые и зарезервированные ресурсы + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ + resource_consumed + + + dict + + Используемые ресурсы. +
+ cpu + + int + + Количество виртуальных процессоров. +
+ disksize + + int + + Объём дисков в ГБ. +
+ extips + + int + + Количество внешних IP-адресов. +
+ exttraffic + + int + + Объём трафика внешних сетей. +
+ gpu + + int + + Количество графических процессоров. +
+ ram + + int + + Объём оперативной памяти в МБ. +
+ seps + + dict + + Объём дисков по пулам СХД. +
+ (идентификатор СХД) + + dict + + Пулы СХД. +
+ (название пула) + + dict + + Словарь пула СХД. +
+ disksize + + int + + Объём дисков в ГБ. +
+ resource_reserved + + dict + + Зарезервированные ресурсы. +
Структура словаря аналогична словарю + + resource_consumed + . +
+ +### Доступные аккаунты + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ accounts + + list + + Список словарей, описывающих аккаунты. +
+ acl + + list + + Список словарей, описывающих доступы пользователей. +
+ right + + str + + Права доступа. +
+ status + + str + + Статус. +
+ type + + str + + Тип. +
+ userGroupId + + str + + Идентификатор пользователя или группы пользователей. +
+ computeFeatures + + list + + Список дополнительных возможностей гипервизора, доступных ВМ. +
+ createdTime + + int + + Unix-время создания. +
+ createdTime_readable + + str + + Дата и время создания. +
+ deletedTime + + int + + Unix-время удаления. +
+ deletedTime_readable + + str + + Дата и время удаления. +
+ id + + int + + Идентификатор. +
+ name + + str + + Имя. +
+ resource_consumed + + list + + Используемые ресурсы. +
Только если + accounts.resource_consumption: true + и только для неудалённых объектов. +
Структура словаря аналогична словарю + + resource_consumed + . +
+ resource_reserved + + list + + Зарезервированные ресурсы. +
Только если + accounts.resource_consumption: true + и только для неудалённых объектов. +
Структура словаря аналогична словарю + + resource_consumed + . +
+ status + + str + + Статус. +
+ updatedTime + + int + + Unix-время обновления. +
+ updatedTime_readable + + str + + Дата и время обновления. +
+ +### Аудиты + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ audits + + list + + Список словарей, описывающих аудиты. +
+ Call + + str + + Метод API. +
+ Guid + + str + + Уникальный идентификатор аудита. +
+ Response Time + + float + + Время отклика в секундах. +
+ Status Code + + int + + Код ответа HTTP. +
+ Time + + float + + Unix-время. +
+ Time_readable + + str + + Дата и время. +
+ +### Доступные методы API + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ api_methods + + list + + Список словарей, описывающих доступные методы API. +
+ (название группы методов API) + + dict + + Доступные методы группы. +
+ (название подгруппы методов API) + + list + + Методы подгруппы. +
+ ALL + + bool + + Доступ ко всем методам группы. +
+ +### Найденные объекты + + + + + + + + + + + + +
+ Ключ + + Тип +
данных + 		+ Описание +
+ objects_search + + list + + Список словарей, описывающих найденные объекты. +
+ +## Примеры использования + +### Получение основной информации о пользователе +``` +- name: Example + hosts: localhost + tasks: + - name: Get basic user info + decort_user_info: + # Параметры для авторизации упущены +``` + +### Получение информации об используемых и зарезервируемых ресурсах +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with resource consumption + decort_user_info: + # Параметры для авторизации упущены + resource_consumption: true +``` + +### Получение информации о доступных аккаунтах + +#### Только неудалённые +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with not deleted accounts + decort_user_info: + # Параметры для авторизации упущены + accounts: {} +``` + +#### Только удалённые в корзину +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with deleted accounts + decort_user_info: + # Параметры для авторизации упущены + accounts: + deleted: true +``` + +#### С информацией об используемых и зарезервированных ресурсах +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with accounts + decort_user_info: + # Параметры для авторизации упущены + accounts: + resource_consumption: true +``` + +#### С фильтрацией по статусу +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with accounts + decort_user_info: + # Параметры для авторизации упущены + accounts: + filter: + status: CONFIRMED +``` + +#### С сортировкой по имени +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with accounts + decort_user_info: + # Параметры для авторизации упущены + accounts: + sorting: + field: name +``` + +#### С постраничным выводом +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with accounts + decort_user_info: + # Параметры для авторизации упущены + accounts: + pagination: + size: 2 +``` + +### Получение информации об аудитах + +#### Без использования параметров вывода +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with audits + decort_user_info: + # Параметры для авторизации упущены + audits: {} +``` + +#### С фильтрацией по методу API +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with audits + decort_user_info: + # Параметры для авторизации упущены + audits: + filter: + call: cloudapi/account +``` + +#### С фильтрацией по временному периоду +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with audits + decort_user_info: + # Параметры для авторизации упущены + audits: + filter: + time: + start: + unix: 1724668267 + end: + date_time: 2024-08-26_13-40 +``` + +#### С постраничным выводом +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with audits + decort_user_info: + # Параметры для авторизации упущены + audits: + pagination: + size: 2 +``` + +### Получение доступных методов API +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with API methods + decort_user_info: + # Параметры для авторизации упущены + api_methods: true +``` + +### Поиск доступных объектов +``` +- name: Example + hosts: localhost + tasks: + - name: Get user info with found objects + decort_user_info: + # Параметры для авторизации упущены + objects_search: test +``` diff --git a/wiki/7.0.0/модуль-decort_vins.md b/wiki/7.0.0/модуль-decort_vins.md new file mode 100644 index 0000000..4c05f25 --- /dev/null +++ b/wiki/7.0.0/модуль-decort_vins.md @@ -0,0 +1,110 @@ +# Модуль decort_vins +## Обзор модуля decort_vins + +Модуль decort_vins предназначен для управления внутренними сетями (Virtual Network Segment, ViNS) и позволяет производить с ними следующие действия: +- создавать + - на уровне ресурсной группы (если РГ задана) + - на уровне аккаунта (если РГ не задана) +- удалять (безвозвратно) +- восстанавливать из корзины +- запрашивать информацию +- включать/отключать +- соединять (необходимы права администратора) +- изменять: + - включать/отключать SSH-доступ к виртуальному маршрутизатору (необходимы права администратора) + - включать/отключать режим **Custom Config** для виртуального маршрутизатора (необходимы права администратора) + - сохранять конфигурацию виртуального маршрутизатора для возможности последующего отката к ней (необходимы права администратора) + +## Параметры модуля decort_vins +Ниже приведен список параметров для модуля **decort_vins** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)): + +| Параметр | Тип, допустимые значения | Описание | +| ------ | ------ | ------ | +| account_id | (int) | Уникальный целочисленный идентификатор аккаунта, которому принадлежит данная внутреняя сеть. При идентификации внутренней сети по имени (см. параметр `vins_name`) должен быть задан либо идентификатор, либо имя аккаунта (см. параметр `account_name`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется.| +| account_name | (string) | Имя аккаунта, которому принадлежит данная внутренняя сеть. При идентификации внутренней сети по имени (см. параметр `vins_name`) должно быть задано либо имя, либо идентификатор аккаунта (см. параметр account_id). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется.| +|description | (string)| Текстовое описание внутренней сети. Данный аргумент является опциональным и учитывается только при создании внутренней сети, а при всех прочих операциях игнорируется.| +| ext_net_id | (int) | Идентификатор внешней сети, к которой должна быть подключена внутренняя сеть. Если задать значение `0`, то платформой будет выбрана внешняя сеть по умолчанию. | +| ext_ip_addr | (string) | IP-адрес внешней сети, заданной через параметр `ext_net_id`. Если не задан, то IP-адрес для внешней сети будет выбран платформой автоматически. +| ipcidr | (string) | Адрес сети для создаваемой внутренней сети. Если этот параметр не задан, то платформа назначит адрес автоматически. Обратите внимание, что внутренние сети, принадлежащие одному и тому же аккаунту, не могут иметь пересекающихся сетей.| +|rg_id | (int) | Идентификатор ресурсной группы, в которой должна быть создана или уже существует внутренняя сеть. Если одновременно заданы `rg_id` и `rg_name`, то `rg_name` игнорируется.| +| rg_name | (string) | Имя ресурсной группы, в которой должна быть создана или уже существует внутренняя сеть. Если одновременно заданы `rg_name` и `rg_id`, то `rg_name` игнорируется.| +| state | (string)
Значения:
`present`
`absent`
`enabled`
`disabled`
Default: `present` | Целевое состояние внутренней сети. | +| vins_id | (int) | Идентификатор внутренней сети. Соответствующая внутренная сеть должна существовать. Таким образом, с помощью `vins_id` нельзя создать новую внутреннюю сеть, а только управлять уже имеющимися. Если задан данный параметр, то параметры `vins_name`, `account_name`, `account_id`, `rg_name` и `rg_id` игнорируются.| +| vins_name| (string) | Имя внутренней сети. Для идентификации внутренней сети требуется либо `vins_name` и информация об аккаунте/ресурсной группе, которой принадлежит сеть, либо `vins_id`. Обратите внимание, что это имя уникально только в рамках ресурсной группы или аккаунта, на уровне которого существует данная внутренняя сеть.| +| mgmtaddr | (list) | Список существующих IP-адресов виртуального маршрутизатора во внутренней сети, через которые необходимо разрешить SSH-доступ к виртуальному маршрутизатору. +| custom_config | (bool)
Default: `false` | Включить/отключить режим пользовательской конфигурации виртуального маршрутизатора. | +| config_save | (bool)
Default: `false` | Выполнить сохранение текущей конфигурации виртуального маршрутизатора для возможности последующего отката к ней. | +| connect_to | (list) | Список словарей, содержащих информацию о внутренних сетях, к которым необходимо подключить данную. См. примеры. + +## Возвращаемые значения модуля decort_vins + +Модуль decort_vins возвращает информацию о внутренней сети в виде словаря facts со следующими ключами: + +| Ключ | Тип данных | Описание | +| --- | --- | --- | +| account_id | (int) | Уникальный целочисленный идентификатор аккаунта, которому принадлежит внутренняя сеть. | +| custom_net_addr | (list) | Список IP-адресов пользовательских интерфейсов виртуального маршрутизатора +| ext_ip_addr | (string) | IP-адрес интерфейса, которым виртуальный маршрутизатор подключён к внешней сети. | +| ext_net_id | (int) | Идентификатор внешней сети, к которой подключена внутренняя сеть. `-1` означает, что внутренняя сеть не подключёна к внешней сети. | +| gid | (int) | Идентификатор физического кластера (Grid ID), на базе которого развёрнуты ресурсы данной внутренней сети. | +| id | (int) | Уникальный целочисленный идентификатор внутренней сети. | +| name | (string) | Имя внутренней сети. | +| int_net_addr | (string) | Адрес внутренней сети. | +| rg_id | (int) | Уникальный целочисленный идентификатор ресурсной группы, которой принадлежит данная внутренняя сеть. Если данная внутренняя сеть создана на уровне аккаунта, то `rg_id=0`. | +| ssh_ipaddr | (list) | Список IP-адресов виртуального маршрутизатора во внутренней сети, на которых включён SSH-доступ к нему. +| ssh_password | (str) | Пароль для SSH-доступа к виртуальному маршрутизатору. +| ssh_port | (int) | Номер порта для SSH-подключения к виртуальному маршрутизатору. +| state | (string) | Состояние внутренней сети. | + + + +## Пример использования модуля decort_vins + +В данном примере создаётся внутренняя сеть с именем "MyVins01" (vins_name: "MyVins01"). + +Внутренняя сеть создаётся на уровне ресурсной группы "MyRg01" (rg_name: "MyRg01"), принадлежащей аккаунту "MyMainAccount" (account_name: "MyMainAccount"). Внутренняя сеть будет иметь подключение во внешнюю сеть по умолчанию (ext_net_id: 0). +``` + - name: Manage ViNS on resource group level + decort_vins: + account_name: "MyMainAccount" + rg_name: "MyRg01" + authenticator: jwt + jwt: "{{ my_jwt.jwt }}" + controller_url: "https://ds1.digitalenergy.online" + ext_net_id: 0 + vins_name: "MyVins01" + register: my_vins + ``` + +Здесь результат исполнения модуля decort_vins записывается в переменную my_vins, которую можно дальше использовать в Ansible playbooks. Ниже показано, как получить и использовать идентификатор внутренней сети для подключения к нему виртуального сервера. +``` +- name: Manage virtual machine + decort_kvmvm: + << для краткости фрагмент опущен >> + networks: + - type: VINS + id: "{{ my_vins.facts.id }}" + << для краткости фрагмент опущен >> +``` + +В данном примере идёт создание внутренней сети, а потом её привязка к внутренним сетям с id 864 и 196. +``` + - name: Manage ViNS on resource group level + decort_vins: + authenticator: jwt + jwt: "{{ my_jwt.jwt }}" + controller_url: "https://cloud.digitalenergy.online" + vins_name: "ViNS_connected_by_decort_vins_module" + rg_id: 98 + connect_to: + - id: 864 + ipaddr: 192.168.5.66 + netmask: 24 + - id: 196 + ipaddr: 192.168.9.133 + netmask: 24 + register: managed_vins + +``` + + diff --git a/wiki/Home.md b/wiki/Home.md index d23867e..2c07924 100644 --- a/wiki/Home.md +++ b/wiki/Home.md @@ -1,5 +1,6 @@ ## Документация: +- [Модули Ansible версии 7.0.0](./7.0.0/Home.md) - [Модули Ansible версии 6.1.0](./6.1.0/Home.md) - [Модули Ansible версии 6.0.0](./6.0.0/Home.md) - [Модули Ansible версии 5.6.0](./5.6.0/Home.md)