Docker Support
==============

A pre-built Docker image can be used as an alternative to installing a Python environment with the
modules required for the OpenDXL Console. Docker images for the OpenDXL Console are posted to the
following Docker repository:

`<https://hub.docker.com/r/opendxl/opendxl-console/>`_

The remainder of this page walks through the steps required to configure the console,
pull the image from the repository, and run the console via a Docker container.

Console Configuration
---------------------

The first step is to connect to the host that is running Docker and configure the OpenDXL Console. The configuration
files that are required for the console will reside on the host system and be made available to the Docker
container via a data volume.

Once you have logged into the host system, perform the following steps:

    1.) Create a directory to contain the configuration files

        .. container:: note, admonition

            mkdir dxlconsole-config

    2.) Change to the newly created directory

        .. container:: note, admonition

            cd dxlconsole-config

    3.) Download the latest configuration files for the OpenDXL Console

        The latest release of the console can be found at the following page:

        `<https://github.com/opendxl/opendxl-console/releases/latest>`_

        Download the latest configuration package (dxlconsole-python-dist-config). For example:

        .. container:: note, admonition

           wget ht\ tps://github.com/opendxl/opendxl-console/releases/download/\ |version|\/dxlconsole-python-dist-config-\ |version|\.zip

    4.) Extract the configuration package

        .. container:: note, admonition

           unzip dxlconsole-python-dist-config-\ |version|\.zip

    5.) Populate the configuration files:

        * :ref:`Client Configuration File <dxl_client_config_file_label>`
        * :ref:`Console Configuration File <dxl_console_config_file_label>`

Pull Docker Image
-----------------

The next step is to `pull` the OpenDXL Console image from the Docker repository.

The image can be pulled using the following Docker command:

    :literal:`docker pull opendxl/opendxl-console:<release-version>`

    The following parameters must be specified:

        * ``release-version``
          The release version of the OpenDXL Console

For example:

    .. container:: note, admonition

        docker pull opendxl/opendxl-console:\ |version|\

Create Docker Container
-----------------------

The final step is to create a Docker container based on the pulled image.

The container can be created using the following Docker command:

    :literal:`docker run -d --name dxlconsole -p <host-console-port>:8443 -v <host-config-dir>:/opt/dxlconsole-config opendxl/opendxl-console:<release-version>`

    The following parameters must be specified:

        * ``host-console-port``
          The port used to access the OpenDXL Console via the host system
        * ``host-config-dir``
          The directory on the host that contains the console configuration files
        * ``release-version``
          The version of the image (See "Pull Docker Image" section above)

For example:

    .. container:: note, admonition

        docker run -d --name dxlconsole -p 8443:8443 -v /home/myuser/dxlconsole-config:/opt/dxlconsole-config opendxl/opendxl-console:\ |version|\

**Note:** A restart policy can be specified via the restart flag (``--restart <policy>``). This flag can be used to restart
the container when the system reboots or if the service terminates abnormally. The ``unless-stopped`` policy will
restart the container unless it has been explicitly stopped.

Additional Docker Commands
--------------------------

The following Docker commands are useful once the container has been created.

    * **Container Status**

        The ``ps`` command can be used to show the status of the container.

            :literal:`docker ps --filter name=dxlconsole`

        Example output:

            .. parsed-literal::

                CONTAINER ID  COMMAND                 CREATED        STATUS
                c60eaf0788fe  "python -m dxlconsole"  7 minutes ago  Up 7 minutes

    * **Container Logs**

        The ``logs`` command can be used to display the log messages for the container.

            :literal:`docker logs dxlconsole`

        Example output:

            .. parsed-literal::

                Running application ...
                On 'run' callback.
                On 'load configuration' callback.
                Incoming message configuration: queueSize=1000, threadCount=10
                Message callback configuration: queueSize=1000, threadCount=10
                Attempting to connect to DXL fabric ...
                Connected to DXL fabric.
                On 'DXL connect' callback.


        The log output can be `followed` by adding a ``-f`` flag (similar to tail) to the logs command.

    * **Stop/Restart/Start**

        The container can be stopped, restarted, and started using the following commands:

            * ``docker stop dxlconsole``
            * ``docker restart dxlconsole``
            * ``docker start dxlconsole``