Common Workflows

These walkthroughs take you through tasks that use several pages. Each step links to the page with the details.

Onboard a device and deploy your first application

You need the admin role for the first two steps and operator or admin for the rest.

1. Add a CA certificate. Open Certificates and click Add CA Certificate. Generate a new CA or import yours. Devices cannot register without it.
2. Add an application source. Open Repositories → Git Registries or OCI Registries and add a registry that contains Margo applications (see Repositories). Wait until its first sync is Synced. The applications appear under Applications.
3. Register the device. Install a Margo-compliant agent on the device and point it at the device API of your tenant (see Margo Onboarding). The device appears under Devices, first as Pending, then Online once it has reported its capabilities.
4. Label the device. Select the device, click Edit and add labels such as line = press.
5. Deploy. Open the application, select a version and click Deploy. Pick the device in Select Devices, check the parameters, choose Immediate and click Deploy Application.
6. Watch it. The deployment opens. Its status goes from Pending through Installing to Installed (see Deployments).

Roll out an update to a device group

1. Create the group. Open Device Groups, click Create device group and add the devices.
2. Start the deployment. Open the application, select the new version and click Deploy. In Select Devices, pick the group. Resolved targets shows every device it reaches.
3. Choose a careful rollout. In Rollout Strategy, choose Canary (a few devices first) or Rolling (in batches), and switch on auto-rollback with a failure threshold.
4. Follow and steer. On the deployment page, use Promote Canary or Approve Batch when your rollout waits for you. If the rollout halts, a banner tells you why (see When the server halts a rollout).
5. Get notified. Create an alert rule of type Rollout halted in Alerts so you hear about halts by e-mail or webhook.

To move an existing deployment to the new version instead, use Re-deploy (see Re-deploying).

Add a registry and deploy from it

1. Add the registry. In Repositories → OCI Registries, click Add OCI Registry, enter the URL, the credentials and the Repositories to import (see The repository list).
2. Check it. Click Refresh. The health check confirms the credentials, and the sync imports the applications. Open the Sync tab to see the results for each repository.
3. Deploy. The imported applications appear under Applications. Deploy them as in the first walkthrough.