Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for group env vars #4666

Merged
merged 1 commit into from
Oct 22, 2024
Merged

Update docs for group env vars #4666

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/user/device-groups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,19 @@ 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](#adding-a-device-to-a-group-which-has-an-active-pipeline-snapshot) and [Removing a Device from a group](#removing-a-device-from-a-group-which-has-an-active-pipeline-snapshot)
* 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

Expand Down