WIP

config/commands/debug.yaml

@@ -3,6 +3,9 @@ description: |
   Display help for debug commands and exit.
 include_options: [global/*]
 subcommands:
+  - name: diagnose
+    description: |
+      XXX
   - name: dump
     links: [skupper/debug_dumps]
     description: |

config/commands/index.yaml

@@ -13,7 +13,7 @@ groups:
   - title: System operations
     commands:
       - system
-  - title: Debug operations
+  - title: Debugging operations
     commands:
       - debug
   - title: Other operations

config/resources/link.yaml

@@ -26,10 +26,10 @@ spec:
     - name: tlsCredentials
       links: [skupper/router_tls, kubernetes/tls_secrets, skupper/system_tls_credentials]
       description: |
-        The name of a bundle of TLS certificates and keys used for
-        secure router-to-router communication.  The bundle
-        contains the trusted server certificate.  It optionally
-        includes a client certificate and key for mutual TLS.
+        The name of a bundle of certificates used for mutual TLS
+        router-to-router communication.  The bundle contains the
+        client certificate and key and the trusted server certificate
+        (usually a CA).
 
         On Kubernetes, the value is the name of a Secret in the
         current namespace.

config/resources/listener.yaml

@@ -56,12 +56,13 @@ spec:
       group: advanced
       links: [skupper/application_tls, kubernetes/tls_secrets, skupper/system_tls_credentials]
       description: |
-        The name of a bundle of TLS certificates and keys used for
-        secure client-to-router communication.  The bundle contains
-        the trusted server certificate.
+        The name of a bundle of TLS certificates used for secure
+        client-to-router communication.  The bundle contains the
+        server certificate and key.  It optionally includes the
+        trusted client certificate (usually a CA) for mutual TLS.
 
-        On Kubernetes, the value is the name of a Secret in the current
-        namespace.
+        On Kubernetes, the value is the name of a Secret in the
+        current namespace.
 
         On Docker, Podman, and Linux, the value is the name of a
         directory under `input/certs/` in the current namespace.

config/resources/properties.yaml

@@ -106,10 +106,10 @@ connector/spec/tlsCredentials:
   group: advanced
   links: [skupper/application_tls, kubernetes/tls_secrets, skupper/system_tls_credentials]
   description: |
-    The name of a bundle of TLS certificates and keys used for
-    secure router-to-server communication.  The bundle contains the
-    trusted server certificate.  It optionally includes a client
-    certificate and key for mutual TLS.
+    The name of a bundle of TLS certificates used for secure
+    router-to-server communication.  The bundle contains the trusted
+    server certificate (usually a CA).  It optionally includes a
+    client certificate and key for mutual TLS.
 
     On Kubernetes, the value is the name of a Secret in the current
     namespace.

config/resources/router-access.yaml

@@ -17,10 +17,10 @@ spec:
     - name: tlsCredentials
       links: [skupper/router_tls, kubernetes/tls_secrets, skupper/system_tls_credentials]
       description: |
-        The name of a bundle of TLS certificates and keys used for
-        secure router-to-router communication.  The bundle
-        contains the trusted server certificate.  It optionally
-        includes a client certificate and key for mutual TLS.
+        The name of a bundle of TLS certificates used for mutual TLS
+        router-to-router communication.  The bundle contains the
+        server certificate and key and the trusted client certificate
+        (usually a CA).
 
         On Kubernetes, the value is the name of a Secret in the
         current namespace.

input/commands/debug/index.md

@@ -38,6 +38,8 @@ skupper debug [subcommand] [options]
 ## Subcommands
 
 <table class="objects">
+<tr><th><a href="diagnose.html">Debug diagnose</a></th><td><p>XXX</p>
+</td></tr>
 <tr><th><a href="dump.html">Debug dump</a></th><td><p>Generate a debug dump file</p>
 </td></tr>
 </table>

input/commands/index.md

@@ -102,10 +102,12 @@ refdog_object_links:
 </table>
 
 
-#### Debug operations
+#### Debugging operations
 
 <table class="objects">
 <tr><th><a href="{{site_prefix}}/commands/debug/index.html">Debug</a></th><td>Overview of debug commands</td></tr>
+<tr><th><a href="{{site_prefix}}/commands/debug/diagnose.html">Debug diagnose</a></th><td><p>XXX</p>
+</td></tr>
 <tr><th><a href="{{site_prefix}}/commands/debug/dump.html">Debug dump</a></th><td><p>Generate a debug dump file</p>
 </td></tr>
 </table>

input/resources/attached-connector.md

@@ -166,10 +166,10 @@ If true, expose each pod as an individual service.
 </div>
 <div class="attribute-body">
 
-The name of a bundle of TLS certificates and keys used for
-secure router-to-server communication.  The bundle contains the
-trusted server certificate.  It optionally includes a client
-certificate and key for mutual TLS.
+The name of a bundle of TLS certificates used for secure
+router-to-server communication.  The bundle contains the trusted
+server certificate (usually a CA).  It optionally includes a
+client certificate and key for mutual TLS.
 
 On Kubernetes, the value is the name of a Secret in the current
 namespace.

input/resources/connector.md

@@ -207,10 +207,10 @@ If true, expose each pod as an individual service.
 </div>
 <div class="attribute-body">
 
-The name of a bundle of TLS certificates and keys used for
-secure router-to-server communication.  The bundle contains the
-trusted server certificate.  It optionally includes a client
-certificate and key for mutual TLS.
+The name of a bundle of TLS certificates used for secure
+router-to-server communication.  The bundle contains the trusted
+server certificate (usually a CA).  It optionally includes a
+client certificate and key for mutual TLS.
 
 On Kubernetes, the value is the name of a Secret in the current
 namespace.

input/resources/link.md

@@ -115,10 +115,10 @@ the link.
 </div>
 <div class="attribute-body">
 
-The name of a bundle of TLS certificates and keys used for
-secure router-to-router communication.  The bundle
-contains the trusted server certificate.  It optionally
-includes a client certificate and key for mutual TLS.
+The name of a bundle of certificates used for mutual TLS
+router-to-router communication.  The bundle contains the
+client certificate and key and the trusted server certificate
+(usually a CA).
 
 On Kubernetes, the value is the name of a Secret in the
 current namespace.

input/resources/listener.md

@@ -174,12 +174,13 @@ If true, expose each pod as an individual service.
 </div>
 <div class="attribute-body">
 
-The name of a bundle of TLS certificates and keys used for
-secure client-to-router communication.  The bundle contains
-the trusted server certificate.
+The name of a bundle of TLS certificates used for secure
+client-to-router communication.  The bundle contains the
+server certificate and key.  It optionally includes the
+trusted client certificate (usually a CA) for mutual TLS.
 
-On Kubernetes, the value is the name of a Secret in the current
-namespace.
+On Kubernetes, the value is the name of a Secret in the
+current namespace.
 
 On Docker, Podman, and Linux, the value is the name of a
 directory under `input/certs/` in the current namespace.

input/resources/router-access.md

@@ -97,10 +97,10 @@ include "inter-router" for links between interior routers and
 </div>
 <div class="attribute-body">
 
-The name of a bundle of TLS certificates and keys used for
-secure router-to-router communication.  The bundle
-contains the trusted server certificate.  It optionally
-includes a client certificate and key for mutual TLS.
+The name of a bundle of TLS certificates used for mutual TLS
+router-to-router communication.  The bundle contains the
+server certificate and key and the trusted client certificate
+(usually a CA).
 
 On Kubernetes, the value is the name of a Secret in the
 current namespace.

input/topics/debug-dumps.md

@@ -1,12 +1,17 @@
 # Debug dumps
 
-- The purpose of a debug dump is to package up details of a site so
-  another party can identify and fix a problem.
+- The purpose of a debug dump is to package up the details of a site
+  so another party can identify and fix a problem.
 - A dump is a tarball containing various files with the site details.
 - Key elements include site resources and status; component versions,
   config files, and logs; and info about the environment where Skupper
   is running.
 
+- Should we include workloads in the namespace?  Services, deployments, pods?
+- .txt file summaries for some things?
+- What details about the overall network should we get?
+  - Links from other sites?
+
 ~~~
 versions.yaml  # Same as the output of 'skupper version --output yaml'
 platform.yaml  # Info about the platform and namespace hosting the site