-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(quickstarts): topology quickstarts
- Loading branch information
Thuan Vo
committed
Apr 25, 2023
1 parent
0980382
commit 5802903
Showing
12 changed files
with
363 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 0 additions & 67 deletions
67
src/app/QuickStarts/quickstarts/cryostat-link-quickstart.tsx
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
159 changes: 159 additions & 0 deletions
159
src/app/QuickStarts/quickstarts/topology/custom-target-quickstart.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| /* | ||
| * Copyright The Cryostat Authors | ||
| * | ||
| * The Universal Permissive License (UPL), Version 1.0 | ||
| * | ||
| * Subject to the condition set forth below, permission is hereby granted to any | ||
| * person obtaining a copy of this software, associated documentation and/or data | ||
| * (collectively the "Software"), free of charge and under any and all copyright | ||
| * rights in the Software, and any and all patent rights owned or freely | ||
| * licensable by each licensor hereunder covering either (i) the unmodified | ||
| * Software as contributed to or provided by such licensor, or (ii) the Larger | ||
| * Works (as defined below), to deal in both | ||
| * | ||
| * (a) the Software, and | ||
| * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if | ||
| * one is included with the Software (each a "Larger Work" to which the Software | ||
| * is contributed by such licensors), | ||
| * | ||
| * without restriction, including without limitation the rights to copy, create | ||
| * derivative works of, display, perform, and distribute the Software and make, | ||
| * use, sell, offer for sale, import, export, have made, and have sold the | ||
| * Software and the Larger Work(s), and to sublicense the foregoing rights on | ||
| * either these or other terms. | ||
| * | ||
| * This license is subject to the following condition: | ||
| * The above copyright notice and either this complete permission notice or at | ||
| * a minimum a reference to the UPL must be included in all copies or | ||
| * substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
|
|
||
| import { conclusion, CryostatIcon } from '@app/QuickStarts/quickstart-utils'; | ||
| import { FeatureLevel } from '@app/Shared/Services/Settings.service'; | ||
| import { QuickStart } from '@patternfly/quickstarts'; | ||
| import * as React from 'react'; | ||
|
|
||
| const CustomTargetQuickstart: QuickStart = { | ||
| metadata: { | ||
| name: 'topology/create-custom-target-quickstart', | ||
| featureLevel: FeatureLevel.PRODUCTION, | ||
| }, | ||
| spec: { | ||
| version: 2.3, | ||
| displayName: 'Create a Custom Target', | ||
| durationMinutes: 10, | ||
| icon: <CryostatIcon />, | ||
| description: `Don't see your applications? Use Custom Targets to tell Cryostat about them!`, | ||
| introduction: ` | ||
| ## Custom Targets | ||
| By default, target JVMs are automatically discovered over remote Java Management Extensions (JMX) by **Cryostat**, using various mechanisms (e.g. **Kubernetes API**, **JDP**). | ||
| However, in some cases (e.g. JMX port is not <code>9091</code> and port name is not <code>jfr-jmx</code>), Cryostat might not see your applications. Fortunately, you can tell Cryostat about them by specifying **Custom Targets**. | ||
| ### What you'll learn | ||
| - How to test and create a Custom Target definition | ||
| ### What you'll need | ||
| - A Java application that Cryostat cannot automatically discover | ||
| - The connection URL and JMX credentials, if required, for that application | ||
| `, | ||
| tasks: [ | ||
| { | ||
| title: 'Go to the Topology page', | ||
| description: `1. In the [APP] console navigation bar, click the [Topology]{{highlight nav-topology-tab}}.`, | ||
| review: { | ||
| instructions: '#### Verify that you see the Topology page.', | ||
| failedTaskHelp: | ||
| 'If you do not see the navigation bar, click the [menu button]{{highlight nav-toggle-btn}} on the masthead.', | ||
| }, | ||
| }, | ||
| { | ||
| title: 'Open Custom Target Creation Form', | ||
| description: ` | ||
| 1. From the toolbar, click on the [catalog icon]{{highlight topology-catalog-btn}}. | ||
| This will open a modal containing the **Topology Entity Catalog**. | ||
| [Alternatively, press <kbd>Ctrl</kbd> + <kbd>Space</kbd> or righ click the topology view (this will open a mini catalog for quick access).]{{admonition tip}} | ||
| 2. Find and select the **Custom Target** option. To aid you search, use the search bar. | ||
| 3. Click on the **Create** button to open the **Custom Target Creation Form**. | ||
| `, | ||
| review: { | ||
| instructions: '#### Verify that you can open the catalog and select Custom Target.', | ||
| failedTaskHelp: 'If you do not see the Custom Target option, use the search bar to find it.', | ||
| }, | ||
| }, | ||
| { | ||
| title: 'Fill out the Custom Target form', | ||
| description: ` | ||
| 1. Enter the **Connection URL** for the target into the [Connection URL]{{highlight ct-connecturl-input}} field. | ||
| 2. Optionally assign an **Alias** to the target by using the [Alias]{{highlight ct-alias-input}} field. | ||
| 3. If the target has **JMX authentication** enabled, click the [JMX Credential Option]{{highlight ct-credential-expand}} to expand the form. | ||
| 4. Use the [Username]{{highlight ct-username-input}} and [Password]{{highlight ct-password-input}} fields to enter the username and password. | ||
| `, | ||
| review: { | ||
| instructions: '#### Verify that you have filled out the form.', | ||
| failedTaskHelp: | ||
| 'Click the [JMX Credential Option]{{highlight ct-credential-expand}} to expand the form to reveal the username and password fields.', | ||
| }, | ||
| }, | ||
| { | ||
| title: 'Test the custom target definition.', | ||
| description: ` | ||
| After form is filled, the [sample node]{{highlight ct-sample-testnode}} will be populated with those information. | ||
| To test the **Custom Target** definition: | ||
| 1. Click on the [sample node icon]{{highlight ct-sample-testnode-icon}} to test your custom target definition. **Cryostat** will attempt a connection to the target defined by the form data. | ||
| 2. If the attempt succeeds, a **Checkmark** icon is shown. Otherwise, an **Exclaimation** icon along with an alert banner that describes the error. | ||
| 3. Re-enter the form and repeat step 1-2 until you have a valid definition. | ||
| `, | ||
| review: { | ||
| instructions: '#### Verify that you can test the custom target definition.', | ||
| failedTaskHelp: 'You must provide a valid **Connection URL** to enable testing.', | ||
| }, | ||
| }, | ||
| { | ||
| title: 'Create the Custom Target.', | ||
| description: ` | ||
| To create the **Custom Target** definition: | ||
| 1. Click [Create]{{highlight ct-create-btn}}. | ||
| 2. If the submission is successful, the view will automatically be directed to the **Topology** page. Otherwise, revise your form inputs. | ||
| `, | ||
| review: { | ||
| instructions: '#### Verify that you can create the custom target and redirected to Topology View.', | ||
| failedTaskHelp: 'Revise your **Custom Target** definition to ensure it is valid.', | ||
| }, | ||
| }, | ||
| { | ||
| title: 'View the Custom Target.', | ||
| description: ` | ||
| The **Custom Target** will appear under **Custom Targets Realm**. | ||
| [In Graph View, use the toolbar to filter out the **Custom Targets Realm** and the control bar to fit graph into screen, if needed.]{{admonition tip}} | ||
| `, | ||
| review: { | ||
| instructions: '#### Verify that you can can see the Custom Target.', | ||
| failedTaskHelp: 'In a clustered graph, use the filter and control bar to adjust the view.', | ||
| }, | ||
| }, | ||
| ], | ||
| conclusion: conclusion('Create a Custom Target', 'Custom Targets'), | ||
| type: { | ||
| text: 'Featured', | ||
| color: 'blue', | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| export default CustomTargetQuickstart; |
Oops, something went wrong.