From d0b581fff80fbd3fdd4478d21902f487afb818a4 Mon Sep 17 00:00:00 2001 From: Dominika Vagnerova Date: Mon, 4 Sep 2023 16:09:35 +0200 Subject: [PATCH] cryostat docs fixes to address QE review #1831 --- .../topics/proc_deploying_cryostat.adoc | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/documentation/asciidoc/topics/proc_deploying_cryostat.adoc b/documentation/asciidoc/topics/proc_deploying_cryostat.adoc index 3ea217706..b2adc226b 100644 --- a/documentation/asciidoc/topics/proc_deploying_cryostat.adoc +++ b/documentation/asciidoc/topics/proc_deploying_cryostat.adoc @@ -9,7 +9,7 @@ Depending on your requirements, you can store and analyze your recordings using .Prerequisites * Install the Cryostat Operator. You can install the Cryostat Operator in your {k8s} project by using Operator Lifecycle Manager (OLM). -* link:{k8s_docs}#enabling-jmx_monitor[Enable JMX] on your cluster. +* Have JMX enabled on your {brandname} cluster. You must enable JMX before deploying the cluster, as JMX settings cannot be modified after deployment. .Procedure @@ -19,19 +19,26 @@ Depending on your requirements, you can store and analyze your recordings using ---- include::yaml/cryostat.yaml[] ---- ++ +[NOTE] +==== +The Cryostat Operator requires cert-manager for traffic encryption. +If the cert-manager is enabled but not installed, the deployment fails. +For details, see the {cryostat_installation} guide. +==== . Wait for the `Cryostat` CR to be ready. + [source,options="nowrap",subs=attributes+] ---- -{oc} wait -n --for=condition=MainDeploymentAvailable cryostat/test-cryostat-provisioning-cs +{oc} wait -n --for=condition=MainDeploymentAvailable cryostat/cryostat-sample ---- . Open the Cryostat `status.applicationUrl`. + [source,options="nowrap",subs=attributes+] ---- -{oc} -n get cryostat {example_crd_name}-cs +{oc} -n get cryostat cryostat-sample ---- . Retrieve the Operator user credentials to authenticate client JMX connections in the Cryostat UI. @@ -41,7 +48,10 @@ include::yaml/cryostat.yaml[] include::cmd_examples/oc_get_secret_operator_creds_jp.adoc[] ---- -. Optionally store the credentials from the previous step, using the following "Match Expression": +. In the Cryostat UI, navigate to the *Security* menu. +. In the *Store Credentials* window, click the *Add* button. +The *Store Credentials* window opens. +. In the *Match Expression* filed, enter match expression details in the following format: + [source] ---- @@ -51,3 +61,4 @@ target.labels['infinispan_cr'] == '' .Additional resources * link:{cryostat_installation} * link:{cryostat_security_configuration} +* link:{k8s_docs}#enabling-jmx_monitor[Enabling JMX remote ports for {brandname} clusters] \ No newline at end of file