Update Helm docs to include new configuration options of Validator Scan and Sequencer connections #3651
+110
−31
Conversation
This file contains hidden or 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
pasindutennage-da
changed the title
Contributor
martinflorian-da
left a comment
martinflorian-da
left a comment
There was a problem hiding this comment.
Thanks! I left a fair amount of comments so maybe better to do a second iteration.
Could you also build the docs page locally and attach a screenshot? Not sure how the yaml include will look once rendered, if it will be readable well etc. Would prefer checking that before merging to avoid confusing operators.
pasindutennage-da
force-pushed
the
pasindutennage-da/update-validator-compose-and-helm-docs
branch
from
f4e275d to
ba5ad83
Compare
[ci] Signed-off-by: Pasindu Tennage <pasindu.tennage@digitalasset.com>
[ci] Signed-off-by: Pasindu Tennage <pasindu.tennage@digitalasset.com>
[ci] Signed-off-by: Pasindu Tennage <pasindu.tennage@digitalasset.com>
[ci] Signed-off-by: Pasindu Tennage <pasindu.tennage@digitalasset.com>
[ci] Signed-off-by: Pasindu Tennage <pasindu.tennage@digitalasset.com>
[ci] Signed-off-by: Pasindu Tennage <pasindu.tennage@digitalasset.com>
[ci] Signed-off-by: Pasindu Tennage <pasindu.tennage@digitalasset.com>
[ci] Signed-off-by: Pasindu Tennage <pasindu.tennage@digitalasset.com>
[ci] Signed-off-by: Pasindu Tennage <pasindu.tennage@digitalasset.com>
[ci] Signed-off-by: Pasindu Tennage <pasindu.tennage@digitalasset.com>
pasindutennage-da
force-pushed
the
pasindutennage-da/update-validator-compose-and-helm-docs
branch
from
b1d449e to
12ae26f
Compare
[ci] Signed-off-by: Pasindu Tennage <pasindu.tennage@digitalasset.com>
martinflorian-da
approved these changes
Jan 23, 2026
Contributor
martinflorian-da
left a comment
martinflorian-da
left a comment
There was a problem hiding this comment.
Thank you! WDYT about running both a cluster test and a hdm test before merging?
|
|
||
| - Replace ``TRUSTED_SCAN_URL`` with a URL of a Scan you host or trust that is reachable by your Validator. For example, the GSF scan URL, |gsf_scan_url| | ||
| (This Scan instance will be used for obtaining additional Scan URLs for BFT Scan reads.) | ||
| You need to configure how your validator connects to the network's ``scan`` services by defining a ``scanClient`` block in your ``validator-values.yaml``. |
Contributor
There was a problem hiding this comment.
Suggested change
| You need to configure how your validator connects to the network's ``scan`` services by defining a ``scanClient`` block in your ``validator-values.yaml``. | |
| You need to configure how your validator connects to the network's **scan** services by defining a ``scanClient`` block in your ``validator-values.yaml``. |
The other font is for code things; IMO we just want to emphasize what this paragraph is about.
| :language: yaml | ||
| :start-after: TRUSTED_SINGLE_SCAN_START | ||
| :end-before: TRUSTED_SINGLE_SCAN_END | ||
| You need to configure how your validator's participant connects to ``sequencers`` by defining a ``synchronizer`` config in your ``validator-values.yaml``. |
Contributor
There was a problem hiding this comment.
Suggested change
| You need to configure how your validator's participant connects to ``sequencers`` by defining a ``synchronizer`` config in your ``validator-values.yaml``. | |
| You need to configure how your validator's participant connects to **sequencers** by defining a ``synchronizer`` config in your ``validator-values.yaml``. |
| - Expose ``/v0/holdings/summary`` endpoint from scan proxy. | ||
|
|
||
| - Add support for custom fault-tolerance configurations for ``scan`` and ``sequencer`` connections. | ||
| Please see :ref:`docs <helm-validator-install>` for details. |
Contributor
There was a problem hiding this comment.
Suggested change
| Please see :ref:`docs <helm-validator-install>` for details. | |
| Please see the updated :ref:`documentation for Helm-based deployments <helm-validator-install>`. |
|
|
||
| - Add support for custom fault-tolerance configurations for ``scan`` and ``sequencer`` connections. | ||
| Please see :ref:`docs <helm-validator-install>` for details. | ||
| This is supported out of the box, only in the helm charts based deployment scripts. |
Contributor
There was a problem hiding this comment.
Suggested change
| This is supported out of the box, only in the helm charts based deployment scripts. | |
| Docker Compose-based deployments do not currently support the new custom configuration options. |
...and I'd suggest moving that sentence to the end for better reading flow, as all the next sentences are just about Helm.
| - Add support for custom fault-tolerance configurations for ``scan`` and ``sequencer`` connections. | ||
| Please see :ref:`docs <helm-validator-install>` for details. | ||
| This is supported out of the box, only in the helm charts based deployment scripts. | ||
| New ``scanClient`` and ``synchronizer`` configs introduce a novel recommended way to configure the ``scan`` and ``sequencer`` connections. |
Contributor
There was a problem hiding this comment.
Suggested change
| New ``scanClient`` and ``synchronizer`` configs introduce a novel recommended way to configure the ``scan`` and ``sequencer`` connections. | |
| This introduces the new configuration keys ``scanClient`` and ``synchronizer`` as the new recommended way to configure scan and sequencer connections. |
Contributor
There was a problem hiding this comment.
maybe a bit nit... but I feel strongly about the "novel" (sounds odd in this context) and the font for "sequencer" and "scan"
| New ``scanClient`` and ``synchronizer`` configs introduce a novel recommended way to configure the ``scan`` and ``sequencer`` connections. | ||
| Existing configuration options ``scanAddress``, ``nonSvValidatorTrustSingleScan``, ``decentralizedSynchronizerUrl``, ``useSequencerConnectionsFromScan`` are still supported, but will be deprecated in a future release. | ||
| We recommend to migrate to the new ``scanClient`` and ``synchronizer`` configuration options as soon as possible. | ||
| Check the updated :ref:`docs <helm-validator-install>` for more details. |
Contributor
There was a problem hiding this comment.
Suggested change
| Check the updated :ref:`docs <helm-validator-install>` for more details. |
It's a duplicate, isn't it?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3498