Skip to content

Commit 05b5fcc

Browse files
lkedzioraglatosinski
authored andcommitted
[#76509] documentation: linux-client: Add action documentation
1 parent f0ff827 commit 05b5fcc

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

documentation/source/rdfm_linux_device_client.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,25 @@ This allows for performing robust Over-The-Air (OTA) updates of the running syst
1111

1212
In order to support robust updates and rollback, the RDFM Client requires proper partition layout and integration with the U-Boot bootloader. To make it easy to integrate the RDFM Client into your Yocto image-building project, it's recommended to use the [meta-rdfm](https://github.com/antmicro/meta-antmicro/tree/master/meta-rdfm) Yocto layer when building the BSPs.
1313

14+
## Management functionality
15+
16+
Other than the always-available OTA component, `rdfm-client` implements some additional remote management functionality.
17+
18+
### Actions
19+
20+
Actions allow execution of predefined sets of commands remotely via the RDFM server.
21+
These commands are defined in an `actions.conf` JSON configuration file found in the daemon's configuration directory.
22+
For the configuration schema, see the [RDFM actions config](#rdfm-actions-config) section.
23+
24+
The action list is synchronized with the server, and is available for querying via the [Action List API](api.rst#get--api-v2-devices-\(string-mac_address\)-action-list) endpoint.
25+
Actions can be executed using the [Action Execute API](api.rst#get--api-v2-devices-(string-mac_address)-action-exec-(string-action_id)) endpoint.
26+
27+
All action execution requests are stored in a persistent queue on a disk and fulfilled in a First-In, First-Out order.
28+
By default, there can be a maximum of **32 action requests** in the queue, and any further action execution requests are rejected by the client.
29+
This limit is currently hardcoded and not configurable via `rdfm.conf`.
30+
An identical queue is also present for action responses, and action status is reported to the server as soon as it is possible to do so.
31+
This allows actions to remain usable, even when the device faces connectivity or power loss issues.
32+
1433
## Installing from source
1534

1635
### Requirements

0 commit comments

Comments
 (0)