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

chore(release): create 2.4.0 versioned images copy, update references in latest guides #149

Merged
Show file tree
Hide file tree
Changes from all 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
4 changes: 2 additions & 2 deletions guides/_subsections/add-a-trusted-certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ Here's how to add a trusted SSL certificate with the Cryostat web UI.
<li>
{% include howto_step.html
summary="Navigate to the Security tab"
image-name="2.3.0/navigate-to-security.png"
image-name="2.4.0/navigate-to-security.png"
text="Click the <i>Security</i> tab."
%}
</li>
<li>
{% include howto_step.html
summary="Upload the Certificate"
image-name="2.3.0/add-a-trusted-certificate-upload.png"
image-name="2.4.0/add-a-trusted-certificate-upload.png"
text="
Click the <i>Upload</i> button on the <i>Import SSL Certificates</i> card. This action opens a file-upload dialog, where you can choose the certificate that you want to upload to Cryostat. You can repeat this process multiple times to add multiple trusted certificates.
"
Expand Down
20 changes: 10 additions & 10 deletions guides/_subsections/add-and-edit-recording-metadata-labels.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Users can attach metadata or custom labels to JDK flight recordings managed by C
<li>
{% include howto_step.html
summary="Add metadata labels to the Create Recording form"
image-name="2.3.0/add-and-edit-recording-metadata-labels-1.png"
image-name="2.4.0/add-and-edit-recording-metadata-labels-1.png"
text="
When creating a custom flight recording with Cryostat, expand the form section <i>Show metadata options</i>. Click <i>Add Label</i> and add key-value label pairs to the form. Finally, click <i>Create</i> to attach the labels and create the recording.
"
Expand All @@ -20,7 +20,7 @@ Users can attach metadata or custom labels to JDK flight recordings managed by C
<li>
{% include howto_step.html
summary="View your labels on the Active Recordings Table"
image-name="2.3.0/add-and-edit-recording-metadata-labels-2.png"
image-name="2.4.0/add-and-edit-recording-metadata-labels-2.png"
text="
The new recording will appear in the Recordings tab with your custom label as well as default labels containing information about the selected recording template.
"
Expand All @@ -31,23 +31,23 @@ Users can attach metadata or custom labels to JDK flight recordings managed by C
<p>
Recording labels can also be edited after recordings have been created or re-uploaded to archives. It looks like the custom label in our example contains a typo - we can fix the typo by editing the label. First select a recording from the table with the 🗹 checkbox. Then, click the <i>Edit Labels</i> button to bring up the label drawer. Finally, click the <i>Edit</i> button that appears from the drawer.
<br><br>
<a href="{{ site.url }}/images/2.3.0/add-and-edit-recording-metadata-labels-4.png" target="_blank">
<img src="{{ site.url }}/images/2.3.0/add-and-edit-recording-metadata-labels-4.png">
<a href="{{ site.url }}/images/2.4.0/add-and-edit-recording-metadata-labels-4.png" target="_blank">
<img src="{{ site.url }}/images/2.4.0/add-and-edit-recording-metadata-labels-4.png">
</a>
<br><br>
The labels section will appear as a form where you can add, edit, or delete existing labels, just like before when we created the recording. Fix the typo, and click <i>Save</i> to save your edited labels.
</p>
{% endcapture %}
{% include howto_step.html
summary="Edit an existing label"
image-name="2.3.0/add-and-edit-recording-metadata-labels-3.png"
image-name="2.4.0/add-and-edit-recording-metadata-labels-3.png"
text=edit-an-existing-label-text
%}
</li>
<li>
{% include howto_step.html
summary="View your edited labels"
image-name="2.3.0/add-and-edit-recording-metadata-labels-5.png"
image-name="2.4.0/add-and-edit-recording-metadata-labels-5.png"
text="
The recording labels should be updated in the Active Recordings table.
"
Expand All @@ -56,7 +56,7 @@ Users can attach metadata or custom labels to JDK flight recordings managed by C
<li>
{% include howto_step.html
summary="<i>(Optional)</i> Archive your recording to view labels copied onto the archived recording"
image-name="2.3.0/add-and-edit-recording-metadata-labels-6.png"
image-name="2.4.0/add-and-edit-recording-metadata-labels-6.png"
text="
On the Active Recordings table, click the checkbox next to the recording, then click <i>Archive</i> to archive your recording. Notice that the archived recording also copies the labels from the active recording. You can also add labels to any recording uploaded to Cryostat’s archives.
"
Expand All @@ -67,16 +67,16 @@ Users can attach metadata or custom labels to JDK flight recordings managed by C
<p>
Create another recording on the same target. Then select both recordings on the Recordings Table and click <i>Edit Labels</i> and <i>Edit</i>.This time, only labels that are present on both recordings will be shown in the form. Let's delete the two common template-related labels, and add a new label to both recordings. Then finally, click <i>Save</i>.
<br><br>
<a href="{{ site.url }}/images/2.3.0/add-and-edit-recording-metadata-labels-8.png" target="_blank">
<img src="{{ site.url }}/images/2.3.0/add-and-edit-recording-metadata-labels-8.png">
<a href="{{ site.url }}/images/2.4.0/add-and-edit-recording-metadata-labels-8.png" target="_blank">
<img src="{{ site.url }}/images/2.4.0/add-and-edit-recording-metadata-labels-8.png">
</a>
<br><br>
Congratulations, you have successfully bulk-edited labels across multiple recordings!
</p>
{% endcapture %}
{% include howto_step.html
summary="<i>(Optional)</i> Bulk-edit recording labels across multiple recordings"
image-name="2.3.0/add-and-edit-recording-metadata-labels-7.png"
image-name="2.4.0/add-and-edit-recording-metadata-labels-7.png"
text=bulk-edit-recording-labels-text
%}
</li>
Expand Down
4 changes: 2 additions & 2 deletions guides/_subsections/archive-a-recording.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ any state (`RUNNING`, `STOPPED`, etc.), and may even be a snapshot.
{% endcapture %}
{% include howto_step.html
summary="Select an Active Recording"
image-name="2.3.0/archive-a-recording-1.png"
image-name="2.4.0/archive-a-recording-1.png"
caption=select-recording-additional-content
%}
</li>
Expand All @@ -39,7 +39,7 @@ any state (`RUNNING`, `STOPPED`, etc.), and may even be a snapshot.
<li>
{% include howto_step.html
summary="Navigate to the <i>Archived Recordings</i> tab"
image-name="2.3.0/archive-a-recording-2.png"
image-name="2.4.0/archive-a-recording-2.png"
caption="
Once the recording has been archived, a new entry will appear in the
target JVM's <i>Archived Recordings</i> table. All recordings that were
Expand Down
14 changes: 7 additions & 7 deletions guides/_subsections/automated-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Cryostat also provides an *Automated Analysis Card* that is able to display the
<li>
{% include howto_step.html
summary="Expand the recording"
image-name="2.3.0/automated-analysis-1.png"
image-name="2.4.0/automated-analysis-1.png"
caption="
Expand the recording with the chevron to the left of the recording
name. The automated analysis report will appear below the recording.
Expand All @@ -43,7 +43,7 @@ Cryostat also provides an *Automated Analysis Card* that is able to display the
<li>
{% include howto_step.html
summary="View details and suggestions for results"
image-name="2.3.0/automated-analysis-2.png"
image-name="2.4.0/automated-analysis-2.png"
caption="
Click the <i>+</i> button on the right side of each result to view
specifics on what the result means and possible suggestions to fix
Expand All @@ -55,8 +55,8 @@ Cryostat also provides an *Automated Analysis Card* that is able to display the
{% capture download-report-text %}
<p>
<figure>
<a href="{{ site.url }}/images/2.3.0/automated-analysis-4.png" target="_blank">
<img src="{{ site.url }}/images/2.3.0/automated-analysis-4.png">
<a href="{{ site.url }}/images/2.4.0/automated-analysis-4.png" target="_blank">
<img src="{{ site.url }}/images/2.4.0/automated-analysis-4.png">
</a>
<figcaption>
View the report on its own without connecting to Cryostat.
Expand All @@ -65,8 +65,8 @@ Cryostat also provides an *Automated Analysis Card* that is able to display the
</figcaption>
</figure>
<figure>
<a href="{{ site.url }}/images/2.3.0/automated-analysis-5.png" target="_blank">
<img src="{{ site.url }}/images/2.3.0/automated-analysis-5.png">
<a href="{{ site.url }}/images/2.4.0/automated-analysis-5.png" target="_blank">
<img src="{{ site.url }}/images/2.4.0/automated-analysis-5.png">
</a>
<figcaption>
To download the HTML <i>Automated Analysis</i> report to local disk, right click
Expand All @@ -78,7 +78,7 @@ Cryostat also provides an *Automated Analysis Card* that is able to display the
{% endcapture %}
{% include howto_step.html
summary="Download the report"
image-name="2.3.0/automated-analysis-3.png"
image-name="2.4.0/automated-analysis-3.png"
caption="
To download the automated analysis report for offline viewing,
select <i>View Report ...</i> from the recording's overflow
Expand Down
2 changes: 1 addition & 1 deletion guides/_subsections/common/card-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{% endcapture %}
{% include howto_step.html
summary="Open the Card Catalog"
image-name="2.3.0/dashboard/card-catalog.png"
image-name="2.4.0/dashboard/card-catalog.png"
caption="Open the card catalog by clicking the Catalog icon on the Dashboard toolbar."
text=card-catalog-include-text
%}
2 changes: 1 addition & 1 deletion guides/_subsections/common/click-create.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% include howto_step.html
summary="Click <i>Create</i>"
image-name="2.3.0/click-create.png"
image-name="2.4.0/click-create.png"
%}
2 changes: 1 addition & 1 deletion guides/_subsections/common/layout-selector.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ The layout selector contains a list of all available layouts. The currently sele
{% endcapture %}
{% include howto_step.html
summary="Open the layout selector dropdown"
image-name="2.3.0/dashboard/dashboard-layoutselector.png"
image-name="2.4.0/dashboard/dashboard-layoutselector.png"
caption="Click the layout selector dropdown to view the available layouts."
text=layout-selector-text
%}
2 changes: 1 addition & 1 deletion guides/_subsections/common/navigate-to-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{% endcapture %}
{% include howto_step.html
summary="Navigate to <i>Dashboard</i>"
image-name="2.3.0/navigate-to-dashboard.png"
image-name="2.4.0/navigate-to-dashboard.png"
caption="Add dashboard cards, switch between dashboard layouts, and modify the layout configuration to suit your needs."
text=navigate-to-dashboard-include-text
%}
6 changes: 3 additions & 3 deletions guides/_subsections/common/navigate-to-recordings.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
necessary to add the target's certificate to Cryostat's trust store. Go
to <a href="{{ site.url }}/guides/#add-a-trusted-certificate">Add a Trusted Certificate</a>
and return to this section after completing that guide.
<a href="{{ site.url }}/images/2.3.0/navigate-to-recordings-2.png" target="_blank">
<img src="{{ site.url }}/images/2.3.0/navigate-to-recordings-2.png">
<a href="{{ site.url }}/images/2.4.0/navigate-to-recordings-2.png" target="_blank">
<img src="{{ site.url }}/images/2.4.0/navigate-to-recordings-2.png">
</a>
{{ include.additional-content }}
{% endcapture %}
{% include howto_step.html
summary="Navigate to Recordings"
image-name="2.3.0/navigate-to-recordings-1.png"
image-name="2.4.0/navigate-to-recordings-1.png"
caption="
Supply JMX credentials to authenticate to the target, if necessary. If
the target is not configured with JMX authentication then the
Expand Down
2 changes: 1 addition & 1 deletion guides/_subsections/common/navigate-to-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
{% endcapture %}
{% include howto_step.html
summary="Navigate to Settings"
image-name="2.3.0/navigate-to-settings.png"
image-name="2.4.0/navigate-to-settings.png"
caption="
Click the cog or gear icon in the application masthead to access the Settings view.
"
Expand Down
2 changes: 1 addition & 1 deletion guides/_subsections/common/navigate-to-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{% endcapture %}
{% include howto_step.html
summary="Navigate to Topology"
image-name="2.3.0/navigate-to-topology.png"
image-name="2.4.0/navigate-to-topology.png"
caption="Use the bottom control bar to adjust the graph view as needed."
text=navigate-to-topology-include-text
%}
2 changes: 1 addition & 1 deletion guides/_subsections/common/select-a-recording.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
{% endcapture %}
{% include howto_step.html
summary="Select a recording"
image-name="2.3.0/select-a-recording.png"
image-name="2.4.0/select-a-recording.png"
caption=caption-content
text=text-content
%}
2 changes: 1 addition & 1 deletion guides/_subsections/common/select-target-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
{% endcapture %}
{% include howto_step.html
summary="Select the target application"
image-name="2.3.0/select-target-application.png"
image-name="2.4.0/select-target-application.png"
caption=caption-content
text=text-content
%}
2 changes: 1 addition & 1 deletion guides/_subsections/configure-credentials-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ or the other when you complete a Authentication prompt.
<li>
{% include howto_step.html
summary="Locate the Credentials Storage setting"
image-name="2.3.0/credentials-setting.png"
image-name="2.4.0/credentials-setting.png"
text="
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.
Expand Down
2 changes: 1 addition & 1 deletion guides/_subsections/configure-graphical-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ the web-client graphical console can become quite noisy.
<li>
{% include howto_step.html
summary="Locate the Notifications setting"
image-name="2.3.0/notifications-setting.png"
image-name="2.4.0/notifications-setting.png"
text="
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
Expand Down
18 changes: 9 additions & 9 deletions guides/_subsections/create-a-custom-target.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ By default, Cryostat automatically discovers target JVMs over remote Java Manage
<p>
Search for <i>Custom Target</i> tab and click <i>Create</i> to open the <i>Custom Target</i> form.
<figure>
<a href="{{ site.url }}/images/2.3.0/custom-target-1.png" target="_blank">
<img src="{{ site.url }}/images/2.3.0/custom-target-1.png">
<a href="{{ site.url }}/images/2.4.0/custom-target-1.png" target="_blank">
<img src="{{ site.url }}/images/2.4.0/custom-target-1.png">
</a>
<figcaption>
Use the <i>Custom Target</i> form to tell Cryostat about a JVM application that are not automatically discovered.
Expand All @@ -22,15 +22,15 @@ By default, Cryostat automatically discovers target JVMs over remote Java Manage
{% endcapture %}
{% include howto_step.html
summary="Open the <i>Custom Target</i> form"
image-name="2.3.0/topology-7.png"
image-name="2.4.0/topology-7.png"
caption="Click on Catalog Icon to open the Topology Entity Catalog."
text=open-custom-target-form-text
%}
</li>
<li>
{% include howto_step.html
summary="Enter <i>Custom Target</i> definition"
image-name="2.3.0/custom-target-2.png"
image-name="2.4.0/custom-target-2.png"
caption="Use the form to enter the <i>Custom Target</i> definition."
text="
The <code>Connection URL</code> is required for Cryostat to attempt to find the target. You can optionally provide an <code>Alias</code> or <code>JMX credentials</code> if the target has JMX authentication enabled.
Expand All @@ -42,8 +42,8 @@ By default, Cryostat automatically discovers target JVMs over remote Java Manage
<p>
Once you enter a valid connection URL, click on the sample node to test the target connection.
<figure>
<a href="{{ site.url }}/images/2.3.0/custom-target-4.png" target="_blank">
<img src="{{ site.url }}/images/2.3.0/custom-target-4.png">
<a href="{{ site.url }}/images/2.4.0/custom-target-4.png" target="_blank">
<img src="{{ site.url }}/images/2.4.0/custom-target-4.png">
</a>
<figcaption>
An exclamation mark and an alert banner will show if an error occurs while connecting to the target.
Expand All @@ -53,7 +53,7 @@ By default, Cryostat automatically discovers target JVMs over remote Java Manage
{% endcapture %}
{% include howto_step.html
summary="Test the <i>Custom Target</i> definition"
image-name="2.3.0/custom-target-3.png"
image-name="2.4.0/custom-target-3.png"
caption="A checkmark will show if Cryostat can connect to the sample app."
text=test-custom-target-text
%}
Expand All @@ -64,7 +64,7 @@ By default, Cryostat automatically discovers target JVMs over remote Java Manage
<li>
{% include howto_step.html
summary="View the <i>Custom Targets</i>"
image-name="2.3.0/custom-target-5.png"
image-name="2.4.0/custom-target-5.png"
caption="The <i>Custom Target</i> will be available under <i>Custom Targets</i> realm."
text="
Once the <i>Custom Target</i> form is successfully submitted, you will be redirected to the Topology View. Here, you can view your target under <i>Custom Targets</i> realm.
Expand All @@ -74,7 +74,7 @@ By default, Cryostat automatically discovers target JVMs over remote Java Manage
<li>
{% include howto_step.html
summary="<i>(Optional)</i> Delete <i>Custom Targets</i>"
image-name="2.3.0/custom-target-6.png"
image-name="2.4.0/custom-target-6.png"
caption="<i>Custom Targets</i> can be cleaned up with Actions menu."
text="
If the <i>Custom Targets</i> is no longer needed, in the target detail panel, click the <i>Actions</i> menu and select <b>Delete Target</b>.
Expand Down
12 changes: 6 additions & 6 deletions guides/_subsections/create-an-automated-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Previously, if we wanted to enable always-on continuous monitoring using JDK Fli
<li>
{% include howto_step.html
summary="Navigate to the <i>Automated Rules</i> tab"
image-name="2.3.0/create-an-automated-rule-1.png"
image-name="2.4.0/create-an-automated-rule-1.png"
caption="Switch to the <i>Automated Rules</i> tab."
%}
</li>
Expand All @@ -27,7 +27,7 @@ Previously, if we wanted to enable always-on continuous monitoring using JDK Fli
<li>
{% include howto_step.html
summary="Configure the new automated rule"
image-name="2.3.0/create-an-automated-rule-2.png"
image-name="2.4.0/create-an-automated-rule-2.png"
text="
<p>
<b>Name:</b> Enter a name for the new rule. The form will alert you if the name
Expand Down Expand Up @@ -113,7 +113,7 @@ target.annotations.cryostat.PORT > 3000 && target.annotations.platform[‘io.kub
<li>
{% include howto_step.html
summary="Check your match expression"
image-name="2.3.0/create-an-automated-rule-3.png"
image-name="2.4.0/create-an-automated-rule-3.png"
caption="You can select a target JVM to view its properties and use them to build your Match Expression."
text="
<p>
Expand All @@ -125,7 +125,7 @@ target.annotations.cryostat.PORT > 3000 && target.annotations.platform[‘io.kub
<li>
{% include howto_step.html
summary="<i>(Optional)</i> Adjust rule parameters"
image-name="2.3.0/create-an-automated-rule-4.png"
image-name="2.4.0/create-an-automated-rule-4.png"
caption="
Optionally set the recording options and rule parameters."
text="
Expand All @@ -147,7 +147,7 @@ target.annotations.cryostat.PORT > 3000 && target.annotations.platform[‘io.kub
<li>
{% include howto_step.html
summary="Observe the new rule in the <i>Automated Rules</i> table"
image-name="2.3.0/create-an-automated-rule-5.png"
image-name="2.4.0/create-an-automated-rule-5.png"
caption="
The new rule will appear in the <i>Automated Rules</i> table."
%}
Expand All @@ -158,7 +158,7 @@ target.annotations.cryostat.PORT > 3000 && target.annotations.platform[‘io.kub
<li>
{% include howto_step.html
summary="Observe the automatically generated recording in the <i>Active Recordings</i> table"
image-name="2.3.0/create-an-automated-rule-6.png"
image-name="2.4.0/create-an-automated-rule-6.png"
caption="
Switch to the <i>Recordings</i> tab and view the new recording in the <i>Active Recordings</i>
table."
Expand Down
Loading