8000 fortrabbit deployment guide + index listing by ostark · Pull Request #6291 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content
8000

fortrabbit deployment guide + index listing #6291

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from
Closed

fortrabbit deployment guide + index listing #6291

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3fd6374
fortrabbit deployment guide + index listing
Feb 19, 2016
907365e
fortrabbit deployment guide + index listing - 80 chars wrap
Feb 19, 2016
0b59222
use the right RST syntax + fix typos
Feb 22, 2016
5d436af
use the right RST syntax + fix typos
Feb 22, 2016
68efc51
better config code-blocks and proper .rst styles
Feb 23, 2016
3175235
removed double line breaks
Feb 26, 2016
9186532
added/fixed links
Feb 26, 2016
d52daa0
some text formats and added missing configuration-block(s)
Feb 26, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
better config code-blocks and proper .rst styles
  • Loading branch information
Oliver Stark committed Feb 23, 2016
commit 68efc510aac7a315c595397018670855300bc8c0
171 changes: 101 additions & 70 deletions cookbook/deployment/fortrabbit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ This step-by-step cookbook describes how to deploy a Symfony web application to
Setting up fortrabbit
---------------------

Before we begin, you should have done a few things on the fortrabbit side:
Before getting started, you should have done a few things on the fortrabbit side:
Copy link
Member

Choose a reason for hiding this comment

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

should be "website" (or "site") instead of "side"

Copy link
Author

Choose a reason for hiding this comment

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

it's more like "on the other side of the river"


- Sign up
- Add an SSH key to your Account (to deploy via Git)
- Create an App
* Sign up
Copy link
Member

Choose a reason for hiding this comment

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

Can we link to the form on the fortrabbit site?

* Add an SSH key to your Account (to deploy via Git)
Copy link
Member

Choose a reason for hiding this comment

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

Are there resources we can link to?

* Create an App


Preparing your Application
Expand All @@ -30,83 +30,114 @@ But it requires some minor tweaks to its configuration.
Configure Logging
~~~~~~~~~~~~~~~~~

Per default Symfony logs to a file. Modify the app/config/config_prod.yml file
to redirect it to PHP's error_log():

.. code-block:: yaml

monolog:
# ..
handlers:
# ..
nested:
type: error_log
# ..
Per default Symfony logs to a file. Modify the ``app/config/config_prod.yml`` file
to redirect it to :phpfunction:`error_log`:

.. configuration-block::

.. code-block:: yaml

# app/config/config_prod.yml
monolog:
# ...
handlers:
nested:
type: error_log

.. code-block:: xml

<!-- app/config/config_prod.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:monolog="http://symfony.com/schema/dic/monolog"
xsi:schemaLocation="http://symfony.com/schema/dic/services
http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/monolog
http://symfony.com/schema/dic/monolog/monolog-1.0.xsd">

<monolog:config>
<!-- ... -->
<monolog:handler
name="nested"
type="error_log"
/>
</monolog:config>
</container>

.. code-block:: php

// app/config/config_prod.php
$container->loadFromExtension('monolog', array(
// ...
'handlers' => array(
'nested' => array(
'type' => 'error_log',
),
),
));

Configuring Database Access & Session Handler
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can use the fortrabbit App Secrets to attain your database credentials.
Create the file app/config_prod_secrets.php with the following contents::

<?php
// Get the path to the secrects.json file
if (!$secrets = getenv("APP_SECRETS")) {
return;
}

// Read the file and decode json to an array
$secrets = json_decode(file_get_contents($secrets), true);

// Set database parameters to the container
if (isset($secrets['MYSQL'])) {

$container->setParameter('database_driver', 'pdo_mysql');
$container->setParameter('database_host', $secrets['MYSQL']['HOST']);
$container->setParameter('database_name', $secrets['MYSQL']['DATABASE']);
$container->setParameter('database_user', $secrets['MYSQL']['USER']);
$container->setParameter('database_password', $secrets['MYSQL']['PASSWORD']);
}

// Check if the Memcache component is present
if (isset($secrets['MEMCACHE'])) {

$memcache = $secrets['MEMCACHE'];
$handlers = [];

foreach (range(1, $memcache['COUNT']) as $num) {
$handlers [] = $memcache['HOST'. $num]. ':'. $memcache['PORT'. $num];
}

// Apply ini settings
ini_set('session.save_handler', 'memcached');
ini_set('session.save_path', implode(',', $handlers));

if ($memcache['COUNT'] == 2) {
ini_set('memcached.sess_number_of_replicas', 1);
ini_set('memcached.sess_consistent_hash', 1);
ini_set('memcached.sess_binary', 1);
}

}
Create the file ``app/config_prod_secrets.php`` with the following contents::

<?php
// Get the path to the secrects.json file
if (!$secrets = getenv("APP_SECRETS")) {
return;
}

// Read the file and decode json to an array
$secrets = json_decode(file_get_contents($secrets), true);

// Set database parameters to the container
if (isset($secrets['MYSQL'])) {

$container->setParameter('database_driver', 'pdo_mysql');
$container->setParameter('database_host', $secrets['MYSQL']['HOST']);
$container->setParameter('database_name', $secrets['MYSQL']['DATABASE']);
$container->setParameter('database_user', $secrets['MYSQL']['USER']);
$container->setParameter('database_password', $secrets['MYSQL']['PASSWORD']);
}

// Check if the Memcache component is present
if (isset($secrets['MEMCACHE'])) {

$memcache = $secrets['MEMCACHE'];
$handlers = [];

foreach (range(1, $memcache['COUNT']) as $num) {
$handlers [] = $memcache['HOST' . $num] . ':' . $memcache['PORT' . $num];
}

// Apply ini settings
ini_set('session.save_handler', 'memcached');
ini_set('session.save_path', implode(',', $handlers));

if ($memcache['COUNT'] == 2) {
Copy link
Member

Choose a reason for hiding this comment

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

In the docs we follow the Symfony CS which would mean to use Yoda conditions and strict comparison (i.e. 2 === $memcache['COUNT'] here).

ini_set('memcached.sess_number_of_replicas', 1);
ini_set('memcached.sess_consistent_hash', 1);
ini_set('memcached.sess_binary', 1);
}
}

Make sure this file is listed in your *imports*:

.. code-block:: yaml
Copy link
Member

Choose a reason for hiding this comment

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

Can you add config formats for XML and PHP too (like above)? Just let us know in case you need some assitance with the other formats.

Copy link
Author

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 the correct nesting/structure here...

            <framework:config>
                <framework:session>
                    ?? handler_id:  ~
                </framework:session>
            </framework:config>

Copy link
Author

Choose a reason for hiding this comment

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

got it!

<framework:config>
    <framework:session handler_id="null" />
</framework:config>


# app/config/config_prod.yml
imports:
- { resource: config.yml }
- { resource: config_prod_secrets.php }

# ..
framework:
session:
# set handler_id to null to use default session handler from php.ini (memcached)
handler_id: ~
# ..

# app/config/config_prod.yml
imports:
- { resource: config.yml }
- { resource: config_prod_secrets.php }

# ..
framework:
session:
# set handler_id to null to use default session handler from php.ini (memcached)
handler_id: ~
# ..


Configuring the Environment in the Dashboard
Expand Down
0