From 3744764fae22cf518a3414fa1d7c70e5ba9ebe22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20=C5=A0tevko?= Date: Mon, 9 Jan 2017 08:52:06 +0100 Subject: [PATCH] =?UTF-8?q?Add=20module=20for=20managing=20boot=20environm?= =?UTF-8?q?ents=20on=20FreeBSD/Solaris/illumos=20=E2=80=A6=20(#19180)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add module for managing boot environments on FreeBSD/Solaris/illumos systems * Add ANSIBLE_METADATA Document return values Make imports explicit Use native YAML syntax in EXAMPLES * Add beadm module to CHANGELOG.md * Update version to 2.3 --- CHANGELOG.md | 1 + lib/ansible/modules/system/beadm.py | 415 ++++++++++++++++++++++++++++ 2 files changed, 416 insertions(+) create mode 100644 lib/ansible/modules/system/beadm.py diff --git a/CHANGELOG.md b/CHANGELOG.md index 2cce8823ffa..539a77a500e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,6 +29,7 @@ Ansible Changes By Release ###New Modules: - archive +- beadm - aws * ec2_lc_facts * aws_kms diff --git a/lib/ansible/modules/system/beadm.py b/lib/ansible/modules/system/beadm.py new file mode 100644 index 00000000000..e22d74a6174 --- /dev/null +++ b/lib/ansible/modules/system/beadm.py @@ -0,0 +1,415 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# (c) 2016, Adam Števko +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . +# + +ANSIBLE_METADATA = {'status': ['preview'], + 'supported_by': 'community', + 'version': '1.0'} + +DOCUMENTATION = ''' +--- +module: beadm +short_description: Manage ZFS boot environments on FreeBSD/Solaris/illumos systems. +description: + - Create, delete or activate ZFS boot environments. + - Mount and unmount ZFS boot environments. +version_added: "2.3" +author: Adam Števko (@xen0l) +options: + name: + description: + - ZFS boot environment name. + alias: [ "be" ] + required: True + snapshot: + description: + - If specified, the new boot environment will be cloned from the given + snapshot or inactive boot environment. + required: false + default: false + description: + description: + - Associate a description with a new boot environment. This option is + available only on Solarish platforms. + required: false + default: false + options: + description: + - Create the datasets for new BE with specific ZFS properties. Multiple + options can be specified. This option is available only on + Solarish platforms. + required: false + default: false + mountpoint: + description: + - Path where to mount the ZFS boot environment + required: false + default: false + state: + description: + - Create or delete ZFS boot environment. + required: false + default: "present" + choices: [ "present", "absent", "activated", "mounted", "unmounted" ] + force: + description: + - Specifies if the unmount should be forced. + required: false + default: false + choices: [ "true", "false" ] +''' + +EXAMPLES = ''' +name: Create ZFS boot environment +beadm: name=upgrade-be state=present + +name: Create ZFS boot environment from existing inactive boot environment +beadm: name=upgrade-be snapshot=be@old state=present + +name: Create ZFS boot environment with compression enabled and description "upgrade" +beadm: name=upgrade-be options="compression=on" description="upgrade" + state=present + +name: Delete ZFS boot environment +beadm: name=old-be state=absent + +name: Mount ZFS boot environment on /tmp/be +beadm: name=BE mountpoint=/tmp/be state=mounted + +name: Unmount ZFS boot environment +beadm: name=BE state=unmounted + +name: Activate ZFS boot environment +beadm: name=upgrade-be state=activated +''' + +RETURN = ''' +name: + description: BE name + returned: always + type: string + sample: pre-upgrade +snapshot: + description: ZFS snapshot to create BE from + returned: always + type: string + sample: rpool/ROOT/oi-hipster@fresh +description: + description: BE description + returned: always + type: string + sample: Upgrade from 9.0 to 10.0 +options: + description: BE additional options + returned: always + type: string + sample: compression=on +mountpoint: + description: BE mountpoint + returned: always + type: string + sample: /mnt/be +state: + description: state of the target + returned: always + type: string + sample: present +force: + description: if forced action is wanted + returned: always + type: boolean + sample: False +''' + +import os +from ansible.module_utils.basic import AnsibleModule + + +class BE(object): + def __init__(self, module): + self.module = module + + self.name = module.params['name'] + self.snapshot = module.params['snapshot'] + self.description = module.params['description'] + self.options = module.params['options'] + self.mountpoint = module.params['mountpoint'] + self.state = module.params['state'] + self.force = module.params['force'] + + self.is_freebsd = os.uname()[0] == 'FreeBSD' + + def _beadm_list(self): + cmd = [self.module.get_bin_path('beadm')] + cmd.append('list') + cmd.append('-H') + + if not self.is_freebsd: + cmd.append(self.name) + + return self.module.run_command(cmd) + + def _find_be_by_name(self, out): + for line in out.splitlines(): + if line.split('\t')[0] == self.name: + return line + + return None + + def exists(self): + (rc, out, _) = self._beadm_list() + + if rc == 0: + if self.is_freebsd: + if self._find_be_by_name(out): + return True + else: + return True + else: + return False + + def is_activated(self): + (rc, out, _) = self._beadm_list() + + if rc == 0: + if self.is_freebsd: + line = self._find_be_by_name(out) + if line is not None and 'R' in line.split('\t')[1]: + return True + else: + if 'R' in out.split(';')[2]: + return True + + return False + + def activate_be(self): + cmd = [self.module.get_bin_path('beadm')] + + cmd.append('activate') + cmd.append(self.name) + + return self.module.run_command(cmd) + + def create_be(self): + cmd = [self.module.get_bin_path('beadm')] + + cmd.append('create') + + if self.snapshot: + cmd.append('-e') + cmd.append(self.snapshot) + + if not self.is_freebsd: + if self.description: + cmd.append('-d') + cmd.append(self.description) + + if self.options: + cmd.append('-o') + cmd.append(self.options) + + cmd.append(self.name) + + return self.module.run_command(cmd) + + def destroy_be(self): + cmd = [self.module.get_bin_path('beadm')] + + cmd.append('destroy') + cmd.append('-F') + cmd.append(self.name) + + return self.module.run_command(cmd) + + def is_mounted(self): + (rc, out, _) = self._beadm_list() + + if rc == 0: + if self.is_freebsd: + line = self._find_be_by_name(out) + # On FreeBSD, we exclude currently mounted BE on /, as it is + # special and can be activated even if it is mounted. That is not + # possible with non-root BEs. + if line.split('\t')[2] is not '-' and \ + line.split('\t')[2] is not '/': + return True + else: + if out.split(';')[3]: + return True + + return False + + def mount_be(self): + cmd = [self.module.get_bin_path('beadm')] + + cmd.append('mount') + cmd.append(self.name) + + if self.mountpoint: + cmd.append(self.mountpoint) + + return self.module.run_command(cmd) + + def unmount_be(self): + cmd = [self.module.get_bin_path('beadm')] + + cmd.append('unmount') + if self.force: + cmd.append('-f') + cmd.append(self.name) + + return self.module.run_command(cmd) + + +def main(): + module = AnsibleModule( + argument_spec=dict( + name=dict(required=True, aliases=['be'], type='str'), + snapshot=dict(type='str'), + description=dict(type='str'), + options=dict(type='str'), + mountpoint=dict(default=False, type='path'), + state=dict( + default='present', + choices=['present', 'absent', 'activated', + 'mounted', 'unmounted']), + force=dict(default=False, type='bool'), + ), + supports_check_mode=True + ) + + be = BE(module) + + rc = None + out = '' + err = '' + result = {} + result['name'] = be.name + result['state'] = be.state + + if be.snapshot: + result['snapshot'] = be.snapshot + + if be.description: + result['description'] = be.description + + if be.options: + result['options'] = be.options + + if be.mountpoint: + result['mountpoint'] = be.mountpoint + + if be.state == 'absent': + # beadm on FreeBSD and Solarish systems differs in delete behaviour in + # that we are not allowed to delete activated BE on FreeBSD while on + # Solarish systems we cannot delete BE if it is mounted. We add mount + # check for both platforms as BE should be explicitly unmounted before + # being deleted. On FreeBSD, we also check if the BE is activated. + if be.exists(): + if not be.is_mounted(): + if module.check_mode: + module.exit_json(changed=True) + + if be.is_freebsd: + if be.is_activated(): + module.fail_json(msg='Unable to remove active BE!') + + (rc, out, err) = be.destroy_be() + + if rc != 0: + module.fail_json(msg='Error while destroying BE: "%s"' % err, + name=be.name, + stderr=err, + rc=rc) + else: + module.fail_json(msg='Unable to remove BE as it is mounted!') + + elif be.state == 'present': + if not be.exists(): + if module.check_mode: + module.exit_json(changed=True) + + (rc, out, err) = be.create_be() + + if rc != 0: + module.fail_json(msg='Error while creating BE: "%s"' % err, + name=be.name, + stderr=err, + rc=rc) + + elif be.state == 'activated': + if not be.is_activated(): + if module.check_mode: + module.exit_json(changed=True) + + # On FreeBSD, beadm is unable to activate mounted BEs, so we add + # an explicit check for that case. + if be.is_freebsd: + if be.is_mounted(): + module.fail_json(msg='Unable to activate mounted BE!') + + (rc, out, err) = be.activate_be() + + if rc != 0: + module.fail_json(msg='Error while activating BE: "%s"' % err, + name=be.name, + stderr=err, + rc=rc) + elif be.state == 'mounted': + if not be.is_mounted(): + if module.check_mode: + module.exit_json(changed=True) + + (rc, out, err) = be.mount_be() + + if rc != 0: + module.fail_json(msg='Error while mounting BE: "%s"' % err, + name=be.name, + stderr=err, + rc=rc) + + elif be.state == 'unmounted': + if be.is_mounted(): + if module.check_mode: + module.exit_json(changed=True) + + (rc, out, err) = be.unmount_be() + + if rc != 0: + module.fail_json(msg='Error while unmounting BE: "%s"' % err, + name=be.name, + stderr=err, + rc=rc) + + if rc is None: + result['changed'] = False + else: + result['changed'] = True + + if out: + result['stdout'] = out + if err: + result['stderr'] = err + + module.exit_json(**result) + + +if __name__ == '__main__': + main()