You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
424 lines
19 KiB
424 lines
19 KiB
#!/usr/bin/python
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: decort_vins
|
|
|
|
description: See L(Module Documentation,https://repository.basistech.ru/BASIS/decort-ansible/wiki/Home).
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.basic import env_fallback
|
|
|
|
from ansible.module_utils.decort_utils import *
|
|
|
|
|
|
class decort_vins(DecortController):
|
|
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
|
|
vins_facts = None # will hold ViNS facts
|
|
validated_rg_id = 0
|
|
rg_facts = None # will hold RG facts
|
|
validated_acc_id = 0
|
|
acc_facts = None # will hold Account facts
|
|
|
|
if arg_amodule.params['vins_id']:
|
|
# expect existing ViNS with the specified ID
|
|
# This call to vins_find will abort the module if no ViNS with such ID is present
|
|
self.vins_id, self.vins_facts = self.vins_find(arg_amodule.params['vins_id'],check_state=False)
|
|
if self.vins_id == 0:
|
|
self.result['failed'] = True
|
|
self.result['msg'] = "Specified ViNS ID {} not found.".format(arg_amodule.params['vins_id'])
|
|
self.amodule.fail_json(**self.result)
|
|
self.vins_level = "ID"
|
|
#raise Exception(self.vins_facts)
|
|
validated_acc_id = self.vins_facts['accountId']
|
|
validated_rg_id = self.vins_facts['rgId']
|
|
|
|
elif arg_amodule.params['rg_id']:
|
|
# expect ViNS @ RG level in the RG with specified ID
|
|
self.vins_level = "RG"
|
|
# This call to rg_find will abort the module if no RG with such ID is present
|
|
validated_rg_id, rg_facts = self.rg_find(0, # account ID set to 0 as we search for RG by RG ID
|
|
arg_amodule.params['rg_id'], arg_rg_name="")
|
|
|
|
# This call to vins_find may return vins_id=0 if no ViNS found
|
|
self.vins_id, self.vins_facts = self.vins_find(vins_id=0, vins_name=arg_amodule.params['vins_name'],
|
|
account_id=0,
|
|
rg_id=arg_amodule.params['rg_id'],
|
|
rg_facts=rg_facts,
|
|
check_state=False)
|
|
# TODO: add checks and setup ViNS presence flags accordingly
|
|
pass
|
|
elif arg_amodule.params['account_id'] or arg_amodule.params['account_name'] != "":
|
|
# Specified account must be present and accessible by the user, otherwise abort the module
|
|
validated_acc_id, acc_facts = self.account_find(arg_amodule.params['account_name'], arg_amodule.params['account_id'])
|
|
if not validated_acc_id:
|
|
self.result['failed'] = True
|
|
self.result['msg'] = ("Current user does not have access to the requested account "
|
|
"or non-existent account specified.")
|
|
self.amodule.fail_json(**self.result)
|
|
if arg_amodule.params['rg_name'] != "": # at this point we know that rg_id=0
|
|
# expect ViNS @ RG level in the RG with specified name under specified account
|
|
# RG with the specified name must be present under the account, otherwise abort the module
|
|
validated_rg_id, rg_facts = self.rg_find(validated_acc_id, 0, arg_amodule.params['rg_name'])
|
|
if (not validated_rg_id or
|
|
rg_facts['status'] in ["DESTROYING", "DESTROYED", "DELETING", "DELETED", "DISABLING", "ENABLING"]):
|
|
self.result['failed'] = True
|
|
self.result['msg'] = "RG name '{}' not found or has invalid state.".format(arg_amodule.params['rg_name'])
|
|
self.amodule.fail_json(**self.result)
|
|
# This call to vins_find may return vins_id=0 if no ViNS with this name found under specified RG
|
|
self.vins_id, self.vins_facts = self.vins_find(vins_id=0, vins_name=arg_amodule.params['vins_name'],
|
|
account_id=0, # set to 0, as we are looking for ViNS under RG
|
|
rg_id=validated_rg_id,
|
|
rg_facts=rg_facts,
|
|
check_state=False)
|
|
self.vins_level = "RG"
|
|
# TODO: add checks and setup ViNS presence flags accordingly
|
|
else: # At this point we know for sure that rg_name="" and rg_id=0
|
|
# So we expect ViNS @ account level
|
|
# This call to vins_find may return vins_id=0 if no ViNS found
|
|
self.vins_id, self.vins_facts = self.vins_find(vins_id=0, vins_name=arg_amodule.params['vins_name'],
|
|
account_id=validated_acc_id,
|
|
rg_id=0,
|
|
rg_facts=rg_facts,
|
|
check_state=False)
|
|
self.vins_level = "ACC"
|
|
# TODO: add checks and setup ViNS presence flags accordingly
|
|
else:
|
|
# this is "invalid arguments combination" sink
|
|
# if we end up here, it means that module was invoked with vins_id=0 and rg_id=0
|
|
self.result['failed'] = True
|
|
self.result['msg'] = "Cannot find ViNS by name"
|
|
if arg_amodule.params['account_id'] == 0 and arg_amodule.params['account_name'] == '':
|
|
self.result['msg'] = "Cannot find ViNS by name when account name is empty and account ID is 0."
|
|
if arg_amodule.params['rg_name'] == "":
|
|
# rg_name without account specified
|
|
self.result['msg'] = "Cannot find ViNS by name when RG name is empty and RG ID is 0."
|
|
self.amodule.fail_json(**self.result)
|
|
|
|
return
|
|
self.rg_id = validated_rg_id
|
|
self.acc_id = validated_acc_id
|
|
return
|
|
def create(self):
|
|
self.vins_id = self.vins_provision(self.amodule.params['vins_name'],
|
|
self.acc_id, self.rg_id,
|
|
self.amodule.params['ipcidr'],
|
|
self.amodule.params['ext_net_id'], self.amodule.params['ext_ip_addr'],
|
|
self.amodule.params['description'])
|
|
|
|
if self.amodule.params['mgmtaddr'] or self.amodule.params['connect_to']:
|
|
_, self.vins_facts = self.vins_find(self.vins_id)
|
|
if self.amodule.params['connect_to']:
|
|
self.vins_update_ifaces(self.vins_facts,self.amodule.params['connect_to'],)
|
|
if self.amodule.params['mgmtaddr']:
|
|
self.vins_update_mgmt(self.vins_facts,self.amodule.params['mgmtaddr'])
|
|
|
|
return
|
|
def action(self,d_state='',restore=False):
|
|
if restore == True:
|
|
self.vins_restore(arg_vins_id=self.vins_id)
|
|
self.vins_state(self.vins_facts, 'enabled')
|
|
self.vins_facts['status'] = "ENABLED"
|
|
self.vins_facts['VNFDev']['techStatus'] = "STARTED"
|
|
|
|
self.vins_update_extnet(self.vins_facts,
|
|
self.amodule.params['ext_net_id'],
|
|
self.amodule.params['ext_ip_addr'],
|
|
)
|
|
|
|
if d_state == 'enabled' and self.vins_facts['status'] == "DISABLED":
|
|
self.vins_state(self.vins_facts, d_state)
|
|
self.vins_facts['status'] = "ENABLED"
|
|
self.vins_facts['VNFDev']['techStatus'] = "STARTED"
|
|
d_state = ''
|
|
|
|
if self.vins_facts['status'] == "ENABLED" and self.vins_facts['VNFDev']['techStatus'] == "STARTED":
|
|
self.vins_update_ifaces(self.vins_facts,
|
|
self.amodule.params['connect_to'],
|
|
)
|
|
if self.result['changed']:
|
|
_, self.vins_facts = self.vins_find(self.vins_id)
|
|
self.vins_update_mgmt(self.vins_facts,
|
|
self.amodule.params['mgmtaddr'],
|
|
)
|
|
|
|
if d_state != '':
|
|
self.vins_state(self.vins_facts, d_state)
|
|
return
|
|
def delete(self):
|
|
self.vins_delete(self.vins_id, permanently=True)
|
|
self.vins_facts['status'] = 'DESTROYED'
|
|
return
|
|
def nop(self):
|
|
"""No operation (NOP) handler for ViNS management by decort_vins module.
|
|
This function is intended to be called from the main switch construct of the module
|
|
when current state -> desired state change logic does not require any changes to
|
|
the actual ViNS state.
|
|
"""
|
|
self.result['failed'] = False
|
|
self.result['changed'] = False
|
|
if self.vins_id:
|
|
self.result['msg'] = ("No state change required for ViNS ID {} because of its "
|
|
"current status '{}'.").format(self.vins_id, self.vins_facts['status'])
|
|
else:
|
|
self.result['msg'] = ("No state change to '{}' can be done for "
|
|
"non-existent ViNS instance.").format(self.amodule.params['state'])
|
|
return
|
|
def error(self):
|
|
self.result['failed'] = True
|
|
self.result['changed'] = False
|
|
if self.vins_id:
|
|
self.result['failed'] = True
|
|
self.result['changed'] = False
|
|
self.result['msg'] = ("Invalid target state '{}' requested for ViNS ID {} in the "
|
|
"current status '{}'").format(self.vins_id,
|
|
self.amodule.params['state'],
|
|
self.vins_facts['status'])
|
|
else:
|
|
self.result['failed'] = True
|
|
self.result['changed'] = False
|
|
self.result['msg'] = ("Invalid target state '{}' requested for non-existent "
|
|
"ViNS name '{}'").format(self.amodule.params['state'],
|
|
self.amodule.params['vins_name'])
|
|
return
|
|
def package_facts(self, arg_check_mode=False):
|
|
"""Package a dictionary of ViNS facts according to the decort_vins module specification.
|
|
This dictionary will be returned to the upstream Ansible engine at the completion of
|
|
the module run.
|
|
|
|
@param arg_check_mode: boolean that tells if this Ansible module is run in check mode
|
|
"""
|
|
|
|
ret_dict = dict(id=0,
|
|
name="none",
|
|
state="CHECK_MODE",
|
|
)
|
|
|
|
if arg_check_mode:
|
|
# in check mode return immediately with the default values
|
|
return ret_dict
|
|
|
|
if self.vins_facts is None:
|
|
# if void facts provided - change state value to ABSENT and return
|
|
ret_dict['state'] = "ABSENT"
|
|
return ret_dict
|
|
|
|
ret_dict['id'] = self.vins_facts['id']
|
|
ret_dict['name'] = self.vins_facts['name']
|
|
ret_dict['state'] = self.vins_facts['status']
|
|
ret_dict['account_id'] = self.vins_facts['accountId']
|
|
ret_dict['rg_id'] = self.vins_facts['rgId']
|
|
ret_dict['int_net_addr'] = self.vins_facts['network']
|
|
ret_dict['gid'] = self.vins_facts['gid']
|
|
custom_interfaces = list(filter(lambda i: i['type']=="CUSTOM",self.vins_facts['VNFDev']['interfaces']))
|
|
if custom_interfaces:
|
|
ret_dict['custom_net_addr'] = []
|
|
for runner in custom_interfaces:
|
|
ret_dict['custom_net_addr'].append(runner['ipAddress'])
|
|
mgmt_interfaces = list(filter(lambda i: i['listenSsh'] and i['name']!="ens9",self.vins_facts['VNFDev']['interfaces']))
|
|
if mgmt_interfaces:
|
|
ret_dict['ssh_ipaddr'] = []
|
|
for runner in mgmt_interfaces:
|
|
ret_dict['ssh_ipaddr'].append(runner['ipAddress'])
|
|
ret_dict['ssh_password'] = self.vins_facts['VNFDev']['config']['mgmt']['password']
|
|
ret_dict['ssh_port'] = 9022
|
|
if self.vins_facts['vnfs'].get('GW'):
|
|
gw_config = self.vins_facts['vnfs']['GW']['config']
|
|
ret_dict['ext_ip_addr'] = gw_config['ext_net_ip']
|
|
ret_dict['ext_net_id'] = gw_config['ext_net_id']
|
|
else:
|
|
ret_dict['ext_ip_addr'] = ""
|
|
ret_dict['ext_net_id'] = -1
|
|
|
|
return ret_dict
|
|
|
|
|
|
@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',
|
|
],
|
|
),
|
|
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
|
|
# 3) if ViNS does not exist -> deploy
|
|
# 4) if ViNS exists: check desired state, desired configuration -> initiate action(s) accordingly
|
|
# 5) report result to Ansible
|
|
|
|
def main():
|
|
decon = decort_vins()
|
|
amodule = decon.amodule
|
|
#
|
|
# Initial validation of module arguments is complete
|
|
#
|
|
# At this point non-zero vins_id means that we will be managing pre-existing ViNS
|
|
# Otherwise we are about to create a new one as follows:
|
|
# - if validated_rg_id is non-zero, create ViNS @ RG level
|
|
# - if validated_rg_id is zero, create ViNS @ account level
|
|
#
|
|
# When managing existing ViNS we need to account for both "static" and "transient"
|
|
# status. Full range of ViNS statii is as follows:
|
|
#
|
|
# "MODELED", "CREATED", "ENABLED", "ENABLING", "DISABLED", "DISABLING", "DELETED", "DELETING", "DESTROYED", "DESTROYING"
|
|
#
|
|
# if cconfig_save is true, only config save without other updates
|
|
vins_should_exist = False
|
|
|
|
if decon.vins_id:
|
|
vins_should_exist = True
|
|
if decon.vins_facts['status'] in ["MODELED", "DISABLING", "ENABLING", "DELETING", "DESTROYING"]:
|
|
# error: nothing can be done to existing ViNS in the listed statii regardless of
|
|
# the requested state
|
|
decon.result['failed'] = True
|
|
decon.result['changed'] = False
|
|
decon.result['msg'] = ("No change can be done for existing ViNS ID {} because of its current "
|
|
"status '{}'").format(decon.vins_id, decon.vins_facts['status'])
|
|
elif decon.vins_facts['status'] == "DISABLED":
|
|
if amodule.params['state'] == 'absent':
|
|
decon.delete()
|
|
vins_should_exist = False
|
|
elif amodule.params['state'] in ('present', 'disabled'):
|
|
# update ViNS, leave in disabled state
|
|
decon.action()
|
|
elif amodule.params['state'] == 'enabled':
|
|
# update ViNS and enable
|
|
decon.action('enabled')
|
|
elif decon.vins_facts['status'] in ["CREATED", "ENABLED"]:
|
|
if amodule.params['state'] == 'absent':
|
|
decon.delete()
|
|
vins_should_exist = False
|
|
elif amodule.params['state'] in ('present', 'enabled'):
|
|
# update ViNS
|
|
decon.action()
|
|
elif amodule.params['state'] == 'disabled':
|
|
# disable and update ViNS
|
|
decon.action('disabled')
|
|
elif decon.vins_facts['status'] == "DELETED":
|
|
if amodule.params['state'] in ['present', 'enabled']:
|
|
# restore and enable
|
|
decon.action(restore=True)
|
|
vins_should_exist = True
|
|
elif amodule.params['state'] == 'absent':
|
|
# destroy permanently
|
|
decon.delete()
|
|
vins_should_exist = False
|
|
elif amodule.params['state'] == 'disabled':
|
|
decon.error()
|
|
vins_should_exist = False
|
|
elif decon.vins_facts['status'] == "DESTROYED":
|
|
if amodule.params['state'] in ('present', 'enabled'):
|
|
# need to re-provision ViNS;
|
|
decon.create()
|
|
vins_should_exist = True
|
|
elif amodule.params['state'] == 'absent':
|
|
decon.nop()
|
|
vins_should_exist = False
|
|
elif amodule.params['state'] == 'disabled':
|
|
decon.error()
|
|
else:
|
|
# Preexisting ViNS was not found.
|
|
vins_should_exist = False # we will change it back to True if ViNS is created or restored
|
|
# If requested state is 'absent' - nothing to do
|
|
if amodule.params['state'] == 'absent':
|
|
decon.nop()
|
|
elif amodule.params['state'] in ('present', 'enabled'):
|
|
decon.check_amodule_argument('vins_name')
|
|
# as we already have account ID and RG ID we can create ViNS and get vins_id on success
|
|
decon.create()
|
|
vins_should_exist = True
|
|
elif amodule.params['state'] == 'disabled':
|
|
decon.error()
|
|
#
|
|
# conditional switch end - complete module run
|
|
#
|
|
if decon.result['failed']:
|
|
amodule.fail_json(**decon.result)
|
|
else:
|
|
# prepare ViNS facts to be returned as part of decon.result and then call exit_json(...)
|
|
if decon.result['changed']:
|
|
_, decon.vins_facts = decon.vins_find(decon.vins_id)
|
|
decon.result['facts'] = decon.package_facts(amodule.check_mode)
|
|
amodule.exit_json(**decon.result)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|