Docker#
El módulo proporciona configuración dinámica de grupos de servidores proxy en los contextos HTTP y stream basados en etiquetas de contenedores Docker. Para que la funcionalidad funcione, debe configurarse una zona de memoria compartida en el grupo (consulte la descripción de zone para http y stream).
Nota
El módulo admite trabajar tanto con Docker como con sus alternativas, como Podman, que implementan una API compatible.
El módulo se conecta al daemon de Docker mediante la API, cuyo modo de interacción se especifica mediante la directiva docker_endpoint. Después de obtener una lista de contenedores en ejecución, Angie los analiza para detectar la presencia de etiquetas adecuadas. Si la descripción de un contenedor contiene una etiqueta con un puerto, entonces la dirección y el puerto de dicho contenedor, así como los parámetros de otras etiquetas de este contenedor, se añaden automáticamente al bloque upstream correspondiente en la configuración de Angie.
Nota
El mismo contenedor puede añadirse a varios grupos upstream; solo hay que especificar varios conjuntos de etiquetas con diferentes nombres de grupo y puertos.
Esto es especialmente útil si el contenedor ejecuta varios servicios diferentes en diferentes puertos; cada servicio puede asociarse con su propio grupo.
El módulo luego se suscribe a eventos del ciclo de vida del contenedor y empieza a actualizar la configuración del servidor proxy sin recargar Angie:
al iniciar un contenedor con etiquetas adecuadas, su dirección IP interna se añade al grupo especificado;
al detener o eliminar un contenedor, se elimina automáticamente del grupo;
al pausar un contenedor con el comando docker pause, el servidor se marca como
down, y con docker unpause — comoup.
Configuración de ejemplo#
Las directivas del módulo siempre se ubican en el contexto http, pero los grupos de servidores proxy pueden definirse tanto en el contexto http como en el contexto stream.
Ejemplo de configuración para http:
http {
# Examples of connection options:
# docker_endpoint http://127.0.0.1:2375;
# docker_endpoint https://127.0.0.1:2376;
docker_endpoint unix:/var/run/docker.sock;
# maximum Docker response buffer size (optional)
# docker_max_object_size 128k;
upstream u {
zone z 1m; # shared memory zone is required
}
server {
listen 80;
server_name example.com;
location / {
proxy_pass http://u;
}
}
}
De manera similar en el contexto stream:
http {
# Examples of connection options:
# docker_endpoint http://127.0.0.1:2375;
# docker_endpoint https://127.0.0.1:2376;
docker_endpoint unix:/var/run/docker.sock;
# maximum Docker response buffer size (optional)
# docker_max_object_size 128k;
}
stream {
upstream u {
zone z 1m;
}
server {
listen 12345;
proxy_pass u;
}
}
Al recibir un evento para un contenedor, Angie busca etiquetas de la forma
angie.http.upstreams.<name>.port=<port> (para el contexto HTTP)
o angie.stream.upstreams.<name>.port=<port> (para el contexto stream).
Cuando hay una etiqueta presente, la dirección del contenedor en la red Docker especificada
(o la primera disponible si no se especifica la etiqueta angie.network)
se añade al grupo de servidores proxy correspondiente.
Si un contenedor se detiene o se elimina, el servidor se elimina del grupo;
si un contenedor se pausa, el servidor se marca como down.
Fragmento de un archivo docker-compose.yml con etiquetas que Angie reconoce:
services:
myapp:
image: myapp:latest
labels:
- "angie.http.upstreams.u.port=8080"
- "angie.network=my_bridge"
- "angie.http.upstreams.u.weight=2"
- "angie.http.upstreams.u.max_conns=50"
- "angie.http.upstreams.u.max_fails=3"
- "angie.http.upstreams.u.fail_timeout=10s"
- "angie.http.upstreams.u.backup=true"
Etiquetas#
Las etiquetas especifican parámetros del servidor en el grupo de servidores proxy de manera similar a los argumentos de la directiva server:
Etiqueta | Propósito |
|---|---|
| Puerto del contenedor al que Angie se conectará; el contenedor en sí se añade al grupo llamado |
| Nombre de la red Docker de la cual tomar la dirección IP del contenedor. |
| Valor del parámetro |
| Número máximo de conexiones simultáneas ( |
| Umbral para intentos fallidos ( |
| Intervalo para contar intentos fallidos ( |
| Marca el servidor como |
| Establece un identificador de servidor personalizado ( |
| Habilita el modo |
Directivas#
docker_endpoint#
Especifica el método de conexión al daemon de Docker y habilita el seguimiento de eventos de contenedores. Se admiten las siguientes opciones:
| Conexión a través de socket Unix (por ejemplo, |
| Conexión a través de HTTP o HTTPS a una API remota de Docker. |
La conexión puede configurarse adicionalmente utilizando el contexto client, donde el módulo añade dos bloques location con nombre:
@docker_eventsse utiliza para recibir eventos de contenedores;@docker_containers— para obtener información de contenedores.
Por defecto, contienen la directiva proxy_pass con la dirección de conexión y varias otras configuraciones predeterminadas óptimas, a las que se pueden añadir otras configuraciones del módulo Proxy.
Si se especifica la directiva, Angie abre una conexión a Docker utilizando el método especificado, solicita una lista de contenedores en ejecución, analiza sus etiquetas y procesa todos los eventos de contenedores posteriores, añadiendo o eliminando servidores en grupos de servidores proxy según las etiquetas.
Truco
Para acceder al daemon de Docker a través del socket Unix (/var/run/docker.sock u otro), el usuario con el que se ejecuta Angie debe tener permisos de lectura y escritura para este socket.
docker_max_object_size#
Establece el tamaño máximo del búfer que se utiliza tanto para las respuestas JSON a las solicitudes de Docker como para el flujo de eventos de contenedores.
Para solicitudes regulares (versión de API, lista de contenedores, información de contenedor): la respuesta completa debe caber en el búfer, de lo contrario se produce un error.
Para eventos de contenedores, se utiliza procesamiento en streaming con reutilización del búfer, lo que permite procesar un flujo ilimitado de eventos.
El valor típico de 64k es suficiente para aproximadamente 25 contenedores.
Cuando se producen errores de conexión a la API de Docker o errores de procesamiento de respuestas, el módulo reintenta automáticamente en intervalos de tiempo específicos. El número máximo de intentos de reintento para obtener información sobre un contenedor específico está limitado a dos intentos adicionales; después de eso, el módulo deja de intentarlo para ese contenedor.
Contenido