Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(screenshots): update screenshots for 2.3.0 #105

Merged
merged 9 commits into from
Apr 27, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion guides/_subsections/add-a-trusted-certificate.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## [Add a Trusted Certificate](#-add-a-trusted-certificate)
## [Add a Trusted Certificate](#add-a-trusted-certificate)
If you have Java Management Extensions (JMX) over SSL enabled on your containerized JVMs, you must configure Cryostat to trust the SSL certificate presented by the containerized JVM when Cryostat attempts to open a JMX connection. If you do not complete this configuration, Cryostat cannot open a JMX connection for the purposes of performing JFR management tasks.

Here's how to add a trusted SSL certificate with the Cryostat web UI.
Expand Down
2 changes: 1 addition & 1 deletion guides/_subsections/automated-analysis.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## [View and Download Automated Analysis for a Recording](#automated-analysis)
## [View and Download Automated Analysis for a Recording](#view-and-download-automated-analysis-for-a-recording)
Cryostat integrates the same automated analysis reports that you would
find in [JDK Mission Control](https://github.com/openjdk/jmc). The
JMC rules engine analyzes your recording and looks for common problems
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## [Configure JMX Credentials Storage](#configure-jmx-credentials-storage)
## [Configure Credentials Storage](#configure-credentials-storage)

Target JVM applications may require Cryostat to pass an authentication challenge before being able to communicate over JMX
and manage JFR. Cryostat has two supported mechanisms for these JMX credentials:
Target JVM applications may require Cryostat to pass an authentication challenge before being able to communicate over JMX or HTTP
and manage JFR. Cryostat has two supported mechanisms for these credentials:
<ol>
<li>
<b>JMX Credentials Keyring</b>: see <a href="#store-jmx-credentials">Store JMX Credentials</a> for more detail.
This mechanism entails uploading a JMX Credentials definition to the Cryostat backend keyring storage. Cryostat
<b>Credentials Keyring</b>: see <a href="#store-credentials">Store Credentials</a> for more detail.
This mechanism entails uploading a Credentials definition to the Cryostat backend keyring storage. Cryostat
automatically checks the keyring for credentials matching a target application when a request to that application
is opened. If no credentials are found, Cryostat responds to the requesting client (e.g. the Cryostat Web UI) with
a response indicating the JMX authentication failure.
a response indicating the authentication failure.
</li>
<li>
<b>X-JMX-Authorization</b> header passthrough: when the Cryostat Web UI receives a JMX authentication failure response
Expand All @@ -23,19 +23,19 @@ and manage JFR. Cryostat has two supported mechanisms for these JMX credentials:
</ol>

Now that you understand the difference, let's continue to see how you can configure the Cryostat Web UI to use one
or the other when you complete a JMX Authentication prompt.
or the other when you complete a Authentication prompt.

<ol>
<li>
{% include_relative _subsections/common/navigate-to-settings.md %}
</li>
<li>
{% include howto_step.html
summary="Locate the JMX Credentials Storage card"
image-name="2.3.0/jmx-credentials-card.png"
summary="Locate the Credentials Storage setting"
image-name="2.3.0/credentials-setting.png"
text="
This card contains a brief explanation of its purpose and a simple dropdown menu with selections for where any
JMX Credentials entered into a JMX <i>Authentication Required</i> challenge modal will be stored.
This setting contains a brief explanation of its purpose and a simple dropdown menu with selections for where any
Credentials entered into a <i>Authentication Required</i> challenge modal will be stored.
Choose <i>Session (Browser Memory)</i> to use the header passthrough mechanism described above, or choose
<i>Backend</i> to automatically store the credentials in the Cryostat server keyring.
"
Expand Down
8 changes: 4 additions & 4 deletions guides/_subsections/configure-graphical-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ the web-client graphical console can become quite noisy.
</li>
<li>
{% include howto_step.html
summary="Locate the Notifications card"
image-name="2.3.0/notifications-card.png"
summary="Locate the Notifications setting"
image-name="2.3.0/notifications-setting.png"
text="
The Notifications card within this view is used to control the graphical display of notifications that
correspond to WebSocket messages sent by the Cryostat backend when actions and state changes occur. The card
The Notifications setting within this view is used to control the graphical display of notifications that
correspond to WebSocket messages sent by the Cryostat backend when actions and state changes occur. The setting
contains a toggle switch for each category of notification, as well as a global switch to enable/disable all
categories at once. Disabling a notification category only prevents it from appearing as a pop-up notification
toast in the current web-client instance. The notification will still appear in the notification drawer, accessed
Expand Down
47 changes: 47 additions & 0 deletions guides/_subsections/store-credentials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## [Store Credentials](#store-credentials)
If you have Java Management Extensions (JMX) or HTTP authentication enabled on your containerized JVMs, Cryostat will prompt you to enter your credentials before it can access the JDK flight recordings on your target JVMs. You can <a href="#configure-credentials-storage">Configure Credentials Storage</a> and choose whether these credentials are held in browser memory for the current session only, or if they are uploaded to Cryostat's credentials keyring.

If you intend to use Cryostat <a href="#create-an-automated-rule">Automated Rules</a>, then you should store target application credentials in Cryostat's credentials keyring, which is outlined below. Even if you do not use Automated Rules, you may find it more convenient to store credentials in the keyring. This way, the Cryostat web UI does not need to prompt you for credentials when you manually access JFR information about target applications.

<ol>
<li>
{% include howto_step.html
summary="Navigate to the Security tab"
image-name="2.3.0/navigate-to-security.png"
text="
First, navigate to the <i>Security</i> tab. The Store Credentials table lists all credentials in Cryostat's keyring. Click <i>Add</i> to define a new set of credentials.
tthvo marked this conversation as resolved.
Show resolved Hide resolved
"
%}
</li>
<li>
{% include howto_step.html
summary="Enter your credentials"
image-name="2.3.0/store-credentials-1.png"
text="
A modal will appear. You can select a target JVM to view its properties.
These properties can be used to define a <i>matchExpression</i> that tests whether this set of credentials should apply to the selected target JVM.
tthvo marked this conversation as resolved.
Show resolved Hide resolved
This is the same kind of <i>matchExpression</i> as those used by <a href='#create-an-automated-rule'>Automated Rules</a>, so you may find it useful to reuse the same
tthvo marked this conversation as resolved.
Show resolved Hide resolved
<i>matchExpression</i> from your rule definitions for your credentials definitions.
The <i>matchExpression</i>, username, and password fields are all required.
"
%}
</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"
text="
Alternatively, credentials may also be stored if you navigate to either the <i>Recordings</i> tab or the <i>Events</i> tab and select a target JVM with authentication enabled. The authentication form will appear, prompting you to enter your credentials. If you have <a href='#configure-credentials-storage'>configured Backend Credentials Storage</a>, then a new credentials definition with the provided username and password will be stored for this specific target application in the Cryostat keyring. If you have configured credentials with the <i>Session</i> option then these entered credentials will <i>not</i> be stored in the Cryostat keyring.
"
%}
</li>
<li>
{% include howto_step.html
summary="View your stored credentials"
image-name="2.3.0/store-credentials-2.png"
text="
The <i>Store Credentials</i> table will update with rows for each of the credentials you have stored in the keyring. The <i>matchExpression</i> is visible along with a count of the number of known target applications that these credentials will apply to. You can click the reverse chevron icon at the left of the table row to expand the row, which will display a list of those matched target applications. For security reasons it is not possible to view the stored username and password associated with a credentials definition in the keyring.
tthvo marked this conversation as resolved.
Show resolved Hide resolved
"
%}
</li>
</ol>
47 changes: 0 additions & 47 deletions guides/_subsections/store-jmx-credentials.md

This file was deleted.

6 changes: 3 additions & 3 deletions guides/_subsections/view-archived-recordings.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## [Viewing Archived Recordings](#view-archived-recordings)
## [Viewing Archived Recordings](#viewing-archived-recordings)
There are several ways to view <i>Archived Recordings</i>. The first method is to navigate to the Archived Recordings tab. See <a href="#archive-a-recording">Archive a Recording</a>.

### [All-Targets Archived Recordings View](#all-targets-archived-recordings-view)

The second method is to navigate to the new <i>All-Targets</i> archived recording view within the <i>Archives</i> tab on Cryostat console sidebar.
The second method is to navigate to the <i>All-Targets</i> archived recording view within the <i>Archives</i> tab on Cryostat console sidebar.

The All-Targets view gathers all of Cryostat's discovered target JVM applications into one section for ease of access. Here, we are able to interact with any archived recordings that have been saved from a source target by opening a target's nested recordings table.

Expand Down Expand Up @@ -36,7 +36,7 @@ The All-Targets view gathers all of Cryostat's discovered target JVM application

### [All-Archives Archived Recordings View](#all-archives-archived-recordings-view)

The third method is to navigate to the new <i>All-Archives</i> archived recording view within the <i>Archives</i> tab on Cryostat console sidebar.
The third method is to navigate to the <i>All-Archives</i> archived recording view within the <i>Archives</i> tab on Cryostat console sidebar.

The All-Archives view is a view which queries Cryostat's internal storage for any created archived recordings and the directories that contain them. Here, we are able to interact with any archived recordings that have been saved into storage by opening a nested recordings table within each directory.

Expand Down
2 changes: 1 addition & 1 deletion guides/_subsections/view-in-grafana.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## [View a Recording in Grafana](#view-in-grafana)
## [View a Recording in Grafana](#view-a-recording-in-grafana)
Cryostat provides integration with Grafana to plot curated time series
metrics from a recording. By selecting _View in Grafana_ on either an
_Active_ or _Archived Recording_, Cryostat uploads your recording to
Expand Down
4 changes: 2 additions & 2 deletions guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ common actions and workflows of interest and why they are useful.

{% include_relative _subsections/add-and-edit-recording-metadata-labels.md %}

{% include_relative _subsections/store-jmx-credentials.md %}
{% include_relative _subsections/store-credentials.md %}

{% include_relative _subsections/configure-jmx-credentials-storage.md %}
{% include_relative _subsections/configure-credentials-storage.md %}

{% include_relative _subsections/add-a-trusted-certificate.md %}

Expand Down
Binary file modified images/2.3.0/add-a-trusted-certificate-upload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/add-and-edit-recording-metadata-labels-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/add-and-edit-recording-metadata-labels-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/add-and-edit-recording-metadata-labels-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/add-and-edit-recording-metadata-labels-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/add-and-edit-recording-metadata-labels-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/add-and-edit-recording-metadata-labels-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/add-and-edit-recording-metadata-labels-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/add-and-edit-recording-metadata-labels-8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/archive-a-recording-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/archive-a-recording-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/automated-analysis-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/automated-analysis-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/automated-analysis-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/automated-analysis-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/click-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/create-an-automated-rule-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/create-an-automated-rule-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/create-an-automated-rule-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/create-an-automated-rule-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/create-an-automated-rule-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/create-an-automated-rule-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/2.3.0/credentials-setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/download-an-active-or-archived-recording-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/2.3.0/download-an-automated-rule-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/2.3.0/jmx-credentials-card.png
Diff not rendered.
Binary file modified images/2.3.0/navigate-to-all-archives.png
Binary file modified images/2.3.0/navigate-to-all-targets.png
Binary file modified images/2.3.0/navigate-to-events-1.png
Binary file modified images/2.3.0/navigate-to-events-2.png
Binary file modified images/2.3.0/navigate-to-recordings-1.png
Binary file modified images/2.3.0/navigate-to-recordings-2.png
Binary file modified images/2.3.0/navigate-to-security.png
Binary file modified images/2.3.0/navigate-to-settings.png
Binary file removed images/2.3.0/notifications-card.png
Diff not rendered.
Binary file added images/2.3.0/notifications-setting.png
Binary file modified images/2.3.0/re-upload-a-recording-to-archives-1.png
Binary file modified images/2.3.0/re-upload-a-recording-to-archives-2.png
Binary file modified images/2.3.0/re-upload-a-recording-to-archives-3.png
Binary file modified images/2.3.0/re-upload-a-recording-to-archives-4.png
Binary file modified images/2.3.0/select-a-recording.png
Binary file modified images/2.3.0/select-target-application.png
Binary file modified images/2.3.0/snapshot-a-recording-1.png
Binary file modified images/2.3.0/snapshot-a-recording-2.png
Binary file modified images/2.3.0/startstop-a-recording-1.png
Binary file modified images/2.3.0/startstop-a-recording-2.png
Binary file modified images/2.3.0/startstop-a-recording-3.png
Binary file added images/2.3.0/store-credentials-1.png
Binary file added images/2.3.0/store-credentials-2.png
Binary file removed images/2.3.0/store-jmx-credentials-1.png
andrewazores marked this conversation as resolved.
Outdated
Show resolved Hide resolved
Diff not rendered.
Binary file removed images/2.3.0/store-jmx-credentials-2.png
Diff not rendered.
Binary file modified images/2.3.0/upload-an-automated-rule-1.png
Binary file modified images/2.3.0/upload-an-automated-rule-2.png
Binary file modified images/2.3.0/view-archives-recordings-1.png
Binary file modified images/2.3.0/view-archives-recordings-2.png
Binary file modified images/2.3.0/view-in-grafana-1.png