Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Adding documentation for WARM_UP_CONCURRENCY config variable on cloud #6935

Merged
merged 4 commits into from
Mar 30, 2020

Conversation

dhorytskyi
Copy link
Contributor

@dhorytskyi dhorytskyi commented Mar 26, 2020

Purpose of this pull request

Add documentation for the the WARM_UP_CONCURRENCY post-deploy variable to specify the number of warm-up requests that the cache warm up script can send concurrently. This variable helps manage load on the Magento Cloud infrastructure.

Affected DevDocs pages

https://devdocs.magento.com/cloud/env/variables-post-deploy.html

Magento source code

magento/ece-tools#700

whatsnew
Added documentation for the WARM_UP_CONCURRENCY post-deploy variable to specify the number of warm-up requests that the cache warm up script can send concurrently. This variable helps manage load on the Magento Cloud infrastructure.

@devops-devdocs
Copy link
Collaborator

An admin must run tests on this PR before it can be merged.

@magento-engcom-team
Copy link

@dhorytskyi thank you for contributing. Please accept Community Contributors team invitation here to gain extended permissions for this repository.

@jeff-matthews jeff-matthews added the Internal Dev Differentiates work between community and Magento staff label Mar 26, 2020
@meker12 meker12 self-assigned this Mar 27, 2020
@meker12 meker12 changed the base branch from master to Cloud-2002.1.1 March 27, 2020 15:05
@meker12 meker12 changed the base branch from Cloud-2002.1.1 to master March 27, 2020 15:07
@meker12 meker12 changed the base branch from master to Cloud-2002.1.1 March 27, 2020 15:10
Copy link
Contributor

@meker12 meker12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dhorytskyi I changed the base branch to the Cloud-2002.1.1 integration branch since this update is targeted for that release.

- **Default**—_Not set_
- **Version**—Magento 2.1.4 and later

Configure _CONCURRENCY_ with which requests to _WARM_UP_PAGES_ will be sent. This configuration limits number of parallel connections. It can help to decrease server load in case of a big amount of pages to warm-up.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Configure _CONCURRENCY_ with which requests to _WARM_UP_PAGES_ will be sent. This configuration limits number of parallel connections. It can help to decrease server load in case of a big amount of pages to warm-up.
Specify the number of concurrent requests to send during cache warmup operations to reduce server load. This value limits the number of parallel connections and is useful for environment configurations where the `WARM_UP_PAGES` post-deploy variable specifies a large number of pages for cache preloading.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any recommendation to what value to set? The example shows "4".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't add a default value to do not potentially slowdown post-deploy process for customers who don't specify this value.
The number from example is a random one. It's difficult to provide the recommended value because it depends on customer's instance configuration.

Co-Authored-By: Margaret Eker <meker@adobe.com>
@meker12 meker12 merged commit 3e63a61 into magento:Cloud-2002.1.1 Mar 30, 2020
@ghost
Copy link

ghost commented Mar 30, 2020

