4
4
5
5
# The path to the file where access credentials for Concourse Server are
6
6
# stored. For optimal security, this file should be placed in a separate
7
- # directory from Concourse Server with more restrictive operating system
7
+ # directory from Concourse Server with more restrictive operating system
8
8
# permissions
9
9
#
10
10
# DEFAULT {$concourse.home}/.access
@@ -26,8 +26,8 @@ buffer_directory:
26
26
buffer_page_size :
27
27
28
28
# The listener port (1-65535) for client connections. Choose a port between
29
- # 49152 and 65535 to minimize the possibility of conflicts with other services
30
- # on this host.
29
+ # 49152 and 65535 to minimize the possibility of conflicts with other
30
+ # services on this host.
31
31
#
32
32
# DEFAULT: 1717
33
33
client_port :
@@ -40,9 +40,9 @@ client_port:
40
40
# DEFAULT: {$user.home}/concourse/db
41
41
database_directory :
42
42
43
- # The default environment that is automatically loaded when the server
44
- # starts and is used whenever a client does not specify an environment
45
- # for the connection.
43
+ # The default environment that is automatically loaded when the server starts
44
+ # and is used whenever a client does not specify an environment for the
45
+ # connection.
46
46
#
47
47
# DEFAULT: default
48
48
default_environment :
@@ -53,17 +53,17 @@ default_environment:
53
53
# DEFAULT: false
54
54
enable_console_logging :
55
55
56
- # The amount of memory that is allocated to the Concourse Server JVM.
57
- # Concourse requires a minimum heap size of 256MB to start, but much
58
- # more is recommended to ensure that read and write operations avoid
59
- # expensive disk seeks where possible. Concourse generally sets both
60
- # the initial and maximum heap sizes to the specified value, so there
61
- # must be enough system memory available for Concourse Server to start.
62
- #
63
- # Be careful and avoid setting the heap size too large because this may
64
- # cause longer garbage collection (gc) pauses or interfere with the ability
65
- # of Concourse Server to memory map (mmap) certain data files. We
66
- # recommend the following sizing guidelines:
56
+ # The amount of memory that is allocated to the Concourse Server JVM. Concourse
57
+ # requires a minimum heap size of 256MB to start, but much more is recommended
58
+ # to ensure that read and write operations avoid expensive disk seeks where
59
+ # possible. Concourse generally sets both the initial and maximum heap sizes to
60
+ # the specified value, so there must be enough system memory available for
61
+ # Concourse Server to start.
62
+ #
63
+ # Be careful and avoid setting the heap size too large because this may cause
64
+ # longer garbage collection (gc) pauses or interfere with the ability of
65
+ # Concourse Server to memory map (mmap) certain data files. We recommend the
66
+ # following sizing guidelines:
67
67
#
68
68
# SYSTEM MEMORY | Recommended heap_size
69
69
# -----------------------------------------------------------
@@ -89,46 +89,46 @@ http_port:
89
89
http_enable_cors :
90
90
91
91
# A comma separated list of default URIs that are permitted to access HTTP
92
- # endpoints. By default (if enabled), the value of this preference is set
93
- # to the wildcard character '*' which means that any origin is allowed access.
92
+ # endpoints. By default (if enabled), the value of this preference is set to
93
+ # the wildcard character '*' which means that any origin is allowed access.
94
94
# Changing this value to a discrete list will set the default origins that are
95
95
# permitted, but individual endpoints may override this value.
96
96
#
97
97
# DEFAULT: (allow any origin)
98
98
http_cors_default_allow_origin :
99
99
100
- # A comma separated list of default headers that are sent in response to a
101
- # CORS preflight request to indicate which HTTP headers can be used when
102
- # making the actual request. By default (if enabled), the value of this
103
- # preference is set to the wildcard character '*' which means that any headers
104
- # specified in the preflight request are allowed. Changing this value to a
105
- # discrete list will set the default headers that are permitted, but individual
106
- # endpoints may override this value.
100
+ # A comma separated list of default headers that are sent in response to a CORS
101
+ # preflight request to indicate which HTTP headers can be used when making the
102
+ # actual request. By default (if enabled), the value of this preference is set
103
+ # to the wildcard character '*' which means that any headers specified in the
104
+ # preflight request are allowed. Changing this value to a discrete list will
105
+ # set the default headers that are permitted, but individual endpoints may
106
+ # override this value.
107
107
#
108
108
# DEFAULT: (allow any headers)
109
109
http_cors_default_allow_headers :
110
110
111
111
# A comma separated list of default methods that are sent in response to a
112
- # CORS preflight request to indicate which HTTP methods can be used when making
113
- # the actual request. By default (if enabled), the value of this preference is
114
- # set to the wildcard character '*' which means that any method specified in the
115
- # preflight request is allowed. Changing this value to a discrete list will set
116
- # the default methods that are permitted, but individual endpoints may override
117
- # this value.
112
+ # CORS preflight request to indicate which HTTP methods can be used when
113
+ # making the actual request. By default (if enabled), the value of this
114
+ # preference is set to the wildcard character '*' which means that any method
115
+ # specified in the preflight request is allowed. Changing this value to a
116
+ # discrete list will set the default methods that are permitted, but individual
117
+ # endpoints may override this value.
118
118
#
119
119
# DEFAULT: (allow any method)
120
120
http_cors_default_allow_methods :
121
121
122
- # The initial root password for Concourse Server. This password is used to set
123
- # up the initial administrator account when the server is first run. It is strongly
124
- # recommended to change this password immediately after the initial setup to maintain
125
- # security.
122
+ # The initial root password for Concourse Server. This password is used to set
123
+ # up the initial administrator account when the server is first run. It is
124
+ # strongly recommended to change this password immediately after the initial
125
+ # setup to maintain security.
126
126
#
127
127
# DEFAULT: "admin"
128
128
init_root_password :
129
129
130
- # The initial root username for Concourse Server. This username is associated with the
131
- # initial administrator account. It is strongly
130
+ # The initial root username for Concourse Server. This username is associated
131
+ # with the initial administrator account.
132
132
#
133
133
# DEFAULT: "admin"
134
134
init_root_username :
@@ -148,8 +148,8 @@ jmx_port:
148
148
#
149
149
# ERROR: critical information when the system reaches a potentially fatal
150
150
# state and may not operate normally.
151
- # WARN: useful information when the system reaches a less than ideal state but
152
- # can continue to operate normally.
151
+ # WARN: useful information when the system reaches a less than ideal state
152
+ # but can continue to operate normally.
153
153
# INFO: status information about the system that can be used for sanity
154
154
# checking.
155
155
# DEBUG: detailed information about the system that can be used to diagnose
@@ -164,16 +164,16 @@ log_level:
164
164
165
165
# The length of the longest substring that will be indexed for fulltext search.
166
166
#
167
- # This value does not mean that longer words will not be indexed. It simply means
168
- # that, for any indexable value (e.g. a String), any substring that is longer than
169
- # the value of this preference will not be added to the search index. The effect is
170
- # that search strings containing any words with a length greater than the value of
171
- # this preference will return 0 results.
172
-
173
- # For best performance, this value should be set to the longest word length of any
174
- # possible search string. To be safe, we recommend setting this value to be the
175
- # length of the longest possible word in the search language. For example, the longest
176
- # possible word in English is about 40 characters long.
167
+ # This value does not mean that longer words will not be indexed. It simply
168
+ # means that, for any indexable value (e.g. a String), any substring that is
169
+ # longer than the value of this preference will not be added to the search
170
+ # index. The effect is that search strings containing any words with a length
171
+ # greater than the value of this preference will return 0 results.
172
+ #
173
+ # For best performance, this value should be set to the longest word length of
174
+ # any possible search string. To be safe, we recommend setting this value to be
175
+ # the length of the longest possible word in the search language. For example,
176
+ # the longest possible word in English is about 40 characters long.
177
177
#
178
178
# DEFAULT: 40
179
179
max_search_substring_length :
@@ -187,10 +187,10 @@ max_search_substring_length:
187
187
# DEFAULT: automatically chosen based on the client_port
188
188
shutdown_port :
189
189
190
- # The listener port (1-65535) for remote debugger connections. Choose a port between
191
- # 49152 and 65535 to minimize the possibility of conflicts with other services
192
- # on this host. If the value of this preference is set to 0, then remote debugging for
193
- # Concourse Server is disabled.
190
+ # The listener port (1-65535) for remote debugger connections. Choose a port
191
+ # between 49152 and 65535 to minimize the possibility of conflicts with other
192
+ # services on this host. If the value of this preference is set to 0, then
193
+ # remote debugging for Concourse Server is disabled.
194
194
#
195
195
# DEFAULT: 0
196
196
remote_debugger_port :
@@ -199,12 +199,31 @@ remote_debugger_port:
199
199
# ## EXPERIMENTAL CONFIGURATION FOR CONCOURSE SERVER ###
200
200
# ########################################################
201
201
202
- # Automatically use a combination of defragmentation, garbage collection and load
203
- # balancing within the data files to optimize storage for read performance.
202
+ # Potentially use multiple threads to asynchronously read data from disk.
203
+ #
204
+ # When enabled, reads will typically be faster when accessing data that is too
205
+ # large to ever fit in memory or no longer cached due to memory constraints.
206
+ #
207
+ # This setting is particularly useful for search data since those indexes are
208
+ # not cached by default (unless ENABLE_SEARCH_CACHE is enabled). Even if search
209
+ # records are cached, this setting may still provide a performance boost if the
210
+ # size of some search metadata exceeds the limits of what is cacheable in
211
+ # memory.
212
+ #
213
+ # NOTE: There might be some overhead that could make some reads slower if all
214
+ # their relevant segment metadata is cached and there is high contention.
215
+ #
216
+ # DEFAULT: false
217
+ enable_async_data_reads :
218
+
219
+ # Automatically use a combination of defragmentation, garbage collection and
220
+ # load balancing within the data files to optimize storage for read
221
+ # performance.
204
222
#
205
- # The compaction process may run continuously in the background without disrupting
206
- # reads or writes. The storage engine uses a specific strategy to determine how
207
- # data files should be reorganized to improve the performance of read operations.
223
+ # The compaction process may run continuously in the background without
224
+ # disrupting reads or writes. The storage engine uses a specific strategy to
225
+ # determine how data files should be reorganized to improve the performance of
226
+ # read operations.
208
227
#
209
228
# DEFAULT: false
210
229
enable_compaction :
@@ -215,29 +234,29 @@ enable_compaction:
215
234
# for essential metadata by a third. As a result, overall system performance may
216
235
# improve due to a reduction in garbage collection pauses.
217
236
#
218
- # However, this setting may increase CPU usage and slightly reduce peak performance
219
- # on a per-operation basis due to weaker reference locality.
237
+ # However, this setting may increase CPU usage and slightly reduce peak
238
+ # performance on a per-operation basis due to weaker reference locality.
220
239
#
221
240
# DEFAULT: false
222
241
enable_efficient_metadata :
223
242
224
- # Maintain and in-memory cache of the data indexes used to respond to search commands.
225
- # Search indexes tend to be much larger than those used for primary and secondary
226
- # lookups, so enabling the search cache may cause memory issues (and overall
227
- # performance degradation) if search is heavily used. Furthermore, indexing and
228
- # write performance may suffer if cached search indexes must be incrementally kept
229
- # current.
243
+ # Maintain and in-memory cache of the data indexes used to respond to search
244
+ # commands. Search indexes tend to be much larger than those used for primary
245
+ # and secondary lookups, so enabling the search cache may cause memory issues
246
+ # (and overall performance degradation) if search is heavily used. Furthermore,
247
+ # indexing and write performance may suffer if cached search indexes must be
248
+ # incrementally kept current.
230
249
#
231
250
# DEFAULT: false
232
251
enable_search_cache :
233
252
234
253
# Attempt to optimize verify commands by using special lookup records.
235
254
#
236
- # A lookup record only contains data for a single field. The database does not cache
237
- # lookup records, so, while generating one is theoretically faster than generating a
238
- # full or partial record, repeated attempts to verify data in the same field (e.g. a
239
- # counter whose value is stored against a single locator/key) or record may be slower
240
- # due to lack of caching.
255
+ # A lookup record only contains data for a single field. The database does not
256
+ # cache lookup records, so, while generating one is theoretically faster than
257
+ # generating a full or partial record, repeated attempts to verify data in the
258
+ # same field (e.g. a counter whose value is stored against a single
259
+ # locator/key) or record may be slower due to lack of caching.
241
260
#
242
261
# DEFAULT: false
243
262
enable_verify_by_lookup :
@@ -247,22 +266,22 @@ enable_verify_by_lookup:
247
266
# ############################################
248
267
init :
249
268
250
- # Configuration for the root user. If provided, will override values for flat config
251
- # options that are prefixed with "init_"
269
+ # Configuration for the root user. If provided, will override values for flat
270
+ # config options that are prefixed with "init_"
252
271
root :
253
272
254
- # The initial root password for Concourse Server. This password is used to set
255
- # up the initial administrator account when the server is first run. It is
256
- # strongly recommended to change this password immediately after the initial setup
257
- # to maintain security.
273
+ # The initial root password for Concourse Server. This password is used to
274
+ # set up the initial administrator account when the server is first run. It
275
+ # is strongly recommended to change this password immediately after the
276
+ # initial setup to maintain security.
258
277
#
259
278
# DEFAULT: the value of the init_root_password option, if available.
260
279
# Otherwise "admin"
261
280
password :
262
281
263
- # The initial root username for Concourse Server. This username is associated
264
- # with the initial administrator account. It is strongly
282
+ # The initial root username for Concourse Server. This username is
283
+ # associated with the initial administrator account.
265
284
#
266
- # DEFAULT: the value of the init_root_username option, if available.
285
+ # DEFAULT: the value of the init_root_username option, if available.
267
286
# Otherwise "admin"
268
- username:
287
+ username :
0 commit comments