feat(cred): document credentials testing table (#119)

cryostatio · May 17, 2023 · 1fc4999 · 1fc4999
1 parent f0c06d2
commit 1fc4999
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/guides/_subsections/store-credentials.md b/guides/_subsections/store-credentials.md
@@ -26,7 +26,31 @@ If you intend to use Cryostat <a href="#create-an-automated-rule">Automated Rule
       "
     %}
   </li>
-    <li>
+  <li>
+    {% include howto_step.html
+      summary="Test your credentials"
+      image-name="2.3.0/store-credentials-3.png"
+      text="
+      Navigate to the <b>Test</b> tab to use the <b>Credential Test Table</b> to check if the entered credential is valid for the matched targets.
+      <br><br>
+
+      You can individually test each target or bulk test all targets at the same time. The <b>Status</b> column will report the following test status:
+
+      <ol>
+        <li>
+            <b>Valid:</b> valid credential for the target JVM.
+        </li>
+        <li>
+            <b>Invalid:</b> invalid credential for the target JVM.
+        </li>
+        <li>
+            <b>Not applicable:</b> JMX authentication is not enabled on the target JVM.
+        </li>
+      </ol>  
+      "
+    %}
+  </li>
+  <li>
     {% include howto_step.html
       summary="(Alternative to Steps 1 and 2) Store Credentials when connecting to a target JVM"
       image-name="2.3.0/navigate-to-recordings-1.png"

diff --git a/images/2.3.0/store-credentials-3.png b/images/2.3.0/store-credentials-3.png