Magallanes es una joven herramienta de despliegue de aplicaciones PHP escrita en PHP. Es muy fácil de usar, pero al mismo tiempo es muypoderosa. En esta charla repasaremos diferentes alternativas de despliegue de aplicaciones PHP y la importancia la automatización de este proceso. Nos meteremos de lleno con Magallanes, veremos que ofrece, como utilizarlo y como extenderlo. Para terminar mostraremos un ejemplo de despliegue de una aplicación Symfony2.

1. Herramienta de despliegue PHP
sencilla y poderosa.
Javier Núñez
@javiernuber
javiernuber@gmail.com

2. Javier Núñez
Software developer
Solucionex
javiernuber@gmail.com
@javiernuber

3. INTRODUCCIÓN

4. DEPLOYMENT
Software deployment is all of the
activities that make a software system
available for use.

5. “Actividad imprescindible en el
desarrollo de un producto de
software

6. “Seguro que esta actividad la repites
muchas veces

7. “
AUTOMATIZA!!

8. Cómo debería ser una
herramienta de despliegue
○ Sencilla
○ Fiable y segura
○ Rollbacks
○ Registro de operaciones y errores (logs)
○ Reusable
○ Escalable

9. Métodos de despliegue
○ FTP
○ Rsync
○ Control de versiones (GIT, SVN)
○ Build Tools (Ant, Phing, Jenking)
○ Herramientas de despligue (Capistrano/Capifony, Magallanes,
Deployer, Rocketeer, Idephix)
○ IT Automation tools (Ansible, Pupper, Chef)

10. Métodos de despliegue
○ FTP
○ Rsync
○ Control de versiones (GIT, SVN)
○ Build Tools (Ant, Phing, Jenking)
○ Herramientas de despligue (Capistrano/Capifony, Magallanes,
Deployer, Rocketeer, Idephix)
○ IT Automation tools (Ansible, Pupper, Chef)

11. MAGALLANES

12. ¿QUE ES MAGALLANES?
Magallanes es una herramienta de despliegue
de aplicaciones PHP escrita en PHP. Muy fácil
de usar, configurar y ampliar.

13. Características
○ 100% PHP (>= PHP 5.3)
○ Configurable
○ Permite definir múltiples entornos
○ No se apega a ningún framework
○ Con utilidades de serie para algunos frameworks
○ Extensible

14. Características
○ 100% PHP (>= PHP 5.3)
○ Configurable
○ Permite definir múltiples entornos
○ No se apega a ningún framework
○ Con utilidades de serie para algunos frameworks
○ Extensible
Creador: Andrés Montañez
@andres_montañez

15. Instalación
wget
http://download.magephp.com/magallanes.latest.tar.gz
-­‐O
magallanes.tar.gz
tar
xfz
magallanes.tar.gz
cd
magallanes
bin/mage
install
-­‐-­‐systemWide
-­‐-­‐installDir=/opt/magallanes
En el parámetro --installDir indicamos el directorio de instalación.
Con el parámetro --systemWide se creará un enlace simbólico al comando mage en /
usr/bin/mage
mage
version
Ya tenemos disponible el comando mage en nuestra consola

16. Instalación
Instalación con Composer
{
"require-­‐dev":
{
"andres-­‐montanez/magallanes":
"~1.0.1"
}
}
Actualizamos los vendors
php
composer
update
andres-­‐montanez/magallanes
bin/mage
version

17. Inicialización
Primero inicializamos el proyecto
Este comando genera en el proyecto la carpeta .mage con la definición del
proyecto y los entornos.
mage
init
-­‐-­‐name=“PHP
Cáceres
App"
-­‐-­‐email=”hola@phpcaceres.es"

18. general.yml
#
global
settings
name:
PHP
Cáceres
email:
javiernuber@gmail.com
notifications:
false
logging:
true
maxlogs:
30
ssh_needs_tty:
false

19. Environment
Un entorno define cómo se hará el despliegue de nuestra aplicación.
Ejemplos clásicos de entornos son production, staging, o testing.
mage
add
environment
-­‐-­‐name="production"
La ejecución del comando genera un fichero llamado production.yml
dentro de la carpeta .mage/environment
Crear un entorno es tan fácil como lanzar el siguiente comando:
mage
list
environments
Para ver los entornos existentes

