diff --git a/README.md b/README.md index 6ccc8a7..1f093e0 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,13 @@ This playbook generates a cluster overview report for an **Open Shift 3** Cluster. ---- # Features * Requires no additional dependency -* Generates a stand-alone HTML file +* Generates a stand-alone HTML file * Light-weight and fast -* A total of 3 oc commands are run on the cluster, data is processed on the ansible node. +* Very few oc commands are run on the cluster, data is processed on the ansible node. * Modular design, new report components can be easily added If you would like to request a new component/features in the report, please open a new github issue. @@ -60,12 +59,31 @@ Set the `email_report:` to True and provide the SMTP configuration in cluster-re # Sample ![OpenShift Cluster Overview Report 2020-03-09](https://user-images.githubusercontent.com/10104541/76197494-ae7ce280-6205-11ea-8b26-cc1c8d0676c0.png) -# TODO +# TODO (WISH LIST) * Check for orphaned pods * Compare the master-config.yaml -* Elasticsearch status +* Elasticsearch status, indexes * Warning events in the core namespaces +* Quick certificate check +* Gluster stroage check +* Pending CSR check +* Core pods (registry, es, prometheus etc.) using persistent storage check +* Latency check of core services (api, registry, router) from all nodes +* All pods on each node using hostpath/localvolumes +* Persistent volumes check +* Service serving certificate check +* Disk usage of important directories (/var, /var/lib/docker /var/lib/etcd etc.) +* Top 10 namespaces using CPU/Memory requests/limits +* Handle CRI-O +* Show network info i.e, host IPs, oc-hostsubnets +* DNS on nodes/pods check +* Proxy on nodes/pods check +* Users/serviceaccounts with admin/cluster-admin privileges +* Imagestream check (deployments using old istreams) +* OVS flow, bridges, interfaces check +* Create proper document/wiki + # Contribution