Skip to content

Commit 3510b4c

Browse files
AUTO: Sync ScalarDL docs in English to docs site repo (#911)
Co-authored-by: josh-wong <[email protected]>
1 parent e496352 commit 3510b4c

File tree

1 file changed

+190
-16
lines changed

1 file changed

+190
-16
lines changed

docs/configurations.mdx

Lines changed: 190 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ This configuration is deprecated and will be deleted in release 5.0.0 since Ledg
5858
### `authentication.method`
5959

6060
- **Field:** `scalar.dl.ledger.authentication.method`
61-
- **Description:** The authentication method for a client and servers. This field specifies the authentication method used between clients and servers.
61+
- **Description:** The authentication method for clients and Ledger servers. `digital-signature` or `hmac` can be specified.
6262
- **Default value:** `digital-signature` (Optional)
6363

6464
### `direct_asset_access.enabled`
@@ -188,13 +188,13 @@ You can configure several settings for the Auditor server, such as service port
188188
### `authentication.hmac.cipher_key`
189189

190190
- **Field:** `scalar.dl.auditor.authentication.hmac.cipher_key`
191-
- **Description:** A cipher key used to encrypt and decrypt the HMAC secret keys of client entities. This is used only when `scalar.dl.auditor.authentication.method` is set to "hmac".
191+
- **Description:** A cipher key used to encrypt and decrypt the HMAC secret keys of client entities. This is used only when `scalar.dl.auditor.authentication.method` is set to `hmac`.
192192
- **Default value:** empty (Optional)
193193

194194
### `authentication.method`
195195

196196
- **Field:** `scalar.dl.auditor.authentication.method`
197-
- **Description:** The authentication method for a client and Auditor servers. This must be consistent with the client configuration.
197+
- **Description:** The authentication method for clients and Auditor servers. `digital-signature` or `hmac` can be specified. This must be consistent with the Ledger configuration.
198198
- **Default value:** `digital-signature` (Optional)
199199

200200
### `authorization.credential`
@@ -203,12 +203,72 @@ You can configure several settings for the Auditor server, such as service port
203203
- **Description:** An authorization credential (e.g., Bearer token).
204204
- **Default value:** empty (Optional)
205205

206+
### `cert_holder_id` (Deprecated)
207+
208+
- **Field:** `scalar.dl.auditor.cert_holder_id`
209+
- **Description:** The holder ID of a certificate. This field is used to identify the certificate holder for the Auditor.
210+
- **Default value:** `auditor`
211+
212+
:::note
213+
214+
This configuration is deprecated and will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only. For more details about authentication, see the [ScalarDL Authentication Guide](./authentication.mdx).
215+
216+
:::
217+
218+
### `cert_version` (Deprecated)
219+
220+
- **Field:** `scalar.dl.auditor.cert_version`
221+
- **Description:** The version of the certificate. This field specifies the version of the Auditor certificate.
222+
- **Default value:** `1`
223+
224+
:::note
225+
226+
This configuration is deprecated and will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only. For more details about authentication, see the [ScalarDL Authentication Guide](./authentication.mdx).
227+
228+
:::
229+
206230
### `grpc.deadline_duration_millis`
207231

208232
- **Field:** `scalar.dl.auditor.grpc.deadline_duration_millis`
209233
- **Description:** Deadline duration in milliseconds for each gRPC request.
210234
- **Default value:** empty (Optional)
211235

236+
### `grpc.max_inbound_message_size`
237+
238+
- **Field:** `scalar.dl.auditor.grpc.max_inbound_message_size`
239+
- **Description:** The maximum message size allowed for a single gRPC frame. If an inbound message larger than this limit is received, it will not be processed, and the RPC will fail with `RESOURCE_EXHAUSTED`.
240+
- **Default value:** empty (Optional)
241+
242+
### `grpc.max_inbound_metadata_size`
243+
244+
- **Field:** `scalar.dl.auditor.grpc.max_inbound_metadata_size`
245+
- **Description:** The maximum size of metadata allowed to be received. This is cumulative size of the entries with some overhead, as defined for HTTP/2's SETTINGS_MAX_HEADER_LIST_SIZE.
246+
- **Default value:** `8 KiB` (Optional)
247+
248+
### `ledger.cert_holder_id` (Deprecated)
249+
250+
- **Field:** `scalar.dl.auditor.ledger.cert_holder_id`
251+
- **Description:** The holder ID of the certificate of Ledger. This field is used to identify the certificate holder for the Ledger.
252+
- **Default value:** `ledger`
253+
254+
:::note
255+
256+
This configuration is deprecated and will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only. For more details about authentication, see the [ScalarDL Authentication Guide](./authentication.mdx).
257+
258+
:::
259+
260+
### `ledger.cert_version` (Deprecated)
261+
262+
- **Field:** `scalar.dl.auditor.ledger.cert_version`
263+
- **Description:** The version of the certificate. This field specifies the version of the Ledger certificate.
264+
- **Default value:** `1`
265+
266+
:::note
267+
268+
This configuration is deprecated and will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only. For more details about authentication, see the [ScalarDL Authentication Guide](./authentication.mdx).
269+
270+
:::
271+
212272
### `ledger.host`
213273

214274
- **Field:** `scalar.dl.auditor.ledger.host`
@@ -239,6 +299,18 @@ You can configure several settings for the Auditor server, such as service port
239299
- **Description:** Namespace of auditor tables.
240300
- **Default value:** `auditor` (Optional)
241301

302+
### `private_key_path`
303+
304+
- **Field:** `scalar.dl.auditor.private_key_path`
305+
- **Description:** The path to the private key file in PEM format. This or `scalar.dl.auditor.private_key_pem` is used to sign certificates with a digital signature. When `scalar.dl.auditor.servers.authentication.hmac.secret_key` is empty, the signature is also used by Ledger to authenticate the corresponding certificate from Auditor.
306+
- **Default value:** empty (Optional)
307+
308+
### `private_key_pem`
309+
310+
- **Field:** `scalar.dl.auditor.private_key_pem`
311+
- **Description:** PEM-encoded private key data. This or `scalar.dl.auditor.private_key_path` is used to sign certificates with a digital signature. When `scalar.dl.auditor.servers.authentication.hmac.secret_key` is empty, the signature is also used by Ledger to authenticate the corresponding certificate from Auditor.
312+
- **Default value:** empty (Optional)
313+
242314
### `server.admin_port`
243315

244316
- **Field:** `scalar.dl.auditor.server.admin_port`
@@ -281,18 +353,18 @@ You can configure several settings for the Auditor server, such as service port
281353
- **Description:** Prometheus exporter port.
282354
- **Default value:** `8080`
283355

284-
### `server.tls.enabled`
285-
286-
- **Field:** `scalar.dl.auditor.server.tls.enabled`
287-
- **Description:** A flag to enable TLS communication between clients and servers.
288-
- **Default value:** `false`
289-
290356
### `server.tls.cert_chain_path`
291357

292358
- **Field:** `scalar.dl.auditor.server.tls.cert_chain_path`
293359
- **Description:** Path to the certificate chain file used for TLS communication.
294360
- **Default value:** empty
295361

362+
### `server.tls.enabled`
363+
364+
- **Field:** `scalar.dl.auditor.server.tls.enabled`
365+
- **Description:** A flag to enable TLS communication between clients and servers.
366+
- **Default value:** `false`
367+
296368
### `server.tls.private_key_path`
297369

298370
- **Field:** `scalar.dl.auditor.server.tls.private_key_path`
@@ -305,12 +377,6 @@ You can configure several settings for the Auditor server, such as service port
305377
- **Description:** A secret key of HMAC for the authentication of messages between Ledger and Auditor servers.
306378
- **Default value:** empty (Optional)
307379

308-
### `tls.enabled`
309-
310-
- **Field:** `scalar.dl.auditor.tls.enabled`
311-
- **Description:** A flag to enable TLS communication.
312-
- **Default value:** `false`
313-
314380
### `tls.ca_root_cert_path`
315381

316382
- **Field:** `scalar.dl.auditor.tls.ca_root_cert_path`
@@ -323,6 +389,12 @@ You can configure several settings for the Auditor server, such as service port
323389
- **Description:** PEM-encoded custom CA root certificate for TLS communication.
324390
- **Default value:** empty
325391

392+
### `tls.enabled`
393+
394+
- **Field:** `scalar.dl.auditor.tls.enabled`
395+
- **Description:** A flag to enable TLS communication.
396+
- **Default value:** `false`
397+
326398
### `tls.override_authority`
327399

328400
- **Field:** `scalar.dl.auditor.tls.override_authority`
@@ -396,7 +468,7 @@ You can configure several settings for clients, such as Ledger server and Audito
396468
### `authentication.method`
397469

398470
- **Field:** `scalar.dl.client.authentication.method`
399-
- **Description:** The authentication method for a client and servers.
471+
- **Description:** The authentication method for clients and Ledger/Auditor servers. `digital-signature` or `hmac` can be specified. This must be consistent with the Ledger/Auditor configuration.
400472
- **Default value:** `digital-signature` (Optional)
401473

402474
### `authorization.credential`
@@ -405,12 +477,90 @@ You can configure several settings for clients, such as Ledger server and Audito
405477
- **Description:** An authorization credential for Ledger.
406478
- **Default value:** empty (Optional)
407479

480+
### `cert_holder_id` (Deprecated)
481+
482+
- **Field:** `scalar.dl.client.cert_holder_id`
483+
- **Description:** The holder ID of a certificate. This field is used to identify the certificate holder for the client.
484+
- **Default value:** empty
485+
486+
:::note
487+
488+
This configuration is deprecated and will be deleted in release 5.0.0. Use `scalar.dl.client.entity.id` instead. If both configurations are specified, `scalar.dl.client.entity.id` will be used.
489+
490+
:::
491+
492+
### `cert_path` (Deprecated)
493+
494+
- **Field:** `scalar.dl.client.cert_path`
495+
- **Description:** The path of a certificate file in PEM format. This field specifies the path to the client certificate file.
496+
- **Default value:** empty
497+
498+
:::note
499+
500+
This configuration is deprecated and will be deleted in release 5.0.0. Use `scalar.dl.client.entity.identity.digital_signature.cert_path` instead.
501+
502+
:::
503+
504+
### `cert_pem` (Deprecated)
505+
506+
- **Field:** `scalar.dl.client.cert_pem`
507+
- **Description:** PEM-encoded certificate data. This field specifies the PEM-encoded certificate data for the client.
508+
- **Default value:** empty
509+
510+
:::note
511+
512+
This configuration is deprecated and will be deleted in release 5.0.0. Use `scalar.dl.client.entity.identity.digital_signature.cert_pem` instead.
513+
514+
:::
515+
516+
### `cert_version` (Deprecated)
517+
518+
- **Field:** `scalar.dl.client.cert_version`
519+
- **Description:** The version of the certificate. This field specifies the version of the client certificate.
520+
- **Default value:** `1`
521+
522+
:::note
523+
524+
This configuration is deprecated and will be deleted in release 5.0.0. Use `scalar.dl.client.entity.identity.digital_signature.cert_version` instead.
525+
526+
:::
527+
408528
### `entity.id`
409529

410530
- **Field:** `scalar.dl.client.entity.id`
411531
- **Description:** A unique ID of a requester (e.g., a user or a device).
412532
- **Default value:** empty
413533

534+
### `entity.identity.digital_signature.cert_path`
535+
536+
- **Field:** `scalar.dl.client.entity.identity.digital_signature.cert_path`
537+
- **Description:** The path of a certificate file in PEM format, which is required if `scalar.dl.client.entity.identity.digital_signature.cert_pem` is empty.
538+
- **Default value:** empty
539+
540+
### `entity.identity.digital_signature.cert_pem`
541+
542+
- **Field:** `scalar.dl.client.entity.identity.digital_signature.cert_pem`
543+
- **Description:** PEM-encoded certificate data. Required if `scalar.dl.client.entity.identity.digital_signature.cert_path` is empty.
544+
- **Default value:** empty
545+
546+
### `entity.identity.digital_signature.cert_version`
547+
548+
- **Field:** `scalar.dl.client.entity.identity.digital_signature.cert_version`
549+
- **Description:** The version of the certificate.
550+
- **Default value:** `1` (Optional)
551+
552+
### `entity.identity.digital_signature.private_key_path`
553+
554+
- **Field:** `scalar.dl.client.entity.identity.digital_signature.private_key_path`
555+
- **Description:** The path of a private key file in PEM format, which corresponds to the specified certificate. Required if `scalar.dl.client.entity.identity.digital_signature.private_key_pem` is empty.
556+
- **Default value:** empty
557+
558+
### `entity.identity.digital_signature.private_key_pem`
559+
560+
- **Field:** `scalar.dl.client.entity.identity.digital_signature.private_key_pem`
561+
- **Description:** PEM-encoded private key data. Required if `scalar.dl.client.entity.identity.digital_signature.private_key_path` is empty.
562+
- **Default value:** empty
563+
414564
### `entity.identity.hmac.secret_key`
415565

416566
- **Field:** `scalar.dl.client.entity.identity.hmac.secret_key`
@@ -447,6 +597,30 @@ You can configure several settings for clients, such as Ledger server and Audito
447597
- **Description:** A client mode (CLIENT or INTERMEDIARY).
448598
- **Default value:** empty (Optional)
449599

600+
### `private_key_path` (Deprecated)
601+
602+
- **Field:** `scalar.dl.client.private_key_path`
603+
- **Description:** The path of a private key file in PEM format. This field specifies the path to the client private key file.
604+
- **Default value:** empty
605+
606+
:::note
607+
608+
This configuration is deprecated and will be deleted in release 5.0.0. Use `scalar.dl.client.entity.identity.digital_signature.private_key_path` instead.
609+
610+
:::
611+
612+
### `private_key_pem` (Deprecated)
613+
614+
- **Field:** `scalar.dl.client.private_key_pem`
615+
- **Description:** PEM-encoded private key data. This field specifies the PEM-encoded private key data for the client.
616+
- **Default value:** empty
617+
618+
:::note
619+
620+
This configuration is deprecated and will be deleted in release 5.0.0. Use `scalar.dl.client.entity.identity.digital_signature.private_key_pem` instead.
621+
622+
:::
623+
450624
### `server.host`
451625

452626
- **Field:** `scalar.dl.client.server.host`

0 commit comments

Comments
 (0)