Skip to content

Commit 8d60169

Browse files
bbatscheshiftedreality
authored andcommitted
MAGECLOUD-3651: Update description of variables that support _merge (#577)
1 parent 5d98db5 commit 8d60169

File tree

1 file changed

+47
-37
lines changed

1 file changed

+47
-37
lines changed

dist/.magento.env.yaml

Lines changed: 47 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,11 @@
243243
# deploy: #
244244
# REDIS_USE_SLAVE_CONNECTION: true #
245245
#######################################################################################################################
246-
# QUEUE_CONFIGURATION - use this environment variable to retain customized AMQP service settings between deployments. #
246+
# QUEUE_CONFIGURATION - Replace or modify the AMQP configuration generated during the deployment process. This #
247+
# configuration is generated only if your project has been configured with a RabbitMQ service. #
248+
# To replace the existing configuration, specify values for each configuration option required #
249+
# for your environment. To modify the existing configuration, specify values only for the #
250+
# options to add or update. Then, add the `_merge: true` option. #
247251
# Magento Version: 2.1.4 and later #
248252
# Default value: not set #
249253
# Stages: deploy #
@@ -261,7 +265,11 @@
261265
# host: mq.host #
262266
# port: 1234 #
263267
#######################################################################################################################
264-
# SEARCH_CONFIGURATION - use this variable to retain customized search service settings between deployments. #
268+
# SEARCH_CONFIGURATION - Replace or modify the Magento search configuration generated during the deployment process. #
269+
# The generated configuration is based on the available relationships. #
270+
# To replace the existing configuration, specify values for each configuration option required #
271+
# for your environment. To modify the existing configuration, specify values only for the #
272+
# options to add or update. Then, add the `_merge: true` option. #
265273
# Magento Version: 2.1.4 and later #
266274
# Default value: not set #
267275
# Stages: deploy #
@@ -275,9 +283,11 @@
275283
# elasticsearch_index_prefix: magento #
276284
# elasticsearch_server_timeout: '15' #
277285
#######################################################################################################################
278-
# ELASTICSUITE_CONFIGURATION - use this variable to retain customized ElasticSuite service settings #
279-
# between deployments. All configs provided in this configuration are nested in main ElasticSuite #
280-
# config section 'system/default/smile_elasticsuite_core_base_settings' #
286+
# ELASTICSUITE_CONFIGURATION - Customize ElasticSuite service configuration stored in the #
287+
# 'system/default/smile_elasticsuite_core_base_settings' section of the config.php file. #
288+
# To replace the existing configuration, specify values for each configuration option #
289+
# required for your environment. To modify the existing configuration, specify values #
290+
# only for the options to add or update. Then, add the `_merge: true` option. #
281291
# Magento Version: 2.2.0 and later #
282292
# Default value: Depends on template configuration of ElasticSearch (i.e. default number of replicas and shards) #
283293
# and ElasticSearch host. #
@@ -320,22 +330,10 @@
320330
# - consumer1 #
321331
# - consumer2 #
322332
#######################################################################################################################
323-
# LOCK_PROVIDER - use to set the lock provider. #
324-
# The lock provider prevents the launch of duplicate cron jobs and cron groups. #
325-
# You must use the file lock provider in the Production environment. Starter environments and #
326-
# the Pro Integration environment do not use the MAGENTO_CLOUD_LOCKS_DIR variable, so ece-tools #
327-
# applies the db lock provider automatically. #
328-
# Magento Version: 2.2.5 and later #
329-
# Default value: "file" #
330-
# Stages: deploy #
331-
# Example: #
332-
# stage: #
333-
# deploy: #
334-
# LOCK_PROVIDER: "db" #
335-
#######################################################################################################################
336-
# CACHE_CONFIGURATION - use to configure Redis page and default caching. By default, the deployment process #
337-
# overwrites all settings in the env.php file. When setting the cm_cache_backend_redis #
338-
# parameter, you must specify the server, port, and database options. #
333+
# CACHE_CONFIGURATION - Replace or modify the Magento cache configuration generated during the deployment process. #
334+
# To replace the existing configuration, specify values for each configuration option required #
335+
# for your environment. To modify the existing configuration, specify values only for the #
336+
# options to add or update. Then, add the `_merge: true` option. #
339337
# Magento Version: Magento 2.1.4 and later #
340338
# Default value: not set #
341339
# Stages: deploy #
@@ -349,9 +347,24 @@
349347
# page_cache: #
350348
# backend: file #
351349
#######################################################################################################################
352-
# SESSION_CONFIGURATION - use to configure Redis session storage. You must specify the save, redis, host, port, #
353-
# and database options for the session storage variable. #
354-
# By default, the deployment process overwrites all settings in the env.php file. #
350+
# LOCK_PROVIDER - Use to set the lock provider. #
351+
# The lock provider prevents the launch of duplicate cron jobs and cron groups. #
352+
# You must use the file lock provider in the Production environment. Starter environments and #
353+
# the Pro Integration environment do not use the MAGENTO_CLOUD_LOCKS_DIR variable, so ece-tools #
354+
# applies the db lock provider automatically. #
355+
# Magento Version: 2.2.5 and later #
356+
# Default value: "file" #
357+
# Stages: deploy #
358+
# Example: #
359+
# stage: #
360+
# deploy: #
361+
# LOCK_PROVIDER: "db" #
362+
#######################################################################################################################
363+
# SESSION_CONFIGURATION - Replace or modify the Magento session configuration generated during the deployment process.#
364+
# By default, ece-tools configures Magento to store Redis session data. #
365+
# To replace the existing configuration, specify values for each configuration option #
366+
# required for your environment. To modify the existing configuration, specify values only #
367+
# for the options to add or change. Then, add the `_merge: true` option. #
355368
# Magento Version: Magento 2.1.4 and later #
356369
# Default value: not set #
357370
# Stages: deploy #
@@ -371,10 +384,11 @@
371384
# port: 6379 #
372385
# save: redis #
373386
#######################################################################################################################
374-
# DATABASE_CONFIGURATION - use to configure database connections. You must specify at least the default connection. #
375-
# By default, the deployment process overwrites all settings in the env.php file. #
376-
# In case when added option "_merge: true" setting are merging with default configuration. #
377-
# #
387+
# DATABASE_CONFIGURATION – Customize the Magento database connection information generated by ece-tools during the #
388+
# deployment process. #
389+
# To replace the existing configuration, specify values for each configuration option #
390+
# required for your environment. To modify the existing configuration, specify values only #
391+
# for the options to add or update. Then, add the `_merge: true` option. #
378392
# Magento Version: Magento 2.1.4 and later #
379393
# Default value: not set #
380394
# Stages: deploy #
@@ -409,15 +423,11 @@
409423
# initStatements: SET NAMES utf8 #
410424
# active: 1 #
411425
#######################################################################################################################
412-
# RESOURCE_CONFIGURATION - use to map a resource name to a database connection. #
413-
# By default, the deployment process overwrites all settings in the env.php file; #
414-
# however, you can choose to merge one or more values for a service configuration without #
415-
# overwriting all of the values. #
416-
# #
417-
# Set the _merge option to one of the following: #
418-
# true - Merge the configured service values with the environment variable values. #
419-
# false - Overwrite the configured service values with the environment variable values. #
420-
# #
426+
# RESOURCE_CONFIGURATION - Replace or modify the data connection resource configuration generated during deployment. #
427+
# This configuration maps a resource name to a database connection. #
428+
# To replace the existing configuration, specify values for each configuration option #
429+
# needed for your environment. To modify the existing configuration, specify values only for #
430+
# the options to add or update. Then, add the `_merge: true` option. #
421431
# Magento Version: Magento 2.1.4 and later #
422432
# Default value: not set #
423433
# Stages: deploy #

0 commit comments

Comments
 (0)