Skip to content

Update splice content embeds #621

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.

Sign up for GitHub

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

Merged
Jatinp26 merged 1 commit into from
May 28, 2026
Merged

Update splice content embeds #621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2,024 changes: 1,860 additions & 164 deletions config/snippet-config/splice-snippet-list-remote.json
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs-main/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,6 @@
"global-synchronizer/reference/crypto-schemes",
"global-synchronizer/reference/kms-driver-guide",
"global-synchronizer/reference/canton-metrics",
"global-synchronizer/reference/splice-metrics",
"global-synchronizer/reference/error-codes"
]
},
Expand Down
101 changes: 24 additions & 77 deletions docs-main/global-synchronizer/canton-console/console-overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,16 @@ title: "Console Overview"
description: "Accessing and using the Canton Console for validator and SV node operations"
---

import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessNone40 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-console-access-none-40.mdx";
import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessBash166 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-console-access-bash-166.mdx";
import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessBash174 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-console-access-bash-174.mdx";

import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessNone104 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-console-access-none-104.mdx";
import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessNone136 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-console-access-none-136.mdx";
import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessNone40 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-console-access-none-40.mdx";
import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessNone71 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-console-access-none-71.mdx";
import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessParsedLiteral126 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-console-access-parsed-literal-126.mdx";
import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessParsedLiteral154 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-console-access-parsed-literal-154.mdx";
import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessParsedLiteral63 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-console-access-parsed-literal-63.mdx";
import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessParsedLiteral94 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-console-access-parsed-literal-94.mdx";
import { NetworkVariables } from '/snippets/components/version.mdx';
import { networkData } from '/snippets/generated/version-dashboard-data.mdx';

Expand All @@ -21,15 +27,15 @@ Requirements:

Once you see the following banner for the console you have successfully gained access

``` text
_____ _
/ ____| | |
| | __ _ _ __ | |_ ___ _ __
| | / _` | '_ \| __/ _ \| '_ \
| |___| (_| | | | | || (_) | | | |
\_____\__,_|_| |_|\__\___/|_| |_|

Welcome to Canton!
```text
_____ _
/ ____| | |
| | __ _ _ __ | |_ ___ _ __
| | / _` | '_ \| __/ _ \| '_ \
| |___| (_| | | | | || (_) | | | |
\_____\__,_|_| |_|\__\___/|_| |_|

Welcome to Canton!
```

## Participant console
Expand All @@ -45,44 +51,21 @@ Welcome to Canton!

<NetworkVariables networkData={networkData}>

```bash
docker run -it --rm --network host -v $(pwd)/console.conf:/app/app.conf |docker_repo_prefix|/canton:|version_literal| --console
```
<ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessParsedLiteral63 />

</NetworkVariables>

<Warning>
If you run the participant using the docker compose setup the docker command must be run with the docker network used by the participant. Adjust the configuration to connect to the participant container:
</Warning>

```text
canton {
remote-participants {
participant {
admin-api {
port = 5002
address = participant
}
ledger-api {
port = 5001
address = participant
}
token = "<auth token>"
}
}
features.enable-preview-commands = yes
features.enable-testing-commands = yes
features.enable-repair-commands = yes
}
```
<ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessNone71 />

Running docker with the default network (`splice-validator`):

<NetworkVariables networkData={networkData}>

```bash
docker run -it --rm --network splice-validator -v $(pwd)/console.conf:/app/app.conf |docker_repo_prefix|/canton:|version_literal| --console
```
<ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessParsedLiteral94 />

</NetworkVariables>

Expand All @@ -94,31 +77,11 @@ docker run -it --rm --network splice-validator -v $(pwd)/console.conf:/app/app.c

2. Add the configuration to a local file `console.conf`

```
canton {
remote-sequencers {
sequencer {
public-api {
port = 5008
address = localhost
}
admin-api {
port = 5009
address = localhost
}
}
}
features.enable-preview-commands = yes
features.enable-testing-commands = yes
features.enable-repair-commands = yes
}
```
<ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessNone104 />

3. Run the docker command

```bash
docker run -it --rm --network host -v $(pwd)/console.conf:/app/app.conf |docker_repo_prefix|/canton:|version_literal| --console
```
<ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessParsedLiteral126 />

</NetworkVariables>

Expand All @@ -130,27 +93,11 @@ docker run -it --rm --network host -v $(pwd)/console.conf:/app/app.conf |docker_

2. Add the configuration to a local file `console.conf`

```
canton {
remote-mediators {
mediator {
admin-api {
port = 5007
address = localhost
}
}
}
features.enable-preview-commands = yes
features.enable-testing-commands = yes
features.enable-repair-commands = yes
}
```
<ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessNone136 />

3. Run the docker command

```bash
docker run -it --rm --network host -v $(pwd)/console.conf:/app/app.conf |docker_repo_prefix|/canton:|version_literal| --console
```
<ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConsoleAccessParsedLiteral154 />

</NetworkVariables>

Expand Down
8 changes: 4 additions & 4 deletions docs-main/global-synchronizer/deployment/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: "Custom Configuration"
description: "Key configuration parameters for Canton Network validator nodes"
---

import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConfigurationNone49 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-configuration-none-49.mdx";
import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConfigurationYaml68 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-configuration-yaml-68.mdx";
import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConfigurationNone51 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-configuration-none-51.mdx";
import ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConfigurationYaml70 from "/snippets/external/splice/main/splice-rst-code-docs-src-deployment-configuration-yaml-70.mdx";

{/* COPIED_START source="splice:docs/src/deployment/configuration.rst" hash="22d3b95a" */}

Expand Down Expand Up @@ -40,7 +40,7 @@ point to the release that these docs are built from; or inline the source code o

Both Canton and splice support bootstrap scripts during initialization. While this usually should not be needed as the validator app takes care of initializing the node, in some scenarios it can be useful. To do so, you need to set the `OVERRIDE_BOOTSTRAP_SCRIPT` environment variable to the content of your bootstrap script. Note that the script must be wrapped in a `main` function, e.g.,

<ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConfigurationNone49 />
<ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConfigurationNone51 />

You can set this environment variable through `additionalEnvVars` as described below.

Expand All @@ -50,7 +50,7 @@ Note that this overwrites any bootstrap scripts baked into the container image.

The helm charts can be configured through the value `additionalEnvVars`, which passes the values as environment variables to the apps.

<ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConfigurationYaml68 />
<ExternalSpliceMainSpliceRstCodeDocsSrcDeploymentConfigurationYaml70 />


{/* COPIED_END */}
Loading