Deployer Bundle
This is a Symfony bundle to deploy to multiple hosts at once using the
git strategy. It provides commands to do it easily., (*1)
Each host may have independent configuration, i.e., you may want to
checkout a development branch in your staging server, whereas you may
want the master branch in your production server., (*2)
By default, the bundle only checkouts a specific version (either a tag or no)
and clears the cache, but there are optional tasks that may also be executed.
The order of execution is:, (*3)
- checkout version
- composer update (if set)
- assets install (if set)
- database migrations (if set)
- cache clear
Installation
Step 0: Install fabric
This bundle uses Fabric to connect to hosts
and execute tasks on them. You usually install it via
pip:, (*4)
$ pip install fabric
Check fabric installation chapter
for further information about installation., (*5)
Step 1: Download the Bundle
Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:, (*6)
$ composer require rrb/deployer-bundle
This command requires you to have Composer installed globally, as explained
in the installation chapter
of the Composer documentation., (*7)
Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the app/AppKernel.php file of your project:, (*8)
<?php
// app/AppKernel.php
// ...
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = array(
// ...
new Rrb\DeployerBundle\RrbDeployerBundle(),
);
// ...
}
// ...
}
This bundle requires a minimal configuration in order to work (you
have to tell it where to deploy, right?), so you have to enable and
configure it in your config.yml file. This is the minimal configuration
that you require:, (*9)
rrb_deployer:
hosts:
host_name_1:
environment:
src: '/path/to/src/in/host/'
host:
user: 'username'
server: 'hostname'
host_name_2:
environment:
src: '/path/to/src/in/host/'
host:
user: 'username'
server: 'hostname'
host_name_3:
environment:
src: '/path/to/src/in/host/'
host:
user: 'username'
server: 'hostname'
...
You may have as many hosts as you want. Check the
configuration reference to know more about
all available configuration options., (*10)
By default, fabric forwards the ssh-agent, so it is better if you deploy
using RSA keys. But, of course, there is the option of connect using
a password: just remember to add it to your parameters.yml file and
use its value in your config.yml file. Never commit your passwords!, (*11)
See the commands reference for deploying., (*12)
Commands
Deploy
It will deploy to the last commit of the branch set in config.yml file. Deploy will always be sequential., (*13)
You may deploy to all hosts:, (*14)
$ bin/console rrb:deployer:deploy --all
You may deploy to only one host, (*15)
$ bin/console rrb:deployer:deploy host_name_2
...or to a list of hosts, but not all:, (*16)
$ bin/console rrb:deployer:deploy host_name_2 host_name_3
If no host is specified, first host defined will be used:, (*17)
$ bin/console rrb:deployer:deploy
is the same as executing:, (*18)
$ bin/console rrb:deployer:deploy host_name_1
You may also force a task execution besides deploy, overriding the default
configuration:, (*19)
$ bin/console rrb:deployer:deploy host_name_1 --composer-update
Check the command reference to know all available
options. Options supplied to command take precedence over the ones
defined in the config.yml file., (*20)
Remember to replace bin/console by app/console if you are using
an older version of Symfony., (*21)
Tag
It will deploy to the last tag created or, if set, to a specific tag version. That is the only difference
with the deploy options., (*22)
To deploy to last tag for the first host defined:, (*23)
$ bin/console rrb:deployer:tag
To deploy to version 1.4.1 for the first host defined:, (*24)
$ bin/console rrb:deployer:deploy --tag=1.4.1
Check the command reference to know all available
options. Options supplied to command take precedence over the ones
defined in the config.yml file., (*25)
Configuration reference
These are the default values, that may be overridden:, (*26)
# Default configuration for "RrbDeployerBundle"
rrb_deployer:
fabric: fab
timeout: 3600
idle_timeout: 600
hosts: # Required
# Prototype
default:
environment:
php: php
# This is the absolute path to the source code within server
src: ~ # Required
env: prod
host:
user: ~ # Required
password: null
# This is the domain name or the IP of the server to deploy to
server: ~ # Required
port: 22
git:
remote: origin
branch: master
tasks:
database_migration:
enabled: false
composer_update:
enabled: false
bin: composer
memory_limit: null
assets_install:
enabled: false
symlink: true
relative: false
path: web
Commands reference
rrb:deployer:deploy
Usage:
rrb:deployer:deploy [options] [--] [<hosts>]...
Arguments:
hosts Host(s) name(s) defined in config.yml to deploy to (separate multiple hosts with a space). If omitted, first host defined will be used.
Options:
--all If set, it will deploy to all servers defined in config.yml. It overrides hosts argument.
--composer-update If set, it will update composer. It overrides value in config.yml.
--assets-install If set, it will install assets. It overrides value in config.yml.
--database-migration If set, it will execute migrations of Doctrine. It overrides value in config.yml.
-h, --help Display this help message
-q, --quiet Do not output any message
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
Help:
Command to deploy changes to hosts using git
rrb:deployer:tag
Usage:
rrb:deployer:tag [options] [--] [<hosts>]...
Arguments:
hosts Host(s) name(s) defined in config.yml to deploy to (separate multiple hosts with a space). If omitted, first host defined will be used.
Options:
-t, --tag=TAG Tag number to checkout, if any.
--all If set, it will deploy to all servers defined in config.yml. It overrides hosts argument.
--composer-update If set, it will update composer. It overrides value in config.yml.
--assets-install If set, it will install assets. It overrides value in config.yml.
--database-migration If set, it will execute migrations of Doctrine. It overrides value in config.yml.
-h, --help Display this help message
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-e, --env=ENV The Environment name. [default: "dev"]
--no-debug Switches off debug mode.
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
Help:
Command to checkout a tag using git
Wallogit.com
