Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.3k
Added a new article about applications with multiple kernels#6840
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
request/multiple_kernels.rst Outdated
| // web/api.php | ||
| // ... | ||
| $kernel = new ApiKernel('prod', true); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I guess the second parameter "debug" must befalse here ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
You guessed right. Fixed. Thanks.
request/multiple_kernels.rst Outdated
| the ``app/config/api/`` directory. | ||
| The new configuration can be created from scratch when you load just a few | ||
| bundles, because it it will be very simple. Otherwise, duplicate the existing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
typo "it it" ?
yceruto commentedAug 3, 2016
@javiereguiluz very nice article, thank! |
ogizanagi commentedAug 3, 2016 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
I wonder if we shouldn't explain more the differences between kernel environments & using multiple kernels ? Because I know it can be confusing, especially for newcomers. Especiallyas you state:
But multiple kernels are not meant to execute the very same application with a different configuration. That's pretty much what kernel environments are for. Different kernels are meant to execute different parts of a whole that can eventually be called "the application". It is true it doesn't often share much configuration, but what is important is that it's not the same part of the application at all. And thus, won't share the same components/bundles usage, nor sometimes some part of the business code, and above all not the same infrastructure stuff. |
javiereguiluz commentedAug 4, 2016
@ogizanagi I completely agree with you. I've refactored the "use cases" section. Thanks! |
request/multiple_kernels.rst Outdated
| only load the routes that match the parts of the application exposed to the | ||
| public. The second kernel would load the rest of the application and its | ||
| access would be protected by the web server; | ||
| * An application that uses a bundle which doesn't allow multiple instances could |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I'm not sure about this one.
It is presented as a solution to bundles registering a single service instead of allowing the creation of multiple instances through configuration. But creating new kernels has way too much impact to be considered for this use-case.
Once again, a kernel environment is probably more appropriate to define a different bundle configuration. But anyway, none of the 2 solutions would allow to make the different bundle configurations cohabit within the very same request. In my opinion, the sentence is misleading regarding this 😕.
The only solution for this use case is to not use the bundle/bundle configuration, and register services yourself.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
OK. I'm probably going to remove this use case. I added because the other day one person asked me if EasyAdmin supported defining two different backends in the same app. The bundle itself doesn't support that ... but with this multi-kernel trick, everything is easily solved.
Can anyone think of other use cases or do we just leave the first two proposed ones? Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
What about micro-services oriented apps ? You can split your services in multiple optimized modules, allowing to enable/disable a group of micro services on a server instance, by simply exposing or not a kernel instance.
It avoids dealing with multiple git repositories and allow to share code/configuration more easily.
However, it's very close to the mentioned API use-case, but with more advanced partitioning.
javiereguiluzAug 4, 2016 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
That's nice! I've added that use case. Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Maybe the most common use case is the front-end/back-end sceneries, a big e-commerce application, for example ?
javiereguiluz commentedOct 4, 2016
Lately I've been playing with multi-kernel apps, so I've just added a section which may be important: running commands using different kernels. I think this is ready for the final review. Thanks! |
| // web/api.php | ||
| // ... | ||
| $kernel = new ApiKernel('prod', false); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
if you don't put a require call to load the file defining it, you already need to show the update of the autoload config
| @@ -0,0 +1,183 @@ | |||
| .. index:: | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Maybe this should be in theconfiguration/ directory?
| Creating a new kernel in a Symfony application is a three-step process: | ||
| 1. Create a new front controller to load the new kernel; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
There is another way to do this (which is done on a BIG Symfony site I know of): keepingapp.php andapp_dev.php and using some URL matching to load different kernels. For example, if the URL starts with/admin, then load theAdminKernel, elseAppKernel. I think it's worth mentioning both. So, what about:
A) Making step (1) actually step (3) (I think creating the kernel and hooking up the configuration makes sense to have first, then finally show how you can instantiate the now-created kernel)
B) Rename this step toStep 3) Executing the kernel from a front controller
C) Mention theif statement approach above (it could be mentioned first or second).
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| Instead of creating the new front controller from scratch, it's recommended to | ||
| duplicate the existing ones. For example, create ``web/api_dev.php`` from |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
.> ... from scratch, it's easier to duplicate the existing ones
(it just sounds a bit more relaxed)
request/multiple_kernels.rst Outdated
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| Now you need to define the ``ApiKernel`` class used by the new front controller. | ||
| The recommendation again is to duplicate the existing ``app/AppKernel.php`` file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
The easiest way to do this is by duplicating the existing...
request/multiple_kernels.rst Outdated
| The recommendation again is to duplicate the existing ``app/AppKernel.php`` file | ||
| and make the needed changes. | ||
| In this example, the changes of the new ``ApiKernel`` would be to load less |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
In this example, the
ApiKernelwill load less bundles thanAppKernel. Be sure to also change
the location of thecache,logsand config files so they don't collide with the files
fromAppKernel
request/multiple_kernels.rst Outdated
| config files to not mess with the regular application:: | ||
| // app/ApiKernel.php | ||
| <?php |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
We usually don't have the<?php. If youdo want it for some specific reason, the filename should probably be moved inside of it, so that the comment is in PHP. But probably, we should just remove<?php
request/multiple_kernels.rst Outdated
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| Finally, define the configuration used by the application when it executes the | ||
| new API kernel. According to the previous code, this config must be defined in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Finally, define the configuration files that the new
ApiKernelwill load. According to the
above code, this config will live in the...
| - { resource: ../config_dev.yml } | ||
| # override option values ... | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Another option is toshare some configuration files, especially if both kernels use some of the same bundles that you want configured in the same ways. I'm haven't done this enough to settle on the best organization for this... but we could at least mention it. Perhaps aapp/config/shared.yml file where we show just a little bit of config and mention how you could import this from theconfig.yml file of both kernels.
request/multiple_kernels.rst Outdated
| Then, replace the ``AppKernel`` instantiation by your own kernel instantiation | ||
| (e.g. ``ApiKernel``) and now you can execute commands using the new kernel | ||
| (e.g. ``php bin/api cache:clear``) Now you can use execute commands using the new kernel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Extra:
Now you can use execute commands using the new kernel
and missing. at the end
request/multiple_kernels.rst Outdated
| -------------------------------------- | ||
| If your application is very complex and you create several kernels, it's better | ||
| to store them on their own directories instead of messing with lots of files in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
store them in their...
weaverryan commentedOct 25, 2016
This is really solid! 👍 from me if the changes are made. Status: Needs Work |
…rnels (javiereguiluz)This PR was merged into the 2.7 branch.Discussion----------Added a new article about applications with multiple kernelsThisfixes#997 (opened in January 2012 !!!).---1) I don't know which is the best location for this article (probably not `request/`)2) When merging up, in the 2.8 branch the following must be added:At the end of `Step 2)`, add this:``` rstIn order to make this class available in the front controller, don't forget toadd it to the ``classmap`` configuration of the ``composer.json`` file:.. code-block:: json { "autoload": { "psr-4": { "": "src/" }, "classmap": ["app/AppKernel.php", "app/ApiKernel.php"] }, ... }```At the end of the article, add this:``` rst.. tip: Symfony 2.8 introduced a `new micro kernel`_ PHP trait that simplifies the creation of kernels. You can even define them in a single PHP file... _`new micro kernel`:http://symfony.com/blog/new-in-symfony-2-8-symfony-as-a-microframework```Commits-------bc3618d Made a bunch of fixes recommended by Ryan2613810 Added a note about rendering templates from different kernelse403fd8 Added a new section about running commands under a different kernelaf4ff18 Added a new use case related to micro-services2c5aeb1 Removed a use case097a73d Reworded the use cases section5c8ed87 Fixed typod45e1f4 Fixed an example codea23d82d Fixed another syntax issue21329ec Fixed some syntax issues7cb2aa1 Added a new article about applications with multiple kernels
weaverryan commentedDec 15, 2016
It's merged! Woohoo! |
* 2.7: (22 commits) [#6894] Adding link to Doctrine [#6857] Re-wording the section a bit [#6840] Adding note based on Stof's feedback Moving file - I think configuration is more appropriate Revert "Updated the contents for the new Symfony 3 dir structure" Updated the contents for the new Symfony 3 dir structure Remove "Symfony3 will use" Using lower case on "Form" Made a bunch of fixes recommended by Ryan Added a note about rendering templates from different kernels Added a new section about running commands under a different kernel Integrated improvement by javiereguiluz Explain what happens if `flush()` fails Update events.rst Added a new use case related to micro-services Removed a use case Reworded the use cases section Fixed typo Fixed an example code Fixed another syntax issue ...
* 2.8: (22 commits) [#6894] Adding link to Doctrine [#6857] Re-wording the section a bit [#6840] Adding note based on Stof's feedback Moving file - I think configuration is more appropriate Revert "Updated the contents for the new Symfony 3 dir structure" Updated the contents for the new Symfony 3 dir structure Remove "Symfony3 will use" Using lower case on "Form" Made a bunch of fixes recommended by Ryan Added a note about rendering templates from different kernels Added a new section about running commands under a different kernel Integrated improvement by javiereguiluz Explain what happens if `flush()` fails Update events.rst Added a new use case related to micro-services Removed a use case Reworded the use cases section Fixed typo Fixed an example code Fixed another syntax issue ...
* 3.1: (25 commits) [#6894] Adding link to Doctrine [#6857] Re-wording the section a bit [#6840] Adding note based on Stof's feedback Moving file - I think configuration is more appropriate Revert "Updated the contents for the new Symfony 3 dir structure" Updated the contents for the new Symfony 3 dir structure Remove "Symfony3 will use" Using lower case on "Form" Make lines shorter to comply with our soft limit of 80 chars per line Made a bunch of fixes recommended by Ryan Added a note about rendering templates from different kernels Fix comments [Serializer] Docs for the @MaxDepth annotation Added a new section about running commands under a different kernel Integrated improvement by javiereguiluz Explain what happens if `flush()` fails Update events.rst Added a new use case related to micro-services Removed a use case Reworded the use cases section ...
* 3.2: (26 commits) [#6894] Adding link to Doctrine [#6857] Re-wording the section a bit [#6840] Adding note based on Stof's feedback Moving file - I think configuration is more appropriate Revert "Updated the contents for the new Symfony 3 dir structure" Updated the contents for the new Symfony 3 dir structure Remove "Symfony3 will use" Using lower case on "Form" Added a mention to sameSite cookie option Make lines shorter to comply with our soft limit of 80 chars per line Made a bunch of fixes recommended by Ryan Added a note about rendering templates from different kernels Fix comments [Serializer] Docs for the @MaxDepth annotation Added a new section about running commands under a different kernel Integrated improvement by javiereguiluz Explain what happens if `flush()` fails Update events.rst Added a new use case related to micro-services Removed a use case ...
Uh oh!
There was an error while loading.Please reload this page.
Thisfixes#997 (opened in January 2012 !!!).
I don't know which is the best location for this article (probably not
request/)When merging up, in the 2.8 branch the following must be added:
At the end of
Step 2), add this:At the end of the article, add this: