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

feat(release): update for Cryostat 4.0.0 release #203

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 10 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
13 changes: 7 additions & 6 deletions _data/versions.yaml
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
cryostat:
version: '3.0.0'
release-branch: 'cryostat-v3.0'
version: '4.0.0'
release-branch: 'cryostat-v4.0'
agent:
version: '0.4.0'
version: '0.5.0'
openshift:
version: '4.12'
version: '4.14'
kubernetes:
version: '1.25'
version: '1.29'
operator-sdk:
version: '1.31.0'
operator-lifecycle-manager:
version: '0.25.0'
cert-manager:
version: '1.11.5'
version: '1.13.6'
documentation:
- 'latest'
- 3.0.0
- 2.4.0
- 2.3.0
- 2.2.0
Expand Down
192 changes: 71 additions & 121 deletions get-started/index.md

Large diffs are not rendered by default.

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 @@ -5,7 +5,7 @@ If you have Java Management Extensions **(JMX)** over `SSL` enabled on your cont
<li>
{% include howto_step.html
summary="Navigate to the <i>Security</i> Tab"
image-name="3.0.0/navigate-to-security.png"
image-name="4.0.0/navigate-to-security.png"
text="Click the <i>Security</i> tab. This should initially be in an empty state if you have not yet defined any additional trusted certificates."
%}
</li>
Expand All @@ -28,7 +28,7 @@ certificate(s) within the truststore directory.
<li>
{% include howto_step.html
summary="Navigate to the <i>Security</i> Tab"
image-name="3.0.0/navigate-to-security-with-certs.png"
image-name="4.0.0/navigate-to-security-with-certs.png"
text="Click the <i>Security</i> tab. The file paths of any additional trusted certificates you have added should appear in the list."
%}
</li>
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` ma
<li>
{% include howto_step.html
summary="Add <code>Metadata Labels</code> to the <i>Create Recording</i> form"
image-name="3.0.0/add-and-edit-recording-metadata-labels-1.png"
image-name="4.0.0/add-and-edit-recording-metadata-labels-1.png"
text="
When creating a custom <code>Flight Recording</code> with <b>Cryostat</b>, expand the form section <i>Show metadata options</i>. Click <i>Add Label</i> and add <i>key-Value</i> <code>Label</code> pairs to the form. Finally, click <i>Create</i> to attach the <code>Labels</code> and create the <code>Recording</code>.
"
Expand All @@ -20,7 +20,7 @@ Users can attach `Metadata` or `Custom Labels` to **JDK** `Flight Recordings` ma
<li>
{% include howto_step.html
summary="View your <code>Labels</code> on the <i>Active Recordings</i> Table"
image-name="3.0.0/add-and-edit-recording-metadata-labels-2.png"
image-name="4.0.0/add-and-edit-recording-metadata-labels-2.png"
text="
The new <code>Recording</code> will appear in the <i>Recordings Tab</i> with your <code>Custom Label</code> as well as default <code>Labels</code> containing information about the selected <code>Recording</code> template.
"
Expand All @@ -31,23 +31,23 @@ Users can attach `Metadata` or `Custom Labels` to **JDK** `Flight Recordings` ma
<p>
<code>Recording Labels</code> can also be edited after <code>Recordings</code> have been created or re-uploaded to archives. It looks like the <code>Custom Label</code> in our example contains a typo - we can fix the typo by editing the <code>Label</code>. First select a <code>Recording</code> 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/3.0.0/add-and-edit-recording-metadata-labels-4.png" target="_blank">
<img src="{{ site.url }}/images/3.0.0/add-and-edit-recording-metadata-labels-4.png">
<a href="{{ site.url }}/images/4.0.0/add-and-edit-recording-metadata-labels-4.png" target="_blank">
<img src="{{ site.url }}/images/4.0.0/add-and-edit-recording-metadata-labels-4.png">
</a>
<br><br>
The <code>Labels</code> section will appear as a form where you can <i>Add</i>, <i>Edit</i>, or <i>Delete</i> existing <code>Labels</code>, just like before when we created the <code>Recording</code>. Fix the typo, and click <i>Save</i> to save your edited <code>Labels</code>.
</p>
{% endcapture %}
{% include howto_step.html
summary="Edit an Existing <code>Label</code>"
image-name="3.0.0/add-and-edit-recording-metadata-labels-3.png"
image-name="4.0.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 <code>Labels</code>"
image-name="3.0.0/add-and-edit-recording-metadata-labels-5.png"
image-name="4.0.0/add-and-edit-recording-metadata-labels-5.png"
text="
The <code>Recording Labels</code> should be updated in the <i>Active Recordings</i> table.
"
Expand All @@ -56,7 +56,7 @@ Users can attach `Metadata` or `Custom Labels` to **JDK** `Flight Recordings` ma
<li>
{% include howto_step.html
summary="<i>(Optional)</i> Archive your <code>Recording</code> to view <code>Labels</code> copied onto the <code>Archived Recording</code>"
image-name="3.0.0/add-and-edit-recording-metadata-labels-6.png"
image-name="4.0.0/add-and-edit-recording-metadata-labels-6.png"
text="
On the <i>Active Recordings</i> table, click the <i>Checkbox</i> next to the <code>Recording</code>, then click <i>Archive</i> to archive your <code>Recording</code>. Notice that the <code>Archived Recording</code> also copies the <code>Labels</code> from the <code>Active Recording</code>. You can also add <code>Labels</code> to any <code>Recording</code> uploaded to <b>Cryostat’s</b> archives.
"
Expand All @@ -67,16 +67,16 @@ Users can attach `Metadata` or `Custom Labels` to **JDK** `Flight Recordings` ma
<p>
Create another <code>Recording</code> on the same target. Then select both <code>Recordings</code> on the <i>Recordings Table</i> and click <i>Edit Labels</i> and start editing. This time, only <code>Labels</code> that are present on both <code>Recordings</code> will be shown in the form. Let's <i>Delete</i> the two common template-related <code>Labels</code>, and <i>Add</i> a new <code>Label</code> to both <code>Recordings</code>. Then finally, click <i>Save</i>.
<br><br>
<a href="{{ site.url }}/images/3.0.0/add-and-edit-recording-metadata-labels-8.png" target="_blank">
<img src="{{ site.url }}/images/3.0.0/add-and-edit-recording-metadata-labels-8.png">
<a href="{{ site.url }}/images/4.0.0/add-and-edit-recording-metadata-labels-8.png" target="_blank">
<img src="{{ site.url }}/images/4.0.0/add-and-edit-recording-metadata-labels-8.png">
</a>
<br><br>
Congratulations, you have successfully bulk-edited <code>Labels</code> across multiple <code>Recordings</code>!
</p>
{% endcapture %}
{% include howto_step.html
summary="<i>(Optional)</i> Bulk-edit <code>Recording Labels</code> across multiple <code>Recordings</code>"
image-name="3.0.0/add-and-edit-recording-metadata-labels-7.png"
image-name="4.0.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 <i>Active Recording</i>"
image-name="3.0.0/archive-a-recording-1.png"
image-name="4.0.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="3.0.0/archive-a-recording-2.png"
image-name="4.0.0/archive-a-recording-2.png"
caption="
Once the <code>Recording</code> has been archived, a new entry will appear in the
<code>target</code> <b>JVM's</b> <i>Archived Recordings</i> table. All <code>Recordings</code> that were
Expand Down
4 changes: 2 additions & 2 deletions guides/_subsections/automated-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ for use in the *Dashboard*. Read the section on the
<li>
{% include howto_step.html
summary="Expand the <code>Recording</code>"
image-name="3.0.0/automated-analysis-1.png"
image-name="4.0.0/automated-analysis-1.png"
caption="
Expand the <code>Recording</code> with the <i>Chevron</i> to the left of the <code>Recording</code>
name. The <code>Automated Analysis</code> report will appear below the <code>Recording</code>.
Expand All @@ -42,7 +42,7 @@ for use in the *Dashboard*. Read the section on the
<li>
{% include howto_step.html
summary="View Details and Suggestions for Results"
image-name="3.0.0/automated-analysis-2.png"
image-name="4.0.0/automated-analysis-2.png"
caption="
Click on each result to view
specifics on what the result means and possible suggestions to fix
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 <i>Card Catalog</i>"
image-name="3.0.0/dashboard/card-catalog.png"
image-name="4.0.0/dashboard/card-catalog.png"
caption="Open the <i>Card Catalog</i> by clicking the <i>Catalog icon</i> on the <i>Dashboard</i> 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="3.0.0/click-create.png"
image-name="4.0.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 <i>Layout Selector</i> contains a list of all available layouts. The current
{% endcapture %}
{% include howto_step.html
summary="Open the <i>Layout Selector Dropdown</i>"
image-name="3.0.0/dashboard/dashboard-layoutselector.png"
image-name="4.0.0/dashboard/dashboard-layoutselector.png"
caption="Click the <i>layout selector dropdown</i> 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="3.0.0/navigate-to-dashboard.png"
image-name="4.0.0/navigate-to-dashboard.png"
caption="Add <code>dashboard cards</code>, switch between <code>dashboard layouts</code>, and modify the <code>layout configuration</code> 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 <code>target's</code> certificate to <b>Cryostat's</b> 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/3.0.0/navigate-to-recordings-2.png" target="_blank">
<img src="{{ site.url }}/images/3.0.0/navigate-to-recordings-2.png">
<a href="{{ site.url }}/images/4.0.0/navigate-to-recordings-2.png" target="_blank">
<img src="{{ site.url }}/images/4.0.0/navigate-to-recordings-2.png">
</a>
{{ include.additional-content }}
{% endcapture %}
{% include howto_step.html
summary="Navigate to <i>Recordings</i>"
image-name="3.0.0/navigate-to-recordings-1.png"
image-name="4.0.0/navigate-to-recordings-1.png"
caption="
Supply <b>JMX</b> credentials to authenticate to the <code>target</code>, if necessary. If
the <code>target</code> is not configured with <b>JMX</b> 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 <i>Settings</i>"
image-name="3.0.0/navigate-to-settings.png"
image-name="4.0.0/navigate-to-settings.png"
caption="
Click the <i>cog</i> or <i>gear</i> icon in the application masthead to access the <i>Settings</i> 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 <i>Topology</i>"
image-name="3.0.0/navigate-to-topology.png"
image-name="4.0.0/navigate-to-topology.png"
caption="Use the bottom <i>Control Bar</i> to adjust the <i>Graph View</i> 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 <code>Recording</code>"
image-name="3.0.0/select-a-recording.png"
image-name="4.0.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 @@ -7,7 +7,7 @@
{% endcapture %}
{% include howto_step.html
summary="Select the <i>Target Application</i>"
image-name="3.0.0/select-target-application.png"
image-name="4.0.0/select-target-application.png"
caption="Clik the <i>Dropdown arrow</i> on the right side of <i>Target</i> prompt to select or create a <code>target</code>."
text=text-content
%}
19 changes: 19 additions & 0 deletions guides/_subsections/configure-feature-level.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### [Configure Feature Level](#configure-feature-level)
Some features in the **web-client** UI are *Beta*-level features. This indicates that they are still underdoing design and development, and may have significant limitations, or be redesigned or even removed in the future.

For those reasons, *Beta* features are hidden by default in the **Cryostat** UI. They can be enabled by following the steps below.

<ol>
<li>
{% include_relative _subsections/common/navigate-to-settings.md %}
</li>
<li>
{% include howto_step.html
summary="Locate the Advanced settings"
image-name="4.0.0/advanced-setting.png"
text="
The <i>Advanced</i> tab within this view contains a control to set the <b>Feature Level</b> of the UI. This is set to <i>Production</i> by default. You can enable additional features by setting this to <i>Beta</i>, with the aforementioned caveats in mind. Once this is set, a <i>Beta</i> badge will appear on the <b>Cryostat</b> application titlebar. Additional features enabled by this setting, such as <b>Dashboard</b> cards, will be labelled with a similar badge to indicate the feature level. If you set the feature level back to <i>Production</i> then any <i>Beta</i>-level features will be hidden from the UI again.
"
%}
</li>
</ol>
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 <i>Notifications</i> Setting"
image-name="3.0.0/notifications-setting.png"
image-name="4.0.0/notifications-setting.png"
text="
The <i>Notifications</i> setting within this view is used to control the graphical display of notifications that
correspond to <code>WebSocket</code> messages sent by the <b>Cryostat</b> backend when actions and state changes occur. The setting
Expand Down
22 changes: 12 additions & 10 deletions guides/_subsections/create-a-custom-target.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ without going through the network stack.
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/3.0.0/custom-target-1.png" target="_blank">
<img src="{{ site.url }}/images/3.0.0/custom-target-1.png">
<a href="{{ site.url }}/images/4.0.0/custom-target-1.png" target="_blank">
<img src="{{ site.url }}/images/4.0.0/custom-target-1.png">
</a>
<figcaption>
Use the <i>Custom Target</i> form to tell <b>Cryostat</b> about <b>JVM</b>
Expand All @@ -32,15 +32,15 @@ without going through the network stack.
{% endcapture %}
{% include howto_step.html
summary="Open the <i>Custom Target</i> Form"
image-name="3.0.0/topology-7.png"
image-name="4.0.0/topology-7.png"
caption="Click on <i>Catalog Icon</i> to open the <i>Topology Entity Catalog</i>."
text=open-custom-target-form-text
%}
</li>
<li>
{% include howto_step.html
summary="Enter <i>Custom Target</i> Definition"
image-name="3.0.0/custom-target-2.png"
image-name="4.0.0/custom-target-2.png"
caption="Use the form to enter the <i>Custom Target</i> definition."
text="
The <i>Connection URL</i> is required for <b>Cryostat</b> to attempt to
Expand All @@ -55,8 +55,8 @@ without going through the network stack.
Once you enter a valid <i>Connection URL</i>, click on the sample <code>node</code> to test
the <code>target</code> connection.
<figure>
<a href="{{ site.url }}/images/3.0.0/custom-target-4.png" target="_blank">
<img src="{{ site.url }}/images/3.0.0/custom-target-4.png">
<a href="{{ site.url }}/images/4.0.0/custom-target-4.png" target="_blank">
<img src="{{ site.url }}/images/4.0.0/custom-target-4.png">
</a>
<figcaption>
An exclamation mark and an alert banner will show if an error
Expand All @@ -66,14 +66,16 @@ without going through the network stack.
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.
certificate which Cryostat does not trust. Cryostat will also
refuse to add new Custom Target definitions for targets that it
has already discovered by other means.
</figcaption>
</figure>
</p>
{% endcapture %}
{% include howto_step.html
summary="Test the <i>Custom Target</i> Definition"
image-name="3.0.0/custom-target-3.png"
image-name="4.0.0/custom-target-3.png"
caption="A &#9989; checkmark will show if <b>Cryostat</b> can connect to the sample app."
text=test-custom-target-text
%}
Expand All @@ -85,7 +87,7 @@ without going through the network stack.
<li>
{% include howto_step.html
summary="View the <i>Custom Targets</i>"
image-name="3.0.0/custom-target-5.png"
image-name="4.0.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
Expand All @@ -97,7 +99,7 @@ without going through the network stack.
<li>
{% include howto_step.html
summary="<i>(Optional)</i> Delete <i>Custom Targets</i>"
image-name="3.0.0/custom-target-6.png"
image-name="4.0.0/custom-target-6.png"
caption="<i>Custom Targets</i> can be cleaned up with <i>Actions</i> menu."
text="
If the <i>Custom Targets</i> is no longer needed, in the target detail
Expand Down
Loading