Skip to content

Commit 0624b7d

Browse files
committed
Fix initial settings reference
1 parent 3e248e2 commit 0624b7d

File tree

1 file changed

+103
-37
lines changed

1 file changed

+103
-37
lines changed

doc/tooling/tcm/tcm_configuration_reference.rst

Lines changed: 103 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2299,15 +2299,17 @@ TODO: doc link :ref:`tcm_connect_clusters`
22992299

23002300
.. important::
23012301

2302-
no env vars?
2303-
no cli opts?
2302+
The ``initial-settings.*`` configuration options can be set in the YAML
2303+
configuration file only. There are no environment variables nor
2304+
command-line options for them.
23042305

23052306
.. _tcm_configuration_reference_initial_clusters:
23062307

23072308
.. confval:: initial-settings.clusters
23082309

2309-
An array of clusters to connect to |tcm| automatically upon the first startup.
2310-
TODO: link to instruction
2310+
An array of clusters to create in |tcm| automatically upon the first startup.
2311+
2312+
See also :ref:`tcm_connect_clusters`.
23112313

23122314
|
23132315
| Type: []Cluster
@@ -2324,7 +2326,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
23242326

23252327
|
23262328
| Type: string
2327-
| Default: ""
2329+
| Default: "" (ID is generated automatically)
23282330
23292331

23302332
.. _tcm_configuration_reference_initial_cluster_name:
@@ -2369,11 +2371,11 @@ TODO: doc link :ref:`tcm_connect_clusters`
23692371
- ``yellow``
23702372
- ``orange``
23712373
- ``teal``
2372-
- empty string (no highlighting)
2374+
- empty string (no color)
23732375

23742376
|
23752377
| Type: string
2376-
| Default: ""
2378+
| Default: "" (no color)
23772379
23782380

23792381
.. _tcm_configuration_reference_initial_cluster_urls:
@@ -2391,7 +2393,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
23912393

23922394
.. confval:: initial-settings.clusters.<cluster>.<url>.label
23932395

2394-
URL label to show in |tcm|.
2396+
URL label to show in |tcm|. Typically, this is the linked service name.
23952397

23962398
|
23972399
| Type: string
@@ -2401,7 +2403,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
24012403

24022404
.. confval:: initial-settings.clusters.<cluster>.<url>.url
24032405

2404-
The URL address.
2406+
The URL address of the linked service.
24052407

24062408
|
24072409
| Type: string
@@ -2421,18 +2423,17 @@ TODO: doc link :ref:`tcm_connect_clusters`
24212423

24222424
|
24232425
| Type: string
2424-
| Default: TBD??
2426+
| Default: ??TODO
24252427
24262428
.. _tcm_configuration_reference_initial_cluster_storage_etcd_endpoints:
24272429

24282430
.. confval:: initial-settings.clusters.<cluster>.storage-connection.etcd-connection.endpoints
24292431

2430-
An array of node URIs of the etcd cluster where the Tarantool cluster configuration is stored,
2431-
separated by semicolons (;).
2432+
An array of node URIs of the etcd cluster where the Tarantool cluster configuration is stored.
24322433

24332434
|
24342435
| Type: []string
2435-
| Default: TBD??
2436+
| Default: []
24362437
24372438
.. _tcm_configuration_reference_initial_cluster_storage_etcd_autosync:
24382439

@@ -2441,8 +2442,8 @@ TODO: doc link :ref:`tcm_connect_clusters`
24412442
An automated sync interval.
24422443

24432444
|
2444-
| Type: string
2445-
| Default:
2445+
| Type: time.Duration
2446+
| Default: TODO??
24462447
24472448
.. _tcm_configuration_reference_initial_cluster_storage_etcd_dialtimeout:
24482449

@@ -2452,7 +2453,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
24522453

24532454
|
24542455
| Type: time.Duration
2455-
| Default: 10s TBD:check
2456+
| Default: TODO??
24562457
24572458
.. _tcm_configuration_reference_initial_cluster_storage_etcd_dialkatime:
24582459

@@ -2462,7 +2463,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
24622463

24632464
|
24642465
| Type: time.Duration
2465-
| Default: 30s TBD:check
2466+
| Default: TODO??
24662467
24672468
.. _tcm_configuration_reference_initial_cluster_storage_etcd_dialkatimeout:
24682469

@@ -2472,29 +2473,29 @@ TODO: doc link :ref:`tcm_connect_clusters`
24722473

24732474
|
24742475
| Type: time.Duration
2475-
| Default: 30s TBD:check
2476+
| Default: TODO??
24762477
24772478
.. _tcm_configuration_reference_initial_cluster_storage_etcd_maxcallsend:
24782479

24792480
.. confval:: initial-settings.clusters.<cluster>.storage-connection.etcd-connection.max-call-send-msg-size
24802481

2481-
The maximum size (in bytes) of a transaction between the cluster and its etcd
2482-
configuration storage. TBD:check
2482+
The maximum size (in bytes) of a message between the cluster and its etcd
2483+
configuration storage. TODO:check
24832484

24842485
|
24852486
| Type: int
2486-
| Default: 2097152 TBD:check
2487+
| Default: TODO?? 2097152?
24872488
24882489
.. _tcm_configuration_reference_initial_cluster_storage_etcd_maxcallrecv:
24892490

24902491
.. confval:: initial-settings.clusters.<cluster>.storage-connection.etcd-connection.max-call-recv-msg-size
24912492

2492-
The maximum size (in bytes) of a transaction between the cluster and its etcd
2493+
The maximum size (in bytes) of a message between the cluster and its etcd
24932494
configuration storage. TBD:check
24942495

24952496
|
24962497
| Type: int
2497-
| Default: 2097152 TBD:check
2498+
| Default: TODO?? 2097152
24982499
24992500
.. _tcm_configuration_reference_initial_cluster_storage_etcd_username:
25002501

@@ -2520,7 +2521,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
25202521

25212522
.. confval:: initial-settings.clusters.<cluster>.storage-connection.etcd-connection.reject-old-cluster
25222523

2523-
TBD: ??
2524+
TODO: ??
25242525

25252526
|
25262527
| Type: bool TBD:check
@@ -2534,7 +2535,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
25342535

25352536
|
25362537
| Type: bool
2537-
| Default: false TBD:check
2538+
| Default: false
25382539
25392540
.. _tcm_configuration_reference_initial_cluster_storage_etcd_method:
25402541

@@ -2554,7 +2555,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
25542555

25552556
|
25562557
| Type: string
2557-
| Default: "" TBD:check
2558+
| Default: ""
25582559
25592560

25602561
.. _tcm_configuration_reference_initial_cluster_etcd_tls_enabled:
@@ -2696,7 +2697,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
26962697

26972698
|
26982699
| Type: string
2699-
| Default:
2700+
| Default: ""
27002701
27012702
.. _tcm_configuration_reference_initial_cluster_storage_tarantool_password:
27022703

@@ -2706,7 +2707,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
27062707

27072708
|
27082709
| Type: string
2709-
| Default:
2710+
| Default: ""
27102711
27112712

27122713
.. _tcm_configuration_reference_initial_cluster_storage_tarantool_endpoints:
@@ -2717,7 +2718,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
27172718

27182719
|
27192720
| Type: []string
2720-
| Default: ""
2721+
| Default: []
27212722
27222723
.. _tcm_configuration_reference_initial_cluster_storage_tarantool_method:
27232724

@@ -2744,7 +2745,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
27442745

27452746
|
27462747
| Type: string
2747-
| Default: "" TBD:check
2748+
| Default: "" TODO:check
27482749
27492750

27502751
.. _tcm_configuration_reference_initial_cluster_storage_tarantool_ssl_key-file:
@@ -2852,7 +2853,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
28522853

28532854
An authentication method for connecting to the cluster.
28542855

2855-
TBD: values
2856+
TODO: values
28562857

28572858
|
28582859
| Type: string
@@ -2866,7 +2867,7 @@ TODO: doc link :ref:`tcm_connect_clusters`
28662867

28672868
|
28682869
| Type: time.Duration
2869-
| Default: TBD
2870+
| Default: TODO
28702871
28712872
.. _tcm_configuration_reference_initial_cluster_tarantool_rate-limit:
28722873

@@ -2876,14 +2877,79 @@ TODO: doc link :ref:`tcm_connect_clusters`
28762877

28772878
|
28782879
| Type: uint
2879-
| Default: TBD
2880+
| Default: TODO
28802881
2881-
.. _tcm_configuration_reference_initial_cluster_tarantool_ssl:
28822882

2883-
.. confval:: initial-settings.clusters.<cluster>.tarantool-connection.ssl
2883+
.. _tcm_configuration_reference_initial_cluster__tarantool_ssl_key-file:
28842884

2885-
tbd
2885+
.. confval:: initial-settings.clusters.<cluster>.tarantool-connection.ssl.key-file
2886+
2887+
A path to a TLS private key file to use for connecting to the cluster instances.
2888+
2889+
See also: :ref:`configuration_connections_ssl`.
28862890

28872891
|
28882892
| Type: string
2889-
| Default: ""
2893+
| Default: ""
2894+
2895+
.. _tcm_configuration_reference_initial_cluster_tarantool_ssl_cert-file:
2896+
2897+
.. confval:: initial-settings.clusters.<cluster>.tarantool-connection.ssl.cert-file
2898+
2899+
A path to an SSL certificate to use for connecting to the cluster instances.
2900+
2901+
See also: :ref:`configuration_connections_ssl`.
2902+
2903+
|
2904+
| Type: string
2905+
| Default: ""
2906+
2907+
.. _tcm_configuration_reference_initial_cluster_tarantool_ssl_ca-file:
2908+
2909+
.. confval:: initial-settings.clusters.<cluster>.tarantool-connection.ssl.ca-file
2910+
2911+
A path to a trusted CA certificate to use for connecting to the cluster instances.
2912+
2913+
See also: :ref:`configuration_connections_ssl`.
2914+
2915+
|
2916+
| Type: string
2917+
| Default: ""
2918+
2919+
.. _tcm_configuration_reference_initial_cluster_tarantool_ssl_ciphers:
2920+
2921+
.. confval:: initial-settings.clusters.<cluster>.tarantool-connection.ssl.ciphers
2922+
2923+
A list of SSL cipher suites that can be used for connecting to the cluster instances.
2924+
Possible values are listed in :ref:`<uri>.params.ssl_ciphers <configuration_reference_iproto_uri_params_ssl_ciphers>`.
2925+
2926+
See also: :ref:`configuration_connections_ssl`.
2927+
2928+
|
2929+
| Type: string
2930+
| Default: ""
2931+
2932+
.. _tcm_configuration_reference_initial_cluster_tarantool_ssl_enabled:
2933+
2934+
.. confval:: initial-settings.clusters.<cluster>.tarantool-connection.ssl.enabled
2935+
2936+
A password for an encrypted private SSL key to use for connecting to the cluster instances.
2937+
2938+
See also: :ref:`configuration_connections_ssl`.
2939+
2940+
|
2941+
| Type: string
2942+
| Default: ""
2943+
2944+
.. _tcm_configuration_reference_initial_cluster_tarantool_ssl_password-file:
2945+
2946+
.. confval:: initial-settings.clusters.<cluster>.tarantool-connection.ssl.password-file
2947+
2948+
A text file with passwords for encrypted private SSL keys to use
2949+
for connecting to the cluster instances.
2950+
2951+
See also: :ref:`configuration_connections_ssl`.
2952+
2953+
|
2954+
| Type: string
2955+
| Default: ""

0 commit comments

Comments
 (0)