.. _inginious-agent-docker:

inginious-agent-docker
======================

Start a Docker grading agent. This is typically only used when running the INGInious backend remotely. If you configured
INGInious to use a local backend, it is automatically run by ``inginious-webapp`` or ``inginious-lti``.

.. program:: inginious-agent-docker

::

    inginious-agent-docker [-h] [--friendly-name FRIENDLY_NAME]
                           [--debug-host DEBUG_HOST]
                           [--debug-ports DEBUG_PORTS] [--tmpdir TMPDIR]
                           [--concurrency CONCURRENCY] [-v] [--debugmode]
                           [--disable-autorestart]
                           [--ssh]
                           [--runtime RUNTIME [RUNTIME ...]]
                           [--tasks TASKS | --fs {local}] [--fs-help]
                           backend


.. option:: -h, --help

   Display the help message.

.. option:: --friendly-name

   Friendly name to help identify agent.

.. option:: --debug-host DEBUG_HOST

   The agent hostname for SSH debug. If not specified, the agent autodiscover the public IP address.

.. option:: --debug-ports DEBUG_PORTS

   Range of port for job remote debugging. By default it is 64120-64130

.. option:: --debugger

   Enables container debug through IDE. Only supports Pycharm's debugging for the moment by using a python debug server using port 5678.

.. option:: --tmpdir TMPDIR

   Path to a directory where the agent can store information,
   such as caches. Defaults to ./agent_data

.. option:: --tasks TASKS

   The path to the directory **containing the courses**. Default to ``./tasks``.

.. option:: --concurrency CONCURRENCY

    Maximal number of jobs that can run concurrently on this agent. By default, it is the two times the number
    of cores available.

.. option:: -v, --verbose

   Increases output verbosity: logging level to DEBUG.

.. option:: --debugmode

   Enables debug mode. For developers only.

.. option:: --disable-autorestart

   Disables the auto restart on agent failure.

.. option:: --ssh

    Allow this agent to handle tasks using ssh features.

.. option:: --runtime

   Add a runtime, such as crun, runc or kata. If no runtime is given, the available runtimes are detected automatically.

   Expects at least 2 arguments: the name of the runtime (eg runc),
   the name of the environment type (eg docker or kata). You can then add flags:

   - 'root' indicates that the runtime starts containers as root
   - 'shared' indicates that the containers on this runtime use the host kernel (i.e. they are not VMs)"

   Common values are 'runc docker shared' and 'kata-runtime kata root'.


.. option:: backend

   The backend port, using the following syntax : ``protocol://host:port``. E.g. ``tcp://127.0.0.1:2001``.
   The agent will connect to the backend listening on that port.