Probes
Docker

Probe Deployment: Docker

This guide will walk you through deploying an IPMN probe using Docker.

Prerequisites

  • A registered probe on the IPMN App with a unique Probe ID (UUID) and authentication token (SECRET).
  • A system with Docker installed.

Deployment Steps

  1. Pull the IPMN probe Docker image: Pull the official IPMN probe image from the GitHub Container Registry using the following command:

    docker pull ghcr.io/ipmn/probe:latest

  2. Create and run a new Docker container: Run a new Docker container with the IPMN probe image. Replace Probe_UUID and Authentication_Token with the Probe ID and authentication token you received when registering your probe.

    docker run -d --restart always --name ipmn-probe -e UUID=<Probe_UUID> -e SECRET=<Authentication_Token> ghcr.io/ipmn/probe:latest

  3. Verify the probe is running: Check the status of the IPMN probe container:

    docker ps -f name=ipmn-probe

    If everything is set up correctly, you should see the container running and active.

  4. Check container logs: To view the logs of the IPMN probe container, use the following command:

    docker logs ipmn-probe

    This will display the container's logs, which can be helpful for troubleshooting or monitoring the probe's activity.

Updating the IPMN Probe

To update the IPMN probe to the latest version, follow these steps:

  1. Pull the latest IPMN probe Docker image: Pull the latest official IPMN probe image from the GitHub Container Registry using the following command:

    docker pull ghcr.io/ipmn/probe:latest

  2. Stop and remove the existing IPMN probe container: Stop and remove the running IPMN probe container with the following commands:

    docker stop ipmn-probe
docker rm ipmn-probe

  3. Re-run the IPMN probe container with the updated image: Run a new Docker container with the updated IPMN probe image, using the same Probe ID and authentication token as before:

    docker run -d --restart always --name ipmn-probe -e UUID=<Probe_UUID> -e SECRET=<Authentication_Token> ghcr.io/ipmn/probe:latest

  4. Verify the updated probe is running: Check the status of the updated IPMN probe container:

    docker ps -f name=ipmn-probe

    You should see the container running and active with the updated image.

Your IPMN probe is now deployed and running as a Docker container. The probe will execute assigned tasks and submit the results to the IPMN, contributing valuable data to the platform.

systemd