Automatización de la implementación a través de SSH con Python Fabric: cómo funciona

Una de las formas más básicas en que se implementa un proyecto es mediante SSH en un host remoto seguido de la ejecución de algunos comandos básicos. Además de la implementación, esto también puede ser útil para ejecutar cualquier comando que desee en un host remoto, como cuando se activa una canalización de CI/CD. En este artículo, analizaré cómo implementar un proyecto básico en un servidor remoto a través de Gitlab CI usando Python Fabric.

¿Qué es la tela?

Fabric es una biblioteca de Python de código abierto que se utiliza para ejecutar comandos de forma remota a través de SSH.

Fabric es compatible con Python 2 y 3. Para usarlo con Python3, instálelo con:

 pip3 install fabric

Dado que el objetivo final aquí es usar Fabric en una canalización de implementación automatizada, en realidad no necesita tener Fabric instalado en su máquina local (a menos que sea allí donde se ejecute su canalización).

La instalación de fabric también instala el

 fab

Creando un archivo fab

Crear un archivo llamado

 fabfile.py

 from fabric import task @task def deploy (ctx) : print( "Inside the task!" )

Esto define una tarea llamada "implementar" que se puede pasar como argumento al binario fabuloso para su ejecución. los

 @task

 deploy

 ctx

Al ejecutar esto ejecutando

 fab deploy

 fabfile.py

Ahora, use esto para hacer lo que Fabric está diseñado: conectar un host remoto y ejecutar comandos en él.

 from fabric import Connection, task @task def deploy (ctx) : with Connection( "HOST" ) as c: with c.cd( "/home/project/path/" ): c.run( "docker-compose down" ) c.run( "git pull origin master --recurse-submodules --rebase" ) c.run( "docker-compose up --build -d" )

Aquí, reemplaza

 HOST

 c.cd()

 c.run()

En este ejemplo, uso los administradores de contexto de Python con la ayuda de

 with

A estas alturas, es posible que haya notado que solo el nombre de host a menudo no es suficiente para establecer una conexión. ¿Qué pasa con el nombre de usuario y la clave privada para establecer una conexión SSH? Esto no es inmediatamente obvio, pero debido a que Fabric usa una biblioteca llamada Paramiko bajo el capó para manejar el lado SSH de las cosas, podemos pasar argumentos a Paramiko.

 SSHclient.connect

 connect_kwargs

 from fabric import Connection, task @task def deploy (ctx) : with Connection( "HOST" , user= "USERNAME" , connect_kwargs={ "key_filename" : "~/.ssh/your_key" } ) as c: with c.cd( "/home/project/path/" ): c.run( "docker-compose down" ) c.run( "git pull origin master --recurse-submodules --rebase" ) c.run( "docker-compose up --build -d" )

de paramiko

 SSHclient.connect

 key_filename

También puede pasar la clave SSH como una instancia de Paramiko

 pkey.Pkey

Por supuesto, es mucho más seguro cargar todo esto como variables de entorno. Al usar Gitlab CI, mientras configura las variables de entorno, puede elegir que la clave esté disponible como un archivo en lugar de una cadena, que es necesaria para que funcione con el

 key_filename

Aquí hay una captura de pantalla de la sección Variables en la configuración de Gitlab CI/CD con el nombre de host agregado como una cadena y la clave agregada como un archivo.

Es posible que desee cargar estos valores de otras formas según cómo esté organizado su equipo y según sus requisitos de seguridad.

Con estas variables de entorno en su lugar, el fabfile cambia a esto:

 import os from fabric import Connection, task @task def deploy (ctx) : with Connection( os.environ[ "HOST" ], user= "USERNAME" , connect_kwargs={ "key_filename" : os.environ[ "DEPLOY_KEY_FILE" ]}, ) as c: with c.cd( "/home/project/path/" ): c.run( "docker-compose down" ) c.run( "git pull origin master --recurse-submodules --rebase" ) c.run( "docker-compose up --build -d" )

Configuración de Gitlab CI

Ahora que el archivo fab está listo, todo lo que tenemos que hacer es ejecutarlo con el paquete Python Fabric. Esto se puede hacer de la forma que desee: manualmente, usando acciones de Github, etc. Aquí tengo un ejemplo de cómo ejecutarlo con el CI de Gitlab.

Para ello, crea un

 .gitlab-ci.yml

 image: "python:3.6" stages: - deploy deploy_to_production: stage: deploy script: - pip3 install fabric - fab deploy only: - master

Este es un archivo de configuración básico que debería ser fácil de entender si está familiarizado con el CI de Gitlab. Solo tiene un trabajo llamado

 deploy_to_production

 pip3 install fabric

 fab deploy

 fabfile.py

Conclusión

Fabric tiene muchas más opciones que las que se describen aquí, como enviar la contraseña de sudo al host remoto cuando sea necesario, manejar múltiples hosts, etc. Vale la pena revisar su documentación si planea hacer uso de eso.

En conclusión, esta es una forma realmente simple y efectiva de crear scripts mediante programación para que se ejecuten a través de SSH y activarlos desde métodos comunes, como a través de una herramienta de CI/CD.

Espero que hayas encontrado útil esta publicación. Puedes encontrarme en Twitter y LinkedIn .