Skip to end of metadata
Go to start of metadata

Prerequisites

Summary

This tutorial will cover the downloading, configuration, and starting of Ignition Edge MQTT as a Docker container using Portainer.

Upon completion of this tutorial you will have Ignition Edge MQTT installed as a Docker container which will be ready to configure and use.

Tutorial

Step 1: Start Portainer

Begin by ensure Portainer is running and you are set up to manager the target Docker environment.  Information on Portainer can be found here.  If using a Hilscher Edge device consult the Hilscher documentation for access to the Portainer Portal.

Step 2: Download the Ignition Edge MQTT image

Open a Web Browser to your Portainer instance and select 'Images' on the left.  In the name section enter one of the two following strings depending on your platform architecture:

  • If Linux 64-bit is supported: cirruslink/ignition-edge-linux-64:latest
  • If Linux ARM HF is supported: cirruslink/ignition-edge-linux-armhf:latest

The repositories can be viewed here:

Shown below is an example for 64-bit Linux.  After entering the target image into the name field, click the 'Pull the Image' button to download it.  You must have internet connectivity for this to succeed.

Once the download is complete, you should see something similar to the following.

Step 3: Create the Volumes

Select 'Volumes' on the left and add two new ones by clicking the 'Add Volume' button.  Then type the name of the first volume as 'ignition-data' as shown below and click 'Create the volume'.  Ensure 'Access control' is also disabled.

Repeat the volume creation process described above to create a second volume called 'ignition-bin'.  When complete, the volumes should look as follows:

Step 4: Define and Start the Container

Now select 'Containers' on the left and click the 'Add Container' button.  Set the following parameters:

  • Name = IgnitionEdgeMQTT
  • Image Name = (the image downloaded dependent on your hardware platform architecture)
    • If Linux 64-bit is supported: cirruslink/ignition-edge-linux-64:latest
    • If Linux ARM HF is supported: cirruslink/ignition-edge-linux-armhf:latest
  • Always pull the image = not selected
  • Publish all exposed ports = selected
  • Map the following additional ports
    • 22 → 22 (TCP)
    • 8000 → 8000 (TCP)
    • 8043 → 8043 (TCP)
    • 8060 → 8060 (TCP)
    • 8088 → 8088 (TCP)
  • Enable access control = not enabled

This is all shown below in the 64-bit Linux example.

In addition set the following advanced properties via the bottom tabs.

  • Set the 'Command' to '/root/startup.sh' as shown below.

  • Map the Volumes as shown below.

  • Set the Restart policy to

Finally, start the container by clicking the 'Deploy the container' under the 'Actions' section as shown below.

After deploying you should see the new container now running as shown below.

Step 5: Connect to the Igntion Edge Web UI and install MQTT Transmission


Download the latest MQTT Transmission from the Ignition download page here.  Now browse to the new Ignition instance running as a Docker container.  The URL will be http://localhost:8088 if you are running the Docker environment locally.  Otherwise it would be accessible at http://[ip_address_of_docker_environment]:8088.  When logging in, use the default credentials of Ignition:

  • Username: admin
  • Password: password

Browse to the Configure tab on the top and then the Modules link on the left as shown below.

Now click the 'Install or Upgrade a Module...' link near the bottom of the main panel.  Browse to the downloaded MQTT Transmission module and install it.  When complete, it should look similar to what is shown below.

At this point you are ready to configure and use Ignition Edge MQTT.  See the following two links for information on how to configure and use Ignition Edge MQTT.




  • No labels