20. production.yml
#production
deployment:
user:
phpcaceres
from:
./
to:
/var/www/vhosts/www
excludes:
-­‐
app/cache/*
-­‐
app/logs/*
hosts:
-­‐
192.16.0.100
-­‐
192.16.0.101
tasks:
pre-­‐deploy:
-­‐
scm/update
on-­‐deploy:
-­‐
symfony2/cache-­‐warmup:
{env:prod}
post-­‐release:
-­‐
purge-­‐apc-­‐cache
post-­‐deploy:
-­‐
pusrge-­‐varnish-­‐cache

21. production.yml
#production
deployment:
user:
phpcaceres
use-­‐sudo:
true
from:
./
to:
/var/www/vhosts/www
excludes:
-­‐
app/cache/*
-­‐
app/logs/*
hosts:
-­‐
192.16.0.100
-­‐
192.16.0.101
tasks:
pre-­‐deploy:
-­‐
scm/update
on-­‐deploy:
-­‐
symfony2/cache-­‐warmup:
{env:prod}
post-­‐release:
-­‐
purge-­‐apc-­‐cache
post-­‐deploy:
-­‐
pusrge-­‐varnish-­‐cache
@tharandur
https://github.com/andres-montanez/Magallanes/pull/226

22. Deployment
mage
deploy
to:production
Desplegar un entrono es muy fácil:

23. Ejemplo ejecución

24. Estrategias de despliegue
deployment:
strategy:
targz
deployment:
strategy:
rsync
Sincronización de ficheros
Copia un paquete targz
deployment:
strategy:
git-­‐rebase
Hace un git rebase en el destino, conserva los archivos sin seguimiento
deployment:
strategy:
git-­‐remote-­‐cache
Mantiene el repositorio en una capeta compartida que actualiza y copia en cada release
deployment:
strategy:
disabled
No se copia ningún archivo

25. Releases
releases:
enabled:
true
max:
5
symlink:
current
directory:
releases
Las releases se configuran en cada entorno (podemos usarlas o no).
Cada release es un copia completa del proyecto (necesitamos más espacio en el server)
Ejemplo de jerarquía de directorios:

26. Releases
mage
releases
list
to:production
Listado de releases que hay en un entorno
mage
deploy
to:production
-­‐-­‐overrideRelease
Sobrescribir la release actual.

27. Rollback a release
mage
releases
rollback
-­‐-­‐release=20150620184648
to:production
Solo tenemos que indicar la release a la que queremos cambiar
mage
releases
rollback
-­‐-­‐release=-­‐1
to:production
mage
releases
rollback
-­‐-­‐release=-­‐2
to:production
mage
releases
rollback
-­‐-­‐release=-­‐3
to:production
Mas fácil todavía
mage
releases
rollback
–release=0
to:production
Podemos volver a la última release
mage
releases
rollback
-­‐-­‐release=-­‐1
to:production
-­‐-­‐deleteCurrent
También podemos borrar la última release al hacer rollback

28. Stages
Pre-Deploy
Estas tareas se ejecutan en la copia local de código. Es el lugar para
establecer la rama correspondiente, actualizar el repositorio de código,
instalar los vendors y compilar archivos necesarios. Ideal para realizar el
trabajo pesado.
On-Deploy
Estas tareas se ejecutan en cada host definido. Aquí se realiza el despliegue
del código con la estrategia establecida.
Post-Release
Solo si se están usando versiones. Estas tareas se ejecutan en cada host
después de que se establece el enlace simbólico a la nueva release.
Post-Deploy
Estas tareas se ejecutan localmente. Se ejecuta después de que el despliegue
se realiza.

29. Tareas incluidas
Composer
○ Generate autoload (composer/generate-­‐autoload)
○ Install (composer/install)
Filesystem
○ Apply FACL (filesystem/link-­‐shared-­‐files)
○ Link shared files (filesystem/link-­‐shared-­‐files)
○ Permissions readable only by web server
(filesystem/permissions-­‐
readable-­‐only-­‐by-­‐web-­‐server)
○ Permissions (filesystem/permissions)
○ Permissions writable only by web server
(filesystem/permissions-­‐
writable-­‐only-­‐by-­‐web-­‐server)
SCM
○ Change branch (scm/change-­‐branch)
○ Clone(scm/clone)
○ Force update(scm/force-­‐update)
○ Remove clone(scm/remove-­‐clone)
○ Update (scm/update)

30. Tareas incluidas
Symfony2
○ Assetic dump (symfony2/assetic-­‐dump)
○ Assets install (symfony2/assets-­‐install)
○ Cache clear (symfony2/cache-­‐clear)
○ Cache warmup (symfony2/cache-­‐warmup)
○ Clean front controller (symfony2/clear-­‐front-­‐controller)
Magento
○ Clear cache (magento/clear-­‐cache)
○ Clear full page cache (magento/clear-­‐full-­‐page-­‐cache)
General
○ Manual tasks(general/manually)

31. Tareas personalizadas
○ Son clase PHP muy sencillitas
○ Extienden de MageTaskAbstractTask
○ El namespace tiene que ser Task
○ Obliga a implementar los métodos getName() y run()
○ Se almacenan en .mage/tasks
○ Retorna true o false
○ Podemos lanzar MageTaskErrorWithMessageException si
se produce un error con un mensaje.
○ Podemos lanzar MageTaskSkipException si la tarea es
omitida.
Crear nuestras propias tareas en muy sencillo, esto nos permite adaptar
Magallanes a cualquier aplicación PHP sin ningún tipo de problema.

32. Tareas personalizadas
<?php
namespace
Task;
use
MageTaskBuiltInSymfony2SymfonyAbstractTask;
class
DoctrineSchemaUpdate
extends
SymfonyAbstractTask
{
public
function
getName()
{
return
'Doctrine
-­‐
Updating
database';
}
public
function
run()
{
$updateCmd
=
"
doctrine:schema:update
–force";
$result
=
$this-­‐>runCommandRemote($this-­‐>getAppPath()
.
$updateCmd
);
if
($result
===
false)
{
$createCmd
=
"
doctrine:schema:create
-­‐-­‐force”
$result
=
$this-­‐>runCommandRemote($this-­‐>getAppPath()
.
createCmd
);
}
return
$result;
}
}

33. Tareas personalizadas
...
on-­‐deploy:
-­‐
doctrine-­‐schema-­‐update
...
Ya podemos utilizar nuestra tarea, así de fácil.

34. Interfaces Tareas
MageTaskReleasesIsReleaseAware
Implementando esta interface la tarea sabe que el entorno de
ejecución es una release.
MageTaskReleasesRollbackAware
En un rollback solo se ejecutan las tareas que implementan esta
interface.
MageTaskReleasesSkipOnOverride
Las tareas que emplementan esta interface se ejecutan cuando se
despliega con la opción --releaseOverride

35. Comandos mage
○ init
○ intall
○ upgrade
○ add
○ list
environments
○ Deploy
to:production
○ lock
to:production
○ unlock
to:production
○ releases
rollback
–release=-­‐1
to:production
○ releases
list
to:production
○ compile
○ version

36. Comandos personalizados
Si necesitas extender Magallanes añadiendo un nuevo comando, es tan
fácil como hacer una tarea personalizada
○ Son clase PHP muy sencillitas
○ Extienden de MageTaskAbstractCommand
○ El namespace tiene que ser Command
○ Obliga a implementar el método run()
○ Se almacenan en .mage/commands

37. Comandos personalizados
<?php
namespace
Command;
use
MageCommandAbstractCommand;
use
MageConsole;
class
ComandoPrueba
extends
AbstractCommand
{
public
function
run()
{
Console::output(‘Hola
esto
es
una
prueba’,
1,
2)
return
0;
}
}
mage
comando-­‐prueba

38. https://github.com/javiernuber/magallanes-phpcaceres
Ejemplos

39. GRACIAS!!
¿ALGUNA PREGUNTA?
@javiernuber
javiernuber@gmail.com