mik-laj commented on a change in pull request #18199: URL: https://github.com/apache/airflow/pull/18199#discussion_r707249940
########## File path: docs/docker-stack/docker-operator-with-localexecutor-in-docker-compose.md ########## @@ -0,0 +1,87 @@ +# Using the DockerOperator with the LocalExecutor in Docker Compose + +This guide will allow you to run the DockerOperator using the LocalExecutor with +Apache Airflow deployed on Docker Compose. The guide is split into four consecutive steps: + +* 1. Preparing the docker-compose.yaml +* 2. Adding a new services in the docker-compose.yaml +* 3. Creating a DAG that connects to the Docker API using this proxy +* 4. Testing the DockerOperator + +To deploy Airflow on Docker with Docker Compose you should fetch the docker-compose.yaml: + +``` +curl -LfO 'https://airflow.apache.org/docs/apache-airflow/2.1.2/docker-compose.yaml' +``` + +For more information about running Airflow in Docker refer to the following +[documentation](https://airflow.apache.org/docs/apache-airflow/stable/start/docker.html). + +## 1. Preparing the docker-compose.yaml + +First you need to adapt the standard docker-compose.yaml file to work with +the LocalExecutor and DockerOperator: + +1. line 50: replace `CeleryExecutor` with `LocalExecutor` +2. line 58: add the `apache-airflow-providers-docker==2.1.0` package to `_PIP_ADDITIONAL_REQUIREMENTS` +3. comment out or delete lines: 53, 65-66, 85-94, 118-128, 140-150 + +Note that the apache-airflow-providers version must be 2.1.0 or higher. + +You can now initialize the environment with: + +``` +docker-compose up airflow-init +``` + +## 2. Adding a new services in the docker-compose.yaml + +You have to add one additional service to the docker-compose.yaml to use the +DockerOperator. + +``` +# Required because of DockerOperator. For secure access and handling permissions. +docker-socket-proxy: + image: tecnativa/docker-socket-proxy:0.1.1 + environment: + CONTAINERS: 1 + IMAGES: 1 + AUTH: 1 + POST: 1 + privileged: true + volumes: + - /var/run/docker.sock:/var/run/docker.sock:ro + restart: always +``` + +This service allows to mount the Docker socket more securely. +You can find more information about this Docker image [here](https://github.com/Tecnativa/docker-socket-proxy). + +## 3. Creating a DAG that connects to the Docker API using this proxy + +Below is an example DAG that uses the DockerOperator: + +``` +curl -LfO 'https://raw.githubusercontent.com/apache/airflow/main/airflow/providers/docker/example_dags/example_docker.py' +``` + +Place this file inside the dags/ folder. + +You have to modify the task `t3` that uses the DockerOperator for it to work with the +docker-socker-proxy: + +* line 45: set the `api_version` to at least `1.30` +* line 46: replace `localhost` with `docker-socket-proxy` +* line 47: change the command to `"echo TEST DOCKER SUCCESSFUL"` Review comment: Can you use diff to show the required changes? ```diff t3 = DockerOperator( - api_version='1.19', + api_version='1.30', - docker_url='tcp://localhost:2375', # Set your docker URL + docker_url='tcp://docker-socket-proxy:2375', # Set your docker URL - command='/bin/sleep 30', + command="echo TEST DOCKER SUCCESSFUL", image='centos:latest', network_mode='bridge', task_id='docker_op_tester', dag=dag, ) ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
