Compose
Archivo Compose
El archivo compose.yml sirve para definir
los parámetros de creación y funcionamiento
del contenedor (o los contenedores)
del proyecto.
Se trata de un archivo YAML,
es decir un tipo de archivos que es habitualmente usado para definir
diccionarios y listas de datos mediante indentado,
lo que lo hace muy fácil de interpretar visualmente.
Una de las grandes ventajas que proporciona
el uso de este archivo
es el despliegue de proyectos enteros
mediante el comando simplificado llamado compose.
docker-compose.yml
Este archivo es llamado en muchos proyectos como docker-compose.yml.
También puede ponérsele la extensión .yaml.
Nombre de proyecto
El campo name asigna un nombre al proyecto,
el cual será leído por el gestor de contenedores
y suele ser usado para nombrar a los elementos internos del proyecto.
Si este campo no se indica explícitamente entonces se asigna automáticamente. Suele tomarse el nombre de la carpeta que contiene al archivo.
Sección services
La sección services es la de uso más habitual
porque en ella se definen los contenedores del proyecto.
Cada proyecto funciona como un entorno aislado
donde los contenedores internos
son incapaces de interactuar
con otros proyectos
ni tampoco
con el sistema anfitrión.
Este es un esquema típico:
---
title: "Servicios - idea básica"
config:
markdownAutoWrap: false
---
flowchart LR
subgraph proyecto [Entorno proyecto]
subgraph services [Servicios]
c1["`Contenedor 1`"]
c2["`Contenedor 2`"]
end
endA cada contenedor se le pone un "nombre de servicio" a elección del usuario y bajo él se definen los parámetros del container que se necesiten. A continuación se muestran algunos de los parámetros más habituales.
image
Si se necesita usar una imagen preconstruida
que no experimentará cambios internos
se usa solamente el campo image.
En este caso, el gestor de contenedores buscará localmente
la imagen indicada por su nombre y versión para crear el contenedor.
Si no se encuentra la imagen pedida,
entonces el gestor buscará e intentará descargar la imagen
desde alguno de los proveedores de imágenes habilitados.
La sintaxis básica es la siguiente:
services:
base-datos: # nombre de servicio - arbitrario
image: nombre_imagen:tag_version
latest automáticamente.
Algunos ejemplos de uso para image:
- Gestores de bases de datos: MariaDB, PostgreSQL, Redis, MongoDB, etc.
- Servidores proxy, balanceadores de carga: Apache, NGINX, Traefik.
- Frameworks: Wordpress, Mkdocs, Sphynx.
Por ejemplo, para utilizar la versión 9.3 de MySQL:
services:
base-datos: # nombre de servicio - arbitrario
image: mysql:9.3.0 # tag: '9.3.0'
build
Si se necesita crear una imagen a medida de una aplicación,
o se necesita instalar componentes adicionales a la imagen
entonces se usa el campo build ("construir").
Este campo indica la ruta a un archivo Dockerfile
que servirá como referencia para crear la nueva imagen
a partir de una preexistente.
Si la imagen preexistente no existe
entonces se la descarga automáticamente.
services:
nueva-imagen: # nombre de servicio - arbitrario
build: ruta_dockerfile # ruta relativa al Dockerfile
El nombre asignado a la imagen modificada es una composición del nombre del proyecto y del nombre de servicio.
Etiquetar imágenes
Si image y build son indicados en el mismo contenedor
entonces se creará una nueva imagen
siguiendo los pasos indicados por el Dockerfile
y a ésta se la nombrará con el nombre y etiqueta
especificados por el campo image.
Si la etiqueta se omite se asigna automáticamente el tag latest.
Ejemplo:
container_name
El nombre del contenedor es un parámetro opcional que sirve para gestionar el contenedor desde la terminal mediante comandos específicos. Funciona como un identificador único del contenedor en el sistema local y por tanto no puede repetirse entre varios contenedores existentes.
Ejemplo de uso:
services:
base-datos:
image: mysql:9.3.0
container_name: contenedor_mysql
Comando Compose
El comando Compose interpreta el archivo compose.yml y con el crea,
ejecuta, lee y borra los contenedores indicados en el proyecto.
La terminal debe estar ubicada en la ruta del archivo para funcionar.
Implementaciones
Dependiendo de la implementación del comando Compose instalada en el sistema, el comando se debe llamar como:
docker-compose comando # Docker - versiones viejas / paquete externo
docker compose comando # Docker - versiones nuevas
podman-compose comando # Podman - Paquete externo
podman compose comando # Podman Desktop - extension
Elegir la variante que corresponda según el componente instalado en el sistema.
En este tutorial se asumirá que es podman compose comando
Creación y arranque
El proyecto se crea con el comando up.
Este comando descarga la imagen indicada por el Dockerfile en caso de ser necesario y crea la imagen personalizada. Luego pone en marcha al contenedor y muestra los mensajes de log a medida que se producen.
El comando up no reconstruye la imagen en caso de modificarse la rutina Python. Para forzar la reconstrucción hay que agregar la opción build:
Sólo arranque
La puesta en marcha en segundo plano se realiza con el comando start:
Registro
La consulta del registro de logs pasados se hace con logs:
Los logs de cada contenedor también se pueden consultar desde el cliente gráfico tanto de Docker como de Podman.
Borrado
El proyecto se elimina con el comando down:
Este comando apaga los contenedores del proyecto y los elimina.