Ansible community.docker.docker_compose: administre aplicaciones de Docker de varios contenedores con el ejemplo de Docker Compose

Nota

Este complemento es parte del colección community.docker (versión 1.2.2).

Para instalarlo use: ansible-galaxy collection install community.docker.

Para usarlo en un libro de jugadas, especifique: community.docker.docker_compose.

• Sinopsis
• Requisitos
• Parámetros
• Notas
• Ejemplos de
• Valores devueltos

Sinopsis

• Utiliza Docker Compose para iniciar, cerrar y escalar servicios.
• Funciona con componer versiones 1 y 2.
• La configuración se puede leer desde un docker-compose.yml o docker-compose.yaml archivo o en línea usando el definición opción.
• Consulte los ejemplos para obtener más detalles.
• Admite el modo de verificación.
• Este módulo se llamó docker_service antes de Ansible 2.8. El uso no cambió.

Requisitos

Los siguientes requisitos son necesarios en el host que ejecuta este módulo.

• API de Docker> = 1.20
• SDK de Docker para Python: tenga en cuenta que el docker-py El módulo de Python ha sido reemplazado por estibador (ver aquí para detalles). Para Python 2.6, docker-py debe ser usado. De lo contrario, se recomienda instalar el docker Módulo de Python. Tenga en cuenta que ambos módulos deben no ser instalado al mismo tiempo. También tenga en cuenta que cuando ambos módulos están instalados y uno de ellos se desinstala, es posible que el otro deje de funcionar y sea necesario volver a instalarlo.
• SDK de Docker para Python > = 1.8.0 (utilizar docker-py para Python 2.6)
• PyYAML> = 3,11
• docker-compose> = 1.7.0

Parámetros

Notas

Nota

• Conéctese al demonio de Docker proporcionando parámetros con cada tarea o definiendo variables de entorno. Puedes definir DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_SSL_VERSION, DOCKER_TLS, DOCKER_TLS_VERIFY y DOCKER_TIMEOUT. Si está utilizando una máquina acoplable, ejecute el script que se envía con el producto que configura el entorno. Establecerá estas variables por ti. Ver https://docs.docker.com/machine/reference/env/ para más detalles.
• Al conectarse al demonio de Docker con TLS, es posible que deba instalar paquetes de Python adicionales. Para el SDK de Docker para Python, versión 2.4 o posterior, esto se puede hacer instalando docker[tls] con ansible.builtin.pip.
• Tenga en cuenta que el SDK de Docker para Python solo permite especificar la ruta a la configuración de Docker para muy pocas funciones. En general, utilizará $HOME/.docker/config.json Si el DOCKER_CONFIG la variable de entorno no está especificada, y use $DOCKER_CONFIG/config.json de lo contrario.
• Este módulo utiliza el SDK de Docker para Python para comunicarse con el demonio de Docker.

Ejemplos de

# Examples use the django example at https://docs.docker.com/compose/django. Follow it to create the# flask directory-name: Run using a project directory
  hosts: localhost
  gather_facts: no
  tasks:-name: Tear down existing services
      community.docker.docker_compose:project_src: flask
        state: absent

    -name: Create and start services
      community.docker.docker_compose:project_src: flask
      register: output

    -ansible.builtin.debug:var: output

    -name: Run `docker-compose up` again
      community.docker.docker_compose:project_src: flask
        build: no
      register: output

    -ansible.builtin.debug:var: output

    -ansible.builtin.assert:that:"not output.changed "-name: Stop all services
      community.docker.docker_compose:project_src: flask
        build: no
        stopped: yes
      register: output

    -ansible.builtin.debug:var: output

    -ansible.builtin.assert:that:-"not web.flask_web_1.state.running"-"not db.flask_db_1.state.running"-name: Restart services
      community.docker.docker_compose:project_src: flask
        build: no
        restarted: yes
      register: output

    -ansible.builtin.debug:var: output

    -ansible.builtin.assert:that:-"web.flask_web_1.state.running"-"db.flask_db_1.state.running"-name: Scale the web service to 2
  hosts: localhost
  gather_facts: no
  tasks:-community.docker.docker_compose:project_src: flask
        scale:web:2register: output

    -ansible.builtin.debug:var: output

-name: Run with inline v2 compose
  hosts: localhost
  gather_facts: no
  tasks:-community.docker.docker_compose:project_src: flask
        state: absent

    -community.docker.docker_compose:project_name: flask
        definition:version:'2'services:db:image: postgres
            web:build:" playbook_dir /flask"command:"python manage.py runserver 0.0.0.0:8000"volumes:-" playbook_dir /flask:/code"ports:-"8000:8000"depends_on:- db
      register: output

    -ansible.builtin.debug:var: output

    -ansible.builtin.assert:that:-"web.flask_web_1.state.running"-"db.flask_db_1.state.running"-name: Run with inline v1 compose
  hosts: localhost
  gather_facts: no
  tasks:-community.docker.docker_compose:project_src: flask
        state: absent

    -community.docker.docker_compose:project_name: flask
        definition:db:image: postgres
            web:build:" playbook_dir /flask"command:"python manage.py runserver 0.0.0.0:8000"volumes:-" playbook_dir /flask:/code"ports:-"8000:8000"links:- db
      register: output

    -ansible.builtin.debug:var: output

    -ansible.builtin.assert:that:-"web.flask_web_1.state.running"-"db.flask_db_1.state.running"

Valores devueltos

Los valores de retorno comunes están documentados aquí, los siguientes son los campos exclusivos de este módulo:

Autores

• Chris Houseknecht (@chouseknecht)