fabric-composer

fabric-composer is a basic generic deploy system for all PHP projects using Composer made with python library, Fabric.

Requirements

• python >= 2.5
• Unix system;
• fabric
• pyyaml

Installation and usage

Download the code from github

wget https://github.com/mcuadros/fabric-composer/archive/master.zip
unzip master.zip

Setup the config.yaml file. You can just copy the example file or create a new one

cd fabric-composer-master
cp config.yaml.example config.yaml

Now you are ready to make the deploy using fab bin

fab deploy:example

These are tha avaliable commands:

• fab deploy:<project_name> Launches the deploy on all hosts

• fab info:<project_name> Prints some PHP and Composer related info for each server

Configuration

The config file, called config.yaml, contains all the configuration needed to deploy a project. You can define as many project configurations as you want in the same file.

All properties are mandatory

example: # project name
    user: johndoe # username used by the SSH layer when connecting to remote hosts
    hosts: # host list where the deploy will be done
        - www-1.example.com
        - www-2.example.com
    deploy_path: /var/www/sonata # path where all files will be copied
    remote_workspace_path: /home/johndoe/deploy/ # workspace in remote server
    local_workspace_path: /tmp/ # workspace in local server
    repository: git@github.com:sonata-project/sandbox.git # git repository
    composer_params: --no-dev --optimize-autoloader --no-interaction # optional composer commands
    post_prepare_commands: [] # commands to be executed at the end of composer install in local server
    post_deploy_commands: [] # commands to be executed at the end of composer update in the remote server

Deploy strategy

The deploy is made as follows:

1. [local] git clone from project repository
2. [local] composer install
3. [local] execution of post_install_commands (optional)
4. [local] the code is compressed
5. [remote] compressed code is delivered to every remote server
6. [remote] the code is decompressed
7. [remote] composer update with --dry-run, this will validate the code
8. [remote] a soft link is made from the workspace path to the deploy path

License

MIT, see LICENSE