Automatización de Despliegues con Laravel Envoy 🚀

Introducción

Laravel Envoy es una herramienta sencilla y poderosa que permite automatizar tareas de despliegue y administración de servidores en entornos de desarrollo y producción. Con una sintaxis limpia similar a Blade, Envoy facilita la ejecución de tareas remotas en uno o varios servidores sin complicaciones. En este artículo, veremos cómo instalar, configurar y ejecutar comandos con Laravel Envoy, además de explorar algunos ejemplos prácticos para automatizar el despliegue de aplicaciones.

Prerrequisitos

Antes de empezar, asegúrate de contar con:

1. Acceso SSH configurado en tus servidores para cada entorno (~/.ssh/id_rsa).
2. Un proyecto Laravel ya desplegado en cada entorno.
3. Ramas configuradas para cada entornom en nuestro ejemolo usaremos 3:
   • dev para desarrollo.
   • qa para QA.
   • master para producción.

Paso 1: Instalación de Envoy en el Proyecto

Para instalar Envoy solo en el proyecto, agrega la dependencia de desarrollo ejecutando el siguiente comando:

composer require laravel/envoy --dev

Esto agregará Envoy a tu proyecto, permitiéndote ejecutarlo solo dentro del contexto de este proyecto y asegurando que cada entorno o desarrollador tenga la misma versión.

Paso 2: Crear el Archivo Envoy.blade.php

En el directorio raíz de tu proyecto, crea un archivo llamado Envoy.blade.php. Este archivo será el núcleo de las configuraciones de despliegue para los entornos dev, QA y prod.

touch Envoy.blade.php

Paso 3: Configuración de los Entornos

Define los entornos en el archivo Envoy.blade.php utilizando la anotación @servers para especificar las direcciones IP de cada servidor y el usuario SSH para conectarte. En este ejemplo, usaremos user@your-server-ip y la llave SSH en ~/.ssh/id_rsa.

Ejemplo de Configuración

@servers([
    'dev' => 'user@dev-your-server-ip',
    'qa' => 'user@qa-your-server-ip',
    'prod' => 'user@prod-your-server-ip',
])

@setup
    // Directorio donde está alojado el proyecto en cada servidor
    $appDir = '/var/www/laravel-project';
    
    // Ramas de Git correspondientes a cada entorno
    $branches = [
        'dev' => 'dev',
        'qa' => 'qa',
        'prod' => 'master',
    ];

    // Obtener el entorno en el que se va a ejecutar el despliegue
    if (!isset($server)) {
        throw new Exception("El entorno no está definido. Usa --server=dev|qa|prod");
    }
@endsetup

Con esta configuración, @servers define los accesos SSH para cada entorno y @setup establece el directorio base del proyecto y las ramas correspondientes.

Paso 4: Crear las Tareas de Despliegue

Configura las tareas de despliegue para cada entorno. Estas tareas realizarán las siguientes acciones:

1. Navegar al directorio del proyecto en el servidor.
2. Actualizar el código desde la rama correspondiente usando git pull.
3. Ejecutar migraciones (opcional).
4. Limpiar el caché de la aplicación para asegurar que los cambios se apliquen correctamente.

Tarea de Despliegue

@task('deploy', ['on' => $server])
    echo "Iniciando despliegue en el entorno: {{ $server }}...";
    
    cd {{ $appDir }};
    git pull origin {{ $branches[$server] }};
    
    echo "Ejecutando migraciones...";
    php artisan migrate --force;
    
    echo "Limpiando caché...";
    php artisan optimize:clear;
    
    echo "Despliegue completado para el entorno {{ $server }}.";
@endtask

En esta tarea:

• git pull origin {{ $branches[$server] }} actualiza el código en función de la rama especificada para el entorno (dev, qa o master).
• php artisan migrate --force ejecuta las migraciones necesarias en el entorno.
• php artisan optimize:clear limpia el caché para aplicar cualquier cambio de configuración o de código.

Paso 5: Otras Tareas Comunes

Además de la tarea de despliegue, puedes configurar otras tareas para manejar aspectos específicos de tu aplicación, como limpiar el caché o generar un sitemap. Estas tareas adicionales facilitan la administración y el mantenimiento de la aplicación.

Limpiar Caché

@task('cache:clear', ['on' => $server])
    echo "Limpiando caché en el entorno {{ $server }}...";
    cd {{ $appDir }};
    php artisan optimize:clear;
    echo "Cache limpiado en {{ $server }}.";
@endtask

Generar Sitemap

@task('sitemap:generate', ['on' => $server])
    echo "Generando sitemap en el entorno {{ $server }}...";
    cd {{ $appDir }};
    php artisan sitemap:generate;
    echo "Sitemap generado en {{ $server }}.";
@endtask

Paso 6: Ejecución de las Tareas

Para ejecutar las tareas de despliegue, usa el comando envoy run seguido de la tarea que quieres ejecutar y el entorno (--server=dev, --server=qa o --server=prod).

Ejemplo de Ejecución

1. Despliegue en Desarrollo (dev):

envoy run deploy --server=dev

2. Despliegue en QA:

envoy run deploy --server=qa

3. Despliegue en Producción (prod):

envoy run deploy --server=prod

De forma similar, puedes ejecutar las tareas de limpieza de caché o generación de sitemap en cualquier entorno:

envoy run cache:clear --server=qa

envoy run sitemap:generate --server=prod

Consejos de Seguridad

1. Permisos de SSH: Asegúrate de que solo los usuarios autorizados tengan acceso a las llaves SSH en ~/.ssh/id_rsa.
2. Backups y Pruebas en QA: Realiza siempre pruebas en el entorno de QA antes de desplegar cambios en producción.
3. Entornos Segregados: Cada entorno debe tener su propia base de datos y configuraciones para evitar problemas de sobreescritura de datos o conflictos.

Conclusión

Con Laravel Envoy puedes simplificar y automatizar el despliegue de tus aplicaciones en múltiples entornos. Este ejemplo muestra cómo configurar un entorno de despliegue eficiente y seguro en servidores de desarrollo, QA y producción, controlando las ramas correspondientes y utilizando comandos personalizados para administrar la aplicación.

Para proyectos de mayor escala, Envoy es una herramienta que ayuda a ahorrar tiempo y minimizar errores, proporcionando un flujo de despliegue organizado y repetible en múltiples entornos. ¡Prueba Envoy en tu proyecto y verás los beneficios de la automatización en acción!