From cf74b7a62d070c05a6a6bd2a87a2a37d2db521a5 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 29 Nov 2016 16:05:24 +0100 Subject: [PATCH 1/3] Added docs for framework.cache.prefix_seed --- reference/configuration/framework.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 54ffd717f00..11264ffeee0 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -104,6 +104,8 @@ Configuration * `php_errors`_ * `log`_ * `throw`_ +* `cache`_ + * `prefix_seed`_ secret ~~~~~~ @@ -1463,6 +1465,26 @@ throw Throw PHP errors as ``\ErrorException`` instances. The parameter ``debug.error_handler.throw_at`` controls the threshold. +cache +~~~~~ + +prefix_seed +........... + +.. versionadded:: 3.2 + The ``prefix_seed`` option was introduced in Symfony 3.2. + +**type**: ``string`` **default**: ``null`` + +If defined, this value is used as part of the "namespace" generated for the +cache item keys. It's useful to prevent naming collisions when deploying +multiple applications into the same path (on different servers) that share the +same cache backend. + +It's also useful when using `blue/green deployment`_ strategies and more +generally, when you need to abstract out the actual deployment directory, for +example when warming caches offline. + Full Default Configuration -------------------------- @@ -1607,3 +1629,4 @@ Full Default Configuration .. _`Doctrine Cache`: http://docs.doctrine-project.org/projects/doctrine-common/en/latest/reference/caching.html .. _`egulias/email-validator`: https://github.com/egulias/EmailValidator .. _`PhpStormProtocol`: https://github.com/aik099/PhpStormProtocol +.. _`blue/green deployment`: http://martinfowler.com/bliki/BlueGreenDeployment.html From f41e3d8a84f80921ad097ba475b9ca1b838a6ad0 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 29 Nov 2016 17:38:13 +0100 Subject: [PATCH 2/3] Mentioned the best practice of using the app name as its value --- reference/configuration/framework.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 11264ffeee0..522b213953b 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -104,7 +104,7 @@ Configuration * `php_errors`_ * `log`_ * `throw`_ -* `cache`_ +* `cache `_ * `prefix_seed`_ secret @@ -1477,7 +1477,8 @@ prefix_seed **type**: ``string`` **default**: ``null`` If defined, this value is used as part of the "namespace" generated for the -cache item keys. It's useful to prevent naming collisions when deploying +cache item keys. A common practice is to use the unique name of the application +(e.g. ``symfony.com``) because that prevents naming collisions when deploying multiple applications into the same path (on different servers) that share the same cache backend. From c6b1f9cdcbf24c6509e3da2697d9c5302541c616 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Thu, 1 Dec 2016 10:47:12 +0100 Subject: [PATCH 3/3] Minor reword --- reference/configuration/framework.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 522b213953b..8f79ad5c721 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -1483,8 +1483,8 @@ multiple applications into the same path (on different servers) that share the same cache backend. It's also useful when using `blue/green deployment`_ strategies and more -generally, when you need to abstract out the actual deployment directory, for -example when warming caches offline. +generally, when you need to abstract out the actual deployment directory (for +example, when warming caches offline). Full Default Configuration --------------------------