Skip to content

Commit 0d56615

Browse files
committed
[irods/irods#7700] Remove optional annotations from required config properties.
This commit also sorts config properties within the "dns_cache" and "hostname_cache" stanzas.
1 parent 7df54e2 commit 0d56615

File tree

1 file changed

+10
-17
lines changed

1 file changed

+10
-17
lines changed

docs/system_overview/configuration.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -34,50 +34,45 @@ iRODS 5 servers only require a working `server_config.json` file. All server pro
3434
// The number of seconds a server-side temporary password is good.
3535
"default_temporary_password_lifetime_in_seconds": 120,
3636

37-
// (Optional)
3837
// A list of iRODS server hostnames the delay server dispatches rules to for execution.
3938
// If the list is empty, the delay server will dispatch rules to the local server for execution.
4039
"delay_rule_executors": [],
4140

42-
// (Optional)
4341
// The number of seconds the delay server sleeps before checking the catalog for rules
4442
// ready for execution.
4543
"delay_server_sleep_time_in_seconds": 30,
4644

47-
// (Optional)
4845
// Contains settings for controlling the behavior of the internal DNS cache.
4946
"dns_cache": {
50-
// The amount of shared memory allocated to the DNS cache.
51-
"shared_memory_size_in_bytes": 5000000,
47+
// The number of seconds between runs of the CRON task which clears the internal DNS cache.
48+
// Changing this value requires a server restart in order to take effect.
49+
"cache_clearer_sleep_time_in_seconds": 600,
5250

5351
// The amount of time an entry stays valid before being evicted from the cache.
5452
"eviction_age_in_seconds": 3600,
5553

56-
// The number of seconds between runs of the CRON task which clears the internal DNS cache.
57-
// Changing this value requires a server restart in order to take effect.
58-
"cache_clearer_sleep_time_in_seconds": 600
54+
// The amount of shared memory allocated to the DNS cache.
55+
"shared_memory_size_in_bytes": 5000000
5956
},
6057

61-
// (Optional)
6258
// Contains settings for controlling the behavior of the internal Hostname cache.
6359
"hostname_cache": {
64-
// The amount of shared memory allocated to the Hostname cache.
65-
"shared_memory_size_in_bytes": 2500000,
60+
// The number of seconds between runs of the CRON task which clears the internal hostname cache.
61+
// Changing this value requires a server restart in order to take effect.
62+
"cache_clearer_sleep_time_in_seconds": 600,
6663

6764
// The amount of time an entry stays valid before being evicted from the cache.
6865
"eviction_age_in_seconds": 3600,
6966

70-
// The number of seconds between runs of the CRON task which clears the internal hostname cache.
71-
// Changing this value requires a server restart in order to take effect.
72-
"cache_clearer_sleep_time_in_seconds": 600
67+
// The amount of shared memory allocated to the Hostname cache.
68+
"shared_memory_size_in_bytes": 2500000
7369
},
7470

7571
// Defines the maximum data size for single buffer transfers.
7672
// When the data size exceeds the defined threshold, parallel transfer is used.
7773
// Connecting clients and servers within the same zone must use the same value.
7874
"maximum_size_for_single_buffer_in_megabytes": 32,
7975

80-
// (Optional)
8176
// The maximum number of bytes available to the delay queue.
8277
// When set to 0, the delay server will use as much memory as it needs to hold queued rules.
8378
"maximum_size_of_delay_queue_in_bytes": 0,
@@ -89,11 +84,9 @@ iRODS 5 servers only require a working `server_config.json` file. All server pro
8984
// Changing this value requires a server restart in order to take effect.
9085
"migrate_delay_server_sleep_time_in_seconds": 5,
9186

92-
// (Optional)
9387
// The number of delay rules allowed to execute simultaneously.
9488
"number_of_concurrent_delay_rule_executors": 4,
9589

96-
// (Optional)
9790
// The amount of time the stacktrace file processing thread sleeps before files are
9891
// processed and written to the log file.
9992
// Changing this value requires a server restart in order to take effect.

0 commit comments

Comments
 (0)