Skip to content

feat(registration): implement wizard for additional configuration options#829

Draft
andrewazores wants to merge 16 commits intocryostatio:mainfrom
andrewazores:registration-wizard
Draft

feat(registration): implement wizard for additional configuration options#829
andrewazores wants to merge 16 commits intocryostatio:mainfrom
andrewazores:registration-wizard

Conversation

@andrewazores
Copy link
Member

@andrewazores andrewazores commented Mar 20, 2026

Welcome to Cryostat! 👋

Before contributing, make sure you have:

  • Read the contributing guidelines
  • Linked a relevant issue which this PR resolves
  • Linked any other relevant issues, PR's, or documentation, if any
  • Resolved all conflicts, if any
  • Rebased your branch PR on top of the latest upstream main branch
  • Attached at least one of the following labels to the PR: [chore, ci, docs, feat, fix, test]
  • Signed all commits using a GPG signature

To recreate commits with GPG signature git fetch upstream && git rebase --force --gpg-sign upstream/main


Fixes: #792
See cryostatio/cryostat-web#2153 - similar eslint problem occurred here

Description of the change:

Adds a multi-step wizard component to the modal dialog that appears when users click the "Register with Cryostat" action on a Deployment on the Console's Topology view.

Previously the modal only allowed users to select from a list of detected Cryostat instances. If the selected instance was not an Operator-created instance (ie installed via Helm chart), registration would be blocked. No further customization was possible from this point.

Now, the modal appears with the wizard component displaying the first page as instance selection, which works much like before. The "Quick Register" footer button accepts all default values and completes the registration patching process. If further customization is desired, the user can click the "Next" button to proceed through the wizard, until the final review stage at which point the "Next" button now reads "Register" and completes the registration with any customization options the user selected.

Available customization options:

  1. which container in the Pod to configure. If there is only one container, this is pre-selected and no choice is offered to the user - but they will at least see (so they can confirm) what they're going to be injecting the Agent into.
  2. the environment variable to use for setting the -javaagent flag. This defaults to JAVA_TOOL_OPTIONS, but now the user can customize this as necessary for their application/framework/base image.
  3. Agent Harvester configuration. When the Agent is autoconfigured directly by the Operator this is not normally enabled, but in this graphical flow it is enabled by default: the Harvester will be started with the Continuous event template, with a maximum data age of 5 minutes and a maximum data size of 20 MiB. This ensures that the functionality of capturing tail-end JFR data on application shutdown is enabled. Users who expect their Deployments to run a stable number of Pods will hopefully find this helpful since it should allow the Agent to help catch JFR dumps in case of OOMKill or application crash. Users who use dynamic Deployment scaling might want to disable this feature if Pods are frequently scaled down due to ex. traffic levels, so containers frequently exit without any problems to diagnose.
  4. Agent log level. This still defaults to 'off', but this might be helpful in case there is a bug with the Agent or with its connection to the Cryostat server. The user can enable these logs to diagnose the problem or to share the logs with us.

How to manually test:

  1. Run CRYOSTAT_IMAGE=quay.io... bash smoketest.bash...
  2. ...

@github-actions github-actions bot added the needs-triage Needs thorough attention from code reviewers label Mar 20, 2026
@andrewazores andrewazores added feat New feature or request safe-to-test and removed needs-triage Needs thorough attention from code reviewers labels Mar 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feat New feature or request safe-to-test

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] Cryostat Autoconfig registration modal wizard for optional features

1 participant