Device Groups

Navigation: Team > Application > Device Groups

When managing many devices that are intended to run the same snapshot, Device Groups allow you to organise your devices into logical groups. These groups can then be set as the target of a DevOps Pipelines.

Furthermore:

  • Devices added to an active Device Group will automatically be updated to the active pipeline snapshot
  • Devices removed from an active Device Group will have their active pipeline snapshot cleared More details are provided below in Adding a Device to a group and Removing a Device from a group
  • Device Groups can have Environment Variables set at the group level. These are merged with the Environment Variables set in each member device. The following rules apply:
    • Values set in the Device take precedence over values set in the Device Group.
    • Removing a device from the group will remove these variables from the device.
    • The devices environment variables are never modified, they are only merged at runtime.
    • Updating these environment variables will cause devices in the group to be restarted when a change is detected

This greatly simplifies deployments of the same configuration to one or even hundreds of devices with a single click.

The following requirements apply:

  • FlowFuse 1.15+ Enterprise Tier
  • FlowFuse Cloud teams on the Enterprise tier
  • FlowFuse 2.10+ is require for Group Environment Variables

Creating a Device Group

  1. Select the Application you want to configure a Device Group for.
  2. Select the "Device Groups" tab
  3. Click "Add Device Group"
  4. Name your Device Group appropriately (this can be changed later)
  5. Click "Create"

Note: Adding a description can help you better distinguish device groups.

Updating Device Group Membership

  1. In the Device Groups table, click the Device Group you want to modify
  2. Click "Edit"
    1. On the left, you will be shown available devices (ones that are assigned to your application and are available to be added to a device group)
    2. On the right, you will be shown devices that are already in the device group
  3. Place a checkmark next to the devices in the Available Devices list that you want to add to the Device Group then click "Add Devices"
  4. Place a checkmark next to the devices in the Device Group list that you want to remove then click "Remove Devices"
  5. Click "Save"
  6. You will be prompted to confirm your changes
    1. Refer to the below information for more details about what happens when you add or remove devices from a device group
    2. Click "Confirm" to continue or "Cancel" to abort

Note: If you make a mistake, you can cancel your changes at any time by clicking "Cancel" Note: When a device you want to add to a group doesn't appear in the list, it's likely already assigned to another group.

Adding a Device to a group which has an active pipeline snapshot

When a pipeline stage is operated and it deploys to a device group, that device group remembers the snapshot that was deployed.

Subsequently, if you add a device to a group, it will be instructed to update to the active snapshot.

Removing a Device from a group which has an active pipeline snapshot

When a pipeline stage is operated and it deploys to a device group, that device group remembers the snapshot that was deployed.

Subsequently, if you remove a device from a group and the device is running the active pipeline snapshot, the device snapshot will be cleared, effectively resetting the device to a blank state.

Removing the snapshot from a device group

Under the settings of a device group, you can remove the target snapshot. This will also clear the snapshot of all devices in the group.