From 0618db904dadb05fde70c181a5940989ac127fe2 Mon Sep 17 00:00:00 2001

From: Irit Goihman <igoihman@redhat.com>

Date: Thu, 1 Feb 2018 16:44:32 +0200

Subject: [PATCH] [plugins] add vdsm plugin

Add a plugin for vdsm

Resolves: #1205

Signed-off-by: Irit Goihman <igoihman@redhat.com>

Signed-off-by: Bryn M. Reeves <bmr@redhat.com>

---

 sos/plugins/vdsm.py | 146 ++++++++++++++++++++++++++++++++++++++++++++

 1 file changed, 146 insertions(+)

 create mode 100644 sos/plugins/vdsm.py

diff --git a/sos/plugins/vdsm.py b/sos/plugins/vdsm.py

new file mode 100644

index 00000000..c648abbf

--- /dev/null

+++ b/sos/plugins/vdsm.py

@@ -0,0 +1,146 @@

+# Copyright (C) 2018 Red Hat, Inc.

+

+# This file is part of the sos project: https://github.com/sosreport/sos

+#

+# This copyrighted material is made available to anyone wishing to use,

+# modify, copy, or redistribute it subject to the terms and conditions of

+# version 2 of the GNU General Public License.

+#

+# See the LICENSE file in the source distribution for further information.

+

+from sos.plugins import Plugin, RedHatPlugin

+

+import glob

+import json

+import re

+

+

+# This configuration is based on vdsm.storage.lvm.LVM_CONF_TEMPLATE.

+#

+# locking_type is set to 0 in order to match lvm sos commands. With this

+# configuration we don't take any locks, so we will never block because

+# there is a stuck lvm command.

+# locking_type=0

+#

+# use_lvmetad is set to 0 in order not to show cached, old lvm metadata.

+# use_lvmetad=0

+#

+# preferred_names and filter config values are set to capture Vdsm devices.

+# preferred_names=[ '^/dev/mapper/' ]

+# filter=[ 'a|^/dev/mapper/.*|', 'r|.*|' ]

+LVM_CONFIG = """

+global {

+    locking_type=0

+    use_lvmetad=0

+}

+devices {

+    preferred_names=["^/dev/mapper/"]

+    ignore_suspended_devices=1

+    write_cache_state=0

+    disable_after_error_count=3

+    filter=["a|^/dev/mapper/.*|", "r|.*|"]

+}

+"""

+LVM_CONFIG = re.sub(r"\s+", " ", LVM_CONFIG).strip()

+

+

+class Vdsm(Plugin, RedHatPlugin):

+    """vdsm Plugin"""

+

+    packages = (

+        'vdsm',

+        'vdsm-client',

+    )

+

+    plugin_name = 'vdsm'

+

+    def setup(self):

+        self.add_forbidden_path('/etc/pki/vdsm/keys/*')

+        self.add_forbidden_path('/etc/pki/vdsm/libvirt-spice/*-key.*')

+        self.add_forbidden_path('/etc/pki/libvirt/private/*')

+

+        self.add_cmd_output('service vdsmd status')

+

+        self.add_copy_spec([

+            '/tmp/vds_installer*',

+            '/tmp/vds_bootstrap*',

+            '/etc/vdsm/*'

+        ])

+

+        limit = self.get_option('log_size')

+

+        self.add_copy_spec('/var/log/vdsm/*', sizelimit=limit)

+

+        self._add_vdsm_forbidden_paths()

+        self.add_copy_spec([

+            '/var/run/vdsm/*',

+            '/usr/libexec/vdsm/hooks',

+            '/var/lib/vdsm'

+        ])

+

+        qemu_pids = self.get_process_pids('qemu-kvm')

+        if qemu_pids:

+            files = ["cmdline", "status", "mountstats"]

+            self.add_copy_spec([

+                "/proc/%s/%s" % (pid, name)

+                for pid in qemu_pids

+                for name in files

+            ])

+        self.add_cmd_output([

+            "ls -ldZ /etc/vdsm",

+            "su vdsm -s sh -c 'tree -l /rhev/data-center'",

+            "su vdsm -s sh -c 'ls -lR /rhev/data-center'"

+        ])

+        self.add_cmd_output([

+            "lvm vgs -v -o +tags --config \'%s\'" % LVM_CONFIG,

+            "lvm lvs -v -o +tags --config \'%s\'" % LVM_CONFIG,

+            "lvm pvs -v -o +all --config \'%s\'" % LVM_CONFIG

+        ])

+

+        self.add_cmd_output([

+            'vdsm-client Host getCapabilities',

+            'vdsm-client Host getStats',

+            'vdsm-client Host getAllVmStats',

+            'vdsm-client Host getVMFullList',

+            'vdsm-client Host getDeviceList',

+            'vdsm-client Host hostdevListByCaps',

+            'vdsm-client Host getAllTasksInfo',

+            'vdsm-client Host getAllTasksStatuses'

+        ])

+

+        try:

+            res = self.call_ext_prog(

+                'vdsm-client Host getConnectedStoragePools'

+            )

+            if res['status'] == 0:

+                pools = json.loads(res['output'])

+                for pool in pools:

+                    self.add_cmd_output(

+                        'vdsm-client StoragePool getSpmStatus'

+                        ' storagepoolID={}'.format(pool)

+                    )

+        except ValueError as e:

+            self._log_error(

+                'vdsm-client Host getConnectedStoragePools: %s' % (e)

+            )

+

+        try:

+            res = self.call_ext_prog('vdsm-client Host getStorageDomains')

+            if res['status'] == 0:

+                sd_uuids = json.loads(res['output'])

+                dump_volume_chains_cmd = 'vdsm-tool dump-volume-chains %s'

+                self.add_cmd_output([

+                    dump_volume_chains_cmd % uuid for uuid in sd_uuids

+                ])

+        except ValueError as e:

+            self._log_error(

+                'vdsm-client Host getStorageDomains: %s' % (e)

+            )

+

+    def _add_vdsm_forbidden_paths(self):

+        """Add confidential sysprep vfds under /var/run/vdsm to

+         forbidden paths """

+

+        for file_path in glob.glob("/var/run/vdsm/*"):

+            if file_path.endswith(('.vfd', '/isoUploader', '/storage')):

+                self.add_forbidden_path(file_path)

-- 

2.17.2