docs: document Docker daemon socket bind mount requirement for agents
@@ -55,16 +55,22 @@ available options and descriptions for them, run:
docker cp "$id":/etc/determined/master.yaml .
docker rm "$id"
-Then edit the configuration file (``master.yaml``) as appropriate and
-run
+Then edit the ``master.yaml`` configuration file as appropriate and start the
+master with the edited configuration:
.. code::
docker run -v "$PWD"/master.yaml:/etc/determined/master.yaml determinedai/determined-master:VERSION
-to start the master with the edited config file. The process for the
-agent is the same, except that "master" should be replaced by "agent"
-everywhere it appears.
+The process for starting an agent is analogous, with the caveat that the agent
+container must bind mount the host's Docker daemon socket. This allows the
+``determinedai/determined-agent`` container to orchestrate the containers that
+execute trials and notebook servers:
+
+.. code::
+
+ docker run -v /var/run/docker.sock:/var/run/docker.sock \
+ -v "$PWD"/agent.yaml:/etc/determined/agent.yaml determinedai/determined-agent:VERSION
Environment variables and command-line arguments can be passed as usual
for Docker:
@@ -72,7 +78,8 @@ for Docker:
.. code::
docker run -e DET_DB_HOST=the-db-host determinedai/determined-master:VERSION --db-port=5432
- docker run -e DET_MASTER_HOST=the-master-host determinedai/determined-agent:VERSION run --master-port=8080
+ docker run -v /var/run/docker.sock:/var/run/docker.sock \
+ -e DET_MASTER_HOST=the-master-host determinedai/determined-agent:VERSION run --master-port=8080
Note that the agent requires ``run`` as the first argument if any
arguments are provided.
