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.
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
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.
A 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.
Parámetros de contenedores
Cada contenedor acepta múltiples parámetros de configuración. Estos son 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.
Algunos ejemplos de uso para image:
- Gestores de bases de datos: MariaDB, PostgreSQL, Redis, MongoDB, etc.
- Proxys, 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'
Si no se indica ningún tag entonces se asigna el tag latest automáticamente.
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 # ruta al Dockerfile - suele ser relativa
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 esta 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
Secciones opcionales
A veces se necesitan crear secciones adicionales en el proyecto. Algunas de ellas son:
volumes
Los volumenes son elementos usados
para guardar los datos
de los contenedores
en el sistema anfitrión.
Si los volumenes requieren ser configurados
o se importan desde otros proyectos
entonces la sección volumes es creada.
networks
Las networks son elementos
que sirven para interconectar varios contenedores.
Si se crean networks en el proyecto
o se importan desde otros proyectos
entonces se crea la sección networks.
include
La sección include es de uso opcional y
sirve para apuntar a otros archivos Compose,
incluyendo su contenido
de manera automática
dentro del proyecto actual.
No todas las implementaciones del comando Compose soportan su uso.