Este es un tema que tendría que haber abordado hace mucho tiempo, pero que, como en otras cosas de la vida, vas dejando. Y al igual que sucede en la vida, no es que este tema no sea importante, que lo es, sino que lo vas dejando, porque como no pasa nada, pero ¿y cuando pasa?, entonces nos lamentamos. Como te decía, es lo mismo que sucede en la vida real con la salud, mientras tienes saludo, porque te tienes que cuidar, pero cuando llegan los problemas, es cuando nos comenzamos a preocupar. En este caso, no ha sido directamente por un problema con el que me he tropezado, si no por una molestia, de la que te he hablado en otras ocasiones, y que puede ser que haya encontrado una solución. Y todo ello gracías al Health Check de Docker. Una característica que nos ofrece Docker y que nos permite conocer la salud de nuestros contenedores. Por que si, un contenedor puede estar running pero el proceso muerto, y como te digo, tu sin enterarte.
Tu contenedor Docker podría estar muerto y tu sin enterarte
Un paseo por el pasado
Hace ya algún tiempo, que al actualizar, de forma automática las imágenes que componen el stack de atareao.es, todos los contenedores no arrancan de forma adecuada y me quedo sin la página durante unas horas. Para minimizar este proyecto, lo que hice, fue, que esta actualización se hiciera una vez a la semana, pero como te puedes imaginar, esto no es una solución, es un parche.
Posteriormente, añadí dependencias, para que asegurar que cuando se levanta WordPress, ya esté levantada la base de datos y Redis. Sin embargo, esto no es suficiente, porque si bien MariaDB, está iniciado, todavía no está preparada para recibir peticiones. Entiendo o supongo que es precisamente, este punto donde se queda el proceso y no continua.
Hasta hace poco esto lo tenía de la siguiente manera,
depends:
- mariadb
- redis
De forma que mi servicio WordPress dependía de estos dos servicios. Con esto yo pensaba que estaba todo resuelto, pero no es tanto así, porque aunque la base de datos esté levantada puede ser que no esté disponible para recibir peticiones, como te decía anteriormente. Y aquí justo es donde aparece el Health Check de Docker.
Docker Health Check
Pero, antes que nada, ¿que es esto del Health Check de Docker? En la documentación oficial de Docker, dice que el Health Check es una forma de comprobar si un contenedor está funcionando correctamente. Esto se hace mediante un comando que se ejecuta dentro del contenedor y que devuelve un estado de salud. Este estado puede ser healthy, unhealthy o starting. De esta forma, podemos saber si el contenedor está funcionando correctamente o no.
Básicamente se trata de pruebas que se ejecutan en el propio contenedor y que nos permite determinar si todo funciona como debería o no. Se trata de una capa mas sobre el estado del servicio. Sin embargo, te tengo que avisar de que no todos los contenedores lo tienen configurado por defecto. Aunque siempre tienes la posibilidad de configurarlo tu.
Esta característica es la que nos informa de que un contenedor está healthy o unhealthy. En el caso de que el contenedor esté unhealthy, Docker no lo va a reiniciar automáticamente, pero si lo puedes hacer tu. De esta forma, puedes configurar un servicio para que dependa de otro, pero no solo de que esté levantado, sino también de que esté funcionando correctamente.
Por ejemplo, en mi caso particular, la cuestión es que si bien el contenedor ya inició, lo cierto es que la base de datos está todavía en proceso. Con lo que todavía no está healthy. Así es posible que tengas un proceso running y unhealthy. Es posible ver este estado utilizando un simple docker ps, o mediante un docker inspect <nombre-del-contenedor>.
Configuración del Health Check
Existen dos formas principales de configurar un healthcheck, que es o bien en el propio Dockerfile o bien en el docker-compose.yml. Es decir, que en cualquier caso, siempre es posible definir tu propio healthcheck que te asegure que tu servicio esté funcionando de forma saludable.
Por ejemplo, en el Dockerfile podría ser de la siguiente forma,
Te cuento algunos casos reales donde estoy usando healthchecks:
Aplicación web en Rust + React: tengo configurado un healthcheck que comprueba si la API responde y si el frontend devuelve el HTML esperado. Así me aseguro de que el backend y frontend están activos antes de permitir otras tareas programadas.
PostgreSQL: uso un script que intenta conectarse al puerto 5432 y ejecutar una simple consulta SQL. Esto evita iniciar otros contenedores que dependen de la base de datos hasta que realmente esté lista.
Tautulli y Plex: en casa tengo montado mi servidor multimedia con Docker. Si alguno de los servicios no está en estado healthy, envío una alerta vía Telegram usando un bot.
Backups automáticos con Restic y Gocron: antes de lanzar el backup, reviso que los contenedores de los que se va a hacer backup estén healthy. Si no, cancelo el backup y lo intento más tarde.
Combinando con las dependencias
Y todo esto ¿como casa con las dependencias? Justo aquí viene la parte que a mi mas me interesa, que es precisamente unir esto, para que WordPress no se inicie hasta que la base de datos esté funcionando perfectamente. Para ello, he modificado el depends de la siguiente forma,
Con estas opciones hasta que los dos servicios no estén iniciados y en modo saludable no se iniciará WordPress.
Conclusión
Tengo que decirte que si bien, lo tengo implementado todavía no he tenido la oportunidad de verificar si esto resuelve mis problemas o no. Desde luego, con las pruebas que he hecho hasta el momento todo pinta que si, pero, todavía tendrán que pasar unos días hasta que te lo pueda confirmar. Tampoco serán muchos días, porque en breve viene una actualización de WordPress.
Sea como fuere, esta características es una herramienta sencilla pero realmente potente para asegurarte que tus contenedores no solo están arrancados si no que además están vivos y coleando.
¿Tu utilizas esta característica de Docker?¿Donde la estás utilizando?¿Tienes otros casos de uso distintos?
Hola soy lorenzo y esto es atareado con Linux episodio número 680 y 8 probablemente este tema,
Lo tendría que haber abordado hace mucho pero que mucho tiempo pero como en otras cosas como,
En otras cosas de la vida pues lo vas dejando lo vas postergando porque hay cosas que te seducen,
Más pero lo cierto es que como te decía es un tema que tenía que haber abordado hace bastante tiempo,
Sí que es cierto que de forma puntual en algún caso lo he aplicado pero como aquel sin mirar mucho,
De qué va el asunto y es que al final cuando te encuentras con un problema cuando te encuentras,
En una situación en la que necesitas algo más de información en la que en la que realmente necesitas,
Resolver un problema es cuando pues te metes exactamente en el asunto en el meollo de la,
Cuestión y vas indagando hasta que encuentras exactamente qué es la solución que te puede,
Resolver como te digo esto pasa también en la vida en un momento determinado no prestas atención a,
Determinados asuntos hasta que algo hace que te obligue o te obliga a que le tengas que prestar,
Esos esa atención y cuando le prestas esa atención pues ya lo aplicas a casi cualquier cosa y en ese,
Momento dices esto lo tenía que haber hecho antes bueno pues exactamente esto mismo es lo que me ha,
Pasado con el health check es decir con averiguar si mis contenedores están en un modo saludable o no,
Es algo que como te digo he ido dejando y hasta la fecha pues no le he prestado la atención que requería,
Y ahora le he prestado la atención que requiere pero no exactamente para saber si mi contenedor está,
Saludable sino más bien para asegurarme de que cuando el resto de servicios que levanto en un,
Docker compose se levantan el por ejemplo la base de datos ya está totalmente operativa y esto es lo,
Que me ha condicionado así que vamos directo salturrón te voy a hablar cómo puedes saber si tus,
Contenedores están saludables o como he titulado este episodio que tu contenedor podría estar muerto y tú,
Ni te enteras bueno empiezo por un paseo por el pasado y es que como ya te he contado en alguna,
Ocasión como te he mencionado en yo creo que varias ocasiones lo cierto es que tengo varios WordPress,
Varios varias páginas web que están montadas utilizando mariadb redis y WordPress y en alguna,
Ocasión lo que me ha sucedido es que cuando se actualiza que como sabes lo actualizo de forma,
Completamente automática utilizando WordPress cuando se actualiza pues no arranca bien y bueno,
Pues me quedo sin página web esto hasta el momento pues no tenía mucha importancia pero claro cuando,
Empiezas a vaya cuando tienes páginas web que no son tuyas pues la cosa ya toma un cariz un tanto,
Importante no le puedes o sea si si tú a ti mismo te tiras piedras bueno pues vale pero lo que está muy,
Feo es tirarle piedras a otro o por lo menos evitar que a otros en las se las tiren bueno tú ya me entiendes,
La cuestión es que bueno pues que atareado punto es en un momento determinado se quede sin funcionar pues,
Hombre puede ser un problema a mí ya me representa un verdadero incordio pero si la página de alguien que,
La tengo hospedada pues no funciona pues me molesta bastante bueno sea como fuere sea mía o sea de otro,
Al final he decidido ponerle solución y he decidido ponerle solución a esto de que la base de datos no esté,
Perfectamente levantada se haya levantado ya en el WordPress aquello no funcione y no sepa exactamente,
Como ni por qué y realmente hasta el momento pues lo que había hecho era poner una dependencia una,
Dependencia de WordPress es decir WordPress dependía de que estuviera arrancado en redis y maría debe y yo,
Pensaba que con esto ya lo tenía solucionado pero digamos que la realidad es muy tozuda y me ha,
Demostrado que efectivamente esto bueno pues esto no lo termina de solucionar tengo que buscar otra,
Solución que me permita que esto esté funcionando correctamente y esto es lo que me ha llevado a los,
Docker health check y claro evidentemente lo primero es saber qué es un Docker health check o qué es el,
Health check de Docker y si te vas a la documentación oficial de Docker lo que vas a ver es que health check,
Es una forma de comprobar si un contenedor está funcionando correctamente esto se hace pues con,
Un comando que se ejecuta dentro del contenedor y que te devuelve el estado de la salud te permite,
Saber si tu contenedor está funcionando correctamente o no es decir tu contenedor puede estar en varios,
Estados que puede ser healthy un healthy y starting de esta forma podemos saber si tu contenedor está,
Funcionando correctamente o no y tú dirás hombre en el momento que mi contenedor pone running ya tengo,
Claro que mi contenedor está funcionando si tu contenedor está en marcha pero el servicio lo que,
Tengas dentro de tu contenedor puede ser que no esté funcionando o puede ser que todavía no se haya,
Iniciado quiero decir que todavía esté en proceso de arranque por ejemplo si tienes que iniciar una,
Base de datos a lo mejor simplemente está leyendo los archivos de configuración o si tu servicio depende,
De algún servicio externo o en fin hay multitud de razones por las que es posible que tu servicio,
Todavía no haya arrancado y sin embargo el contenedor sí con lo cual es interesante saberlo esta,
Característica pues lo que nos dice es básicamente si tu contenedor está saludable es un mejor dicho,
Si tu servicio el servicio que está dentro de tu contenedor está en un estado saludable o no está,
En un estado saludable de manera que si está en un estado que es un healthy en Docker no lo va a,
Intentar arrancar de forma completamente automática no lo va a intentar rearrancar es decir si está un healthy,
Ahí se queda en tu caso siempre puedes forzar a que arranque y de esta manera sabes en qué estado se,
Queda ahora me pongo en la situación claro yo en el momento que tenía estos servicios no he comprobado,
En ningún caso si estaban me refiero a mi stack de WordPress no yo no he comprobado si tenía la base de,
Datos en estado un healthy o no claro no lo he comprobado porque efectivamente no tenía el,
Health check para comprobarlo y ahora entenderás por qué Docker porque el health check de Docker me ha venido,
Aquí ni al pelo porque ahora me permite primero saber cuál es el estado en el que se encuentra la base de datos y,
Condicionar el arranque precisamente a ese estado por ejemplo como te digo en mi caso particular lo que sucede es que no se inicia o no se ha iniciado,
Correctamente o todavía está en proceso de inicio yo sí que he puesto una dependencia de que el contenedor de que el WordPress se inicie,
Después pero claro efectivamente el contenedor ya está arrancado pero la base de datos está todavía ahí así que bueno pues es,
Importante averiguar en qué estado está para poder continuar con el proceso tú en un momento determinado siempre,
Puedes revisar cuál es el estado de un contenedor simplemente con un Docker ps o con un Docker inspect seguido,
Por el nombre del contenedor y con esto ya tendrás información clara de qué es lo que sucede con tu,
Contenedor el siguiente paso sería configurar los health check y aquí tienes dos opciones o bien puedes,
Configurar el health check directamente dentro de tu Docker file o bien si tu Docker file ya viene impuesto,
Es decir si tú ya te has de digamos ya tienes la imagen porque la imagen la tenías en Docker hub o en,
GitHub o donde sea que la tengas bueno pues lo puedes configurar utilizando Docker compose en el caso de el,
Docker file en las notas de este episodio te dijo cómo puedes hacerlo por ejemplo para un engine x comprobando,
Simplemente si tienes conectividad con el puerto 3000 una cosa realmente sencilla o bien en el caso de que lo,
Quieras hacer en tu Docker compose también te pongo un ejemplo de cómo podrías hacer lo mismo comprobando,
Exactamente con un curl si todo esto funciona ten en cuenta que si lo haces en tu equipo en tu ordenador en,
En tu Docker compose dentro de la imagen ya tiene que haber un curl esto es importante porque con la,
Manía que tengo yo por ejemplo de que mis Docker o mejor dicho que mis imágenes sean lo más mínimas,
Posibles en muchas ocasiones ni les pongo curl ni les pongo las herramientas para hacer un pin o un telnet ni,
Nada de esto o sea que todas estas cosas hay que tenerlas en cuenta como te decía anteriormente cualquier,
Contenedor pasa básicamente por tres estados en lo que se refiere al gence y algún gence a la salud,
Del contenedor un primer paso o un primer estado que es el de starting que lo que nos dice que el,
Contenedor o el servicio se está arrancando y todavía no se han realizado todos los checks suficientes el,
Siguiente proceso es el siguiente estado es el de gence que es cuando ya ha pasado todos los checks y,
Luego el un healthy lo que nos dice es si fallan los checks el número de veces que lo hemos configurado,
De esta manera podemos confirmar que nuestro proceso está funcionando correctamente esto es importante,
Quiero decir que tienes que configurar todos estos pasos para de una manera eficiente y efectiva,
Comprobar o estar seguro de que tu proceso está completamente arrancado decirte que bueno en este caso,
Yo simplemente he puesto un curl contra la localhost 3000 por ejemplo lo que te he puesto en los ejemplos,
Pero tu proceso de comprobación de que todo está funcionando correctamente puede ser tan complicado,
Tan complejo o tan exhaustivo como tú quieras es decir tú puedes determinar los pasos que consideras,
Imprescindibles para que tu servicio sea considerado como saludable en las notas del episodio te he puesto,
Básicamente los cuatro los cuatro health checks que actualmente estoy utilizando básicamente uno para,
María debe que es el que más por saco por decirlo de una manera fina me ha dado porque he encontrado,
Distintas opciones y distintas posibilidades para hacerlo lo que pasa que dependiendo de las posibilidades,
Que he encontrado pues te obliga a realizar una serie de pasos en el inicio del contenedor que no me ha gustado,
También depende de la versión de maría debe que tengas en fin y he encontrado una solución que es la que te dejo,
En las notas del episodio que es relativamente sencilla y que no necesitas absolutamente nada,
Luego el siguiente set de redis que como te digo dentro de mi stack tengo montado maría debe WordPress,
Un engine x y también redis de esta manera también verifico que redis está perfectamente saludable,
Cuando lo inicio tampoco tiene gran cosa porque al final redis lo único que hace es una un caché,
Entonces no vas a tener problema pero bueno ahí lo dejo y luego otro del que tengo es el del engine x que,
Tampoco debería dar ningún problema pero bueno no está de más tenerlo también configurado,
Y por último el que te dejo aquí también es la base de datos postgre actualmente estoy haciendo un proyecto,
Bueno realmente estoy haciendo varios proyectos pero uno de los proyectos mejor dicho dos de los proyectos,
Utilizan postgre sql como base de datos entonces he considerado realmente importante tener resuelto,
Esto de los de los health check para asegurarme que mi proceso está perfectamente levantado,
Así que te como te digo te he puesto uno estos cuatro ejemplos de cómo puedes configurar health check,
Con una maría de b con un engine x con redis y con postgre sql,
Pero además te voy a decir pues algunos casos en los que actualmente estoy utilizando básicamente estos health check,
Para asegurarme que mi servicio funciona correctamente el primero es algo de lo que te acabo de decir,
Que es la aplicación web una aplicación web en rast y bueno el backend está hecho en rast el frontend está en react,
Y lo tengo configurado del health check para que compruebe si la api responde correctamente,
Y el frontend devuelve el html esperado,
Así me aseguro que tanto el backend como el front están activos,
Y puedo hacer todas las tareas que espero,
No solamente es esto sino que además compruebo exactamente,
Mediante otro health check que el postgre sql,
Que es la base de datos que estoy utilizando en el backend,
Funciona también perfectamente,
Igualmente también tengo un script que intenta conectarse al puerto 5432 de postgre sql,
Hace una simple consulta,
Y para esto necesito saber que efectivamente mi postgre está funcionando correctamente,
Otros servicios por ejemplo,
Tautuji y Plex,
Que los tengo montados en un servidor multimedia,
Y si alguno de los servicios pues no está en estado healthy,
Me envía una alerta a telegram mediante un bot,
Y luego backups,
Como te decía pues estoy utilizando Restic y GoChrome para hacer determinados backups,
Y bueno pues para esto antes de hacer el backup,
Necesito que donde voy a hacer el backup esté funcionando correctamente,
Por ejemplo ahora los backups,
Muchos de los backups los estoy haciendo en S3,
Necesito saber efectivamente que S3 está funcionando correctamente,
Para hacer el backup,
Y si no pues igualmente,
Ese mensaje ya sea a telegram o a matrix,
O a cualquiera de los servicios que vengo utilizando,
Pues me viene fantástico,
Porque me permite saber por ejemplo,
Que un backup no se ha realizado,
Pero no solamente que no se ha realizado,
Sino también me permite saber,
Por qué no se ha realizado,
Cuál es la razón que ha llevado a que,
Esto no haya terminado de funcionar,
Y esto es un poco pues todo lo que quería contarte sobre el tema de HealthCheck,
Qué es HealthCheck,
Por qué tiene su utilidad,
Y me queda un detalle fundamental,
Que básicamente es por lo que he empezado este episodio,
Y es la razón que me ha llevado a él,
Ahora una vez ya tengo configurado el HealthCheck,
Cómo puedo utilizarlo para el tema de las dependencias,
Si recuerdas al principio del episodio,
Lo que te he dicho es que yo había puesto que mi WordPress dependiera,
Mediante la sentencia,
Depends,
Depends On,
Dependiera de,
MaríaDB y de Redis,
Hasta aquí estaba todo claro,
La cuestión es que,
Ahora mismo sigo igual,
También depende,
De MaríaDB y de Redis,
Pero le puedo añadir dos condiciones adicionales,
Que es la condición,
De el estado de salud de cada uno de los servicios,