Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sandbox Mode

Sandbox mode lets any signed-in user create their own DevNet validator from the CatalyX UI by entering a name. The platform fills in the network details.

Sandbox mode is an optional platform mode, added in 2.0.2. With it turned on, a signed-in user creates a DevNet validator straight from the CatalyX UI by entering a name. They do not need the network endpoints, an onboarding secret, or access to the cluster.

Sandbox mode is off by default. A platform administrator turns it on with Helm values. If you do not see a Create Validator button on the Validators page, sandbox mode is not enabled on your platform. See Turning sandbox mode on.

How sandbox mode changes the UI

Area
Standard mode
Sandbox mode

Creating a validator

Not in the UI. Apply a Validator resource — see Create a Validator.

A Create Validator button on the Validators page.

What you see

Every validator and application in the namespace.

Only the validators and applications you created.

How many validators

No limit.

One per user.

Network

DevNet, TestNet, or MainNet.

DevNet only.

Editing a validator

Edit the Validator resource.

No edit action in the UI.


Create a sandbox validator

1

Open the Validators page

Select Validators in the sidebar. The Create Validator button appears at the top of the page while you have no validator yet.

2

Fill in the form

Click Create Validator and fill in the fields below. Only Name is required.

Field
Required
Notes

Name

Yes

Lowercase letters, numbers, and hyphens, for example my-validator-1.

Party hint

No

Format word-word-number, for example my-validator-1. When empty, the name is used.

Enable PQS

No

Adds a Participant Query Store to the validator.

PQS database

No

Shown when PQS is enabled. For example pqs_my_validator_1.

PQS version

No

Shown when PQS is enabled. Overrides the Splice version for the PQS image.

3

Click Create

The platform does the rest:

  • It gets an onboarding token from the sponsoring Super Validator and stores it as the Secret <validator-name>-onboarding-secret.

  • It reads the current Splice version and migration ID from Scan.

  • It creates the Validator with managed Keycloak, and marks you as its owner.

4

Wait for the validator to become Ready

The new validator appears in your list. Its components start one by one, and the validator shows Ready once all of them are running. From there, open it to use the Validator Details tabs as usual.


Known limitations

  • DevNet only. The onboarding token comes from the Super Validator's DevNet self-onboarding API.

  • One validator per user. The Create Validator button is hidden once you have a validator.

  • No edit or delete in the UI. Ask your platform administrator to change or remove a sandbox validator.

  • No admin view. Validators without an owner — for example ones applied with kubectl — are hidden from every user while sandbox mode is on.

  • The onboarding Secret can be left behind. It is written before the Validator, so it stays if the create fails, and it is not deleted with the validator.


Turning sandbox mode on

This part is for platform administrators. Sandbox mode is enabled with the api.sandbox.* Helm values, and it also needs:

  • The operator database (operator.database.*), because sandbox validators have no spec.database.

  • Managed authentication (operator.keycloak.*), because every sandbox validator uses managed Keycloak.

See Sandbox mode values and Operator database for the full list of values.

If a sandbox URL is missing, creating a validator fails with 503. If the operator database is not configured, the validator is created but never reconciles.

Last updated

Was this helpful?