From 1cfdd5f9f6ba6ade5fe4ea3d975c446b72e2d32d Mon Sep 17 00:00:00 2001 From: Andrew Azores Date: Tue, 11 Jun 2024 09:23:45 -0400 Subject: [PATCH] fix(custom-targets): remove restriction on k8s jfr-jmx/9091, explain localhost:0 (#188) * fix(custom-targets): remove restriction on k8s jfr-jmx/9091, explain localhost:0 * provide more reasons connection test may fail * formatting --- guides/_subsections/create-a-custom-target.md | 23 +++++++++++++------ 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/guides/_subsections/create-a-custom-target.md b/guides/_subsections/create-a-custom-target.md index 80eb0c6..45c140e 100644 --- a/guides/_subsections/create-a-custom-target.md +++ b/guides/_subsections/create-a-custom-target.md @@ -1,11 +1,14 @@ ## [Create a Custom Target](#create-a-custom-target) -**Cryostat** automatically discovers `target` **JVMs** using various mechanisms (e.g. -**Kubernetes API**, **JDP**, [Cryostat Agent plugin](#using-the-cryostat-agent)). -However, in some cases (e.g. for **Kubernetes API**, **JMX** port is not `9091` and -port name is not `jfr-jmx`), **Cryostat** might not see your applications. In these -scenarios you can tell **Cryostat** about them by filling out the *Custom Target* -form to specify *Custom Targets*. +**Cryostat** automatically discovers `target` **JVMs** using various mechanisms +(e.g. **Kubernetes API**, **JDP**, [Cryostat Agent plugin](#using-the-cryostat-agent)). +However, in some cases it may not be feasible or desirable to configure your +application to suit **Cryostat**'s discovery requirements. In these scenarios +you can tell **Cryostat** about them by filling out the *Custom Target* form to +specify *Custom Targets*. This can also be used to have **Cryostat** register +itself as a discovered target by using the special value `localhost:0`, which +informs **Cryostat**'s **JVM** to use a special **JMX** connection to itself +without going through the network stack.
  1. @@ -57,7 +60,13 @@ form to specify *Custom Targets*.
    An exclamation mark and an alert banner will show if an error - occurs while connecting to the target. + occurs while connecting to the target. This may + occur if the URL is incorrect due to incorrect hostname or + port number, or if the port is blocked by a firewall or network + policy, or if the JVM listening on the specified port requires + JMX credentials that Cryostat does not have in its keyring, or + if the JVM listening on the specified port presents an SSL/TLS + certificate which Cryostat does not trust.