From 352aa5e5a3dbabe61769251764b34d28404cfe25 Mon Sep 17 00:00:00 2001
From: A Holt <holta@users.noreply.github.com>
Date: Sat, 22 Jun 2019 16:38:00 -0400
Subject: [PATCH] Update and rename diagnostics_features.md to
 iiab-diagnostics.README.md

---
 scripts/diagnostics_features.md    | 58 -----------------------------
 scripts/iiab-diagnostics.README.md | 60 ++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+), 58 deletions(-)
 delete mode 100644 scripts/diagnostics_features.md
 create mode 100644 scripts/iiab-diagnostics.README.md

diff --git a/scripts/diagnostics_features.md b/scripts/diagnostics_features.md
deleted file mode 100644
index 062e2369d..000000000
--- a/scripts/diagnostics_features.md
+++ /dev/null
@@ -1,58 +0,0 @@
-## Objective 
-
-Create a flat file which can be uploaded to pastebinit.
-
-File contains 4 kinds of things:
-
-1. Files
-   1. /etc/iiab/iiab.ini
-   2. /etc/iiab/iiab.env
-   3. /etc/iiab/local_vars.yml
-   4. /etc/iiab/config_vars.yml
-   5. /etc/resolv.conf
-   6. /opt/iiab/iiab-install.log
-   7. /opt/iiab/iiab-debug.log
-   8. /opt/iiab/iiab-network.log
-
-2. Facts:
-   1. All Ansible facts
-
-3. Output from commands:
-   1. Output of /sbin/ip addr
-   2. Output of /sbin/ifconfig
-   3. Output of /sbin/brctl show
-   4. Output of /bin/netstat -rn (routing table)
-   5. Output of /bin/netstat -natp (which services have which ports)
-   ...
-   systemctl status dnsmasq
-   journalctl -u dnsmasq
-
-4. as well as contents of following directories:
-   1. /etc/network/interfaces.d (and interfaces)
-   2. /etc/sysconfig/network-scripts/if-cfg*
-   3. /etc/NetworkManager/system-connections
-   4. /etc/systemd/network/
-
-#### Suggested Usage 
-
-1. Run the diagnostics:
-
-   ```
-   sudo iiab-diagnostics
-   ```
-
-   ( This will bundle up all the diagnostics, into a new file places in: /etc/iiab/diagnostics/ )
-
-2. Upload the file using the pastebinit command:
-
-   ```
-   pastebinit < /etc/iiab/diagnostics/<name of file you just created>
-   ```
-   
-   This will generalte a link (URL).
-
-3. Post the link (URL) to a "New issue" at https://github.com/iiab/iiab/issues
-
-   Include a description of the symptoms, and how to reproduce the problem.
-
-4. If you don't understand Step 3, email everything to bugs@iiab.io instead.
diff --git a/scripts/iiab-diagnostics.README.md b/scripts/iiab-diagnostics.README.md
new file mode 100644
index 000000000..d398a1508
--- /dev/null
+++ b/scripts/iiab-diagnostics.README.md
@@ -0,0 +1,60 @@
+## Objective
+
+To streamline troubleshooting of remote Internet-in-a-Box (IIAB) installations, we bundle up common machine/software diagnostics, all together in 1 human-readable file, that can be easily circulated online AND offline.
+
+The ``pastebinit`` command can then be used to upload this file, creating a short URL that makes things even easier.
+
+But first off, the file is compiled by harvesting 3 kinds of things:
+
+1. Files
+   1. /etc/iiab/iiab.env
+   2. /etc/iiab/iiab.ini
+   3. /etc/iiab/local_vars.yml
+   4. /etc/iiab/config_vars.yml
+   5. /etc/iiab/openvpn_handle
+   6. /opt/iiab/iiab-install.log
+   7. /opt/iiab/iiab-debug.log
+   8. /opt/iiab/iiab-network.log
+   9. /etc/resolv.conf
+   10. /etc/network/interfaces
+   11. /usr/bin/iiab-gen-iptables
+
+2. Contents of directories:
+   1. /etc/network/interfaces.d
+   2. /etc/sysconfig/network-scripts/if-cfg*
+   3. /etc/NetworkManager/system-connections
+   4. /etc/systemd/network/
+
+3. Output from commands:
+   1. ansible localhost -m setup 2>/dev/null    # All Ansible facts
+   2. ip addr    # Network interfaces
+   3. ifconfig    # Older view
+   4. brctl show    # Bridge for LAN side
+   5. netstat -rn    # Routing table
+   6. netstat -natp    # Ports/Services in use
+   7. systemctl status dnsmasq    # Is dnsmasq running?
+   8. journalctl -u dnsmasq    # dnsmasq log
+
+#### Suggested Usage 
+
+1. Run the diagnostics:
+
+   ```
+   sudo iiab-diagnostics
+   ```
+
+   ( This will bundle up all the diagnostics, into a new file places in: /etc/iiab/diagnostics/ )
+
+2. Upload the file using the pastebinit command:
+
+   ```
+   pastebinit < /etc/iiab/diagnostics/<name of file you just created>
+   ```
+   
+   This will generalte a link (URL).
+
+3. Post the link (URL) to a "New issue" at https://github.com/iiab/iiab/issues
+
+   Include a description of the symptoms, and how to reproduce the problem.
+
+4. If you don't understand Step 3, email everything to bugs@iiab.io instead.