Skip to content

Commit 63fab46

Browse files
authored
Include link to alternative examples to Auth0 in the validator auth setup docs (#2149)
Signed-off-by: Brian Healey <brian.healey@daml.com> Signed-off-by: Brian Healey <brian.healey@digitalasset.com>
1 parent 79592a9 commit 63fab46

File tree

4 files changed

+22
-1
lines changed

4 files changed

+22
-1
lines changed

docs/src/community/docker-compose-helm-chart.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@
88
Alternative Docker Compose Deployment
99
=====================================
1010

11+
.. warning::
12+
13+
This section features solutions shared by community members. While they haven’t been formally tested by the Splice maintainers,
14+
users are encouraged to verify the information independently. Contributions to enhance accuracy and completeness are always welcome.
15+
1116
This guide introduces a community-contributed Docker Compose solution for deploying Canton validator nodes and supporting infrastructure, following the ``x-docker`` standard used by Mario Delgado’s team for onboarding blockchains.
1217
Note that while it was tested during a scheduled upgrade on DevNet, that required
1318
updating the ``.env`` file with the migration ID, renaming the databases (with a planned change to use standardized names like ``participant_${MIGRATION_ID}`` and ``validator_${MIGRATION_ID}``), and including ``validator-migration.yaml`` as part of the migration setup. For further information, please contact the authors of the contribution.

docs/src/community/helm-kubernetes-templating-tool.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@
88
Automated Helm/Kubernetes Templating Tool
99
=========================================
1010

11+
.. warning::
12+
13+
This section features solutions shared by community members.
14+
While they haven’t been formally tested by the Splice maintainers,
15+
users are encouraged to verify the information independently.
16+
Contributions to enhance accuracy and completeness are always welcome.
17+
1118
Managing deployments for Validator and Super Validator nodes using Kubernetes, Helm, and Git can be challenging,
1219
especially when keeping multiple environments (DevNet, TestNet, MainNet) in sync with evolving configuration files and values.
1320
Frequent version bumps, new variables, and hard migrations often require manual, error-prone updates to numerous ``values-*.yml`` files.

docs/src/community/oidc-config-okta-keycloak.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@
88
Okta and Keycloak OIDC Configuration Guide
99
==========================================
1010

11+
.. warning::
12+
13+
This section features solutions shared by community members.
14+
While they haven’t been formally tested by the Splice maintainers,
15+
users are encouraged to verify the information independently.
16+
Contributions to enhance accuracy and completeness are always welcome.
17+
1118
To deploy a validator node, configure authentication using your preferred OIDC provider.
1219
This section provides instructions for Okta and Keycloak.
1320
For Auth0 instructions and more details on configuring authentication, see :ref:`Configuring Authentication <helm-validator-auth>`.

docs/src/validator_operator/validator_helm.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,9 @@ OIDC Provider Requirements
119119
++++++++++++++++++++++++++
120120

121121
This section provides pointers for setting up an OIDC provider for use with your Validator node.
122-
Feel free to skip directly to :ref:`helm-validator-auth0` if you plan to use `Auth0 <https://auth0.com>`_ for your Validator node's authentication needs.
122+
Feel free to skip directly to :ref:`helm-validator-auth0` if you plan to use `Auth0 <https://auth0.com>`_ for your Validator node's authentication needs.
123+
124+
These docs focus on Auth0, and are being continuously tested and maintained. Other OIDC providers can be used, and are in active use by various community members, who have contributed some notes and examples in `Okta and Keycloak community authored examples </community/oidc-config-okta-keycloak.html>`.
123125

124126
Your OIDC provider must be reachable [#reach]_ at a well known (HTTPS) URL.
125127
In the following, we will refer to this URL as ``OIDC_AUTHORITY_URL``.

0 commit comments

Comments
 (0)