Hi @dhorytskyi, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@dhorytskyi dhorytskyi deleted the MCLOUD-3045 branch March 30, 2020 20:32
meker12 added a commit that referenced this pull request Jun 24, 2020
* MAGECLOUD-4890  Implement support for backup databases from split connections for `ece-tools` (#6769)
* MAGECLOUD-4890: Implement support for backup databases from split connections for `ece-tools`
* Add examples
* Update src/cloud/project/project-webint-snap.md
* Magecloud 5091: Update devdocs documentation with changes in MAGECLOUD-2880 (#6820)
* MAGECLOUD-5091: Update devdocs documentation with changes in MAGECLOUD-2880
* Update src/cloud/project/project-webint-snap.md
* Add documentation for SCD_RUN_BALER env variable for Magento Cloud (#6895)
Co-authored-by: Ben Batschelet <bbatsche@users.noreply.github.com>
* Adding documentation for WARM_UP_CONCURRENCY config variable on cloud (#6935)
* MCLOUD-3045: Cache warm-up script
Co-Authored-By: Margaret Eker <meker@adobe.com>
* Add Baler module install and config instructions (#6944)
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>
Co-authored-by: Ben Batschelet <bbatsche@users.noreply.github.com>
* Fixed broken link.
* Add instructions for testing Magento Cloud Component code contributions (#6914)
* Added documentation for running functional tests for Magento Cloud code contributions in a Cloud Docker environment
* Functional testing instructions for Magento Cloud code contributions (#7019)
* Consolidated Magento Cloud functional testing topics for Cloud Suite
packages to a single topic with configuration and testing instructions.
* Removed ECE-Tools testing topic--information consolidated in
new topic
- Added Magento Cloud code testing topic
- Updated Cloud variables for Cloud Suite package names
- Added Cloud variable for current release version for each package
- Renamed the functional test topic filenames with more
descriptive names

Co-authored-by: Bohdan Korablov <korablov@adobe.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

* MCLOUD-5956: Cloud rewrite import notice (#7196)

* Add note about large uploads and php.ini

* Remove extra line break

* Add docs for REDIS_BACKEND deploy variable (#7194)

* Add docs for REDIS_BACKEND deploy variable
Co-authored-by: Margaret Eker <meker@adobe.com>

* Fix linting and AWS reference

* Format fixes

* MCLOUD-3734: Wizard CLI command for split Db  'wizard:split-db-state' (#7322)

- Added documentation for the  'wizard:split-db-state' to verify status and configuration for deploying the split database configuration on Magento Cloud.

* Fix table syntax

* Fix broken links

* Add updates for error code reference (#7409)

* Add updates for error code reference
* Added release note for error logging improvements

* Fix markdown syntax

* Updates to docs and release notes Laminas plugin dependency required
as a result of Zend migration to Laminas project (MCLOUD-4094)

* Fix auto-generated suggestions in error reference

* ece-tools draft release notes (#7442)

* Added additional ece-tools release note items
* Added note for MCLOUD-5883

Co-authored-by: maeker12 <{ID}+{username}@users.noreply.github.com>

Co-authored-by: Yevhen Miroshnychenko <ymiroshnychenko@magento.com>
Co-authored-by: Oleksandr Shmyheliuk <oshmyheliuk@magento.com>
Co-authored-by: Dmytro Horytskyi <5802616+dhorytskyi@users.noreply.github.com>
Co-authored-by: Bohdan Korablov <korablov@adobe.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>
Co-authored-by: Michael Casey <mcasey@magento.com>
Co-authored-by: Nadiya Syvokonenko <nsyvokonenko@magento.com>
Co-authored-by: maeker12 <{ID}+{username}@users.noreply.github.com>
meker12 added a commit that referenced this pull request Jun 25, 2020
* MAGECLOUD-4925:  Ability to support custom database parameters in docker image (#6609)

Updated the instructions for adding custom db parameters to the db container configuration

* MAGECLOUD-4925:  Ability to support custom database parameters in docker image (#6609)

Updated the instructions for adding custom db parameters to the db container configuration

* Magento Cloud Docker Varnish container updates: (#6618)

- Document default Varnish configuration
- Add info about --no-varnish option
- Update Magento Cloud Docker 1.0.1 release notes with Varnish change

* Cloud Docker release:  Fix for fpm container errors (#6617)

* Add release note for PHP container error fix
* Moved release note to 1.1.0 section

* MAGECLOUD-4890  Implement support for backup databases from split connections for `ece-tools` (#6769)

* MAGECLOUD-4890: Implement support for backup databases from split connections for `ece-tools`

* Add examples

* Update src/cloud/project/project-webint-snap.md

Co-Authored-By: Margaret Eker <meker@adobe.com>

* Magecloud 5091: Update devdocs documentation with changes in MAGECLOUD-2880 (#6820)

* MAGECLOUD-5091: Update devdocs documentation with changes in MAGECLOUD-2880

* Update src/cloud/project/project-webint-snap.md
Co-authored-by: Margaret Eker <meker@adobe.com>

* Add documentation for SCD_RUN_BALER env variable for Magento Cloud (#6895)

* Add documentation for SCD_RUN_BALER env variable for Magento Cloud
Co-authored-by: Ben Batschelet <bbatsche@users.noreply.github.com>

* Adding documentation for WARM_UP_CONCURRENCY config variable on cloud (#6935)

* MCLOUD-3045: Cache warm-up script
Co-Authored-By: Margaret Eker <meker@adobe.com>

* Add Baler module install and config instructions (#6944)

* Add Baler module install and config instructions
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>
Co-authored-by: Ben Batschelet <bbatsche@users.noreply.github.com>

* Fixed broken link.

* MCLOUD-3063: Provide an Option to Specify Custom URL for Magento (#6977)

* MCLOUD-3063: Provide an Option to Specify Custom URL for Magento
Co-authored-by: Margaret Eker <meker@adobe.com>

* Add instructions for testing Magento Cloud Component code contributions (#6914)

* Added documentation for running functional tests for Magento Cloud code contributions in a Cloud Docker environment

* Functional testing instructions for Magento Cloud code contributions (#7019)

Consolidated Magento Cloud functional testing topics for Cloud Suite
packages to a single topic with configuration and testing instructions.

- Removed ECE-Tools testing topic--information consolidated in
new topic
- Added Magento Cloud code testing topic
- Updated Cloud variables for Cloud Suite package names
- Added Cloud variable for current release version for each package
- Renamed the functional test topic filenames with more
descriptive names

Co-authored-by: Bohdan Korablov <korablov@adobe.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

* MAGECLOUD-4894: [MTS] Add support of split DB on docker (#6852)

* Apply suggestions from code review
Co-authored-by: Yevhen Miroshnychenko <miroshny@adobe.com>
Co-authored-by: Margaret Eker <meker@adobe.com>

* Fix linting errors.

* MCLOUD-5956: Cloud rewrite import notice (#7196)

* Add note about large uploads and php.ini

* Remove extra line break

* Add docs for REDIS_BACKEND deploy variable (#7194)

* Add docs for REDIS_BACKEND deploy variable
Co-authored-by: Margaret Eker <meker@adobe.com>

* Fix linting and AWS reference

* - Added documentation for the `es-en-var` option to customize (#7282)

- Add new option to customize Elasticsearch container configuration
- Updated Docker quick reference topic to remove ece-tools package
reference and clarify the note linking to Docker Service Versions topic

* Add example for using --no-varnish option (#7294)

* Format fixes

* Updates based on review feedback: (#7327)

- Moved error reference to Deploy your store section
- Added include file for link to error message reference
- Added error reference link to Test deployment, Log locations,
and Troubleshooting topics

* Restore error messages yaml file

* Added config instructions for Blackfire.io in Cloud Docker

* Added configuration instructions for Blackfire.io in Cloud Docker (#7335)

* Added config instructions for Blackfire.io in Cloud Docker

* Remove trailing spaces

Co-authored-by: Adarsh Manickam <amanickam@ztech.io>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

* Add info about Xdebug container for Cloud Docker and update configuration instructions (#7321)

* Updated instructions for using Xdebug in docker
- Added information about building new PHP-FPM-XDEBUG container
- Added `--with-xdebug` option to Service containers table
- Updated instructions for configuring and enabling Xdebug using new
container
- Replaced or revised outdated Xdebug references
- Added release notes
- Apply suggestions from code review

Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

* add CACHE_ENABLE_FAILED and CRYPT_KEY_IS_ABSENT error messages (#7337)

- add CACHE_ENABLE_FAILED and CRYPT_KEY_IS_ABSENT error messages

Co-authored-by: Margaret Eker <meker@adobe.com>

* Fix link syntax

* Fix markdown syntax

* Updates and clean up for release documentation:

- Added release notes for Docker 1.0.0 items
- Updated ece-docker build:compose and bin/magento-docker reference
tables with new command options
- Created include file for Docker configuration generator reference
info to add to both ece-tools package and Docker quick reference topics
- Updated service configuration table with new version support and build
options for service containers
- Added missing cache clear command to MFTF instructions
- Updated php.ini reference info in .magento.app.yaml topic with link
to php.ini customization in Docker environment

* Editorial changes

* Fix broken link

* Fix merge conflict error

* Cleanup for Docker split db config instructions

- Updates to clarify instructions
- Added topic to TOC (Docker development > Configure Docker > Enable
split DB configuration

* MCLOUD-2361: OOTB Docker Initialization (#7345)

* Added documentation for the init-docker.sh script to install prerequisite software for Cloud Docker environment

Co-authored-by: Margaret Eker <meker@adobe.com>

* MCLOUD-3734: Wizard CLI command for split Db  'wizard:split-db-state' (#7322)

- Added documentation for the  'wizard:split-db-state' to verify status and configuration for deploying the split database configuration on Magento Cloud.

* Updates for Integration environment changes

* MCLOUD-6137: Mention error log file (#7372)

* Add information about the Cloud error log that stores error and warning notifications from latest Magento Cloud deployment
* Renamed the "build log:  to "deployment log"

Co-authored-by: Margaret Eker <meker@adobe.com>

* Editorial updates based on review feedback
Documentation updates:
- Updated Blackfire set up topic to add Blackfire.io license requirement
- Added documentation for MySQL support to database topics for
Cloud Docker development
- Updated the Service configuration options table to add increment and
offset options and improve formatting of options column (MCLOUD-5735)

Release note updates:
- Added release note for MySQL support (MCLOUD-5691)
- Support for deploying Magento Commerce and Magento Commerce Open Source
with Cloud Docker
- Removal of rsyslog utility (MCLOUD-6173)

* Fix broken links

* Apply suggestions from code review

Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

* Updates and clean up for 1.1.0 release documentation (#7356)

* - Update description for auto_increment options
for Docker custom config
- Fix link reference text
- Fix markdown syntax

* Remove extraneous line

* Fix table syntax

* Removing error code reference updates which are not part of
Docker-1.1.0 release

* Remove cloud error message data file

* Remove error code reference from Docker release branch

* Remove extraneous blank line

* Fix broken links

* Add updates for error code reference (#7409)

* Add updates for error code reference
* Added release note for error logging improvements

* Fix markdown syntax

* Updated package versions on Cloud release landing page

* Updates based on review feedback:
-  Added --rm option to docker-compose run commands
-  Updated the Docker quick reference with a note about
using --rm option to prevent orphaned containers

* Add release notes for Cloud Components 1.0.4 (#7412)

* Add release notes for Cloud Components 1.0.4

* Added release notes for Cloud Patches 1.0.5 (#7411)

* Added release notes for 1.0.5

* Update src/cloud/release-notes/mcp-release-notes.md

* Updates to docs and release notes Laminas plugin dependency required
as a result of Zend migration to Laminas project (MCLOUD-4094)

* Fix auto-generated suggestions in error reference

* ece-tools draft release notes (#7442)

* Added additional ece-tools release note items

* Added note for MCLOUD-5883

Co-authored-by: maeker12 <{ID}+{username}@users.noreply.github.com>

* Cloud 2002.1.1 (#7446)

* MAGECLOUD-4890  Implement support for backup databases from split connections for `ece-tools` (#6769)
* MAGECLOUD-4890: Implement support for backup databases from split connections for `ece-tools`
* Add examples
* Update src/cloud/project/project-webint-snap.md
* Magecloud 5091: Update devdocs documentation with changes in MAGECLOUD-2880 (#6820)
* MAGECLOUD-5091: Update devdocs documentation with changes in MAGECLOUD-2880
* Update src/cloud/project/project-webint-snap.md
* Add documentation for SCD_RUN_BALER env variable for Magento Cloud (#6895)
Co-authored-by: Ben Batschelet <bbatsche@users.noreply.github.com>
* Adding documentation for WARM_UP_CONCURRENCY config variable on cloud (#6935)
* MCLOUD-3045: Cache warm-up script
Co-Authored-By: Margaret Eker <meker@adobe.com>
* Add Baler module install and config instructions (#6944)
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>
Co-authored-by: Ben Batschelet <bbatsche@users.noreply.github.com>
* Fixed broken link.
* Add instructions for testing Magento Cloud Component code contributions (#6914)
* Added documentation for running functional tests for Magento Cloud code contributions in a Cloud Docker environment
* Functional testing instructions for Magento Cloud code contributions (#7019)
* Consolidated Magento Cloud functional testing topics for Cloud Suite
packages to a single topic with configuration and testing instructions.
* Removed ECE-Tools testing topic--information consolidated in
new topic
- Added Magento Cloud code testing topic
- Updated Cloud variables for Cloud Suite package names
- Added Cloud variable for current release version for each package
- Renamed the functional test topic filenames with more
descriptive names

Co-authored-by: Bohdan Korablov <korablov@adobe.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

* MCLOUD-5956: Cloud rewrite import notice (#7196)

* Add note about large uploads and php.ini

* Remove extra line break

* Add docs for REDIS_BACKEND deploy variable (#7194)

* Add docs for REDIS_BACKEND deploy variable
Co-authored-by: Margaret Eker <meker@adobe.com>

* Fix linting and AWS reference

* Format fixes

* MCLOUD-3734: Wizard CLI command for split Db  'wizard:split-db-state' (#7322)

- Added documentation for the  'wizard:split-db-state' to verify status and configuration for deploying the split database configuration on Magento Cloud.

* Fix table syntax

* Fix broken links

* Add updates for error code reference (#7409)

* Add updates for error code reference
* Added release note for error logging improvements

* Fix markdown syntax

* Updates to docs and release notes Laminas plugin dependency required
as a result of Zend migration to Laminas project (MCLOUD-4094)

* Fix auto-generated suggestions in error reference

* ece-tools draft release notes (#7442)

* Added additional ece-tools release note items
* Added note for MCLOUD-5883

Co-authored-by: maeker12 <{ID}+{username}@users.noreply.github.com>

Co-authored-by: Yevhen Miroshnychenko <ymiroshnychenko@magento.com>
Co-authored-by: Oleksandr Shmyheliuk <oshmyheliuk@magento.com>
Co-authored-by: Dmytro Horytskyi <5802616+dhorytskyi@users.noreply.github.com>
Co-authored-by: Bohdan Korablov <korablov@adobe.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>
Co-authored-by: Michael Casey <mcasey@magento.com>
Co-authored-by: Nadiya Syvokonenko <nsyvokonenko@magento.com>
Co-authored-by: maeker12 <{ID}+{username}@users.noreply.github.com>

* Fixed markdown syntax.

* Restore link to ece-tools release notes

* - Fixed Cloud release intro text

* Release note cleanup:
- Fixed editorial and markdown issues
- Re-ordered release note categories and items

* Fix syntax errors

* Update version for Cloud package variables

* - Updated placeholders for release date
- Editorial fixes

* - Updated What's New with Cloud release updates
- Editorial updates and format fixes

* Removed link to split db update temporarily

* Restore architecture files to version on master

* Restore Pro architecture diagram to version on master

* Removed smart wizard update and fixed architecture topic

* Updates based on review feedback

* Updates based on review feedback:
- Updated MariaDB and Elasticsearch version compatibility for Magento
2.4
- Editorial and markdown syntax fixes

* Remove CLI command from RN

Co-authored-by: Yevhen Miroshnychenko <ymiroshnychenko@magento.com>
Co-authored-by: Oleksandr Shmyheliuk <oshmyheliuk@magento.com>
Co-authored-by: Dmytro Horytskyi <5802616+dhorytskyi@users.noreply.github.com>
Co-authored-by: Bohdan Korablov <korablov@adobe.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>
Co-authored-by: Michael Casey <mcasey@magento.com>
Co-authored-by: Adarsh Manickam <amanickam@ztech.io>
Co-authored-by: Nadiya Syvokonenko <nsyvokonenko@magento.com>
Co-authored-by: Ben Batschelet <bbatsche@users.noreply.github.com>
Co-authored-by: maeker12 <{ID}+{username}@users.noreply.github.com>
Co-authored-by: J Wang <jiautd@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Internal Dev Differentiates work between community and Magento staff
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants