From 3f3f87b7982b570ffb976865e3eace2d36960bd4 Mon Sep 17 00:00:00 2001
From: Luke Meyer <lmeyer@redhat.com>
Date: Fri, 16 Jun 2017 15:36:06 -0400
Subject: openshift_checks: improve comments/names

---
 .../openshift_health_checker/openshift_checks/logging/curator.py  | 8 ++------
 .../openshift_checks/logging/elasticsearch.py                     | 8 +++-----
 .../openshift_health_checker/openshift_checks/logging/fluentd.py  | 7 +++----
 .../openshift_health_checker/openshift_checks/logging/logging.py  | 2 +-
 4 files changed, 9 insertions(+), 16 deletions(-)

(limited to 'roles/openshift_health_checker/openshift_checks/logging')

diff --git a/roles/openshift_health_checker/openshift_checks/logging/curator.py b/roles/openshift_health_checker/openshift_checks/logging/curator.py
index c9fc59896..d8e64074f 100644
--- a/roles/openshift_health_checker/openshift_checks/logging/curator.py
+++ b/roles/openshift_health_checker/openshift_checks/logging/curator.py
@@ -1,13 +1,11 @@
-"""
-Module for performing checks on an Curator logging deployment
-"""
+"""Check for an aggregated logging Curator deployment"""
 
 from openshift_checks import get_var
 from openshift_checks.logging.logging import LoggingCheck
 
 
 class Curator(LoggingCheck):
-    """Module that checks an integrated logging Curator deployment"""
+    """Check for an aggregated logging Curator deployment"""
 
     name = "curator"
     tags = ["health", "logging"]
@@ -15,8 +13,6 @@ class Curator(LoggingCheck):
     logging_namespace = None
 
     def run(self, tmp, task_vars):
-        """Check various things and gather errors. Returns: result as hash"""
-
         self.logging_namespace = get_var(task_vars, "openshift_logging_namespace", default="logging")
         curator_pods, error = super(Curator, self).get_pods_for_component(
             self.module_executor,
diff --git a/roles/openshift_health_checker/openshift_checks/logging/elasticsearch.py b/roles/openshift_health_checker/openshift_checks/logging/elasticsearch.py
index 01cb35b81..d57cb9376 100644
--- a/roles/openshift_health_checker/openshift_checks/logging/elasticsearch.py
+++ b/roles/openshift_health_checker/openshift_checks/logging/elasticsearch.py
@@ -1,6 +1,4 @@
-"""
-Module for performing checks on an Elasticsearch logging deployment
-"""
+"""Check for an aggregated logging Elasticsearch deployment"""
 
 import json
 import re
@@ -10,7 +8,7 @@ from openshift_checks.logging.logging import LoggingCheck
 
 
 class Elasticsearch(LoggingCheck):
-    """Module that checks an integrated logging Elasticsearch deployment"""
+    """Check for an aggregated logging Elasticsearch deployment"""
 
     name = "elasticsearch"
     tags = ["health", "logging"]
@@ -41,7 +39,7 @@ class Elasticsearch(LoggingCheck):
         return {"failed": False, "changed": False, "msg": 'No problems found with Elasticsearch deployment.'}
 
     def _not_running_elasticsearch_pods(self, es_pods):
-        """Returns: list of running pods, list of errors about non-running pods"""
+        """Returns: list of pods that are not running, list of errors about non-running pods"""
         not_running = super(Elasticsearch, self).not_running_pods(es_pods)
         if not_running:
             return not_running, [(
diff --git a/roles/openshift_health_checker/openshift_checks/logging/fluentd.py b/roles/openshift_health_checker/openshift_checks/logging/fluentd.py
index 627567293..1e1e7f2bd 100644
--- a/roles/openshift_health_checker/openshift_checks/logging/fluentd.py
+++ b/roles/openshift_health_checker/openshift_checks/logging/fluentd.py
@@ -1,6 +1,4 @@
-"""
-Module for performing checks on an Fluentd logging deployment
-"""
+"""Check for an aggregated logging Fluentd deployment"""
 
 import json
 
@@ -9,7 +7,8 @@ from openshift_checks.logging.logging import LoggingCheck
 
 
 class Fluentd(LoggingCheck):
-    """Module that checks an integrated logging Fluentd deployment"""
+    """Check for an aggregated logging Fluentd deployment"""
+
     name = "fluentd"
     tags = ["health", "logging"]
 
diff --git a/roles/openshift_health_checker/openshift_checks/logging/logging.py b/roles/openshift_health_checker/openshift_checks/logging/logging.py
index 02a094007..46fd4f5c7 100644
--- a/roles/openshift_health_checker/openshift_checks/logging/logging.py
+++ b/roles/openshift_health_checker/openshift_checks/logging/logging.py
@@ -9,7 +9,7 @@ from openshift_checks import OpenShiftCheck, OpenShiftCheckException, get_var
 
 
 class LoggingCheck(OpenShiftCheck):
-    """Base class for logging component checks"""
+    """Base class for OpenShift aggregated logging component checks"""
 
     name = "logging"
     logging_namespace = "logging"
-- 
cgit v1.2.3