Diferencia entre revisiones de «Curso Python DGA 2011/sistemas/admin monitor»
(Página creada con '{{TEP}} == Administración y monitorización de sistemas con Python == === Administración de sistemas con Fabric === ==== ¿ Qué es Fabric ? ==== * Herramienta de línea d…') |
|||
Línea 1: | Línea 1: | ||
− | |||
− | |||
== Administración y monitorización de sistemas con Python == | == Administración y monitorización de sistemas con Python == | ||
Línea 76: | Línea 74: | ||
==== Ejecución de operaciones en remoto ==== | ==== Ejecución de operaciones en remoto ==== | ||
+ | * Fabric se encarga de gestionar las conexiones con los hosts remotos sobre los que ejecutar comandos. | ||
+ | * Se hace cache de conexiones, fab las cierra al terminar. | ||
+ | * Fabric mantiene una cache de passwords, evitando tener que reintroducirlas constantemente. | ||
<source lang="python"> | <source lang="python"> | ||
# fabfile.py | # fabfile.py | ||
Línea 147: | Línea 148: | ||
</source> | </source> | ||
+ | |||
+ | ==== Ejecutando con sudo ==== | ||
+ | * Fabric también trae soporte para ejecutar comandos en máquinas remotas como "sudo" | ||
+ | <source lang="python"> | ||
+ | sudo("echo '192.168.0.2 importanthost' >> /etc/hosts") | ||
+ | </source> | ||
+ | |||
+ | |||
+ | ==== Manejando fallos ==== | ||
+ | * Cuando una tarea falla, fab aborta la ejecución del resto. Esto es muy útil si utilizamos Fabric como herramienta de builds y despliegue de nuestro proyecto. | ||
+ | <source lang="python"> | ||
+ | |||
+ | def test(): | ||
+ | #exec tests | ||
+ | pass | ||
+ | |||
+ | def pack(): | ||
+ | #package the project | ||
+ | |||
+ | def deploy(): | ||
+ | test() | ||
+ | pack() | ||
+ | #and then upload and deploy the actual project | ||
+ | </source> | ||
+ | |||
+ | * Si ejecutamos la tarea deploy, pero la ejecución de tests falla, no se realizará ni el empaquetado ni el despliegue. | ||
+ | * En algunos casos nos interesa manejar manualmente el error (usando warn_only=True): | ||
+ | |||
+ | <source lang="python"> | ||
+ | def exec_local(): | ||
+ | with settings(warn_only=True): | ||
+ | result = local('./inexistent_file', capture=True) | ||
+ | |||
+ | if result.failed and not confirm("inexistent_file doesn't exist. Continue?"): | ||
+ | abort("Aborting at user request.") | ||
+ | |||
+ | print("Successfully finished!") | ||
+ | </source> | ||
+ | |||
+ | {{Tip| Nótese el uso del context manager 'settings'. sirve para ejecutar acciones dentro de el con variables env.XXX de fabric modificadas. Fuera del bloque, env.warn_only es False. Ver http://docs.fabfile.org/en/1.2.1/usage/env.html para una lista completa de variables de configuración}} | ||
+ | |||
+ | ==== Context Managers ==== | ||
+ | |||
+ | Además del context manager ''settings'', que ya hemos visto antes, Fabric trae algunos muy útiles: | ||
+ | |||
+ | * '''cd(path)''' - Cambia el directorio de trabajo actual | ||
+ | <source lang="python"> | ||
+ | with cd('/var/www'): | ||
+ | run('ls') | ||
+ | </source> | ||
+ | |||
+ | ¿Y no es más fácil ejecutar lo siguiente?: | ||
+ | <source lang="python"> | ||
+ | run('/var/www') | ||
+ | run('ls') | ||
+ | </source> | ||
+ | No. '''Fabric no mantiene estado entre conexiones''', así que el comando 'ls' se ejecutará sobre el directorio de trabajo por defecto del usuario en el host | ||
+ | |||
+ | * '''lcd(path)''' - Equivalente a cd, pero para local. | ||
+ | * '''path(path, behavior='append')''' - Añade ''path'' a la variable de entorno PATH del sistema durante la ejecución de los comandos que encapsule. | ||
+ | * '''prefix(command)''' - Añade ''command'' como comando a ejecutar antes de cada comando invocado con '''run/sudo''', añadiéndoselo con && | ||
---- | ---- | ||
− | {{Tip| Aquí se ha descrito la funcionalidad "core" de Fabric. | + | {{Tip| Aquí se ha descrito buena parte de la funcionalidad "core" de Fabric, aunque provee más operaciones y context managers de los aquí descritos. Revisar la documentación de Fabric. Además, el paquete fabric.contrib trae varias utilidades comunes. Echad un vistazo a http://docs.fabfile.org/en/latest/index.html#contrib-api}} |
Revisión de 06:18 2 sep 2011
Contenido
Administración y monitorización de sistemas con Python
Administración de sistemas con Fabric
¿ Qué es Fabric ?
- Herramienta de línea de comandos y librería para facilitar la administración de sistemas y despliegue de aplicaciones a través de SSH.
- Los scripts en fabric son python usando el api que provee.
- Permite ejecutar comandos shell localmente o remotamente, así como subir y bajar ficheros de sistemas remotos.
- Ejecuta mismas tareas en múltiples hosts definidos.
- Es capaz de manejar las peticiones de input por parte de los programas ejecutados a través de la shell remota (ej: petición de passwords)
Instalación
- Usaremos la última release 1.x, a día de hoy 1.2.1
- Ubuntu 11.04 (natty) trae fabric 0.9.3, aunque la próxima oneiric ya saldrá con una 1.0.
Por tanto instalaremos la última release de https://github.com/fabric/fabric/downloads.
Necesitaremos:
- tener setuptools instalada
- python-paramiko - nos sirve el paquete que trae ubuntu
Una vez descargada la release y cumplidas las dependencias:
python setup.py install
Herramienta fab y tareas
Fabric trae la herramienta fab, con la que podemos ejecutar funciones (tareas) que escribamos en fabfile.py
# fabfile.py def hello(name="world"): print("Hello {0}".format(name))
$ fab hello Hello world Done.
- Se pueden pasar parámetros:
$ fab hello:luis
Hello luis
Done.
$ fab hello:name=luis
Hello luis
Done.
- Podemos hacer tareas que llamen a tareas, puesto que las tareas son funciones python.
Ejecución de operaciones en local
# fabfile.py from fabric.api import local def sysinfo(): cpu_info = local("cat /proc/stat") mem_info = local("cat /proc/meminfo") print(cpu_info) print(mem_info)
Ejecución de operaciones en remoto
- Fabric se encarga de gestionar las conexiones con los hosts remotos sobre los que ejecutar comandos.
- Se hace cache de conexiones, fab las cierra al terminar.
- Fabric mantiene una cache de passwords, evitando tener que reintroducirlas constantemente.
# fabfile.py from fabric.api import local def sysinfo(): cpu_info = run("cat /proc/stat") mem_info = run("cat /proc/meminfo") print(cpu_info) print(mem_info)
- Si ejecutamos esta operación, dado que no hemos definido ningún host, fabric nos pedirá donde queremos ejecutar las operaciones (user@host)
$ fab sysinfo No hosts found. Please specify (single) host string for connection:
- Podemos definir los hosts donde ejecutar las operaciones de forma global al script:
env.hosts = ['192.168.0.11', '192.168.0.20', 'my_server']
Aunque esto asumirá que que el usuario con el que nos autenticamos es el mismo usuario que ejecuta el script.
- Podemos poner el usuario con el que se ejecutará:
env.hosts = ['luis@192.168.0.11', 'root@192.168.0.20', 'my_server']
- Podemos especificar hosts para una tarea en concreto:
@hosts('user1@logserver1', 'logserver') def diskusage(): disk_usage = run("df -h /dev/sda1")
- ... o pasar por línea de comandos los hosts
$ fab diskusage --hosts=192.168.0.11
Roles en Fabric
Se pueden agrupar hosts de forma que se puedan ejecutar tareas para un determinado grupo, usando @roles
env.roledefs.update({ 'locales': ['192.168.1.1', '192.168.1.2'], 'logservers': ['logserver1, logserver2'] }) @roles('logservers') def diskusage(): pass
- También se puede ejecutar sobre un rol en concreto desde línea de comandos:
$ fab -R logservers diskusage
Subiendo y bajando ficheros
put('bin/project.zip', '/tmp/project.zip') put('*.py', 'cgi-bin/') put('index.html', 'index.html', mode=0755) get('/path/to/remote_file.txt')
Ejecutando con sudo
- Fabric también trae soporte para ejecutar comandos en máquinas remotas como "sudo"
sudo("echo '192.168.0.2 importanthost' >> /etc/hosts")
Manejando fallos
- Cuando una tarea falla, fab aborta la ejecución del resto. Esto es muy útil si utilizamos Fabric como herramienta de builds y despliegue de nuestro proyecto.
def test(): #exec tests pass def pack(): #package the project def deploy(): test() pack() #and then upload and deploy the actual project
- Si ejecutamos la tarea deploy, pero la ejecución de tests falla, no se realizará ni el empaquetado ni el despliegue.
- En algunos casos nos interesa manejar manualmente el error (usando warn_only=True):
def exec_local(): with settings(warn_only=True): result = local('./inexistent_file', capture=True) if result.failed and not confirm("inexistent_file doesn't exist. Continue?"): abort("Aborting at user request.") print("Successfully finished!")
Context Managers
Además del context manager settings, que ya hemos visto antes, Fabric trae algunos muy útiles:
- cd(path) - Cambia el directorio de trabajo actual
with cd('/var/www'): run('ls')
¿Y no es más fácil ejecutar lo siguiente?:
run('/var/www') run('ls')
No. Fabric no mantiene estado entre conexiones, así que el comando 'ls' se ejecutará sobre el directorio de trabajo por defecto del usuario en el host
- lcd(path) - Equivalente a cd, pero para local.
- path(path, behavior='append') - Añade path a la variable de entorno PATH del sistema durante la ejecución de los comandos que encapsule.
- prefix(command) - Añade command como comando a ejecutar antes de cada comando invocado con run/sudo, añadiéndoselo con &&