Skip to content

docs: Engine API secret note on the Update a DV page - #653

Merged
OisinKyne merged 1 commit into
mainfrom
docs/per-deployment-jwt
Nov 10, 2026
Merged

OisinKyne merged 1 commit into
mainfrom
docs/per-deployment-jwt

Conversation

@OisinKyne

Copy link
Copy Markdown
Contributor

Summary

Adds an "Engine API secret" note to the Update a DV page, in the charon-distributed-validator-node and charon-distributed-validator-cluster tabs.

Details

CDVN, LCDVN and CDVC stop shipping a shared jwt/jwt.hex and generate the Engine API secret per node in a Docker volume (PRs on security/per-deployment-jwt in each repo, with backports to CDVN main-v1.11 and LCDVN main-v0.3). The note tells operators:

  • The normal update (git pull, docker compose up -d) is all that is needed. It recreates the execution and consensus clients once, with the new secret.
  • Both clients must be recreated with the same command, since an old one cannot authenticate to a new one.
  • What to do if git pull stops on a locally changed jwt/jwt.hex, and how to keep an own secret.

Applied to docs/ (next) and versioned_docs/version-v1.11. No other page documents the JWT path of these repos (the only other match is Sedge's jwtsecret in create-a-dv-with-a-group).

Merge after the compose PRs, since the note describes their behaviour. Not tested: the site build was not run. The note uses the :::info[title] admonition form the page already uses for :::warning[...].

ticket: none

CDVN, LCDVN and CDVC now generate the Engine API secret per node.
Say that the normal update recreates the execution and consensus
clients once, and what to do when git pull stops on a changed
jwt/jwt.hex. Applied to docs/ and versioned_docs/version-v1.11.
@sonarqubecloud

Copy link
Copy Markdown

@OisinKyne
OisinKyne merged commit 8b6cbea into main Nov 10, 2026
5 checks passed
@OisinKyne
OisinKyne deleted the docs/per-deployment-jwt branch November 10, 2026 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants