On-board edge devices

Prerequisites

Whether the device is a server or a VM running MediaKind software or a MediaKind appliance, the device is prepared as follows:

• Update to the latest software version (see the product manual).
• Verify that you can access the device's local web UI on http://<edge-device-ip>.
• Check that the device can call out to the public internet and access the api.mk.io domain on HTTPS port 443. See Connect the device to MK.IO from the device UI, when the Enable checkbox is set, the Connected field must be displayed in green.

Add the device to MK.IO

Following the preparation above, the on-boarding process is as follows:

1. From the device's local web UI, you allow the device to connect to MK.IO. When successful, it will present a short code.
2. This code is then used either via MK.IO UI or via MK.IO API to register the device with MK.IO.

Once registered, the device will be available for monitoring and control through MK.IO.

👉

Remote onboarding

The two steps above do not need to be done by the same person. In the case of remote onboarding, where an engineer installing the device does not have access to MK.IO or permission to add the device, the short code can be transferred verbally, by phone for example, between the remote engineer and the MK.IO user who does have access and permission to add the device.

Connect the device to MK.IO from the device UI

1. Open the device's local web UI: http://<edge-device-ip>

2. Go to the Appliance > Fleet page, then tick the Enable checkbox. After a few seconds you should get additional information.

3. Check that the Connected field is set to 'Yes'. This indicates that the device can reach MK.IO.

4. The Registered field will remain to 'No' until you register it to an MK.IO project.

5. Copy the short code (eight random letters and numbers) from this page.

👉

The short code will rotate periodically; the UI will update when it does, so leave it open until the device is on board.

Add the device using the MK.IO UI

1. In another browser window/tab, log in to MK.IO. If you are not already signed-up, read Sign up to MK.IO.
2. Open the project you want to add the device to, and navigate to the Devices page. Click the Add device button then enter the short code from the device, a friendly name and the site.
3. When you click Add, the device is added to the list of edge devices.

Add the device using the MK.IO API

If preferred, the device can be added from the API using the same short code in the spec.shortCode field. Alternatively, the longer-lived device ID presented in its web UI can be used for registration in the spec.locationId field, as in the example below:

PUT https://api.mk.io/api/v1/projects/project_name/fleet/devices/device1

{
    "metadata": {
        "displayName": "Device 1"
    },
    "spec": {
        "siteName": "world",
        "locationId": "a7dafdba-4923-4317-aad1-dc76284b85b5"
    }
}

Check that the device has been onboarded

Once the device is registered to MK.IO, if you go back to the device's local web UI and display the Appliance > Fleet page, the Registered field should be set to 'Yes' and should display the device's name.

You can now view device information and access its remote UI.