diff options
author | Jake Hunsaker <jhunsake@redhat.com> | 2020-04-15 16:03:26 -0400 |
---|---|---|
committer | Jake Hunsaker <jhunsake@redhat.com> | 2020-04-30 11:18:25 -0400 |
commit | 6c334d558aff2dc911614490794eed506f9e522a (patch) | |
tree | e48ed31efdc57d1adc2ba65a8126a40c6d46b7a9 | |
parent | d9dd8ad790b6799491e4891ae19bb85124ab6794 (diff) | |
download | sos-6c334d558aff2dc911614490794eed506f9e522a.tar.gz |
[plugins] Convert docstrings to class attrs
Converts all current plugin docstrings into a `short_desc` attribute,
that is now referenced by `Plugin.get_description()`.
Closes: #1960
Resolves: #2036
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
298 files changed, 590 insertions, 578 deletions
diff --git a/sos/report/plugins/__init__.py b/sos/report/plugins/__init__.py index a7fa9de5..011113b0 100644 --- a/sos/report/plugins/__init__.py +++ b/sos/report/plugins/__init__.py @@ -1709,9 +1709,7 @@ class Plugin(object): def get_description(self): """ This function will return the description for the plugin""" try: - if hasattr(self, '__doc__') and self.__doc__: - return self.__doc__.strip() - return super(self.__class__, self).__doc__.strip() + return self.short_desc except Exception: return "<no description available>" diff --git a/sos/report/plugins/abrt.py b/sos/report/plugins/abrt.py index 97b63618..d633a7cc 100644 --- a/sos/report/plugins/abrt.py +++ b/sos/report/plugins/abrt.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Abrt(Plugin, RedHatPlugin): - """Automatic Bug Reporting Tool - """ + + short_desc = 'Automatic Bug Reporting Tool' plugin_name = "abrt" profiles = ('system', 'debug') diff --git a/sos/report/plugins/acpid.py b/sos/report/plugins/acpid.py index 6cea883c..8bf710fe 100644 --- a/sos/report/plugins/acpid.py +++ b/sos/report/plugins/acpid.py @@ -10,7 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Acpid(Plugin): - """ACPI daemon information""" + + short_desc = 'ACPI daemon information' plugin_name = "acpid" profiles = ('hardware',) packages = ('acpid',) diff --git a/sos/report/plugins/activemq.py b/sos/report/plugins/activemq.py index c9b364b1..de8dcef6 100644 --- a/sos/report/plugins/activemq.py +++ b/sos/report/plugins/activemq.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class ActiveMq(Plugin, DebianPlugin): - """ActiveMQ message broker - """ + + short_desc = 'ActiveMQ message broker' plugin_name = 'activemq' profiles = ('openshift',) diff --git a/sos/report/plugins/alternatives.py b/sos/report/plugins/alternatives.py index 0d8b9a16..a903f97a 100644 --- a/sos/report/plugins/alternatives.py +++ b/sos/report/plugins/alternatives.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Alternatives(Plugin, RedHatPlugin): - """System alternatives - """ + + short_desc = 'System alternatives' packages = ('chkconfig',) commands = ('alternatives',) diff --git a/sos/report/plugins/anaconda.py b/sos/report/plugins/anaconda.py index 8a5f78b4..eb36b3e2 100644 --- a/sos/report/plugins/anaconda.py +++ b/sos/report/plugins/anaconda.py @@ -11,8 +11,8 @@ import os class Anaconda(Plugin, RedHatPlugin): - """Anaconda installer - """ + + short_desc = 'Anaconda installer' plugin_name = 'anaconda' profiles = ('system',) diff --git a/sos/report/plugins/anacron.py b/sos/report/plugins/anacron.py index 69ceec4a..dbd82ed1 100644 --- a/sos/report/plugins/anacron.py +++ b/sos/report/plugins/anacron.py @@ -10,7 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Anacron(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Anacron job scheduling service""" + + short_desc = 'Anacron job scheduling service' plugin_name = 'anacron' profiles = ('system',) diff --git a/sos/report/plugins/ansible.py b/sos/report/plugins/ansible.py index f0d1b114..3e5d3d37 100644 --- a/sos/report/plugins/ansible.py +++ b/sos/report/plugins/ansible.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin class Ansible(Plugin, RedHatPlugin, UbuntuPlugin): - """Ansible configuration management - """ + + short_desc = 'Ansible configuration management' plugin_name = 'ansible' profiles = ('system',) diff --git a/sos/report/plugins/apache.py b/sos/report/plugins/apache.py index 528f1152..b1b366b5 100644 --- a/sos/report/plugins/apache.py +++ b/sos/report/plugins/apache.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Apache(Plugin): - """Apache http daemon - """ + + short_desc = 'Apache http daemon' plugin_name = "apache" profiles = ('webserver', 'openshift') packages = ('httpd',) diff --git a/sos/report/plugins/apparmor.py b/sos/report/plugins/apparmor.py index b3e08f60..5c2ad6fe 100644 --- a/sos/report/plugins/apparmor.py +++ b/sos/report/plugins/apparmor.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, UbuntuPlugin class Apparmor(Plugin, UbuntuPlugin): - """Apparmor mandatory access control - """ + + short_desc = 'Apparmor mandatory access control' plugin_name = 'apparmor' profiles = ('security',) diff --git a/sos/report/plugins/apport.py b/sos/report/plugins/apport.py index 1c8a6676..53f805ad 100644 --- a/sos/report/plugins/apport.py +++ b/sos/report/plugins/apport.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, DebianPlugin, UbuntuPlugin class Apport(Plugin, DebianPlugin, UbuntuPlugin): - """Apport crash reporting tool - """ + + short_desc = 'Apport crash reporting tool' plugin_name = 'apport' profiles = ('debug',) diff --git a/sos/report/plugins/apt.py b/sos/report/plugins/apt.py index c94740b3..e3006834 100644 --- a/sos/report/plugins/apt.py +++ b/sos/report/plugins/apt.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, UbuntuPlugin, DebianPlugin class Apt(Plugin, DebianPlugin, UbuntuPlugin): - """ APT - advanced packaging tool - """ + + short_desc = 'APT - advanced packaging tool' plugin_name = 'apt' profiles = ('system', 'sysmgmt', 'packagemanager') diff --git a/sos/report/plugins/ata.py b/sos/report/plugins/ata.py index e8ee226f..e3df640f 100644 --- a/sos/report/plugins/ata.py +++ b/sos/report/plugins/ata.py @@ -11,8 +11,8 @@ import os class Ata(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """ ATA and IDE information - """ + + short_desc = 'ATA and IDE information' plugin_name = "ata" profiles = ('storage', 'hardware') diff --git a/sos/report/plugins/atomichost.py b/sos/report/plugins/atomichost.py index 90db7ad8..8308358c 100644 --- a/sos/report/plugins/atomichost.py +++ b/sos/report/plugins/atomichost.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class AtomicHost(Plugin, RedHatPlugin): - """ Atomic Host """ + + short_desc = 'Atomic Host' plugin_name = "atomichost" profiles = ('container',) diff --git a/sos/report/plugins/auditd.py b/sos/report/plugins/auditd.py index fd587e24..f9105b5b 100644 --- a/sos/report/plugins/auditd.py +++ b/sos/report/plugins/auditd.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Auditd(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Audit daemon information - """ + + short_desc = 'Audit daemon information' plugin_name = 'auditd' profiles = ('system', 'security') diff --git a/sos/report/plugins/autofs.py b/sos/report/plugins/autofs.py index 15835fc1..9ece75d3 100644 --- a/sos/report/plugins/autofs.py +++ b/sos/report/plugins/autofs.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Autofs(Plugin): - """Autofs on-demand automounter - """ + + short_desc = 'Autofs on-demand automounter' plugin_name = "autofs" profiles = ('storage', 'nfs') diff --git a/sos/report/plugins/azure.py b/sos/report/plugins/azure.py index abdea2fa..0536a9f7 100644 --- a/sos/report/plugins/azure.py +++ b/sos/report/plugins/azure.py @@ -13,8 +13,8 @@ from sos.report.plugins import Plugin, UbuntuPlugin, RedHatPlugin class Azure(Plugin, UbuntuPlugin): - """ Microsoft Azure client - """ + + short_desc = 'Microsoft Azure client' plugin_name = 'azure' profiles = ('virt',) diff --git a/sos/report/plugins/block.py b/sos/report/plugins/block.py index 6d4bde38..2af25e7a 100644 --- a/sos/report/plugins/block.py +++ b/sos/report/plugins/block.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Block(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Block device information - """ + + short_desc = 'Block device information' plugin_name = 'block' profiles = ('storage', 'hardware') diff --git a/sos/report/plugins/boom.py b/sos/report/plugins/boom.py index 83d30621..a872d1b5 100644 --- a/sos/report/plugins/boom.py +++ b/sos/report/plugins/boom.py @@ -11,8 +11,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Boom(Plugin, RedHatPlugin): - """Configuration data for the boom boot manager. - """ + + short_desc = 'Configuration data for the boom boot manager.' plugin_name = 'boom' profiles = ('boot', 'system') diff --git a/sos/report/plugins/boot.py b/sos/report/plugins/boot.py index 78e1eabf..9cc46ea7 100644 --- a/sos/report/plugins/boot.py +++ b/sos/report/plugins/boot.py @@ -11,8 +11,8 @@ from glob import glob class Boot(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Bootloader information - """ + + short_desc = 'Bootloader information' plugin_name = 'boot' profiles = ('system', 'boot') diff --git a/sos/report/plugins/btrfs.py b/sos/report/plugins/btrfs.py index e09b22eb..953e9498 100644 --- a/sos/report/plugins/btrfs.py +++ b/sos/report/plugins/btrfs.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Btrfs(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """Btrfs filesystem - """ + + short_desc = 'Btrfs filesystem' plugin_name = 'btrfs' profiles = ('storage',) diff --git a/sos/report/plugins/buildah.py b/sos/report/plugins/buildah.py index 5307f181..9d237a53 100644 --- a/sos/report/plugins/buildah.py +++ b/sos/report/plugins/buildah.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Buildah(Plugin, RedHatPlugin): - """Buildah container and image builder - """ + + short_desc = 'Buildah container and image builder' plugin_name = 'buildah' packages = ('buildah',) diff --git a/sos/report/plugins/candlepin.py b/sos/report/plugins/candlepin.py index e0f06eca..d90b6fe2 100644 --- a/sos/report/plugins/candlepin.py +++ b/sos/report/plugins/candlepin.py @@ -14,7 +14,8 @@ from re import match class Candlepin(Plugin, RedHatPlugin): - """Candlepin entitlement management""" + + short_desc = 'Candlepin entitlement management' plugin_name = 'candlepin' packages = ('candlepin',) diff --git a/sos/report/plugins/canonical_livepatch.py b/sos/report/plugins/canonical_livepatch.py index 92d34ea1..1088c2f3 100644 --- a/sos/report/plugins/canonical_livepatch.py +++ b/sos/report/plugins/canonical_livepatch.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, UbuntuPlugin class CanonicaLivepatch(Plugin, UbuntuPlugin): - """Canonical Livepatch Service - """ + + short_desc = 'Canonical Livepatch Service' plugin_name = 'canonical_livepatch' profiles = ('system', 'kernel') diff --git a/sos/report/plugins/ceph.py b/sos/report/plugins/ceph.py index 783722ec..a06bdc63 100644 --- a/sos/report/plugins/ceph.py +++ b/sos/report/plugins/ceph.py @@ -11,8 +11,8 @@ from socket import gethostname class Ceph(Plugin, RedHatPlugin, UbuntuPlugin): - """CEPH distributed storage - """ + + short_desc = 'CEPH distributed storage' plugin_name = 'ceph' profiles = ('storage', 'virt') diff --git a/sos/report/plugins/ceph_ansible.py b/sos/report/plugins/ceph_ansible.py index 357b954b..a84c9c62 100644 --- a/sos/report/plugins/ceph_ansible.py +++ b/sos/report/plugins/ceph_ansible.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin class CephAnsible(Plugin, RedHatPlugin, DebianPlugin): - """CEPH distributed storage - Ansible installer - """ + + short_desc = 'CEPH distributed storage - Ansible installer' plugin_name = 'ceph_ansible' profiles = ('storage',) diff --git a/sos/report/plugins/cgroups.py b/sos/report/plugins/cgroups.py index a8710ee8..ea4000b8 100644 --- a/sos/report/plugins/cgroups.py +++ b/sos/report/plugins/cgroups.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Cgroups(Plugin, DebianPlugin, UbuntuPlugin): - """Control groups subsystem - """ + + short_desc = 'Control groups subsystem' plugin_name = "cgroups" profiles = ('container', 'system') diff --git a/sos/report/plugins/chrony.py b/sos/report/plugins/chrony.py index 1921ec20..c0703972 100644 --- a/sos/report/plugins/chrony.py +++ b/sos/report/plugins/chrony.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Chrony(Plugin): - """Chrony clock (for Network time protocol) - """ + + short_desc = 'Chrony clock (for Network time protocol)' plugin_name = "chrony" profiles = ('system', 'services') diff --git a/sos/report/plugins/cifs.py b/sos/report/plugins/cifs.py index 667b0764..37667a54 100644 --- a/sos/report/plugins/cifs.py +++ b/sos/report/plugins/cifs.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Cifs(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """SMB file system information - """ + + short_desc = 'SMB file system information' plugin_name = 'cifs' profiles = ('storage', 'network', 'cifs') packages = ['cifs-utils'] diff --git a/sos/report/plugins/clear_containers.py b/sos/report/plugins/clear_containers.py index b3e9fb20..db641c35 100644 --- a/sos/report/plugins/clear_containers.py +++ b/sos/report/plugins/clear_containers.py @@ -14,8 +14,8 @@ from sos.report.plugins import (Plugin, RedHatPlugin, DebianPlugin, class ClearContainers(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin, SuSEPlugin): - """Intel(R) Clear Containers configuration - """ + + short_desc = 'Intel(R) Clear Containers configuration' plugin_name = 'clear_containers' profiles = ('system', 'virt', 'container') diff --git a/sos/report/plugins/cloud_init.py b/sos/report/plugins/cloud_init.py index 96a1e6aa..7a4a8af0 100644 --- a/sos/report/plugins/cloud_init.py +++ b/sos/report/plugins/cloud_init.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class CloudInit(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """cloud-init instance configurations - """ + + short_desc = 'cloud-init instance configurations' plugin_name = 'cloud_init' packages = ('cloud-init',) diff --git a/sos/report/plugins/cman.py b/sos/report/plugins/cman.py index a2eae720..268f14c5 100644 --- a/sos/report/plugins/cman.py +++ b/sos/report/plugins/cman.py @@ -11,8 +11,8 @@ from glob import glob class Cman(Plugin, RedHatPlugin): - """cman based Red Hat Cluster High Availability - """ + + short_desc = 'cman based Red Hat Cluster High Availability' plugin_name = "cman" profiles = ("cluster",) diff --git a/sos/report/plugins/cobbler.py b/sos/report/plugins/cobbler.py index 52e514af..471abec0 100644 --- a/sos/report/plugins/cobbler.py +++ b/sos/report/plugins/cobbler.py @@ -14,8 +14,8 @@ class Cobbler(Plugin): class RedHatCobbler(Cobbler, RedHatPlugin): - """Cobbler installation server - """ + + short_desc = 'Cobbler installation server' packages = ('cobbler',) profiles = ('cluster', 'sysmgmt') diff --git a/sos/report/plugins/cockpit.py b/sos/report/plugins/cockpit.py index 067bb4b9..509eefa2 100644 --- a/sos/report/plugins/cockpit.py +++ b/sos/report/plugins/cockpit.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Cockpit(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Cockpit Web Service""" + + short_desc = 'Cockpit Web Service' plugin_name = 'cockpit' packages = ('cockpit-ws', 'cockpit-system') diff --git a/sos/report/plugins/collectd.py b/sos/report/plugins/collectd.py index 48083512..36802019 100644 --- a/sos/report/plugins/collectd.py +++ b/sos/report/plugins/collectd.py @@ -12,9 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Collectd(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """ - Collectd config collector - """ + + short_desc = 'Collectd config collector' plugin_name = "collectd" profiles = ('services', 'webserver') diff --git a/sos/report/plugins/composer.py b/sos/report/plugins/composer.py index 36af13c3..114ea675 100644 --- a/sos/report/plugins/composer.py +++ b/sos/report/plugins/composer.py @@ -2,8 +2,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Composer(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Lorax Composer - """ + + short_desc = 'Lorax Composer' plugin_name = 'composer' profiles = ('sysmgmt', 'virt', ) diff --git a/sos/report/plugins/conntrackd.py b/sos/report/plugins/conntrackd.py index d373c4ac..0244c9c6 100644 --- a/sos/report/plugins/conntrackd.py +++ b/sos/report/plugins/conntrackd.py @@ -12,8 +12,8 @@ from sos.report.plugins import (Plugin, RedHatPlugin, DebianPlugin, class Conntrackd(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin, SuSEPlugin): - """conntrackd - netfilter connection tracking user-space daemon - """ + + short_desc = 'conntrackd - netfilter connection tracking user-space daemon' plugin_name = 'conntrackd' profiles = ('network', 'cluster') diff --git a/sos/report/plugins/console.py b/sos/report/plugins/console.py index 596bddce..9717993b 100644 --- a/sos/report/plugins/console.py +++ b/sos/report/plugins/console.py @@ -11,8 +11,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin class Console(Plugin, RedHatPlugin, UbuntuPlugin): - """Console and keyboard information - """ + + short_desc = 'Console and keyboard information' plugin_name = 'console' profiles = ('system',) diff --git a/sos/report/plugins/container_log.py b/sos/report/plugins/container_log.py index 0d939f69..fa4645bf 100644 --- a/sos/report/plugins/container_log.py +++ b/sos/report/plugins/container_log.py @@ -13,8 +13,8 @@ import os class ContainerLog(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """All container logs - """ + + short_desc = 'All logs under /var/log/containers' plugin_name = 'container_log' logdir = '/var/log/containers/' files = (logdir, ) diff --git a/sos/report/plugins/convert2rhel.py b/sos/report/plugins/convert2rhel.py index 9c796a83..353b428b 100644 --- a/sos/report/plugins/convert2rhel.py +++ b/sos/report/plugins/convert2rhel.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class convert2rhel(Plugin, RedHatPlugin): - """Convert2RHEL - """ + + short_desc = 'Convert2RHEL' plugin_name = 'convert2rhel' profiles = ('system') packages = ('convert2rhel') diff --git a/sos/report/plugins/corosync.py b/sos/report/plugins/corosync.py index 665999c9..af0190fc 100644 --- a/sos/report/plugins/corosync.py +++ b/sos/report/plugins/corosync.py @@ -12,8 +12,8 @@ import re class Corosync(Plugin): - """ Corosync cluster engine - """ + + short_desc = 'Corosync cluster engine' plugin_name = "corosync" profiles = ('cluster',) diff --git a/sos/report/plugins/crio.py b/sos/report/plugins/crio.py index e2d064e5..dacc0745 100644 --- a/sos/report/plugins/crio.py +++ b/sos/report/plugins/crio.py @@ -13,9 +13,7 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, SoSPredicate class CRIO(Plugin, RedHatPlugin, UbuntuPlugin): - """CRI-O containers - """ - + short_desc = 'CRI-O containers' plugin_name = 'crio' profiles = ('container',) packages = ('cri-o', 'cri-tools') diff --git a/sos/report/plugins/cron.py b/sos/report/plugins/cron.py index 09076911..1db6e098 100644 --- a/sos/report/plugins/cron.py +++ b/sos/report/plugins/cron.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Cron(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Cron job scheduler - """ + + short_desc = 'Cron job scheduler' plugin_name = "cron" profiles = ('system',) diff --git a/sos/report/plugins/crypto.py b/sos/report/plugins/crypto.py index 06294b45..cfa57047 100644 --- a/sos/report/plugins/crypto.py +++ b/sos/report/plugins/crypto.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Crypto(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """ System crypto services information - """ + + short_desc = 'System crypto services information' plugin_name = 'crypto' profiles = ('system', 'hardware') diff --git a/sos/report/plugins/cs.py b/sos/report/plugins/cs.py index 2c9ff751..e133237f 100644 --- a/sos/report/plugins/cs.py +++ b/sos/report/plugins/cs.py @@ -16,8 +16,8 @@ from glob import glob class CertificateSystem(Plugin, RedHatPlugin): - """Certificate System and Dogtag - """ + + short_desc = 'Certificate System and Dogtag' plugin_name = 'cs' profiles = ('identity', 'security') diff --git a/sos/report/plugins/ctdb.py b/sos/report/plugins/ctdb.py index 5c4173fe..3def321e 100644 --- a/sos/report/plugins/ctdb.py +++ b/sos/report/plugins/ctdb.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Ctdb(Plugin, DebianPlugin, UbuntuPlugin): - """Samba Clustered TDB - """ + + short_desc = 'Samba Clustered TDB' packages = ('ctdb',) profiles = ('cluster', 'storage') plugin_name = "ctdb" diff --git a/sos/report/plugins/cups.py b/sos/report/plugins/cups.py index 39459e3b..8a4b6e27 100644 --- a/sos/report/plugins/cups.py +++ b/sos/report/plugins/cups.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Cups(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """CUPS IPP print service - """ + + short_desc = 'CUPS IPP print service' plugin_name = 'cups' profiles = ('hardware',) diff --git a/sos/report/plugins/date.py b/sos/report/plugins/date.py index 4bb89d72..e83e60cc 100644 --- a/sos/report/plugins/date.py +++ b/sos/report/plugins/date.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin class Date(Plugin, RedHatPlugin, DebianPlugin): - """Basic system time information - """ + + short_desc = 'Basic system time information' plugin_name = 'date' diff --git a/sos/report/plugins/dbus.py b/sos/report/plugins/dbus.py index ff0dd4a3..37b2466e 100644 --- a/sos/report/plugins/dbus.py +++ b/sos/report/plugins/dbus.py @@ -10,7 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Dbus(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """D-Bus message bus""" + + short_desc = 'D-Bus message bus' plugin_name = "dbus" profiles = ('system',) diff --git a/sos/report/plugins/devicemapper.py b/sos/report/plugins/devicemapper.py index d54e969a..ecb9796f 100644 --- a/sos/report/plugins/devicemapper.py +++ b/sos/report/plugins/devicemapper.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class DeviceMapper(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """device-mapper framework - """ + + short_desc = 'device-mapper framework' plugin_name = 'devicemapper' profiles = ('storage',) diff --git a/sos/report/plugins/devices.py b/sos/report/plugins/devices.py index 2a4cf7c7..23f9b588 100644 --- a/sos/report/plugins/devices.py +++ b/sos/report/plugins/devices.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Devices(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """ devices specific commands - """ + + short_desc = 'devices specific commands' plugin_name = 'devices' profiles = ('system', 'hardware', 'boot') diff --git a/sos/report/plugins/dhcp.py b/sos/report/plugins/dhcp.py index 69992892..33906b12 100644 --- a/sos/report/plugins/dhcp.py +++ b/sos/report/plugins/dhcp.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin class Dhcp(Plugin): - """DHCP daemon - """ + + short_desc = 'DHCP daemon' plugin_name = "dhcp" profiles = ('network',) diff --git a/sos/report/plugins/distupgrade.py b/sos/report/plugins/distupgrade.py index 1ea7bd76..a2edb954 100644 --- a/sos/report/plugins/distupgrade.py +++ b/sos/report/plugins/distupgrade.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class DistUpgrade(Plugin): - """ Distribution upgrade data """ + + short_desc = 'Distribution upgrade data' plugin_name = "distupgrade" profiles = ('system', 'sysmgmt') diff --git a/sos/report/plugins/dlm.py b/sos/report/plugins/dlm.py index 6cc53a61..914cc55b 100644 --- a/sos/report/plugins/dlm.py +++ b/sos/report/plugins/dlm.py @@ -11,7 +11,8 @@ import re class Dlm(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """DLM (Distributed lock manager)""" + + short_desc = 'DLM (Distributed lock manager)' plugin_name = "dlm" profiles = ("cluster", ) diff --git a/sos/report/plugins/dmraid.py b/sos/report/plugins/dmraid.py index 20c647b7..67135f51 100644 --- a/sos/report/plugins/dmraid.py +++ b/sos/report/plugins/dmraid.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Dmraid(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """dmraid software RAID - """ + + short_desc = 'dmraid software RAID' plugin_name = 'dmraid' profiles = ('hardware', 'storage') diff --git a/sos/report/plugins/dnf.py b/sos/report/plugins/dnf.py index b980e792..33ee1325 100644 --- a/sos/report/plugins/dnf.py +++ b/sos/report/plugins/dnf.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class DNFPlugin(Plugin, RedHatPlugin): - """dnf package manager""" + + short_desc = 'dnf package manager' plugin_name = "dnf" profiles = ('system', 'packagemanager', 'sysmgmt') diff --git a/sos/report/plugins/docker.py b/sos/report/plugins/docker.py index ac56322b..ebebe31e 100644 --- a/sos/report/plugins/docker.py +++ b/sos/report/plugins/docker.py @@ -13,9 +13,7 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, SoSPredicate class Docker(Plugin): - """Docker containers - """ - + short_desc = 'Docker containers' plugin_name = 'docker' profiles = ('container',) diff --git a/sos/report/plugins/docker_distribution.py b/sos/report/plugins/docker_distribution.py index 17b6baa0..6f5c966c 100644 --- a/sos/report/plugins/docker_distribution.py +++ b/sos/report/plugins/docker_distribution.py @@ -13,8 +13,7 @@ import os class DockerDistribution(Plugin): - """Docker Distribution""" - + short_desc = 'Docker Distribution' plugin_name = "docker_distribution" profiles = ('container',) diff --git a/sos/report/plugins/dovecot.py b/sos/report/plugins/dovecot.py index feb2d6cb..334e787d 100644 --- a/sos/report/plugins/dovecot.py +++ b/sos/report/plugins/dovecot.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Dovecot(Plugin): - """Dovecot IMAP and POP3 - """ + + short_desc = 'Dovecot IMAP and POP3' plugin_name = "dovecot" profiles = ('mail',) @@ -22,8 +22,7 @@ class Dovecot(Plugin): class RedHatDovecot(Dovecot, RedHatPlugin): - """dovecot server related information - """ + def setup(self): super(RedHatDovecot, self).setup() @@ -32,8 +31,7 @@ class RedHatDovecot(Dovecot, RedHatPlugin): class DebianDovecot(Dovecot, DebianPlugin, UbuntuPlugin): - """dovecot server related information for Debian based distribution - """ + def setup(self): super(DebianDovecot, self).setup() diff --git a/sos/report/plugins/dpkg.py b/sos/report/plugins/dpkg.py index 473b2d12..107a430d 100644 --- a/sos/report/plugins/dpkg.py +++ b/sos/report/plugins/dpkg.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, DebianPlugin, UbuntuPlugin class Dpkg(Plugin, DebianPlugin, UbuntuPlugin): - """Debian Package Management - """ + + short_desc = 'Debian Package Management' plugin_name = 'dpkg' profiles = ('sysmgmt', 'packagemanager') diff --git a/sos/report/plugins/dracut.py b/sos/report/plugins/dracut.py index 7bf9d7fa..0630819d 100644 --- a/sos/report/plugins/dracut.py +++ b/sos/report/plugins/dracut.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Dracut(Plugin, RedHatPlugin): - """ Dracut initramfs generator """ + + short_desc = 'Dracut initramfs generator' plugin_name = "dracut" packages = ("dracut",) diff --git a/sos/report/plugins/ds.py b/sos/report/plugins/ds.py index 61e123b3..32ed2fc3 100644 --- a/sos/report/plugins/ds.py +++ b/sos/report/plugins/ds.py @@ -14,8 +14,8 @@ import os class DirectoryServer(Plugin, RedHatPlugin): - """Directory Server - """ + + short_desc = 'Directory Server' plugin_name = 'ds' profiles = ('identity',) diff --git a/sos/report/plugins/ebpf.py b/sos/report/plugins/ebpf.py index 003bc745..cf27ec8e 100644 --- a/sos/report/plugins/ebpf.py +++ b/sos/report/plugins/ebpf.py @@ -11,8 +11,8 @@ import json class Ebpf(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """eBPF tool - """ + + short_desc = 'eBPF tool' plugin_name = 'ebpf' profiles = ('system', 'kernel', 'network') diff --git a/sos/report/plugins/elastic.py b/sos/report/plugins/elastic.py index aecf37cf..9fe296ff 100644 --- a/sos/report/plugins/elastic.py +++ b/sos/report/plugins/elastic.py @@ -13,9 +13,8 @@ import re class Elastic(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """ - ElasticSearch service - """ + + short_desc = 'ElasticSearch service' plugin_name = 'elastic' profiles = ('services', ) diff --git a/sos/report/plugins/etcd.py b/sos/report/plugins/etcd.py index 986cd291..39d41963 100644 --- a/sos/report/plugins/etcd.py +++ b/sos/report/plugins/etcd.py @@ -14,8 +14,8 @@ from os import path class etcd(Plugin, RedHatPlugin): - """etcd plugin - """ + + short_desc = 'etcd plugin' plugin_name = 'etcd' packages = ('etcd',) diff --git a/sos/report/plugins/fcoe.py b/sos/report/plugins/fcoe.py index 4803d48a..6b6bbccf 100644 --- a/sos/report/plugins/fcoe.py +++ b/sos/report/plugins/fcoe.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class fcoe(Plugin, RedHatPlugin): - """Fibre Channel over Ethernet - """ + + short_desc = 'Fibre Channel over Ethernet' plugin_name = 'fcoe' profiles = ('storage', 'hardware') diff --git a/sos/report/plugins/fibrechannel.py b/sos/report/plugins/fibrechannel.py index a8f318a3..8635852d 100644 --- a/sos/report/plugins/fibrechannel.py +++ b/sos/report/plugins/fibrechannel.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Fibrechannel(Plugin, RedHatPlugin): - """Collects information on fibrechannel devices, if present""" + + short_desc = 'Collect information on fibrechannel devices' plugin_name = 'fibrechannel' profiles = ('hardware', 'storage', 'system') diff --git a/sos/report/plugins/filesys.py b/sos/report/plugins/filesys.py index 87f3f26b..398487bf 100644 --- a/sos/report/plugins/filesys.py +++ b/sos/report/plugins/filesys.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Filesys(Plugin, DebianPlugin, UbuntuPlugin): - """Local file systems - """ + + short_desc = 'Local file systems' plugin_name = 'filesys' profiles = ('storage',) diff --git a/sos/report/plugins/firewalld.py b/sos/report/plugins/firewalld.py index 60b4fb86..2ff39021 100644 --- a/sos/report/plugins/firewalld.py +++ b/sos/report/plugins/firewalld.py @@ -13,8 +13,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, SoSPredicate class FirewallD(Plugin, RedHatPlugin): - """Firewall daemon - """ + + short_desc = 'Firewall daemon' plugin_name = 'firewalld' profiles = ('network',) diff --git a/sos/report/plugins/foreman.py b/sos/report/plugins/foreman.py index a1a20b96..90c5be11 100644 --- a/sos/report/plugins/foreman.py +++ b/sos/report/plugins/foreman.py @@ -16,8 +16,8 @@ from re import match class Foreman(Plugin): - """Foreman/Satellite 6 systems management - """ + + short_desc = 'Foreman/Satellite 6 systems management' plugin_name = 'foreman' plugin_timeout = 1800 diff --git a/sos/report/plugins/freeipmi.py b/sos/report/plugins/freeipmi.py index 12cc0fb2..c54f270e 100644 --- a/sos/report/plugins/freeipmi.py +++ b/sos/report/plugins/freeipmi.py @@ -12,9 +12,8 @@ from sos.report.plugins import Plugin, UbuntuPlugin class Freeipmi(Plugin, UbuntuPlugin): - """Freeipmi hardware information. - """ + short_desc = 'Freeipmi hardware information' plugin_name = 'freeipmi' profiles = ('hardware', 'system', ) diff --git a/sos/report/plugins/frr.py b/sos/report/plugins/frr.py index 6da2cdfb..85ba6b39 100644 --- a/sos/report/plugins/frr.py +++ b/sos/report/plugins/frr.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Frr(Plugin, RedHatPlugin): - """Frr routing service - """ + + short_desc = 'Frr routing service' plugin_name = 'frr' profiles = ('network',) diff --git a/sos/report/plugins/fwupd.py b/sos/report/plugins/fwupd.py index 28a0c1f8..60908083 100644 --- a/sos/report/plugins/fwupd.py +++ b/sos/report/plugins/fwupd.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Fwupd(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """fwupd information - """ + + short_desc = 'fwupd information' plugin_name = 'fwupd' profiles = ('system', ) diff --git a/sos/report/plugins/gdm.py b/sos/report/plugins/gdm.py index ca882f88..dc23c010 100644 --- a/sos/report/plugins/gdm.py +++ b/sos/report/plugins/gdm.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Gdm(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """GNOME display manager - """ + + short_desc = 'GNOME display manager' plugin_name = 'gdm' profiles = ('desktop',) diff --git a/sos/report/plugins/gfs2.py b/sos/report/plugins/gfs2.py index cf5c219b..caa5aac1 100644 --- a/sos/report/plugins/gfs2.py +++ b/sos/report/plugins/gfs2.py @@ -10,7 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Gfs2(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """GFS2 (Global Filesystem 2)""" + + short_desc = 'GFS2 (Global Filesystem 2)' plugin_name = "gfs2" profiles = ("cluster", ) diff --git a/sos/report/plugins/gluster.py b/sos/report/plugins/gluster.py index 680b642a..eb236f1e 100644 --- a/sos/report/plugins/gluster.py +++ b/sos/report/plugins/gluster.py @@ -15,7 +15,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Gluster(Plugin, RedHatPlugin): - """GlusterFS storage""" + + short_desc = 'GlusterFS storage' plugin_name = 'gluster' profiles = ('storage', 'virt') diff --git a/sos/report/plugins/gluster_block.py b/sos/report/plugins/gluster_block.py index 5159c31c..0fa65a16 100644 --- a/sos/report/plugins/gluster_block.py +++ b/sos/report/plugins/gluster_block.py @@ -10,7 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class GlusterBlock(Plugin, RedHatPlugin): - """Gluster Block""" + + short_desc = 'Gluster Block' plugin_name = 'gluster_block' profiles = ('storage',) diff --git a/sos/report/plugins/gnocchi.py b/sos/report/plugins/gnocchi.py index d2e867c6..d2658066 100644 --- a/sos/report/plugins/gnocchi.py +++ b/sos/report/plugins/gnocchi.py @@ -14,7 +14,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Gnocchi(Plugin): - """Gnocchi - Metric as a service""" + + short_desc = 'Gnocchi - Metric as a service' plugin_name = "gnocchi" profiles = ('openstack', 'openstack_controller') diff --git a/sos/report/plugins/grafana.py b/sos/report/plugins/grafana.py index 81599062..0a637f3d 100644 --- a/sos/report/plugins/grafana.py +++ b/sos/report/plugins/grafana.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Grafana(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Fetch Grafana configuration, logs and CLI output - """ + + short_desc = 'Fetch Grafana configuration, logs and CLI output' plugin_name = "grafana" profiles = ('services', 'openstack', 'openstack_controller') diff --git a/sos/report/plugins/grub.py b/sos/report/plugins/grub.py index f3ff6156..2f6d77cf 100644 --- a/sos/report/plugins/grub.py +++ b/sos/report/plugins/grub.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Grub(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """GRUB bootloader - """ + + short_desc = 'GRUB bootloader' plugin_name = 'grub' profiles = ('boot',) diff --git a/sos/report/plugins/grub2.py b/sos/report/plugins/grub2.py index 5d085db3..5fecf3a2 100644 --- a/sos/report/plugins/grub2.py +++ b/sos/report/plugins/grub2.py @@ -11,8 +11,8 @@ from sos.report.plugins import (Plugin, RedHatPlugin, DebianPlugin, class Grub2(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """GRUB2 bootloader - """ + + short_desc = 'GRUB2 bootloader' plugin_name = 'grub2' profiles = ('boot',) diff --git a/sos/report/plugins/gssproxy.py b/sos/report/plugins/gssproxy.py index 13765ce7..56db229e 100644 --- a/sos/report/plugins/gssproxy.py +++ b/sos/report/plugins/gssproxy.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class GSSProxy(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """GSSAPI Proxy - """ + + short_desc = 'GSSAPI Proxy' plugin_name = "gssproxy" profiles = ('services', 'security', 'identity') diff --git a/sos/report/plugins/haproxy.py b/sos/report/plugins/haproxy.py index 6f01a173..0d02e991 100644 --- a/sos/report/plugins/haproxy.py +++ b/sos/report/plugins/haproxy.py @@ -18,8 +18,8 @@ except ImportError: class HAProxy(Plugin, RedHatPlugin, DebianPlugin): - """HAProxy load balancer - """ + + short_desc = 'HAProxy load balancer' plugin_name = 'haproxy' profiles = ('webserver',) diff --git a/sos/report/plugins/hardware.py b/sos/report/plugins/hardware.py index ecb23f88..b27cec31 100644 --- a/sos/report/plugins/hardware.py +++ b/sos/report/plugins/hardware.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Hardware(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """General hardware information - """ + + short_desc = 'General hardware information' plugin_name = "hardware" profiles = ('system', 'hardware') diff --git a/sos/report/plugins/host.py b/sos/report/plugins/host.py index 30d64c68..ecb94d72 100644 --- a/sos/report/plugins/host.py +++ b/sos/report/plugins/host.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin class Host(Plugin, RedHatPlugin, DebianPlugin): - """Host information - """ + + short_desc = 'Host information' plugin_name = 'host' profiles = ('system',) diff --git a/sos/report/plugins/hpasm.py b/sos/report/plugins/hpasm.py index b159137e..14f809ca 100644 --- a/sos/report/plugins/hpasm.py +++ b/sos/report/plugins/hpasm.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Hpasm(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """HP Advanced Server Management - """ + + short_desc = 'HP Advanced Server Management' plugin_name = 'hpasm' profiles = ('system', 'hardware') diff --git a/sos/report/plugins/hts.py b/sos/report/plugins/hts.py index 54a1ff95..4f3dca7c 100644 --- a/sos/report/plugins/hts.py +++ b/sos/report/plugins/hts.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class HardwareTestSuite(Plugin, RedHatPlugin): - """Red Hat Hardware Test Suite - """ + + short_desc = 'Red Hat Hardware Test Suite' plugin_name = 'hts' profiles = ('debug',) diff --git a/sos/report/plugins/i18n.py b/sos/report/plugins/i18n.py index e730ae71..6348f67c 100644 --- a/sos/report/plugins/i18n.py +++ b/sos/report/plugins/i18n.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class I18n(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Internationalization - """ + + short_desc = 'Internationalization' plugin_name = 'i18n' profiles = ('system',) diff --git a/sos/report/plugins/infiniband.py b/sos/report/plugins/infiniband.py index f18f64eb..83c32791 100644 --- a/sos/report/plugins/infiniband.py +++ b/sos/report/plugins/infiniband.py @@ -13,8 +13,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Infiniband(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Infiniband data - """ + + short_desc = 'Infiniband information' plugin_name = 'infiniband' profiles = ('hardware',) diff --git a/sos/report/plugins/insights.py b/sos/report/plugins/insights.py index 17b99980..75d521bc 100644 --- a/sos/report/plugins/insights.py +++ b/sos/report/plugins/insights.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class RedHatInsights(Plugin, RedHatPlugin): - """Collect config and log for Red Hat Insights - """ + + short_desc = 'Collect config and logs for Red Hat Insights' plugin_name = 'insights' packages = ['redhat-access-insights', 'insights-client'] profiles = ('system', 'sysmgmt') diff --git a/sos/report/plugins/ipa.py b/sos/report/plugins/ipa.py index 64f8572c..58ee9c1a 100644 --- a/sos/report/plugins/ipa.py +++ b/sos/report/plugins/ipa.py @@ -14,8 +14,8 @@ from os.path import exists class Ipa(Plugin, RedHatPlugin): - """ Identity, policy, audit - """ + + short_desc = 'Identity, policy, audit' plugin_name = 'ipa' profiles = ('identity', 'apache') diff --git a/sos/report/plugins/ipmitool.py b/sos/report/plugins/ipmitool.py index 4b68c47d..41e7ce77 100644 --- a/sos/report/plugins/ipmitool.py +++ b/sos/report/plugins/ipmitool.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin class IpmiTool(Plugin, RedHatPlugin, DebianPlugin): - """IpmiTool hardware information. - """ + + short_desc = 'IpmiTool hardware information' plugin_name = 'ipmitool' profiles = ('hardware', 'system', ) diff --git a/sos/report/plugins/iprconfig.py b/sos/report/plugins/iprconfig.py index 55cd6992..08503a78 100644 --- a/sos/report/plugins/iprconfig.py +++ b/sos/report/plugins/iprconfig.py @@ -13,8 +13,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class IprConfig(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """IBM Power RAID storage adapter configuration information - """ + + short_desc = 'IBM Power RAID storage adapter configuration information' plugin_name = 'iprconfig' packages = ('iprutils',) diff --git a/sos/report/plugins/ipvs.py b/sos/report/plugins/ipvs.py index 5c0f1c4a..743c8cde 100644 --- a/sos/report/plugins/ipvs.py +++ b/sos/report/plugins/ipvs.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, SoSPredicate class Ipvs(Plugin, RedHatPlugin, DebianPlugin): - """Linux IP virtual server - """ + + short_desc = 'Linux IP virtual server' plugin_name = 'ipvs' profiles = ('cluster', 'network') diff --git a/sos/report/plugins/iscsi.py b/sos/report/plugins/iscsi.py index 1c2a5c8e..74d2704d 100644 --- a/sos/report/plugins/iscsi.py +++ b/sos/report/plugins/iscsi.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Iscsi(Plugin): - """iSCSI initiator - """ + + short_desc = 'iSCSI initiator' plugin_name = "iscsi" profiles = ('storage',) diff --git a/sos/report/plugins/iscsitarget.py b/sos/report/plugins/iscsitarget.py index cbe0ed6b..6efe50bf 100644 --- a/sos/report/plugins/iscsitarget.py +++ b/sos/report/plugins/iscsitarget.py @@ -13,8 +13,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class IscsiTarget(Plugin): - """iSCSI target - """ + + short_desc = 'iSCSI target' plugin_name = "iscsitarget" profiles = ('storage',) diff --git a/sos/report/plugins/jars.py b/sos/report/plugins/jars.py index b463870e..51f79bc7 100644 --- a/sos/report/plugins/jars.py +++ b/sos/report/plugins/jars.py @@ -18,7 +18,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Jars(Plugin, RedHatPlugin): - """Collect information about available Java archives.""" + + short_desc = 'Collect information about available Java archives' plugin_name = "jars" version = "1.0.0" diff --git a/sos/report/plugins/java.py b/sos/report/plugins/java.py index d2191274..fcc58c99 100644 --- a/sos/report/plugins/java.py +++ b/sos/report/plugins/java.py @@ -10,7 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Java(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """Java runtime""" + + short_desc = 'Java runtime' plugin_name = "java" profiles = ('webserver', 'java') diff --git a/sos/report/plugins/juju.py b/sos/report/plugins/juju.py index feb0aecc..0db3ea10 100644 --- a/sos/report/plugins/juju.py +++ b/sos/report/plugins/juju.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, UbuntuPlugin class Juju(Plugin, UbuntuPlugin): - """ Juju orchestration tool - """ + + short_desc = 'Juju orchestration tool' plugin_name = 'juju' profiles = ('virt', 'sysmgmt') diff --git a/sos/report/plugins/kata_containers.py b/sos/report/plugins/kata_containers.py index 31d2bd61..f68990c7 100644 --- a/sos/report/plugins/kata_containers.py +++ b/sos/report/plugins/kata_containers.py @@ -12,8 +12,8 @@ from sos.report.plugins import (Plugin, RedHatPlugin, DebianPlugin, class KataContainers(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin, SuSEPlugin): - """Kata Containers configuration - """ + + short_desc = 'Kata Containers configuration' plugin_name = 'kata_containers' profiles = ('system', 'virt', 'container') diff --git a/sos/report/plugins/kdump.py b/sos/report/plugins/kdump.py index c5040da5..5fc25a9b 100644 --- a/sos/report/plugins/kdump.py +++ b/sos/report/plugins/kdump.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class KDump(Plugin): - """Kdump crash dumps - """ + + short_desc = 'Kdump crash dumps' plugin_name = "kdump" profiles = ('system', 'debug') diff --git a/sos/report/plugins/keepalived.py b/sos/report/plugins/keepalived.py index 589633f7..6eeb7d92 100644 --- a/sos/report/plugins/keepalived.py +++ b/sos/report/plugins/keepalived.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Keepalived(Plugin, RedHatPlugin): - """Keepalived routing server - """ + + short_desc = 'Keepalived routing server' plugin_name = 'keepalived' profiles = ('webserver', 'network', 'cluster') diff --git a/sos/report/plugins/kernel.py b/sos/report/plugins/kernel.py index 20317e0e..b6669053 100644 --- a/sos/report/plugins/kernel.py +++ b/sos/report/plugins/kernel.py @@ -12,8 +12,8 @@ import glob class Kernel(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Linux kernel - """ + + short_desc = 'Linux kernel' plugin_name = 'kernel' profiles = ('system', 'hardware', 'kernel') diff --git a/sos/report/plugins/kernelrt.py b/sos/report/plugins/kernelrt.py index f006d2a7..ee666978 100644 --- a/sos/report/plugins/kernelrt.py +++ b/sos/report/plugins/kernelrt.py @@ -13,8 +13,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class KernelRT(Plugin, RedHatPlugin): - """Realtime kernel variant - """ + + short_desc = 'Realtime kernel variant' plugin_name = 'kernelrt' profiles = ('system', 'hardware', 'kernel', 'mrg') diff --git a/sos/report/plugins/keyutils.py b/sos/report/plugins/keyutils.py index 53657fdb..2792778d 100644 --- a/sos/report/plugins/keyutils.py +++ b/sos/report/plugins/keyutils.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Keyutils(Plugin, RedHatPlugin): - """Kernel key ring - """ + + short_desc = 'Kernel key ring' plugin_name = 'keyutils' profiles = ('system', 'kernel', 'security', 'storage') diff --git a/sos/report/plugins/kimchi.py b/sos/report/plugins/kimchi.py index 7a63b047..4d30d459 100644 --- a/sos/report/plugins/kimchi.py +++ b/sos/report/plugins/kimchi.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Kimchi(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """kimchi-related information - """ + + short_desc = 'kimchi-related information' plugin_name = 'kimchi' packages = ('kimchi',) diff --git a/sos/report/plugins/kpatch.py b/sos/report/plugins/kpatch.py index 04d8521d..0c12991b 100644 --- a/sos/report/plugins/kpatch.py +++ b/sos/report/plugins/kpatch.py @@ -13,8 +13,8 @@ import re class Kpatch(Plugin, RedHatPlugin): - """Kpatch information - """ + + short_desc = 'Kpatch information' plugin_name = 'kpatch' diff --git a/sos/report/plugins/krb5.py b/sos/report/plugins/krb5.py index 140eb3e0..0b7cabf8 100644 --- a/sos/report/plugins/krb5.py +++ b/sos/report/plugins/krb5.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Krb5(Plugin): - """Kerberos authentication - """ + + short_desc = 'Kerberos authentication' plugin_name = 'krb5' profiles = ('identity', 'system') packages = ('krb5-libs', 'krb5-user') diff --git a/sos/report/plugins/kubernetes.py b/sos/report/plugins/kubernetes.py index 61bce333..3717c4c6 100644 --- a/sos/report/plugins/kubernetes.py +++ b/sos/report/plugins/kubernetes.py @@ -16,8 +16,8 @@ import re class Kubernetes(Plugin): - """Kubernetes plugin - """ + + short_desc = 'Kubernetes container orchestration platform' plugin_name = "kubernetes" profiles = ('container',) @@ -175,8 +175,6 @@ class Kubernetes(Plugin): class RedHatKubernetes(Kubernetes, RedHatPlugin): - """Red Hat Kubernetes plugin - """ # OpenShift Container Platform uses the atomic-openshift-master package # to provide kubernetes @@ -196,13 +194,9 @@ class RedHatKubernetes(Kubernetes, RedHatPlugin): class UbuntuKubernetes(Kubernetes, UbuntuPlugin): - """Ubuntu Kubernetes plugin - """ packages = ('kubernetes',) - files = ('/root/cdk/kubeproxyconfig',) - kube_cmd = "kubectl --kubeconfig=/root/cdk/kubeproxyconfig" # vim: et ts=5 sw=4 diff --git a/sos/report/plugins/kvm.py b/sos/report/plugins/kvm.py index e5b9ff4f..c1833e39 100644 --- a/sos/report/plugins/kvm.py +++ b/sos/report/plugins/kvm.py @@ -14,8 +14,8 @@ import os class Kvm(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Kernel virtual machine - """ + + short_desc = 'Kernel virtual machine' plugin_name = 'kvm' profiles = ('system', 'virt') diff --git a/sos/report/plugins/landscape.py b/sos/report/plugins/landscape.py index 3bb537e6..2b2b560b 100644 --- a/sos/report/plugins/landscape.py +++ b/sos/report/plugins/landscape.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, UbuntuPlugin class Landscape(Plugin, UbuntuPlugin): - """Ubuntu Landscape client - """ + + short_desc = 'Ubuntu Landscape client' plugin_name = 'landscape' profiles = ('sysmgmt',) diff --git a/sos/report/plugins/ldap.py b/sos/report/plugins/ldap.py index 2ec0240f..5ebfe6e0 100644 --- a/sos/report/plugins/ldap.py +++ b/sos/report/plugins/ldap.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Ldap(Plugin): - """LDAP configuration - """ + + short_desc = 'LDAP configuration' plugin_name = "ldap" profiles = ('identity', 'sysmgmt', 'system') diff --git a/sos/report/plugins/leapp.py b/sos/report/plugins/leapp.py index e27aa4c5..b367349f 100644 --- a/sos/report/plugins/leapp.py +++ b/sos/report/plugins/leapp.py @@ -12,9 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Leapp(Plugin, RedHatPlugin): - """ - Leapp upgrade handling tool - """ + + short_desc = 'Leapp upgrade handling tool' plugin_name = 'leapp' packages = ('leapp', 'leapp-repository') diff --git a/sos/report/plugins/libraries.py b/sos/report/plugins/libraries.py index 61c78668..21059464 100644 --- a/sos/report/plugins/libraries.py +++ b/sos/report/plugins/libraries.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin class Libraries(Plugin, RedHatPlugin, UbuntuPlugin): - """Dynamic shared libraries - """ + + short_desc = 'Dynamic shared libraries' plugin_name = 'libraries' profiles = ('system',) diff --git a/sos/report/plugins/libreswan.py b/sos/report/plugins/libreswan.py index 0cc9542c..312f7774 100644 --- a/sos/report/plugins/libreswan.py +++ b/sos/report/plugins/libreswan.py @@ -13,8 +13,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Libreswan(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Libreswan IPsec - """ + + short_desc = 'Libreswan IPsec' plugin_name = 'libreswan' profiles = ('network', 'security', 'openshift') diff --git a/sos/report/plugins/libvirt.py b/sos/report/plugins/libvirt.py index be0c3094..1854fd02 100644 --- a/sos/report/plugins/libvirt.py +++ b/sos/report/plugins/libvirt.py @@ -12,8 +12,8 @@ import os class Libvirt(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """libvirt virtualization API - """ + + short_desc = 'libvirt virtualization API' plugin_name = 'libvirt' profiles = ('system', 'virt') diff --git a/sos/report/plugins/lightdm.py b/sos/report/plugins/lightdm.py index 43818c0c..64d254c4 100644 --- a/sos/report/plugins/lightdm.py +++ b/sos/report/plugins/lightdm.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class LightDm(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Light Display Manager - """ + + short_desc = 'Light Display Manager' packages = ('lightdm', ) profiles = ('desktop', ) plugin_name = 'lightdm' diff --git a/sos/report/plugins/lilo.py b/sos/report/plugins/lilo.py index 4b8da846..5edc1d2d 100644 --- a/sos/report/plugins/lilo.py +++ b/sos/report/plugins/lilo.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin class Lilo(Plugin, RedHatPlugin, UbuntuPlugin): - """Lilo bootloader - """ + + short_desc = 'Lilo bootloader' plugin_name = 'lilo' profiles = ('system', 'boot') diff --git a/sos/report/plugins/login.py b/sos/report/plugins/login.py index 3299976a..595aac97 100644 --- a/sos/report/plugins/login.py +++ b/sos/report/plugins/login.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Login(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """login information - """ + + short_desc = 'login information' plugin_name = 'login' profiles = ('system', 'identity') diff --git a/sos/report/plugins/logrotate.py b/sos/report/plugins/logrotate.py index e8286b0c..53501dc1 100644 --- a/sos/report/plugins/logrotate.py +++ b/sos/report/plugins/logrotate.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class LogRotate(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """LogRotate service - """ + + short_desc = 'LogRotate service' plugin_name = 'logrotate' profiles = ('system',) diff --git a/sos/report/plugins/logs.py b/sos/report/plugins/logs.py index d6ec0e6b..138f316a 100644 --- a/sos/report/plugins/logs.py +++ b/sos/report/plugins/logs.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Logs(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """System logs""" + + short_desc = 'System logs' plugin_name = "logs" profiles = ('system', 'hardware', 'storage') diff --git a/sos/report/plugins/lstopo.py b/sos/report/plugins/lstopo.py index 4f6b6a11..75a8328a 100644 --- a/sos/report/plugins/lstopo.py +++ b/sos/report/plugins/lstopo.py @@ -11,8 +11,8 @@ from sos.utilities import is_executable class Lstopo(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """lstopo / machine topology/numa node information - """ + + short_desc = 'Machine topology information' plugin_name = "lstopo" profiles = ("system", "hardware") diff --git a/sos/report/plugins/lustre.py b/sos/report/plugins/lustre.py index 0bb58709..ad834b5f 100644 --- a/sos/report/plugins/lustre.py +++ b/sos/report/plugins/lustre.py @@ -10,7 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Lustre(Plugin, RedHatPlugin): - """Lustre filesystem""" + + short_desc = 'Lustre filesystem' plugin_name = 'lustre' profiles = ('storage', 'network', 'cluster', ) diff --git a/sos/report/plugins/lvm2.py b/sos/report/plugins/lvm2.py index e331e55b..175a919a 100644 --- a/sos/report/plugins/lvm2.py +++ b/sos/report/plugins/lvm2.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Lvm2(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """LVM2 volume manager - """ + + short_desc = 'Logical Volume Manager 2' plugin_name = 'lvm2' profiles = ('storage',) diff --git a/sos/report/plugins/lxd.py b/sos/report/plugins/lxd.py index 637fc166..dc87e534 100644 --- a/sos/report/plugins/lxd.py +++ b/sos/report/plugins/lxd.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, UbuntuPlugin class LXD(Plugin, UbuntuPlugin): - """LXD is a containers hypervisor. - """ + + short_desc = 'LXD container hypervisor' plugin_name = 'lxd' profiles = ('container',) packages = ('lxd',) diff --git a/sos/report/plugins/maas.py b/sos/report/plugins/maas.py index 0eb9a5f8..3cbe604f 100644 --- a/sos/report/plugins/maas.py +++ b/sos/report/plugins/maas.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, UbuntuPlugin class Maas(Plugin, UbuntuPlugin): - """Ubuntu Metal-As-A-Service - """ + + short_desc = 'Ubuntu Metal-As-A-Service' plugin_name = 'maas' profiles = ('sysmgmt',) diff --git a/sos/report/plugins/manageiq.py b/sos/report/plugins/manageiq.py index 7e877161..27ad6ef4 100644 --- a/sos/report/plugins/manageiq.py +++ b/sos/report/plugins/manageiq.py @@ -17,8 +17,8 @@ import os.path class ManageIQ(Plugin, RedHatPlugin): - """ManageIQ/CloudForms related information - """ + + short_desc = 'ManageIQ/CloudForms related information' plugin_name = 'manageiq' diff --git a/sos/report/plugins/md.py b/sos/report/plugins/md.py index e79e5ca1..299ba898 100644 --- a/sos/report/plugins/md.py +++ b/sos/report/plugins/md.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Md(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """MD RAID subsystem - """ + + short_desc = 'MD RAID subsystem' plugin_name = 'md' profiles = ('storage',) diff --git a/sos/report/plugins/megacli.py b/sos/report/plugins/megacli.py index f807f1c4..1bdd9fd7 100644 --- a/sos/report/plugins/megacli.py +++ b/sos/report/plugins/megacli.py @@ -13,8 +13,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class MegaCLI(Plugin, RedHatPlugin): - """LSI MegaRAID devices - """ + + short_desc = 'LSI MegaRAID devices' plugin_name = 'megacli' profiles = ('system', 'storage', 'hardware') diff --git a/sos/report/plugins/memcached.py b/sos/report/plugins/memcached.py index 364ce20c..360987c6 100644 --- a/sos/report/plugins/memcached.py +++ b/sos/report/plugins/memcached.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Memcached(Plugin): - """memcached distributed memory caching system""" + + short_desc = 'memcached distributed memory caching system' plugin_name = 'memcached' profiles = ('webserver',) diff --git a/sos/report/plugins/memory.py b/sos/report/plugins/memory.py index f32e8351..794aff08 100644 --- a/sos/report/plugins/memory.py +++ b/sos/report/plugins/memory.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Memory(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Memory configuration and use - """ + + short_desc = 'Memory configuration and use' plugin_name = 'memory' profiles = ('system', 'hardware', 'memory') diff --git a/sos/report/plugins/mongodb.py b/sos/report/plugins/mongodb.py index de5aa88d..7d0b6046 100644 --- a/sos/report/plugins/mongodb.py +++ b/sos/report/plugins/mongodb.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class MongoDb(Plugin, DebianPlugin, UbuntuPlugin): - """MongoDB document database - """ + + short_desc = 'MongoDB document database' plugin_name = 'mongodb' profiles = ('services',) diff --git a/sos/report/plugins/monit.py b/sos/report/plugins/monit.py index 69262975..70632679 100644 --- a/sos/report/plugins/monit.py +++ b/sos/report/plugins/monit.py @@ -14,8 +14,8 @@ from glob import glob class Monit(Plugin, RedHatPlugin): - """Monit monitoring daemon - """ + + short_desc = 'Monit monitoring daemon' packages = ('monit',) profiles = ('system',) plugin_name = 'monit' diff --git a/sos/report/plugins/mpt.py b/sos/report/plugins/mpt.py index 4687556a..756e249b 100644 --- a/sos/report/plugins/mpt.py +++ b/sos/report/plugins/mpt.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Mpt(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """ LSI Message Passing Technology - """ + + short_desc = 'LSI Message Passing Technology' files = ('/proc/mpt',) profiles = ('storage', ) plugin_name = 'mpt' diff --git a/sos/report/plugins/mssql.py b/sos/report/plugins/mssql.py index 865a9a94..cdfa8ab7 100644 --- a/sos/report/plugins/mssql.py +++ b/sos/report/plugins/mssql.py @@ -13,8 +13,8 @@ import os class MsSQL(Plugin, RedHatPlugin): - """Microsoft SQL Server on Linux - """ + + short_desc = 'Microsoft SQL Server on Linux' plugin_name = "mssql" profiles = ('services',) diff --git a/sos/report/plugins/multipath.py b/sos/report/plugins/multipath.py index fcaf337a..746be9ae 100644 --- a/sos/report/plugins/multipath.py +++ b/sos/report/plugins/multipath.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Multipath(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Device-mapper multipath tools - """ + + short_desc = 'Device-mapper multipath tools' plugin_name = 'multipath' profiles = ('system', 'storage', 'hardware') diff --git a/sos/report/plugins/mysql.py b/sos/report/plugins/mysql.py index 7a481dbe..6fc021e1 100644 --- a/sos/report/plugins/mysql.py +++ b/sos/report/plugins/mysql.py @@ -11,8 +11,8 @@ import os class Mysql(Plugin): - """MySQL and MariaDB RDBMS - """ + + short_desc = 'MySQL and MariaDB RDBMS' plugin_name = "mysql" profiles = ('services',) diff --git a/sos/report/plugins/named.py b/sos/report/plugins/named.py index ae0e5e9a..1f5ad3fb 100644 --- a/sos/report/plugins/named.py +++ b/sos/report/plugins/named.py @@ -11,8 +11,8 @@ from os.path import exists, join, normpath class Named(Plugin): - """BIND named server - """ + + short_desc = 'BIND named server' plugin_name = "named" profiles = ('system', 'services', 'network') diff --git a/sos/report/plugins/navicli.py b/sos/report/plugins/navicli.py index 5b6d766d..eb244890 100644 --- a/sos/report/plugins/navicli.py +++ b/sos/report/plugins/navicli.py @@ -14,8 +14,8 @@ from sos.utilities import is_executable class Navicli(Plugin, RedHatPlugin): - """ EMC Navicli - """ + + short_desc = 'EMC Navicli' plugin_name = 'navicli' profiles = ('storage', 'hardware') diff --git a/sos/report/plugins/networking.py b/sos/report/plugins/networking.py index 9681ba59..0948da75 100644 --- a/sos/report/plugins/networking.py +++ b/sos/report/plugins/networking.py @@ -13,8 +13,9 @@ from re import match class Networking(Plugin): - """network and device configuration - """ + + short_desc = 'Network and networking devices configuration' + plugin_name = "networking" profiles = ('network', 'hardware', 'system') trace_host = "www.example.com" diff --git a/sos/report/plugins/networkmanager.py b/sos/report/plugins/networkmanager.py index 972fe85b..e29f1dcb 100644 --- a/sos/report/plugins/networkmanager.py +++ b/sos/report/plugins/networkmanager.py @@ -11,8 +11,8 @@ import os class NetworkManager(Plugin, RedHatPlugin, UbuntuPlugin): - """NetworkManager service configuration - """ + + short_desc = 'NetworkManager service configuration' plugin_name = 'networkmanager' profiles = ('network', 'hardware', 'system') diff --git a/sos/report/plugins/nfs.py b/sos/report/plugins/nfs.py index 9d4dd72f..bebe0362 100644 --- a/sos/report/plugins/nfs.py +++ b/sos/report/plugins/nfs.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Nfs(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Network file system information - """ + + short_desc = 'Network file system information' plugin_name = 'nfs' profiles = ('storage', 'network', 'nfs') packages = ['nfs-utils'] diff --git a/sos/report/plugins/nfsganesha.py b/sos/report/plugins/nfsganesha.py index ea0f84dd..91442348 100644 --- a/sos/report/plugins/nfsganesha.py +++ b/sos/report/plugins/nfsganesha.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class NfsGanesha(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """NFS-Ganesha file server information - """ + + short_desc = 'NFS-Ganesha file server information' plugin_name = 'nfsganesha' profiles = ('storage', 'network', 'nfs') packages = ('nfs-ganesha',) diff --git a/sos/report/plugins/nfsserver.py b/sos/report/plugins/nfsserver.py index a0effae9..558ebd5d 100644 --- a/sos/report/plugins/nfsserver.py +++ b/sos/report/plugins/nfsserver.py @@ -14,9 +14,8 @@ from stat import ST_SIZE class NfsServer(Plugin, RedHatPlugin): - """NFS server information - """ + short_desc = 'NFS Server information' plugin_name = 'nfsserver' profiles = ('storage', 'network', 'services', 'nfs') diff --git a/sos/report/plugins/nginx.py b/sos/report/plugins/nginx.py index 44078e94..41f72aba 100644 --- a/sos/report/plugins/nginx.py +++ b/sos/report/plugins/nginx.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Nginx(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """nginx http daemon - """ + + short_desc = 'nginx http daemon' plugin_name = "nginx" profiles = ('webserver',) packages = ('nginx',) diff --git a/sos/report/plugins/nis.py b/sos/report/plugins/nis.py index 14e73f5f..2eb0678d 100644 --- a/sos/report/plugins/nis.py +++ b/sos/report/plugins/nis.py @@ -10,9 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Nis(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Network information service - """ + short_desc = 'Network Information Service' plugin_name = 'nis' profiles = ('identity', 'services') diff --git a/sos/report/plugins/nodejs.py b/sos/report/plugins/nodejs.py index 7f3b2f83..1ba464ed 100644 --- a/sos/report/plugins/nodejs.py +++ b/sos/report/plugins/nodejs.py @@ -13,7 +13,8 @@ from sos.report.plugins import (Plugin, RedHatPlugin, DebianPlugin, class NodeJS(Plugin, RedHatPlugin, SuSEPlugin): - """ Get runtime version of NodeJS """ + + short_desc = 'NodeJS runtime version' plugin_name = 'nodejs' profiles = ('system',) diff --git a/sos/report/plugins/npm.py b/sos/report/plugins/npm.py index 97bd61e8..5c6c5ccb 100644 --- a/sos/report/plugins/npm.py +++ b/sos/report/plugins/npm.py @@ -15,10 +15,8 @@ from sos.report.plugins import (Plugin, RedHatPlugin, DebianPlugin, class Npm(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin, SuSEPlugin): - """ - Get info about available npm modules - """ + short_desc = 'Information from available npm modules' plugin_name = 'npm' profiles = ('system',) option_list = [("project_path", diff --git a/sos/report/plugins/nscd.py b/sos/report/plugins/nscd.py index 95a75a89..d2eed778 100644 --- a/sos/report/plugins/nscd.py +++ b/sos/report/plugins/nscd.py @@ -12,9 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Nscd(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Name service caching daemon - """ + short_desc = 'Name service caching daemon' plugin_name = 'nscd' profiles = ('services', 'identity', 'system') diff --git a/sos/report/plugins/nss.py b/sos/report/plugins/nss.py index 1a621072..763f2ce7 100644 --- a/sos/report/plugins/nss.py +++ b/sos/report/plugins/nss.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class NSS(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Network Security Services configuration - """ + + short_desc = 'Network Security Services configuration' plugin_name = "nss" profiles = ('network', 'security') diff --git a/sos/report/plugins/ntb.py b/sos/report/plugins/ntb.py index b405a430..61691680 100644 --- a/sos/report/plugins/ntb.py +++ b/sos/report/plugins/ntb.py @@ -10,9 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Ntb(Plugin, RedHatPlugin): - """Linux PCI-Express Non-Transparent Bridge - """ + short_desc = 'Linux PCI-Express Non-Transparent Bridge' plugin_name = 'ntb' profiles = ('hardware', ) diff --git a/sos/report/plugins/ntp.py b/sos/report/plugins/ntp.py index 540d6b68..a7b1f79b 100644 --- a/sos/report/plugins/ntp.py +++ b/sos/report/plugins/ntp.py @@ -10,9 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Ntp(Plugin): - """Network time protocol - """ + short_desc = 'Network Time Protocol' plugin_name = "ntp" profiles = ('system', 'services') diff --git a/sos/report/plugins/numa.py b/sos/report/plugins/numa.py index a32426f3..181f889f 100644 --- a/sos/report/plugins/numa.py +++ b/sos/report/plugins/numa.py @@ -13,8 +13,8 @@ import os.path class Numa(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """NUMA state and configuration - """ + + short_desc = 'NUMA state and configuration' plugin_name = 'numa' profiles = ('hardware', 'system', 'memory', 'performance') diff --git a/sos/report/plugins/nvidia.py b/sos/report/plugins/nvidia.py index b455c0f4..65f08270 100644 --- a/sos/report/plugins/nvidia.py +++ b/sos/report/plugins/nvidia.py @@ -13,7 +13,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Nvidia(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Nvidia GPU information""" + + short_desc = 'Nvidia GPU information' commands = ('nvidia-smi',) diff --git a/sos/report/plugins/nvme.py b/sos/report/plugins/nvme.py index 86ef778d..a0dfada8 100644 --- a/sos/report/plugins/nvme.py +++ b/sos/report/plugins/nvme.py @@ -10,7 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Nvme(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Collect config and system information about NVMe devices""" + + short_desc = 'Collect config and system information about NVMe devices' plugin_name = "nvme" packages = ('nvme-cli',) diff --git a/sos/report/plugins/oddjob.py b/sos/report/plugins/oddjob.py index 4525df4a..4ce3381a 100644 --- a/sos/report/plugins/oddjob.py +++ b/sos/report/plugins/oddjob.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Oddjob(Plugin, RedHatPlugin): - """OddJob task scheduler - """ + + short_desc = 'OddJob task scheduler' plugin_name = 'oddjob' profiles = ('services', 'sysmgmt') diff --git a/sos/report/plugins/omnipath_client.py b/sos/report/plugins/omnipath_client.py index 699cf878..12e470c9 100644 --- a/sos/report/plugins/omnipath_client.py +++ b/sos/report/plugins/omnipath_client.py @@ -19,8 +19,8 @@ from os.path import join class OmnipathClient(Plugin, RedHatPlugin): - """OmniPath Tools and Fast Fabric Client - """ + + short_desc = 'OmniPath Tools and Fast Fabric Client' plugin_name = 'omnipath_client' profiles = ('hardware',) diff --git a/sos/report/plugins/omnipath_manager.py b/sos/report/plugins/omnipath_manager.py index 4e9e7683..540b7ed8 100644 --- a/sos/report/plugins/omnipath_manager.py +++ b/sos/report/plugins/omnipath_manager.py @@ -18,8 +18,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class OmnipathManager(Plugin, RedHatPlugin): - """OmniPath Fabric Manager - """ + + short_desc = 'OmniPath Fabric Manager' plugin_name = 'omnipath_manager' profiles = ('hardware',) diff --git a/sos/report/plugins/omsa.py b/sos/report/plugins/omsa.py index f6e74f80..e9ce8ffa 100644 --- a/sos/report/plugins/omsa.py +++ b/sos/report/plugins/omsa.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class omsa(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Dell OpenManage Server Administrator (OMSA) - """ + + short_desc = 'Dell OpenManage Server Administrator (OMSA)' plugin_name = 'omsa' profiles = ('hardware', 'debug') diff --git a/sos/report/plugins/opencl.py b/sos/report/plugins/opencl.py index ce66f017..0a2f721b 100644 --- a/sos/report/plugins/opencl.py +++ b/sos/report/plugins/opencl.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenCL(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """OpenCL - """ + + short_desc = 'OpenCL' plugin_name = 'opencl' profiles = ('hardware', 'desktop', 'gpu') diff --git a/sos/report/plugins/opendaylight.py b/sos/report/plugins/opendaylight.py index 8cde7980..b55a5859 100644 --- a/sos/report/plugins/opendaylight.py +++ b/sos/report/plugins/opendaylight.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class OpenDaylight(Plugin, RedHatPlugin): - """OpenDaylight network manager - """ + + short_desc = 'OpenDaylight network manager' plugin_name = 'opendaylight' profiles = ('openstack', 'openstack_controller') diff --git a/sos/report/plugins/opengl.py b/sos/report/plugins/opengl.py index 030369b8..3ba49c6a 100644 --- a/sos/report/plugins/opengl.py +++ b/sos/report/plugins/opengl.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenGL(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """OpenGL - """ + + short_desc = 'OpenGL' plugin_name = 'opengl' profiles = ('hardware', 'desktop', 'gpu') diff --git a/sos/report/plugins/openhpi.py b/sos/report/plugins/openhpi.py index 9766ed9d..67a78681 100644 --- a/sos/report/plugins/openhpi.py +++ b/sos/report/plugins/openhpi.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class OpenHPI(Plugin, RedHatPlugin): - """Open Hardware Platform Interface - """ + + short_desc = 'Open Hardware Platform Interface' plugin_name = 'openhpi' profiles = ('system', 'hardware') diff --git a/sos/report/plugins/openshift.py b/sos/report/plugins/openshift.py index 85c2e26a..2b7b1d15 100644 --- a/sos/report/plugins/openshift.py +++ b/sos/report/plugins/openshift.py @@ -17,7 +17,8 @@ import os.path # For later of OpenShift Origin based on: https://github.com/openshift/origin # like OpenShift Enterprise 3.x see the origin.py plugin class Openshift(Plugin, RedHatPlugin): - """Openshift 2.x node and broker""" + + short_desc = 'Openshift 2.x node and broker' plugin_name = "openshift" profiles = ('virt', 'openshift') diff --git a/sos/report/plugins/openssl.py b/sos/report/plugins/openssl.py index a008067f..b9c77f4d 100644 --- a/sos/report/plugins/openssl.py +++ b/sos/report/plugins/openssl.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenSSL(Plugin): - """OpenSSL configuration - """ + + short_desc = 'OpenSSL configuration' plugin_name = "openssl" profiles = ('network', 'security') @@ -37,8 +37,6 @@ class OpenSSL(Plugin): class RedHatOpenSSL(OpenSSL, RedHatPlugin): - """openssl related information - """ files = ('/etc/pki/tls/openssl.cnf',) @@ -48,8 +46,6 @@ class RedHatOpenSSL(OpenSSL, RedHatPlugin): class DebianOpenSSL(OpenSSL, DebianPlugin, UbuntuPlugin): - """openssl related information for Debian distributions - """ files = ('/etc/ssl/openssl.cnf',) diff --git a/sos/report/plugins/openstack_ansible.py b/sos/report/plugins/openstack_ansible.py index 62661f93..c37eda0d 100644 --- a/sos/report/plugins/openstack_ansible.py +++ b/sos/report/plugins/openstack_ansible.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackAnsible(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """OpenStack-Ansible sos plugin.""" + + short_desc = 'OpenStack-Ansible' plugin_name = "openstack_ansible" profiles = ('openstack',) diff --git a/sos/report/plugins/openstack_aodh.py b/sos/report/plugins/openstack_aodh.py index bb996716..f197c839 100644 --- a/sos/report/plugins/openstack_aodh.py +++ b/sos/report/plugins/openstack_aodh.py @@ -14,7 +14,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class OpenStackAodh(Plugin, RedHatPlugin): - """OpenStack Alarm service""" + + short_desc = 'OpenStack Alarm service' plugin_name = "openstack_aodh" profiles = ('openstack', 'openstack_controller') diff --git a/sos/report/plugins/openstack_ceilometer.py b/sos/report/plugins/openstack_ceilometer.py index 9ed3e814..eda59977 100644 --- a/sos/report/plugins/openstack_ceilometer.py +++ b/sos/report/plugins/openstack_ceilometer.py @@ -16,7 +16,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackCeilometer(Plugin): - """Openstack Ceilometer""" + + short_desc = 'Openstack Ceilometer' plugin_name = "openstack_ceilometer" profiles = ('openstack', 'openstack_controller', 'openstack_compute') diff --git a/sos/report/plugins/openstack_cinder.py b/sos/report/plugins/openstack_cinder.py index ed6e6fa2..f9f568fb 100644 --- a/sos/report/plugins/openstack_cinder.py +++ b/sos/report/plugins/openstack_cinder.py @@ -16,8 +16,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackCinder(Plugin): - """OpenStack cinder - """ + + short_desc = 'OpenStack cinder' plugin_name = "openstack_cinder" profiles = ('openstack', 'openstack_controller') diff --git a/sos/report/plugins/openstack_glance.py b/sos/report/plugins/openstack_glance.py index 61681d06..88df58b0 100644 --- a/sos/report/plugins/openstack_glance.py +++ b/sos/report/plugins/openstack_glance.py @@ -17,7 +17,8 @@ import os class OpenStackGlance(Plugin): - """OpenStack Glance""" + + short_desc = 'OpenStack Glance' plugin_name = "openstack_glance" profiles = ('openstack', 'openstack_controller') diff --git a/sos/report/plugins/openstack_heat.py b/sos/report/plugins/openstack_heat.py index 1dd151c1..ac2ed737 100644 --- a/sos/report/plugins/openstack_heat.py +++ b/sos/report/plugins/openstack_heat.py @@ -14,8 +14,8 @@ import os class OpenStackHeat(Plugin): - """OpenStack Heat - """ + + short_desc = 'OpenStack Heat' plugin_name = "openstack_heat" profiles = ('openstack', 'openstack_controller') diff --git a/sos/report/plugins/openstack_horizon.py b/sos/report/plugins/openstack_horizon.py index 16c8e1d3..aabe9ad2 100644 --- a/sos/report/plugins/openstack_horizon.py +++ b/sos/report/plugins/openstack_horizon.py @@ -15,8 +15,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackHorizon(Plugin): - """OpenStack Horizon - """ + + short_desc = 'OpenStack Horizon' plugin_name = "openstack_horizon" profiles = ('openstack', 'openstack_controller') diff --git a/sos/report/plugins/openstack_instack.py b/sos/report/plugins/openstack_instack.py index 81ecdb39..04862b2d 100644 --- a/sos/report/plugins/openstack_instack.py +++ b/sos/report/plugins/openstack_instack.py @@ -31,8 +31,8 @@ CONTAINERIZED_DEPLOY = [ class OpenStackInstack(Plugin): - """OpenStack Instack - """ + + short_desc = 'OpenStack Instack' plugin_name = "openstack_instack" profiles = ('openstack', 'openstack_undercloud') diff --git a/sos/report/plugins/openstack_ironic.py b/sos/report/plugins/openstack_ironic.py index b27df5d1..314d2a58 100644 --- a/sos/report/plugins/openstack_ironic.py +++ b/sos/report/plugins/openstack_ironic.py @@ -14,8 +14,8 @@ import os class OpenStackIronic(Plugin): - """OpenStack Ironic - """ + + short_desc = 'OpenStack Ironic' plugin_name = "openstack_ironic" profiles = ('openstack', 'openstack_undercloud') diff --git a/sos/report/plugins/openstack_keystone.py b/sos/report/plugins/openstack_keystone.py index f4cd3299..531524d9 100644 --- a/sos/report/plugins/openstack_keystone.py +++ b/sos/report/plugins/openstack_keystone.py @@ -14,8 +14,8 @@ import os class OpenStackKeystone(Plugin): - """OpenStack Keystone - """ + + short_desc = 'OpenStack Keystone' plugin_name = "openstack_keystone" profiles = ('openstack', 'openstack_controller') diff --git a/sos/report/plugins/openstack_manila.py b/sos/report/plugins/openstack_manila.py index 1d8429cb..b4e2523d 100644 --- a/sos/report/plugins/openstack_manila.py +++ b/sos/report/plugins/openstack_manila.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackManila(Plugin): - """OpenStack Manila - """ + + short_desc = 'OpenStack Manila' plugin_name = "openstack_manila" profiles = ('openstack', 'openstack_controller') option_list = [] @@ -71,8 +71,8 @@ class OpenStackManila(Plugin): class DebianManila(OpenStackManila, DebianPlugin, UbuntuPlugin): - """OpenStackManila related information for Debian based distributions.""" + short_desc = 'OpenStack Manila information for Debian based distributions' packages = ( 'python-manila', 'manila-common', @@ -83,8 +83,8 @@ class DebianManila(OpenStackManila, DebianPlugin, UbuntuPlugin): class RedHatManila(OpenStackManila, RedHatPlugin): - """OpenStackManila related information for Red Hat distributions.""" + short_desc = 'OpenStack Manila information for Red Hat distributions' packages = ('openstack-selinux',) def setup(self): diff --git a/sos/report/plugins/openstack_neutron.py b/sos/report/plugins/openstack_neutron.py index 285efeae..d4616445 100644 --- a/sos/report/plugins/openstack_neutron.py +++ b/sos/report/plugins/openstack_neutron.py @@ -14,8 +14,8 @@ import os class OpenStackNeutron(Plugin): - """OpenStack Networking - """ + + short_desc = 'OpenStack Networking' plugin_name = "openstack_neutron" profiles = ('openstack', 'openstack_controller', 'openstack_compute') diff --git a/sos/report/plugins/openstack_nova.py b/sos/report/plugins/openstack_nova.py index 3db9f99f..c254c765 100644 --- a/sos/report/plugins/openstack_nova.py +++ b/sos/report/plugins/openstack_nova.py @@ -18,8 +18,8 @@ import os class OpenStackNova(Plugin): - """OpenStack Nova - """ + + short_desc = 'OpenStack Nova' plugin_name = "openstack_nova" profiles = ('openstack', 'openstack_controller', 'openstack_compute') diff --git a/sos/report/plugins/openstack_novajoin.py b/sos/report/plugins/openstack_novajoin.py index 1f966f96..cb08bbab 100644 --- a/sos/report/plugins/openstack_novajoin.py +++ b/sos/report/plugins/openstack_novajoin.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class OpenStackNovajoin(Plugin): - """OpenStack Novajoin - """ + + short_desc = 'OpenStack Novajoin' plugin_name = "openstack_novajoin" profiles = ('openstack', 'openstack_undercloud') diff --git a/sos/report/plugins/openstack_octavia.py b/sos/report/plugins/openstack_octavia.py index 576c632b..1c376d80 100644 --- a/sos/report/plugins/openstack_octavia.py +++ b/sos/report/plugins/openstack_octavia.py @@ -10,7 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackOctavia(Plugin): - """Openstack Octavia""" + + short_desc = 'Openstack Octavia' plugin_name = "openstack_octavia" profiles = ('openstack', 'openstack_controller') diff --git a/sos/report/plugins/openstack_placement.py b/sos/report/plugins/openstack_placement.py index 7cd9b0b8..052bf51e 100644 --- a/sos/report/plugins/openstack_placement.py +++ b/sos/report/plugins/openstack_placement.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackPlacement(Plugin): - """OpenStack Placement - """ + + short_desc = 'OpenStack Placement' plugin_name = "openstack_placement" profiles = ('openstack', 'openstack_controller') diff --git a/sos/report/plugins/openstack_sahara.py b/sos/report/plugins/openstack_sahara.py index 91489852..ec7e18f1 100644 --- a/sos/report/plugins/openstack_sahara.py +++ b/sos/report/plugins/openstack_sahara.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackSahara(Plugin): - """OpenStack Sahara""" + + short_desc = 'OpenStack Sahara' plugin_name = 'openstack_sahara' profiles = ('openstack', 'openstack_controller') @@ -64,8 +65,8 @@ class OpenStackSahara(Plugin): class DebianSahara(OpenStackSahara, DebianPlugin, UbuntuPlugin): - """OpenStackSahara related information for Debian based distributions.""" + short_desc = 'OpenStack Sahara information for Debian based distributions' packages = ( 'sahara-api', 'sahara-common', @@ -79,8 +80,8 @@ class DebianSahara(OpenStackSahara, DebianPlugin, UbuntuPlugin): class RedHatSahara(OpenStackSahara, RedHatPlugin): - """OpenStack sahara related information for Red Hat distributions.""" + short_desc = 'OpenStack Sahara information for Red Hat distributions' packages = ('openstack-selinux',) def setup(self): diff --git a/sos/report/plugins/openstack_swift.py b/sos/report/plugins/openstack_swift.py index 61ee82e3..0abc117f 100644 --- a/sos/report/plugins/openstack_swift.py +++ b/sos/report/plugins/openstack_swift.py @@ -15,7 +15,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackSwift(Plugin): - """OpenStack Swift""" + + short_desc = 'OpenStack Swift' plugin_name = "openstack_swift" profiles = ('openstack', 'openstack_controller') diff --git a/sos/report/plugins/openstack_tripleo.py b/sos/report/plugins/openstack_tripleo.py index 47cd3e39..a89a6c05 100644 --- a/sos/report/plugins/openstack_tripleo.py +++ b/sos/report/plugins/openstack_tripleo.py @@ -13,8 +13,8 @@ import re class OpenStackTripleO(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Fetch installation informations from OpenStack Installer - """ + + short_desc = 'Installation information from OpenStack Installer' plugin_name = 'openstack_tripleo' profiles = ('openstack', 'openstack_controller', 'openstack_compute') diff --git a/sos/report/plugins/openstack_trove.py b/sos/report/plugins/openstack_trove.py index f3c39acf..eeb4664c 100644 --- a/sos/report/plugins/openstack_trove.py +++ b/sos/report/plugins/openstack_trove.py @@ -13,8 +13,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackTrove(Plugin): - """OpenStack Trove - """ + + short_desc = 'OpenStack Trove' plugin_name = "openstack_trove" profiles = ('openstack', 'openstack_controller') diff --git a/sos/report/plugins/openvswitch.py b/sos/report/plugins/openvswitch.py index 58d176e4..403bfc7a 100644 --- a/sos/report/plugins/openvswitch.py +++ b/sos/report/plugins/openvswitch.py @@ -15,8 +15,8 @@ from os import environ class OpenVSwitch(Plugin): - """ OpenVSwitch networking - """ + + short_desc = 'OpenVSwitch networking' plugin_name = "openvswitch" profiles = ('network', 'virt') diff --git a/sos/report/plugins/origin.py b/sos/report/plugins/origin.py index 0f475da4..43e1d62c 100644 --- a/sos/report/plugins/origin.py +++ b/sos/report/plugins/origin.py @@ -33,7 +33,8 @@ import os.path class OpenShiftOrigin(Plugin): - """ OpenShift Origin """ + + short_desc = 'OpenShift Origin' plugin_name = "origin" files = None # file lists assigned after path setup below @@ -224,8 +225,8 @@ class OpenShiftOrigin(Plugin): class AtomicOpenShift(OpenShiftOrigin, RedHatPlugin): - """ OpenShift Enterprise / OpenShift Container Platform - """ + + short_desc = 'OpenShift Enterprise / OpenShift Container Platform' packages = ('atomic-openshift',) diff --git a/sos/report/plugins/os_net_config.py b/sos/report/plugins/os_net_config.py index 43d13102..a87473c0 100644 --- a/sos/report/plugins/os_net_config.py +++ b/sos/report/plugins/os_net_config.py @@ -10,7 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class OsNetConfig(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """OpenStack Net Config""" + + short_desc = 'OpenStack Net Config' plugin_name = "os_net_config" profiles = ('openstack') diff --git a/sos/report/plugins/ovirt.py b/sos/report/plugins/ovirt.py index d9a97f68..760f49ba 100644 --- a/sos/report/plugins/ovirt.py +++ b/sos/report/plugins/ovirt.py @@ -21,7 +21,8 @@ from sos.utilities import is_executable # Class name must be the same as file name and method names must not change class Ovirt(Plugin, RedHatPlugin): - """oVirt Engine""" + + short_desc = 'oVirt Engine' plugin_name = "ovirt" profiles = ('virt',) diff --git a/sos/report/plugins/ovirt_engine_backup.py b/sos/report/plugins/ovirt_engine_backup.py index 263b76be..ada2afe6 100644 --- a/sos/report/plugins/ovirt_engine_backup.py +++ b/sos/report/plugins/ovirt_engine_backup.py @@ -14,7 +14,8 @@ from datetime import datetime class oVirtEngineBackup(Plugin, RedHatPlugin): - """oVirt Engine database backup""" + + short_desc = 'oVirt Engine database backup' packages = ("ovirt-engine-tools-backup",) plugin_name = "ovirt_engine_backup" diff --git a/sos/report/plugins/ovirt_hosted_engine.py b/sos/report/plugins/ovirt_hosted_engine.py index 450cd698..c441237a 100644 --- a/sos/report/plugins/ovirt_hosted_engine.py +++ b/sos/report/plugins/ovirt_hosted_engine.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class OvirtHostedEngine(Plugin, RedHatPlugin): - """oVirt Hosted Engine""" + + short_desc = 'oVirt Hosted Engine' packages = ( 'ovirt-hosted-engine-setup', diff --git a/sos/report/plugins/ovirt_imageio.py b/sos/report/plugins/ovirt_imageio.py index 58b2c6ab..b51b00f3 100644 --- a/sos/report/plugins/ovirt_imageio.py +++ b/sos/report/plugins/ovirt_imageio.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class OvirtImageIO(Plugin, RedHatPlugin): - """oVirt Image I/O Daemon / Proxy""" + + short_desc = 'oVirt Image I/O Daemon / Proxy' packages = ( 'ovirt-imageio-daemon', diff --git a/sos/report/plugins/ovirt_node.py b/sos/report/plugins/ovirt_node.py index 9da20077..2c47cf6b 100644 --- a/sos/report/plugins/ovirt_node.py +++ b/sos/report/plugins/ovirt_node.py @@ -11,7 +11,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class OvirtNode(Plugin, RedHatPlugin): - """oVirt Node specific information""" + + short_desc = 'oVirt Node specific information' packages = ( 'imgbased', diff --git a/sos/report/plugins/ovirt_provider_ovn.py b/sos/report/plugins/ovirt_provider_ovn.py index 401495b9..eb1f92b5 100644 --- a/sos/report/plugins/ovirt_provider_ovn.py +++ b/sos/report/plugins/ovirt_provider_ovn.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class OvirtProviderOvn(Plugin, RedHatPlugin): - """oVirt OVN Provider - """ + + short_desc = 'oVirt OVN Provider' packages = ('ovirt-provider-ovn',) plugin_name = 'ovirt_provider_ovn' diff --git a/sos/report/plugins/ovn_central.py b/sos/report/plugins/ovn_central.py index 7ccb9f42..eacfd736 100644 --- a/sos/report/plugins/ovn_central.py +++ b/sos/report/plugins/ovn_central.py @@ -14,8 +14,8 @@ import os class OVNCentral(Plugin): - """ OVN Northd - """ + + short_desc = 'OVN Northd' plugin_name = "ovn_central" profiles = ('network', 'virt') diff --git a/sos/report/plugins/ovn_host.py b/sos/report/plugins/ovn_host.py index e187a2aa..5b7fda49 100644 --- a/sos/report/plugins/ovn_host.py +++ b/sos/report/plugins/ovn_host.py @@ -21,8 +21,8 @@ pid_paths = [ class OVNHost(Plugin): - """ OVN Controller - """ + + short_desc = 'OVN Controller' plugin_name = "ovn_host" profiles = ('network', 'virt') diff --git a/sos/report/plugins/pacemaker.py b/sos/report/plugins/pacemaker.py index 17e0a5f8..7294c35a 100644 --- a/sos/report/plugins/pacemaker.py +++ b/sos/report/plugins/pacemaker.py @@ -13,8 +13,8 @@ import os.path class Pacemaker(Plugin): - """Pacemaker high-availability cluster resource manager - """ + + short_desc = 'Pacemaker high-availability cluster resource manager' plugin_name = "pacemaker" version = "1.0" diff --git a/sos/report/plugins/pam.py b/sos/report/plugins/pam.py index 30f20484..cbac32a4 100644 --- a/sos/report/plugins/pam.py +++ b/sos/report/plugins/pam.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Pam(Plugin): - """Pluggable Authentication Modules - """ + + short_desc = 'Pluggable Authentication Modules' plugin_name = "pam" profiles = ('security', 'identity', 'system') diff --git a/sos/report/plugins/pci.py b/sos/report/plugins/pci.py index 7b3c8cda..91d2709e 100644 --- a/sos/report/plugins/pci.py +++ b/sos/report/plugins/pci.py @@ -11,8 +11,8 @@ import os class Pci(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """PCI devices - """ + + short_desc = 'PCI devices' plugin_name = "pci" profiles = ('hardware', 'system') diff --git a/sos/report/plugins/pcp.py b/sos/report/plugins/pcp.py index 3e4f082d..d64bbe46 100644 --- a/sos/report/plugins/pcp.py +++ b/sos/report/plugins/pcp.py @@ -15,8 +15,8 @@ from socket import gethostname class Pcp(Plugin, RedHatPlugin, DebianPlugin): - """Performance Co-Pilot data - """ + + short_desc = 'Performance Co-Pilot data' plugin_name = 'pcp' profiles = ('system', 'performance') diff --git a/sos/report/plugins/peripety.py b/sos/report/plugins/peripety.py index 74a88c67..3076035c 100644 --- a/sos/report/plugins/peripety.py +++ b/sos/report/plugins/peripety.py @@ -14,7 +14,8 @@ import glob class Peripety(Plugin, RedHatPlugin): - """Peripety Storage Event Monitor""" + + short_desc = 'Peripety Storage Event Monitor' packages = ('peripety',) services = ('peripetyd',) diff --git a/sos/report/plugins/perl.py b/sos/report/plugins/perl.py index 52bfc29c..c09e05a5 100644 --- a/sos/report/plugins/perl.py +++ b/sos/report/plugins/perl.py @@ -10,7 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Perl(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """Perl runtime""" + + short_desc = 'Perl runtime' plugin_name = "perl" profiles = ('webserver', 'perl') diff --git a/sos/report/plugins/pmem.py b/sos/report/plugins/pmem.py index a75ff575..fbb96e9c 100644 --- a/sos/report/plugins/pmem.py +++ b/sos/report/plugins/pmem.py @@ -10,12 +10,11 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class pmem(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """Persistent Memory Devices + """This plugin collects data from Persistent Memory devices, + commonly referred to as NVDIMM's or Storage Class Memory (SCM) """ - # This plugin collects data from Persistent Memory devices, - # commonly referred to as NVDIMM's or Storage Class Memory (SCM). - + short_desc = 'Persistent Memory Devices' plugin_name = 'pmem' profiles = ('storage', 'hardware', 'memory') # Utilities can be installed by package or self compiled diff --git a/sos/report/plugins/podman.py b/sos/report/plugins/podman.py index 5441ae3c..f6875197 100644 --- a/sos/report/plugins/podman.py +++ b/sos/report/plugins/podman.py @@ -13,9 +13,7 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin class Podman(Plugin, RedHatPlugin, UbuntuPlugin): - """Podman containers - """ - + short_desc = 'Podman containers' plugin_name = 'podman' profiles = ('container',) packages = ('podman') diff --git a/sos/report/plugins/postfix.py b/sos/report/plugins/postfix.py index c0ecb013..18fab444 100644 --- a/sos/report/plugins/postfix.py +++ b/sos/report/plugins/postfix.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Postfix(Plugin): - """Postfix smtp server - """ + + short_desc = 'Postfix smtp server' plugin_name = "postfix" profiles = ('mail', 'services') diff --git a/sos/report/plugins/postgresql.py b/sos/report/plugins/postgresql.py index b7b4adbc..db162055 100644 --- a/sos/report/plugins/postgresql.py +++ b/sos/report/plugins/postgresql.py @@ -19,7 +19,8 @@ from sos.utilities import find class PostgreSQL(Plugin): - """PostgreSQL RDBMS""" + + short_desc = 'PostgreSQL RDBMS' plugin_name = "postgresql" profiles = ('services',) diff --git a/sos/report/plugins/powerpath.py b/sos/report/plugins/powerpath.py index 1565e079..bd7710c8 100644 --- a/sos/report/plugins/powerpath.py +++ b/sos/report/plugins/powerpath.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, os class PowerPath(Plugin, RedHatPlugin): - """ EMC PowerPath - """ + + short_desc = 'EMC PowerPath' plugin_name = 'powerpath' profiles = ('storage', 'hardware') diff --git a/sos/report/plugins/powerpc.py b/sos/report/plugins/powerpc.py index e5e4564b..6cd8dd14 100644 --- a/sos/report/plugins/powerpc.py +++ b/sos/report/plugins/powerpc.py @@ -14,8 +14,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class PowerPC(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """IBM Power systems - """ + + short_desc = 'IBM Power systems' plugin_name = 'powerpc' profiles = ('system', 'hardware') diff --git a/sos/report/plugins/ppp.py b/sos/report/plugins/ppp.py index dcf72e87..2791b581 100644 --- a/sos/report/plugins/ppp.py +++ b/sos/report/plugins/ppp.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Ppp(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Point-to-point protocol - """ + + short_desc = 'Point-to-point protocol' plugin_name = 'ppp' profiles = ('system', 'network') diff --git a/sos/report/plugins/procenv.py b/sos/report/plugins/procenv.py index 502f1506..ab202aab 100644 --- a/sos/report/plugins/procenv.py +++ b/sos/report/plugins/procenv.py @@ -11,8 +11,8 @@ from sos.report.plugins import Plugin, DebianPlugin, UbuntuPlugin class Procenv(Plugin, DebianPlugin, UbuntuPlugin): - """Process environment - """ + + short_desc = 'Process environment' plugin_name = 'procenv' profiles = ('system',) diff --git a/sos/report/plugins/process.py b/sos/report/plugins/process.py index 7a697830..7d49fb5a 100644 --- a/sos/report/plugins/process.py +++ b/sos/report/plugins/process.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Process(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """process information - """ + + short_desc = 'process information' plugin_name = 'process' profiles = ('system',) diff --git a/sos/report/plugins/processor.py b/sos/report/plugins/processor.py index dc1d538f..f0b68c82 100644 --- a/sos/report/plugins/processor.py +++ b/sos/report/plugins/processor.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Processor(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """CPU information - """ + + short_desc = 'CPU information' plugin_name = 'processor' profiles = ('system', 'hardware', 'memory') diff --git a/sos/report/plugins/psacct.py b/sos/report/plugins/psacct.py index 314a28d4..081b65e6 100644 --- a/sos/report/plugins/psacct.py +++ b/sos/report/plugins/psacct.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Psacct(Plugin): - """Process accounting information - """ + + short_desc = 'Process accounting information' plugin_name = "psacct" profiles = ('system',) diff --git a/sos/report/plugins/ptp.py b/sos/report/plugins/ptp.py index 1f2e0990..a5016c4a 100644 --- a/sos/report/plugins/ptp.py +++ b/sos/report/plugins/ptp.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Ptp(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Precision time protocol - """ + + short_desc = 'Precision time protocol' plugin_name = "ptp" profiles = ('system', 'services') diff --git a/sos/report/plugins/pulp.py b/sos/report/plugins/pulp.py index 521ed0dd..aa2ccea7 100644 --- a/sos/report/plugins/pulp.py +++ b/sos/report/plugins/pulp.py @@ -14,7 +14,8 @@ from re import match class Pulp(Plugin, RedHatPlugin): - """Pulp platform""" + + short_desc = 'Pulp platform' plugin_name = "pulp" packages = ("pulp-server", "pulp-katello") diff --git a/sos/report/plugins/puppet.py b/sos/report/plugins/puppet.py index ee435f03..bfaec129 100644 --- a/sos/report/plugins/puppet.py +++ b/sos/report/plugins/puppet.py @@ -11,8 +11,8 @@ from glob import glob class Puppet(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Puppet service - """ + + short_desc = 'Puppet service' plugin_name = 'puppet' profiles = ('services',) diff --git a/sos/report/plugins/pxe.py b/sos/report/plugins/pxe.py index 3b27c1a1..48fcff46 100644 --- a/sos/report/plugins/pxe.py +++ b/sos/report/plugins/pxe.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Pxe(Plugin): - """PXE service - """ + + short_desc = 'PXE service' plugin_name = "pxe" profiles = ('sysmgmt', 'network') option_list = [("tftpboot", 'gathers content from the tftpboot path', diff --git a/sos/report/plugins/python.py b/sos/report/plugins/python.py index fae3429e..daacec16 100644 --- a/sos/report/plugins/python.py +++ b/sos/report/plugins/python.py @@ -16,8 +16,8 @@ import hashlib class Python(Plugin, DebianPlugin, UbuntuPlugin): - """Python runtime - """ + + short_desc = 'Python runtime' plugin_name = 'python' profiles = ('system',) diff --git a/sos/report/plugins/qpid.py b/sos/report/plugins/qpid.py index 5a80b7e1..2cf42980 100644 --- a/sos/report/plugins/qpid.py +++ b/sos/report/plugins/qpid.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Qpid(Plugin, RedHatPlugin): - """Qpid messaging - """ + + short_desc = 'Qpid messaging' plugin_name = 'qpid' profiles = ('services',) diff --git a/sos/report/plugins/qpid_dispatch.py b/sos/report/plugins/qpid_dispatch.py index de9535ec..78ac5019 100644 --- a/sos/report/plugins/qpid_dispatch.py +++ b/sos/report/plugins/qpid_dispatch.py @@ -13,8 +13,8 @@ from socket import gethostname class QpidDispatch(Plugin, RedHatPlugin): - """Qpid dispatch router - """ + + short_desc = 'Qpid dispatch router' plugin_name = 'qpid_dispatch' profiles = ('services',) diff --git a/sos/report/plugins/qt.py b/sos/report/plugins/qt.py index 742bf44d..54b4c19e 100644 --- a/sos/report/plugins/qt.py +++ b/sos/report/plugins/qt.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Qt(Plugin, RedHatPlugin): - """QT widget toolkit""" + + short_desc = 'QT widget toolkit' plugin_name = 'qt' packages = ('qt', ) diff --git a/sos/report/plugins/quagga.py b/sos/report/plugins/quagga.py index 528b1a1c..0b1c0691 100644 --- a/sos/report/plugins/quagga.py +++ b/sos/report/plugins/quagga.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Quagga(Plugin, RedHatPlugin): - """Quagga routing service - """ + + short_desc = 'Quagga routing service' plugin_name = 'quagga' profiles = ('network',) diff --git a/sos/report/plugins/rabbitmq.py b/sos/report/plugins/rabbitmq.py index fb7af373..620e4dd6 100644 --- a/sos/report/plugins/rabbitmq.py +++ b/sos/report/plugins/rabbitmq.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class RabbitMQ(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """RabbitMQ messaging service - """ + + short_desc = 'RabbitMQ messaging service' plugin_name = 'rabbitmq' profiles = ('services',) var_puppet_gen = "/var/lib/config-data/puppet-generated/rabbitmq" diff --git a/sos/report/plugins/radius.py b/sos/report/plugins/radius.py index 12dc242e..89b951b4 100644 --- a/sos/report/plugins/radius.py +++ b/sos/report/plugins/radius.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Radius(Plugin): - """RADIUS service information - """ + + short_desc = 'RADIUS service information' plugin_name = "radius" profiles = ('network', 'identity') diff --git a/sos/report/plugins/rasdaemon.py b/sos/report/plugins/rasdaemon.py index b4edb65f..afba02df 100644 --- a/sos/report/plugins/rasdaemon.py +++ b/sos/report/plugins/rasdaemon.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Rasdaemon(Plugin, RedHatPlugin): - """rasdaemon kernel trace event monitor - """ + + short_desc = 'rasdaemon kernel trace event monitor' plugin_name = 'rasdaemon' packages = ('rasdaemon', ) diff --git a/sos/report/plugins/rear.py b/sos/report/plugins/rear.py index 11798a0a..d44e3f0a 100644 --- a/sos/report/plugins/rear.py +++ b/sos/report/plugins/rear.py @@ -13,9 +13,7 @@ from sos.report.plugins import Plugin, RedHatPlugin class Rear(Plugin, RedHatPlugin): - """Relax and Recover - """ - + short_desc = 'Relax and Recover' plugin_name = "rear" packages = ('rear',) diff --git a/sos/report/plugins/redis.py b/sos/report/plugins/redis.py index 3771281a..d81d0a44 100644 --- a/sos/report/plugins/redis.py +++ b/sos/report/plugins/redis.py @@ -13,8 +13,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Redis(Plugin, RedHatPlugin): - """Redis, in-memory data structure store - """ + + short_desc = 'Redis, in-memory data structure store' plugin_name = 'redis' profiles = ('services',) diff --git a/sos/report/plugins/release.py b/sos/report/plugins/release.py index 96014210..02402c28 100644 --- a/sos/report/plugins/release.py +++ b/sos/report/plugins/release.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Release(Plugin, RedHatPlugin, UbuntuPlugin): - """Linux release information - """ + + short_desc = 'Linux release information' plugin_name = 'release' profiles = ('system',) diff --git a/sos/report/plugins/rhcos.py b/sos/report/plugins/rhcos.py index 4c6c596b..1315252f 100644 --- a/sos/report/plugins/rhcos.py +++ b/sos/report/plugins/rhcos.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class RHCoreOS(Plugin, RedHatPlugin): - """Red Hat CoreOS""" + + short_desc = 'Red Hat CoreOS' plugin_name = 'rhcos' packages = ('redhat-release-coreos', 'coreos-metadata') diff --git a/sos/report/plugins/rhui.py b/sos/report/plugins/rhui.py index a27b230f..3e889e00 100644 --- a/sos/report/plugins/rhui.py +++ b/sos/report/plugins/rhui.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Rhui(Plugin, RedHatPlugin): - """Red Hat Update Infrastructure - """ + + short_desc = 'Red Hat Update Infrastructure' plugin_name = 'rhui' profiles = ('sysmgmt',) diff --git a/sos/report/plugins/rhv_analyzer.py b/sos/report/plugins/rhv_analyzer.py index 5d749c92..f83074da 100644 --- a/sos/report/plugins/rhv_analyzer.py +++ b/sos/report/plugins/rhv_analyzer.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Rhv_Analyzer(Plugin, RedHatPlugin): - """RHV Log Collector Analyzer""" + + short_desc = 'RHV Log Collector Analyzer' packages = ('rhv-log-collector-analyzer',) diff --git a/sos/report/plugins/rpm.py b/sos/report/plugins/rpm.py index edfe1349..3c5a0aaa 100644 --- a/sos/report/plugins/rpm.py +++ b/sos/report/plugins/rpm.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Rpm(Plugin, RedHatPlugin): - """RPM Package Manager - """ + + short_desc = 'RPM Package Manager' plugin_name = 'rpm' profiles = ('system', 'packagemanager') diff --git a/sos/report/plugins/rpmostree.py b/sos/report/plugins/rpmostree.py index 111f765d..15fe48c4 100644 --- a/sos/report/plugins/rpmostree.py +++ b/sos/report/plugins/rpmostree.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Rpmostree(Plugin, RedHatPlugin): - """rpm-ostree image/package system""" + + short_desc = 'rpm-ostree image/package system' plugin_name = 'rpmostree' packages = ('rpm-ostree',) diff --git a/sos/report/plugins/ruby.py b/sos/report/plugins/ruby.py index a643a90d..7724e4b9 100644 --- a/sos/report/plugins/ruby.py +++ b/sos/report/plugins/ruby.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Ruby(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Ruby runtime""" + + short_desc = 'Ruby runtime' plugin_name = 'ruby' packages = ('ruby', 'ruby-irb') diff --git a/sos/report/plugins/runc.py b/sos/report/plugins/runc.py index c731f0d6..6603f938 100644 --- a/sos/report/plugins/runc.py +++ b/sos/report/plugins/runc.py @@ -13,8 +13,7 @@ from sos.report.plugins import Plugin, RedHatPlugin class Runc(Plugin): - """runC container runtime""" - + short_desc = 'runC container runtime' plugin_name = 'runc' profiles = ('container',) diff --git a/sos/report/plugins/s390.py b/sos/report/plugins/s390.py index a1179518..4183a46c 100644 --- a/sos/report/plugins/s390.py +++ b/sos/report/plugins/s390.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class S390(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """IBM S/390 - """ + + short_desc = 'IBM S/390' plugin_name = 's390' profiles = ('system', 'hardware') diff --git a/sos/report/plugins/salt.py b/sos/report/plugins/salt.py index 9b565929..962a9187 100644 --- a/sos/report/plugins/salt.py +++ b/sos/report/plugins/salt.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin class Salt(Plugin, RedHatPlugin, DebianPlugin): - """Salt - """ + + short_desc = 'Salt' plugin_name = 'salt' profiles = ('sysmgmt',) diff --git a/sos/report/plugins/saltmaster.py b/sos/report/plugins/saltmaster.py index dcad255a..6e9bd552 100644 --- a/sos/report/plugins/saltmaster.py +++ b/sos/report/plugins/saltmaster.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin class SaltMaster(Plugin, RedHatPlugin, DebianPlugin): - """Salt Master - """ + + short_desc = 'Salt Master' plugin_name = 'saltmaster' profiles = ('sysmgmt',) diff --git a/sos/report/plugins/samba.py b/sos/report/plugins/samba.py index 529403f3..7930688e 100644 --- a/sos/report/plugins/samba.py +++ b/sos/report/plugins/samba.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Samba(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Samba Windows interoperability - """ + + short_desc = 'Samba Windows interoperability' packages = ('samba-common',) plugin_name = "samba" profiles = ('services',) diff --git a/sos/report/plugins/sanlock.py b/sos/report/plugins/sanlock.py index 2d3d5ea0..e6d2778b 100644 --- a/sos/report/plugins/sanlock.py +++ b/sos/report/plugins/sanlock.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class SANLock(Plugin): - """SANlock daemon - """ + + short_desc = 'SANlock daemon' plugin_name = "sanlock" profiles = ('cluster', 'virt') packages = ["sanlock"] diff --git a/sos/report/plugins/saphana.py b/sos/report/plugins/saphana.py index f5ba7dc6..60540dec 100644 --- a/sos/report/plugins/saphana.py +++ b/sos/report/plugins/saphana.py @@ -11,7 +11,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class saphana(Plugin, RedHatPlugin): - """SAP HANA""" + + short_desc = 'SAP HANA' plugin_name = 'saphana' profiles = ['sap'] diff --git a/sos/report/plugins/sapnw.py b/sos/report/plugins/sapnw.py index e301cac3..ea5bb808 100644 --- a/sos/report/plugins/sapnw.py +++ b/sos/report/plugins/sapnw.py @@ -19,7 +19,8 @@ def get_directory_listing(path): class sapnw(Plugin, RedHatPlugin): - """SAP NetWeaver""" + + short_desc = 'SAP NetWeaver' plugin_name = 'sapnw' profiles = ['sap'] diff --git a/sos/report/plugins/sar.py b/sos/report/plugins/sar.py index 44d068b3..6a07bf12 100644 --- a/sos/report/plugins/sar.py +++ b/sos/report/plugins/sar.py @@ -11,8 +11,8 @@ import os class Sar(Plugin,): - """System Activity Reporter - """ + + short_desc = 'System Activity Reporter' plugin_name = 'sar' profiles = ('system', 'performance') diff --git a/sos/report/plugins/sas3ircu.py b/sos/report/plugins/sas3ircu.py index 583da0a9..3b2551a7 100644 --- a/sos/report/plugins/sas3ircu.py +++ b/sos/report/plugins/sas3ircu.py @@ -14,8 +14,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class SAS3ircu(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """SAS-3 Integrated RAID adapter information - """ + + short_desc = 'SAS-3 Integrated RAID adapter information' plugin_name = "sas3ircu" commands = ("sas3ircu",) diff --git a/sos/report/plugins/scsi.py b/sos/report/plugins/scsi.py index 804e9a0b..bf6c2862 100644 --- a/sos/report/plugins/scsi.py +++ b/sos/report/plugins/scsi.py @@ -11,8 +11,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Scsi(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """SCSI devices - """ + + short_desc = 'SCSI devices' plugin_name = 'scsi' profiles = ('storage', 'hardware') diff --git a/sos/report/plugins/selinux.py b/sos/report/plugins/selinux.py index f805642e..10282f4e 100644 --- a/sos/report/plugins/selinux.py +++ b/sos/report/plugins/selinux.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class SELinux(Plugin, RedHatPlugin): - """SELinux access control - """ + + short_desc = 'SELinux access control' plugin_name = 'selinux' profiles = ('container', 'system', 'security', 'openshift') diff --git a/sos/report/plugins/sendmail.py b/sos/report/plugins/sendmail.py index 4bafe937..923dad7b 100644 --- a/sos/report/plugins/sendmail.py +++ b/sos/report/plugins/sendmail.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Sendmail(Plugin): - """sendmail service - """ + + short_desc = 'sendmail service' plugin_name = "sendmail" profiles = ('services', 'mail') diff --git a/sos/report/plugins/services.py b/sos/report/plugins/services.py index 2a07fcfa..4e3c2f4b 100644 --- a/sos/report/plugins/services.py +++ b/sos/report/plugins/services.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Services(Plugin): - """System services - """ + + short_desc = 'System services' plugin_name = "services" profiles = ('system', 'boot') diff --git a/sos/report/plugins/skydive.py b/sos/report/plugins/skydive.py index fb1e0cd3..07041557 100644 --- a/sos/report/plugins/skydive.py +++ b/sos/report/plugins/skydive.py @@ -13,8 +13,8 @@ import os class Skydive(Plugin, RedHatPlugin): - """Skydive, a network topology and protocols analyzer - """ + + short_desc = 'Skydive network topology and protocol analyzer' plugin_name = "skydive" profiles = ('network', ) diff --git a/sos/report/plugins/smartcard.py b/sos/report/plugins/smartcard.py index 93cb7c05..a4225bf4 100644 --- a/sos/report/plugins/smartcard.py +++ b/sos/report/plugins/smartcard.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Smartcard(Plugin, RedHatPlugin): - """PKCS#11 smart cards - """ + + short_desc = 'PKCS#11 smart cards' plugin_name = 'smartcard' profiles = ('security', 'identity', 'hardware') diff --git a/sos/report/plugins/snappy.py b/sos/report/plugins/snappy.py index 638d1d4b..2b0c68f5 100644 --- a/sos/report/plugins/snappy.py +++ b/sos/report/plugins/snappy.py @@ -11,8 +11,8 @@ from sos.report.plugins import Plugin, UbuntuPlugin, DebianPlugin, RedHatPlugin class Snappy(Plugin, UbuntuPlugin, DebianPlugin, RedHatPlugin): - """Snap packages - """ + + short_desc = 'Snap packages' plugin_name = 'snappy' profiles = ('system', 'sysmgmt', 'packagemanager') diff --git a/sos/report/plugins/snmp.py b/sos/report/plugins/snmp.py index aec29d6c..a74b4104 100644 --- a/sos/report/plugins/snmp.py +++ b/sos/report/plugins/snmp.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Snmp(Plugin): - """Simple network management protocol - """ + + short_desc = 'Simple network management protocol' plugin_name = "snmp" profiles = ('system', 'sysmgmt') diff --git a/sos/report/plugins/sos_extras.py b/sos/report/plugins/sos_extras.py index 15392608..8a7a6cdc 100644 --- a/sos/report/plugins/sos_extras.py +++ b/sos/report/plugins/sos_extras.py @@ -12,8 +12,8 @@ import stat class SosExtras(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """Collect extra data defined in /etc/sos.extras.d/ . - """ + + short_desc = 'Collect extra data defined in /etc/sos.extras.d' """The plugin traverses 'extras_dir' directory and for each file there, it executes commands or collects files optionally with sizelimit. Expected diff --git a/sos/report/plugins/soundcard.py b/sos/report/plugins/soundcard.py index 030d8511..ce19691e 100644 --- a/sos/report/plugins/soundcard.py +++ b/sos/report/plugins/soundcard.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Soundcard(Plugin): - """ Sound devices - """ + + short_desc = 'Sound devices' plugin_name = "soundcard" profiles = ('desktop', 'hardware') diff --git a/sos/report/plugins/squid.py b/sos/report/plugins/squid.py index c8b5a4db..b845ab52 100644 --- a/sos/report/plugins/squid.py +++ b/sos/report/plugins/squid.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Squid(Plugin): - """Squid caching proxy - """ + + short_desc = 'Squid caching proxy' plugin_name = 'squid' profiles = ('webserver', 'services', 'sysmgmt') diff --git a/sos/report/plugins/ssh.py b/sos/report/plugins/ssh.py index 0bc8d90c..1cb83547 100644 --- a/sos/report/plugins/ssh.py +++ b/sos/report/plugins/ssh.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Ssh(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Secure shell service - """ + + short_desc = 'Secure shell service' plugin_name = 'ssh' profiles = ('services', 'security', 'system', 'identity') diff --git a/sos/report/plugins/ssmtp.py b/sos/report/plugins/ssmtp.py index b97c15aa..9370fd2a 100644 --- a/sos/report/plugins/ssmtp.py +++ b/sos/report/plugins/ssmtp.py @@ -11,8 +11,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Ssmtp(Plugin, RedHatPlugin): - """sSMTP information - """ + + short_desc = 'sSMTP information' plugin_name = 'ssmtp' profiles = ('mail', 'system') diff --git a/sos/report/plugins/sssd.py b/sos/report/plugins/sssd.py index a1fb63e3..2058d90c 100644 --- a/sos/report/plugins/sssd.py +++ b/sos/report/plugins/sssd.py @@ -13,8 +13,8 @@ from sos.report.plugins import (Plugin, RedHatPlugin, DebianPlugin, class Sssd(Plugin): - """System security service daemon - """ + + short_desc = 'System security service daemon' plugin_name = "sssd" profiles = ('services', 'security', 'identity') diff --git a/sos/report/plugins/storageconsole.py b/sos/report/plugins/storageconsole.py index a7457a17..6718e795 100644 --- a/sos/report/plugins/storageconsole.py +++ b/sos/report/plugins/storageconsole.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin class StorageConsole(Plugin, RedHatPlugin, DebianPlugin): - """Red Hat Storage Console - """ + + short_desc = 'Red Hat Storage Console' plugin_name = 'storageconsole' profiles = ('storage',) diff --git a/sos/report/plugins/stratis.py b/sos/report/plugins/stratis.py index 154f57ee..b6071d32 100644 --- a/sos/report/plugins/stratis.py +++ b/sos/report/plugins/stratis.py @@ -12,7 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Stratis(Plugin, RedHatPlugin): - """Stratis Storage""" + + short_desc = 'Stratis Storage' packages = ('stratis-cli', 'stratisd') services = ('stratisd',) diff --git a/sos/report/plugins/subscription_manager.py b/sos/report/plugins/subscription_manager.py index 093b7aaa..9de595cf 100644 --- a/sos/report/plugins/subscription_manager.py +++ b/sos/report/plugins/subscription_manager.py @@ -11,8 +11,8 @@ import glob class SubscriptionManager(Plugin, RedHatPlugin): - """subscription-manager information - """ + + short_desc = 'subscription-manager information' plugin_name = 'subscription_manager' profiles = ('system', 'packagemanager', 'sysmgmt') diff --git a/sos/report/plugins/sudo.py b/sos/report/plugins/sudo.py index 31749541..4c3252fb 100644 --- a/sos/report/plugins/sudo.py +++ b/sos/report/plugins/sudo.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Sudo(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Sudo command execution - """ + + short_desc = 'Sudo command execution' plugin_name = 'sudo' profiles = ('identity', 'system') packages = ('sudo') diff --git a/sos/report/plugins/sunrpc.py b/sos/report/plugins/sunrpc.py index df2c3e3f..5f4287ae 100644 --- a/sos/report/plugins/sunrpc.py +++ b/sos/report/plugins/sunrpc.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class SunRPC(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Sun RPC service - """ + + short_desc = 'Sun RPC service' plugin_name = "sunrpc" profiles = ('system', 'storage', 'network', 'nfs') diff --git a/sos/report/plugins/symcli.py b/sos/report/plugins/symcli.py index e3741fe3..ea2ba4a9 100644 --- a/sos/report/plugins/symcli.py +++ b/sos/report/plugins/symcli.py @@ -14,8 +14,8 @@ from sos.utilities import is_executable class Symcli(Plugin, RedHatPlugin): - """ EMC Symcli - """ + + short_desc = 'EMC Symcli' plugin_name = 'symcli' profiles = ('storage', 'hardware') diff --git a/sos/report/plugins/system.py b/sos/report/plugins/system.py index c48c099a..2fd57da1 100644 --- a/sos/report/plugins/system.py +++ b/sos/report/plugins/system.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class System(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """core system information - """ + + short_desc = 'core system information' plugin_name = "system" profiles = ('system', 'kernel') diff --git a/sos/report/plugins/systemd.py b/sos/report/plugins/systemd.py index 19993e62..9399a905 100644 --- a/sos/report/plugins/systemd.py +++ b/sos/report/plugins/systemd.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Systemd(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """ System management daemon - """ + + short_desc = 'System management daemon' plugin_name = "systemd" profiles = ('system', 'services', 'boot') diff --git a/sos/report/plugins/systemtap.py b/sos/report/plugins/systemtap.py index 7cd1c238..39d0dc97 100644 --- a/sos/report/plugins/systemtap.py +++ b/sos/report/plugins/systemtap.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class SystemTap(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """SystemTap dynamic instrumentation - """ + + short_desc = 'SystemTap dynamic instrumentation' plugin_name = 'systemtap' profiles = ('debug', 'performance') diff --git a/sos/report/plugins/sysvipc.py b/sos/report/plugins/sysvipc.py index 1e271293..516b5e73 100644 --- a/sos/report/plugins/sysvipc.py +++ b/sos/report/plugins/sysvipc.py @@ -11,8 +11,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class SysVIPC(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """SysV IPC - """ + + short_desc = 'SysV IPC' plugin_name = "sysvipc" profiles = ('system', 'services') diff --git a/sos/report/plugins/targetcli.py b/sos/report/plugins/targetcli.py index 7b8a7a6d..886d367c 100644 --- a/sos/report/plugins/targetcli.py +++ b/sos/report/plugins/targetcli.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class TargetCli(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """TargetCLI TCM/LIO configuration - """ + + short_desc = 'TargetCLI TCM/LIO configuration' packages = ('targetcli', 'python-rtslib') profiles = ('storage', ) plugin_name = 'targetcli' diff --git a/sos/report/plugins/teamd.py b/sos/report/plugins/teamd.py index 88602c6e..ba2e61d3 100644 --- a/sos/report/plugins/teamd.py +++ b/sos/report/plugins/teamd.py @@ -11,9 +11,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Teamd(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Network interface teaming - """ + short_desc = 'Network Interface Teaming' plugin_name = 'teamd' profiles = ('network', 'hardware', ) diff --git a/sos/report/plugins/tftpserver.py b/sos/report/plugins/tftpserver.py index 7439ae47..b5460e45 100644 --- a/sos/report/plugins/tftpserver.py +++ b/sos/report/plugins/tftpserver.py @@ -12,9 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class TftpServer(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """TFTP server - """ + short_desc = 'TFTP Server information' plugin_name = 'tftpserver' profiles = ('sysmgmt', 'network') diff --git a/sos/report/plugins/tomcat.py b/sos/report/plugins/tomcat.py index 46d50571..17587830 100644 --- a/sos/report/plugins/tomcat.py +++ b/sos/report/plugins/tomcat.py @@ -11,9 +11,8 @@ from datetime import datetime class Tomcat(Plugin, RedHatPlugin): - """Apache Tomcat server - """ + short_desc = 'Apache Tomcat Server' plugin_name = 'tomcat' profiles = ('webserver', 'java', 'services', 'sysmgmt') diff --git a/sos/report/plugins/tuned.py b/sos/report/plugins/tuned.py index 21770cb1..26dcaa63 100644 --- a/sos/report/plugins/tuned.py +++ b/sos/report/plugins/tuned.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Tuned(Plugin, RedHatPlugin): - """Tuned system tuning daemon - """ + + short_desc = 'Tuned system tuning daemon' packages = ('tuned',) profiles = ('system', 'performance') plugin_name = 'tuned' diff --git a/sos/report/plugins/ubuntu.py b/sos/report/plugins/ubuntu.py index 6eeef2e2..5a89f6f2 100644 --- a/sos/report/plugins/ubuntu.py +++ b/sos/report/plugins/ubuntu.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, UbuntuPlugin class Ubuntu(Plugin, UbuntuPlugin): - """ Ubuntu specific information - """ + + short_desc = 'Ubuntu specific information' plugin_name = 'ubuntu' profiles = ('system',) diff --git a/sos/report/plugins/udev.py b/sos/report/plugins/udev.py index 5bc7d055..5b04c37d 100644 --- a/sos/report/plugins/udev.py +++ b/sos/report/plugins/udev.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Udev(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """udev dynamic device management - """ + + short_desc = 'udev dynamic device management' plugin_name = 'udev' profiles = ('system', 'hardware', 'boot') diff --git a/sos/report/plugins/unity.py b/sos/report/plugins/unity.py index d00acc3a..24bcf8ad 100644 --- a/sos/report/plugins/unity.py +++ b/sos/report/plugins/unity.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, UbuntuPlugin class unity(Plugin, UbuntuPlugin): - """Unity - """ + + short_desc = 'Unity' plugin_name = 'unity' profiles = ('hardware', 'desktop') diff --git a/sos/report/plugins/unpackaged.py b/sos/report/plugins/unpackaged.py index 9ada49ab..f626ce21 100644 --- a/sos/report/plugins/unpackaged.py +++ b/sos/report/plugins/unpackaged.py @@ -13,10 +13,9 @@ import stat class Unpackaged(Plugin, RedHatPlugin): - """ - Collects a list of files that are not handled by the package - manager - """ + + short_desc = ('Collects a list of files that are not handled by the ' + 'package manager') def setup(self): diff --git a/sos/report/plugins/upstart.py b/sos/report/plugins/upstart.py index fdcb89a6..080d983f 100644 --- a/sos/report/plugins/upstart.py +++ b/sos/report/plugins/upstart.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Upstart(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Upstart init system - """ + + short_desc = 'Upstart init system' plugin_name = 'upstart' profiles = ('system', 'services', 'boot') diff --git a/sos/report/plugins/usb.py b/sos/report/plugins/usb.py index 56b35c57..cd80f2fa 100644 --- a/sos/report/plugins/usb.py +++ b/sos/report/plugins/usb.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Usb(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """USB devices - """ + + short_desc = 'USB devices' plugin_name = "usb" profiles = ('hardware',) diff --git a/sos/report/plugins/validation_framework.py b/sos/report/plugins/validation_framework.py index 22c54346..535beddc 100644 --- a/sos/report/plugins/validation_framework.py +++ b/sos/report/plugins/validation_framework.py @@ -17,8 +17,8 @@ from sos.report.plugins import Plugin, RedHatPlugin # this plugin has a generic name. # - The Framework is targeted at Red Hat products, at least for now. class ValidationFramework(Plugin, RedHatPlugin): - """Fetch run logs provided by the Validation Framework - """ + + short_desc = 'Logs provided by the Validation Framework' plugin_name = 'validation_framework' profiles = ('openstack', 'openstack_controller', 'openstack_compute') diff --git a/sos/report/plugins/vdo.py b/sos/report/plugins/vdo.py index 61f30632..f4f4cef1 100644 --- a/sos/report/plugins/vdo.py +++ b/sos/report/plugins/vdo.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Vdo(Plugin, RedHatPlugin): - """Virtual Data Optimizer - """ + + short_desc = 'Virtual Data Optimizer' plugin_name = 'vdo' profiles = ('storage',) diff --git a/sos/report/plugins/vdsm.py b/sos/report/plugins/vdsm.py index 10854faa..fc0f50b7 100644 --- a/sos/report/plugins/vdsm.py +++ b/sos/report/plugins/vdsm.py @@ -50,8 +50,8 @@ LVM_CONFIG = re.sub(r"\s+", " ", LVM_CONFIG).strip() class Vdsm(Plugin, RedHatPlugin): - """vdsm plugin""" + short_desc = 'VDSM - Virtual Desktop and Server Manager' packages = ( 'vdsm', 'vdsm-client', diff --git a/sos/report/plugins/veritas.py b/sos/report/plugins/veritas.py index a9271907..94be4c13 100644 --- a/sos/report/plugins/veritas.py +++ b/sos/report/plugins/veritas.py @@ -11,8 +11,8 @@ import os class Veritas(Plugin, RedHatPlugin): - """Veritas software - """ + + short_desc = 'Veritas software' plugin_name = 'veritas' profiles = ('cluster', 'storage') diff --git a/sos/report/plugins/vhostmd.py b/sos/report/plugins/vhostmd.py index e4223fbd..d90852ba 100644 --- a/sos/report/plugins/vhostmd.py +++ b/sos/report/plugins/vhostmd.py @@ -11,8 +11,8 @@ import os class vhostmd(Plugin, RedHatPlugin): - """vhostmd virtualization metrics collection - """ + + short_desc = 'vhostmd virtualization metrics collection' plugin_name = 'vhostmd' profiles = ['sap', 'virt', 'system'] diff --git a/sos/report/plugins/virsh.py b/sos/report/plugins/virsh.py index 5b32e8d6..dab3d464 100644 --- a/sos/report/plugins/virsh.py +++ b/sos/report/plugins/virsh.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class LibvirtClient(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """client for libvirt virtualization API - """ + + short_desc = 'client for libvirt virtualization API' plugin_name = 'virsh' profiles = ('system', 'virt') diff --git a/sos/report/plugins/virtwho.py b/sos/report/plugins/virtwho.py index 0be53ec2..6c798c0e 100644 --- a/sos/report/plugins/virtwho.py +++ b/sos/report/plugins/virtwho.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class VirtWho(Plugin, RedHatPlugin): - """Virt-Who agent - """ + + short_desc = 'Virt-Who agent' plugin_name = 'virtwho' profiles = ('virt', 'system') diff --git a/sos/report/plugins/vmware.py b/sos/report/plugins/vmware.py index 3fe277bd..6d2d003b 100644 --- a/sos/report/plugins/vmware.py +++ b/sos/report/plugins/vmware.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class VMWare(Plugin, RedHatPlugin): - """VMWare client information - """ + + short_desc = 'VMWare client information' plugin_name = 'vmware' profiles = ('virt',) diff --git a/sos/report/plugins/vsftpd.py b/sos/report/plugins/vsftpd.py index dc5bb70f..25460423 100644 --- a/sos/report/plugins/vsftpd.py +++ b/sos/report/plugins/vsftpd.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin class Vsftpd(Plugin, RedHatPlugin): - """Vsftpd server - """ + + short_desc = 'Vsftpd server' plugin_name = 'vsftpd' profiles = ('services',) diff --git a/sos/report/plugins/vulkan.py b/sos/report/plugins/vulkan.py index d76f0138..8961b33d 100644 --- a/sos/report/plugins/vulkan.py +++ b/sos/report/plugins/vulkan.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Vulkan(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Vulkan - """ + + short_desc = 'Vulkan' plugin_name = 'vulkan' profiles = ('hardware', 'desktop', 'gpu') diff --git a/sos/report/plugins/watchdog.py b/sos/report/plugins/watchdog.py index 92bfc9ac..7fcbd409 100644 --- a/sos/report/plugins/watchdog.py +++ b/sos/report/plugins/watchdog.py @@ -15,7 +15,8 @@ import os class Watchdog(Plugin, RedHatPlugin): - """Watchdog information.""" + + short_desc = 'Watchdog information.' plugin_name = 'watchdog' profiles = ('system',) packages = ('watchdog',) diff --git a/sos/report/plugins/wireless.py b/sos/report/plugins/wireless.py index 70c09eab..1f4853cc 100644 --- a/sos/report/plugins/wireless.py +++ b/sos/report/plugins/wireless.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Wireless(Plugin, DebianPlugin, UbuntuPlugin): - """Wireless - """ + + short_desc = 'Wireless' plugin_name = 'wireless' profiles = ('hardware', 'desktop', 'network') @@ -27,8 +27,8 @@ class Wireless(Plugin, DebianPlugin, UbuntuPlugin): class RedHatWireless(Wireless, RedHatPlugin): - """Wireless - """ + + short_desc = 'Wireless' files = ('/usr/sbin/iw', '/usr/sbin/iwlist') packages = ('iw', 'wireless-tools') diff --git a/sos/report/plugins/x11.py b/sos/report/plugins/x11.py index f0549df7..8cbb5de0 100644 --- a/sos/report/plugins/x11.py +++ b/sos/report/plugins/x11.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class X11(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """X windowing system - """ + + short_desc = 'X windowing system' plugin_name = 'x11' profiles = ('hardware', 'desktop') diff --git a/sos/report/plugins/xen.py b/sos/report/plugins/xen.py index 2035f202..a456b27d 100644 --- a/sos/report/plugins/xen.py +++ b/sos/report/plugins/xen.py @@ -12,8 +12,8 @@ import re class Xen(Plugin, RedHatPlugin): - """Xen virtualization - """ + + short_desc = 'Xen virtualization' plugin_name = 'xen' profiles = ('virt',) diff --git a/sos/report/plugins/xfs.py b/sos/report/plugins/xfs.py index 534399d1..65d947fd 100644 --- a/sos/report/plugins/xfs.py +++ b/sos/report/plugins/xfs.py @@ -10,8 +10,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Xfs(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """XFS filesystem - """ + + short_desc = 'XFS filesystem' plugin_name = 'xfs' profiles = ('storage',) diff --git a/sos/report/plugins/xinetd.py b/sos/report/plugins/xinetd.py index 8940cc1d..ac8ff505 100644 --- a/sos/report/plugins/xinetd.py +++ b/sos/report/plugins/xinetd.py @@ -12,8 +12,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Xinetd(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """xinetd information - """ + + short_desc = 'xinetd information' plugin_name = 'xinetd' profiles = ('services', 'network', 'boot') diff --git a/sos/report/plugins/yum.py b/sos/report/plugins/yum.py index 1ec7f70a..ef23df49 100644 --- a/sos/report/plugins/yum.py +++ b/sos/report/plugins/yum.py @@ -13,8 +13,8 @@ YUM_PLUGIN_PATH = "/usr/lib/yum-plugins/" class Yum(Plugin, RedHatPlugin): - """yum information - """ + + short_desc = 'yum information' plugin_name = 'yum' profiles = ('system', 'packagemanager', 'sysmgmt') diff --git a/sos/report/plugins/zfs.py b/sos/report/plugins/zfs.py index b262bd62..fe2211a4 100644 --- a/sos/report/plugins/zfs.py +++ b/sos/report/plugins/zfs.py @@ -11,8 +11,8 @@ from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Zfs(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """ZFS filesystem - """ + + short_desc = 'ZFS filesystem' plugin_name = 'zfs' profiles = ('storage',) diff --git a/tests/plugin_tests.py b/tests/plugin_tests.py index bc7f7cc8..39705599 100644 --- a/tests/plugin_tests.py +++ b/tests/plugin_tests.py @@ -69,8 +69,8 @@ class MockPlugin(Plugin): class NamedMockPlugin(Plugin): - """This plugin has a description.""" + short_desc = "This plugin has a description." plugin_name = "testing" def setup(self): |