Adds bigip_software_install module (#44733)
This module can be used to install existing images on a bigip.
This commit is contained in:
Tim Rupp
GitHub
parent
fc64ce3e0c
commit
c7eeb37f64
2 changed files with 621 additions and 0 deletions
502
lib/ansible/modules/network/f5/bigip_software_install.py
Normal file
502
lib/ansible/modules/network/f5/bigip_software_install.py
Normal file
|
|
@ -0,0 +1,502 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright: (c) 2018, F5 Networks Inc.
|
||||
# GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: bigip_software_install
|
||||
short_description: Install software images on a BIG-IP
|
||||
description:
|
||||
- Install new images on a BIG-IP.
|
||||
version_added: 2.7
|
||||
options:
|
||||
image:
|
||||
description:
|
||||
- Image to install on the remote device.
|
||||
volume:
|
||||
description:
|
||||
- The volume to install the software image to.
|
||||
state:
|
||||
description:
|
||||
- When C(installed), ensures that the software is installed on the volume
|
||||
and the volume is set to be booted from. The device is B(not) rebooted
|
||||
into the new software.
|
||||
- When C(activated), performs the same operation as C(installed), but
|
||||
the system is rebooted to the new software.
|
||||
default: activated
|
||||
choices:
|
||||
- activated
|
||||
- installed
|
||||
extends_documentation_fragment: f5
|
||||
author:
|
||||
- Tim Rupp (@caphrim007)
|
||||
'''
|
||||
EXAMPLES = r'''
|
||||
- name: Ensure an existing image is installed in specified volume
|
||||
bigip_software_install:
|
||||
image: BIGIP-13.0.0.0.0.1645.iso
|
||||
volume: HD1.2
|
||||
state: installed
|
||||
provider:
|
||||
password: secret
|
||||
server: lb.mydomain.com
|
||||
user: admin
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Ensure an existing image is activated in specified volume
|
||||
bigip_software_install:
|
||||
image: BIGIP-13.0.0.0.0.1645.iso
|
||||
state: activated
|
||||
volume: HD1.2
|
||||
provider:
|
||||
password: secret
|
||||
server: lb.mydomain.com
|
||||
user: admin
|
||||
delegate_to: localhost
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
# only common fields returned
|
||||
'''
|
||||
|
||||
import time
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
try:
|
||||
from library.module_utils.network.f5.bigip import HAS_F5SDK
|
||||
from library.module_utils.network.f5.bigip import F5RestClient
|
||||
from library.module_utils.network.f5.common import F5ModuleError
|
||||
from library.module_utils.network.f5.common import AnsibleF5Parameters
|
||||
from library.module_utils.network.f5.common import cleanup_tokens
|
||||
from library.module_utils.network.f5.common import fq_name
|
||||
from library.module_utils.network.f5.common import f5_argument_spec
|
||||
from library.module_utils.network.f5.common import exit_json
|
||||
from library.module_utils.network.f5.common import fail_json
|
||||
except ImportError:
|
||||
from ansible.module_utils.network.f5.bigip import HAS_F5SDK
|
||||
from ansible.module_utils.network.f5.bigip import F5RestClient
|
||||
from ansible.module_utils.network.f5.common import F5ModuleError
|
||||
from ansible.module_utils.network.f5.common import AnsibleF5Parameters
|
||||
from ansible.module_utils.network.f5.common import cleanup_tokens
|
||||
from ansible.module_utils.network.f5.common import fq_name
|
||||
from ansible.module_utils.network.f5.common import f5_argument_spec
|
||||
from ansible.module_utils.network.f5.common import exit_json
|
||||
from ansible.module_utils.network.f5.common import fail_json
|
||||
|
||||
|
||||
class Parameters(AnsibleF5Parameters):
|
||||
api_map = {
|
||||
|
||||
}
|
||||
|
||||
api_attributes = [
|
||||
'options',
|
||||
'volume',
|
||||
]
|
||||
|
||||
returnables = [
|
||||
|
||||
]
|
||||
|
||||
updatables = [
|
||||
|
||||
]
|
||||
|
||||
|
||||
class ApiParameters(Parameters):
|
||||
@property
|
||||
def image_names(self):
|
||||
result = []
|
||||
result += self.read_image_from_device('image')
|
||||
result += self.read_image_from_device('hotfix')
|
||||
return result
|
||||
|
||||
def read_image_from_device(self, t):
|
||||
uri = "https://{0}:{1}/mgmt/tm/sys/software/{2}".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port'],
|
||||
t,
|
||||
)
|
||||
resp = self.client.api.get(uri)
|
||||
try:
|
||||
response = resp.json()
|
||||
except ValueError:
|
||||
return []
|
||||
|
||||
if 'code' in response and response['code'] == 400:
|
||||
if 'message' in response:
|
||||
return []
|
||||
else:
|
||||
return []
|
||||
if 'items' not in response:
|
||||
return []
|
||||
return [x['name'] for x in response['items']]
|
||||
|
||||
|
||||
class ModuleParameters(Parameters):
|
||||
@property
|
||||
def version(self):
|
||||
if self._values['version']:
|
||||
return self._values['version']
|
||||
|
||||
self._values['version'] = self.image_info['version']
|
||||
return self._values['version']
|
||||
|
||||
@property
|
||||
def build(self):
|
||||
# Return cached copy if we have it
|
||||
if self._values['build']:
|
||||
return self._values['build']
|
||||
|
||||
# Otherwise, get copy from image info cache
|
||||
self._values['build'] = self.image_info['build']
|
||||
return self._values['build']
|
||||
|
||||
@property
|
||||
def image_info(self):
|
||||
if self._values['image_info']:
|
||||
image = self._values['image_info']
|
||||
else:
|
||||
# Otherwise, get a new copy and store in cache
|
||||
image = self.read_image()
|
||||
self._values['image_info'] = image
|
||||
return image
|
||||
|
||||
@property
|
||||
def image_type(self):
|
||||
if self._values['image_type']:
|
||||
return self._values['image_type']
|
||||
if 'software:image' in self.image_info['kind']:
|
||||
self._values['image_type'] = 'image'
|
||||
else:
|
||||
self._values['image_type'] = 'hotfix'
|
||||
return self._values['image_type']
|
||||
|
||||
def read_image(self):
|
||||
image = self.read_image_from_device(type='image')
|
||||
if image:
|
||||
return image
|
||||
image = self.read_hotfix_from_device(type='hotfix')
|
||||
if image:
|
||||
return image
|
||||
return None
|
||||
|
||||
def read_image_from_device(self, type):
|
||||
uri = "https://{0}:{1}/mgmt/tm/sys/software/{2}/{3}".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port'],
|
||||
type,
|
||||
self.image,
|
||||
)
|
||||
resp = self.client.api.get(uri)
|
||||
try:
|
||||
response = resp.json()
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
if 'code' in response and response['code'] == 400:
|
||||
if 'message' in response:
|
||||
return None
|
||||
else:
|
||||
return None
|
||||
return response
|
||||
|
||||
|
||||
class Changes(Parameters):
|
||||
def to_return(self):
|
||||
result = {}
|
||||
try:
|
||||
for returnable in self.returnables:
|
||||
result[returnable] = getattr(self, returnable)
|
||||
result = self._filter_params(result)
|
||||
except Exception:
|
||||
pass
|
||||
return result
|
||||
|
||||
|
||||
class UsableChanges(Changes):
|
||||
pass
|
||||
|
||||
|
||||
class ReportableChanges(Changes):
|
||||
pass
|
||||
|
||||
|
||||
class Difference(object):
|
||||
def __init__(self, want, have=None):
|
||||
self.want = want
|
||||
self.have = have
|
||||
|
||||
def compare(self, param):
|
||||
try:
|
||||
result = getattr(self, param)
|
||||
return result
|
||||
except AttributeError:
|
||||
return self.__default(param)
|
||||
|
||||
def __default(self, param):
|
||||
attr1 = getattr(self.want, param)
|
||||
try:
|
||||
attr2 = getattr(self.have, param)
|
||||
if attr1 != attr2:
|
||||
return attr1
|
||||
except AttributeError:
|
||||
return attr1
|
||||
|
||||
|
||||
class ModuleManager(object):
|
||||
def __init__(self, *args, **kwargs):
|
||||
self.module = kwargs.get('module', None)
|
||||
self.client = kwargs.get('client', None)
|
||||
self.want = ModuleParameters(params=self.module.params, client=self.client)
|
||||
self.have = ApiParameters(client=self.client)
|
||||
self.changes = UsableChanges()
|
||||
|
||||
def _set_changed_options(self):
|
||||
changed = {}
|
||||
for key in Parameters.returnables:
|
||||
if getattr(self.want, key) is not None:
|
||||
changed[key] = getattr(self.want, key)
|
||||
if changed:
|
||||
self.changes = UsableChanges(params=changed)
|
||||
|
||||
def _update_changed_options(self):
|
||||
diff = Difference(self.want, self.have)
|
||||
updatables = Parameters.updatables
|
||||
changed = dict()
|
||||
for k in updatables:
|
||||
change = diff.compare(k)
|
||||
if change is None:
|
||||
continue
|
||||
else:
|
||||
if isinstance(change, dict):
|
||||
changed.update(change)
|
||||
else:
|
||||
changed[k] = change
|
||||
if changed:
|
||||
self.changes = UsableChanges(params=changed)
|
||||
return True
|
||||
return False
|
||||
|
||||
def should_update(self):
|
||||
result = self._update_changed_options()
|
||||
if result:
|
||||
return True
|
||||
return False
|
||||
|
||||
def exec_module(self):
|
||||
result = dict()
|
||||
|
||||
changed = self.present()
|
||||
|
||||
reportable = ReportableChanges(params=self.changes.to_return())
|
||||
changes = reportable.to_return()
|
||||
result.update(**changes)
|
||||
result.update(dict(changed=changed))
|
||||
self._announce_deprecations(result)
|
||||
return result
|
||||
|
||||
def _announce_deprecations(self, result):
|
||||
warnings = result.pop('__warnings', [])
|
||||
for warning in warnings:
|
||||
self.client.module.deprecate(
|
||||
msg=warning['msg'],
|
||||
version=warning['version']
|
||||
)
|
||||
|
||||
def present(self):
|
||||
if self.exists():
|
||||
return False
|
||||
else:
|
||||
return self.update()
|
||||
|
||||
def exists(self):
|
||||
uri = "https://{0}:{1}/mgmt/tm/sys/software/volume/{2}".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port'],
|
||||
self.want.volume
|
||||
)
|
||||
resp = self.client.api.get(uri)
|
||||
try:
|
||||
response = resp.json()
|
||||
except ValueError:
|
||||
return False
|
||||
if resp.status == 404 or 'code' in response and response['code'] == 404:
|
||||
return False
|
||||
|
||||
# version key can be missing in the event that an existing volume has
|
||||
# no installed software in it.
|
||||
if self.want.version != response.get('version', None):
|
||||
return False
|
||||
if self.want.build != response.get('build', None):
|
||||
return False
|
||||
|
||||
if self.want.state == 'installed':
|
||||
return True
|
||||
if self.want.state == 'activated':
|
||||
if 'defaultBootLocation' in response['media'][0]:
|
||||
return True
|
||||
return False
|
||||
|
||||
def volume_exists(self):
|
||||
uri = "https://{0}:{1}/mgmt/tm/sys/software/volume/{2}".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port'],
|
||||
self.want.volume
|
||||
)
|
||||
resp = self.client.api.get(uri)
|
||||
try:
|
||||
response = resp.json()
|
||||
except ValueError:
|
||||
return False
|
||||
if resp.status == 404 or 'code' in response and response['code'] == 404:
|
||||
return False
|
||||
return True
|
||||
|
||||
def update(self):
|
||||
if self.module.check_mode:
|
||||
return True
|
||||
|
||||
if self.want.image and self.want.image not in self.have.image_names:
|
||||
raise F5ModuleError(
|
||||
"The specified image was not found on the device"
|
||||
)
|
||||
|
||||
options = list()
|
||||
if not self.volume_exists():
|
||||
options.append({'create-volume': True})
|
||||
if self.want.state == 'activated':
|
||||
options.append({'reboot': True})
|
||||
self.want.update({'options': options})
|
||||
|
||||
self.update_on_device()
|
||||
self.wait_for_software_install_on_device()
|
||||
if self.want.state == 'activated':
|
||||
self.wait_for_device_reboot()
|
||||
return True
|
||||
|
||||
def update_on_device(self):
|
||||
params = {
|
||||
"command": "install",
|
||||
"name": self.want.image,
|
||||
}
|
||||
params.update(self.want.api_params())
|
||||
|
||||
uri = "https://{0}:{1}/mgmt/tm/sys/software/{2}".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port'],
|
||||
self.want.image_type
|
||||
)
|
||||
resp = self.client.api.post(uri, json=params)
|
||||
try:
|
||||
response = resp.json()
|
||||
if 'commandResult' in response and len(response['commandResult'].strip()) > 0:
|
||||
raise F5ModuleError(response['commandResult'])
|
||||
except ValueError as ex:
|
||||
raise F5ModuleError(str(ex))
|
||||
if 'code' in response and response['code'] in [400, 403]:
|
||||
if 'message' in response:
|
||||
raise F5ModuleError(response['message'])
|
||||
else:
|
||||
raise F5ModuleError(resp.content)
|
||||
return True
|
||||
|
||||
def wait_for_device_reboot(self):
|
||||
while True:
|
||||
time.sleep(5)
|
||||
try:
|
||||
self.client.reconnect()
|
||||
volume = self.read_volume_from_device()
|
||||
if 'active' in volume and volume['active'] is True:
|
||||
break
|
||||
except F5ModuleError:
|
||||
# Handle all exceptions because if the system is offline (for a
|
||||
# reboot) the REST client will raise exceptions about
|
||||
# connections
|
||||
pass
|
||||
|
||||
def wait_for_software_install_on_device(self):
|
||||
# We need to delay this slightly in case the the volume needs to be
|
||||
# created first
|
||||
for dummy in range(10):
|
||||
try:
|
||||
if self.volume_exists():
|
||||
break
|
||||
except F5ModuleError:
|
||||
pass
|
||||
time.sleep(5)
|
||||
while True:
|
||||
time.sleep(10)
|
||||
volume = self.read_volume_from_device()
|
||||
if volume['status'] == 'complete':
|
||||
break
|
||||
elif volume['status'] == 'failed':
|
||||
raise F5ModuleError
|
||||
|
||||
def read_volume_from_device(self):
|
||||
uri = "https://{0}:{1}/mgmt/tm/sys/software/volume/{2}".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port'],
|
||||
self.want.volume
|
||||
)
|
||||
resp = self.client.api.get(uri)
|
||||
try:
|
||||
response = resp.json()
|
||||
except ValueError as ex:
|
||||
raise F5ModuleError(str(ex))
|
||||
|
||||
if 'code' in response and response['code'] == 400:
|
||||
if 'message' in response:
|
||||
raise F5ModuleError(response['message'])
|
||||
else:
|
||||
raise F5ModuleError(resp.content)
|
||||
return response
|
||||
|
||||
|
||||
class ArgumentSpec(object):
|
||||
def __init__(self):
|
||||
self.supports_check_mode = True
|
||||
argument_spec = dict(
|
||||
image=dict(),
|
||||
volume=dict(),
|
||||
state=dict(
|
||||
default='activated',
|
||||
choices=['activated', 'installed']
|
||||
),
|
||||
)
|
||||
self.argument_spec = {}
|
||||
self.argument_spec.update(f5_argument_spec)
|
||||
self.argument_spec.update(argument_spec)
|
||||
|
||||
|
||||
def main():
|
||||
spec = ArgumentSpec()
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=spec.argument_spec,
|
||||
supports_check_mode=spec.supports_check_mode,
|
||||
)
|
||||
|
||||
try:
|
||||
client = F5RestClient(**module.params)
|
||||
mm = ModuleManager(module=module, client=client)
|
||||
results = mm.exec_module()
|
||||
exit_json(module, results, client)
|
||||
except F5ModuleError as ex:
|
||||
fail_json(module, ex, client)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
119
test/units/modules/network/f5/test_bigip_software_install.py
Normal file
119
test/units/modules/network/f5/test_bigip_software_install.py
Normal file
|
|
@ -0,0 +1,119 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright: (c) 2017, F5 Networks Inc.
|
||||
# GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import os
|
||||
import json
|
||||
import pytest
|
||||
import sys
|
||||
|
||||
from nose.plugins.skip import SkipTest
|
||||
if sys.version_info < (2, 7):
|
||||
raise SkipTest("F5 Ansible modules require Python >= 2.7")
|
||||
|
||||
from ansible.compat.tests import unittest
|
||||
from ansible.compat.tests.mock import Mock
|
||||
from ansible.compat.tests.mock import patch
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
try:
|
||||
from library.modules.bigip_software_install import ApiParameters
|
||||
from library.modules.bigip_software_install import ModuleParameters
|
||||
from library.modules.bigip_software_install import ModuleManager
|
||||
from library.modules.bigip_software_install import ArgumentSpec
|
||||
from library.module_utils.network.f5.common import F5ModuleError
|
||||
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
|
||||
from test.unit.modules.utils import set_module_args
|
||||
except ImportError:
|
||||
try:
|
||||
from ansible.modules.network.f5.bigip_software_install import ApiParameters
|
||||
from ansible.modules.network.f5.bigip_software_install import ModuleParameters
|
||||
from ansible.modules.network.f5.bigip_software_install import ModuleManager
|
||||
from ansible.modules.network.f5.bigip_software_install import ArgumentSpec
|
||||
from ansible.module_utils.network.f5.common import F5ModuleError
|
||||
from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
|
||||
from units.modules.utils import set_module_args
|
||||
except ImportError:
|
||||
raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
|
||||
|
||||
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
|
||||
fixture_data = {}
|
||||
|
||||
|
||||
def load_fixture(name):
|
||||
path = os.path.join(fixture_path, name)
|
||||
|
||||
if path in fixture_data:
|
||||
return fixture_data[path]
|
||||
|
||||
with open(path) as f:
|
||||
data = f.read()
|
||||
|
||||
try:
|
||||
data = json.loads(data)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
fixture_data[path] = data
|
||||
return data
|
||||
|
||||
|
||||
class TestParameters(unittest.TestCase):
|
||||
def test_module_parameters(self):
|
||||
args = dict(
|
||||
volume='HD1.2',
|
||||
image='BIGIP-13.0.0.0.0.1645.iso',
|
||||
)
|
||||
|
||||
p = ModuleParameters(params=args)
|
||||
assert p.volume == 'HD1.2'
|
||||
assert p.image == 'BIGIP-13.0.0.0.0.1645.iso'
|
||||
|
||||
|
||||
@patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root',
|
||||
return_value=True)
|
||||
class TestManager(unittest.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
self.spec = ArgumentSpec()
|
||||
|
||||
def test_create(self, *args):
|
||||
set_module_args(dict(
|
||||
image='BIGIP-13.0.0.0.0.1645.iso',
|
||||
volume='HD1.2',
|
||||
server='localhost',
|
||||
password='password',
|
||||
user='admin'
|
||||
))
|
||||
|
||||
current = ApiParameters()
|
||||
current.read_image_from_device = Mock(
|
||||
side_effect=[
|
||||
['BIGIP-13.0.0.0.0.1645.iso'],
|
||||
['BIGIP-12.1.3.4-0.0.2.iso'],
|
||||
]
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=self.spec.argument_spec,
|
||||
supports_check_mode=self.spec.supports_check_mode
|
||||
)
|
||||
|
||||
# Override methods in the specific type of manager
|
||||
mm = ModuleManager(module=module)
|
||||
mm.have = current
|
||||
|
||||
mm.exists = Mock(side_effect=[False, True])
|
||||
mm.create_on_device = Mock(return_value=True)
|
||||
mm.volume_exists = Mock(return_value=True)
|
||||
mm.update_on_device = Mock(return_value=True)
|
||||
mm.wait_for_device_reboot = Mock(return_value=True)
|
||||
mm.wait_for_software_install_on_device = Mock(return_value=True)
|
||||
|
||||
results = mm.exec_module()
|
||||
|
||||
assert results['changed'] is True
|
||||
Loading…
Reference in a new issue