Edgehog Device Runtime is a portable middleware written in Rust, that enables remote device management on Linux-based systems.
License: Apache License 2.0
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
Rust provides a powerful module system that can be used to hierarchically split code in logical units (modules), and manage visibility (public/private) between them.
A module is a collection of items: functions, structs, traits, impl blocks, and even other modules.
Here is the list of interfaces defined for the system:
{
"interface_name": "io.edgehog.devicemanager.apps.CreateImageRequest",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"aggregation": "object",
"mappings": [
{
"endpoint": "/image/id",
"type": "string"
},
{
"endpoint": "/image/repo",
"type": "string"
},
{
"endpoint": "/image/name",
"type": "string"
},
{
"endpoint": "/image/tag",
"type": "string"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.AvailableImages",
"version_major": 0,
"version_minor": 1,
"type": "properties",
"ownership": "device",
"mappings": [
{
"allow_unset": true,
"endpoint": "/%{image_id}/pulled",
"type": "boolean"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.CreateVolumeRequest",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"aggregation": "object",
"mappings": [
{
"endpoint": "/volume/id",
"type": "string"
},
{
"endpoint": "/volume/driver",
"type": "string"
},
{
"endpoint": "/volume/options",
"type": "string"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.AvailableVolumes",
"version_major": 0,
"version_minor": 1,
"type": "properties",
"ownership": "device",
"mappings": [
{
"allow_unset": true,
"endpoint": "/%{volume_id}/created",
"type": "boolean"
},
{
"allow_unset": true,
"endpoint": "/%{volume_id}/driver",
"type": "boolean"
},
{
"allow_unset": true,
"endpoint": "/%{volume_id}/options",
"type": "boolean"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.CreateNetworkRequest",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"aggregation": "object",
"mappings": [
{
"endpoint": "/network/id",
"type": "string"
},
{
"endpoint": "/network/driver",
"type": "string"
},
{
"endpoint": "/network/checkDuplicate",
"type": "boolean"
},
{
"endpoint": "/network/internal",
"type": "boolean"
},
{
"endpoint": "/network/enableIPv6",
"type": "boolean"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.AvailableNetworks",
"version_major": 0,
"version_minor": 1,
"type": "properties",
"ownership": "device",
"mappings": [
{
"endpoint": "/%{network_id}/driver",
"type": "string"
},
{
"endpoint": "/%{network_id}/checkDuplicate",
"type": "boolean"
},
{
"endpoint": "/%{network_id}/internal",
"type": "boolean"
},
{
"endpoint": "/%{network_id}/enableIPv6",
"type": "boolean"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.CreateContainerRequest",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"aggregation": "object",
"mappings": [
{
"endpoint": "/container/id",
"type": "string"
},
{
"endpoint": "/container/hostname",
"type": "string"
},
{
"endpoint": "/container/imageId",
"type": "string"
},
{
"endpoint": "/container/restartPolicy",
"type": "string"
},
{
"endpoint": "/container/env",
"type": "stringarray",
"doc": "Array of KEY=value environment variables"
},
{
"endpoint": "/container/binds",
"type": "stringarray",
"doc": "Array of binds"
},
{
"endpoint": "/container/networks",
"type": "stringarray"
},
{
"endpoint": "/container/portBindings",
"type": "stringarray",
"doc": "Array of ip:[host_port:]container_port[/protocol] | [hostPort:]containerPort[/protocol]. protocol is tcp by default"
},
{
"endpoint": "/container/privileged",
"type": "boolean"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.AvailableContainers",
"version_major": 0,
"version_minor": 1,
"type": "properties",
"ownership": "device",
"mappings": [
{
"endpoint": "/%{container_id}/hostname",
"type": "string"
},
{
"endpoint": "/%{container_id}/imageId",
"type": "string"
},
{
"endpoint": "/%{container_id}/restartPolicy",
"type": "string"
},
{
"endpoint": "/%{container_id}/env",
"type": "stringarray",
"doc": "Array of KEY=value environment variables"
},
{
"endpoint": "/%{container_id}/binds",
"type": "stringarray",
"doc": "Array of binds"
},
{
"endpoint": "/%{container_id}/networks",
"type": "stringarray"
},
{
"endpoint": "/%{container_id}/portBindings",
"type": "stringarray",
"doc": "Array of ip:[host_port:]container_port[/protocol] | [hostPort:]containerPort[/protocol]. protocol is tcp by default"
},
{
"endpoint": "/%{container_id}/privileged",
"type": "boolean"
},
{
"endpoint": "/%{container_id}/status",
"type": "string"
}
]
}Those need to be worked on more.
{
"interface_name": "io.edgehog.devicemanager.apps.CreateReleaseRequest",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"aggregation": "object",
"mappings": [
{
"endpoint": "/release/id",
"type": "string"
},
{
"endpoint": "/release/applicationId",
"type": "string"
},
{
"endpoint": "/release/version",
"type": "string"
},
{
"endpoint": "/release/containers",
"type": "stringarray"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.AvailableRelease",
"version_major": 0,
"version_minor": 1,
"type": "properties",
"ownership": "device",
"mappings": [
{
"endpoint": "/%{release_id}/application_id",
"type": "string"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.ApplicationCommand",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"mappings": [
{
"endpoint": "/%{application_id}/%{version}/command",
"type": "string",
"doc": "TODO: command enum [start, stop]"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.CreateScenarioRequest",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"aggregation": "object",
"mappings": [
{
"endpoint": "/scenario/id",
"type": "string"
},
{
"endpoint": "/scenario/name",
"type": "string"
},
{
"endpoint": "/scenario/applications",
"type": "stringarray"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.AvailableScenarios",
"version_major": 0,
"version_minor": 1,
"type": "properties",
"ownership": "device",
"mappings": [
{
"endpoint": "/%{scenario_id}/name",
"type": "string"
},
{
"endpoint": "/%{scenario_id}/applications",
"type": "stringarray"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.ActivateScenarioRequest",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"aggregation": "object",
"mappings": [
{
"endpoint": "/scenario/id",
"type": "string"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.AvailableScenarios",
"version_major": 0,
"version_minor": 1,
"type": "properties",
"ownership": "device",
"mappings": [
{
"endpoint": "/%{scenario_id}/name",
"type": "string"
},
{
"endpoint": "/%{scenario_id}/applications",
"type": "string"
}
]
}Fetch the logs of a container
Stop one or more running containers
PublisherAt this moment on device_id and credentials_secret read from configuration we check only they exist, but we should to check also if they are an empty value.
There are multiple instances where unwrap is used that could be errors instead
Create the structure to receive the CreateNetowrkRequest and publish the AvailableNetworks property.
{
"interface_name": "io.edgehog.devicemanager.apps.CreateNetworkRequest",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"aggregation": "object",
"mappings": [
{
"endpoint": "/network/id",
"type": "string"
},
{
"endpoint": "/network/driver",
"type": "string"
},
{
"endpoint": "/network/checkDuplicate",
"type": "boolean"
},
{
"endpoint": "/network/internal",
"type": "boolean"
},
{
"endpoint": "/network/enableIpv6",
"type": "boolean"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.AvailableNetworks",
"version_major": 0,
"version_minor": 1,
"type": "properties",
"ownership": "device",
"mappings": [
{
"endpoint": "/%{network_id}/id",
"type": "string"
},
{
"endpoint": "/%{network_id}/driver",
"type": "string"
},
{
"endpoint": "/%{network_id}/checkDuplicate",
"type": "boolean"
},
{
"endpoint": "/%{network_id}/internal",
"type": "boolean"
},
{
"endpoint": "/%{network_id}/enableIpv6",
"type": "boolean"
}
]
}If the device runtime suddenly crashes and one or more device forwarder sessions were active, after it has been restarted, it will neither attempt to unset the sessions' state nor to re-establish them.
To prevent this, it is necessary that, when initialized, the device forwarder retrieves the previously stored ForwarderSessionState property values from Astarte. However, this can only be done if the SqliteStore is being used, which can be trivial if the AstarteMessageHub is used instead of the AstarteDeviceSdk. It is necessary to modify the astarte-message-hub-proto and the AstarteMessageHub to enable the correct transmission of the ForwarderSessionState property values to the device.
Device runtime should make use of systemd notify feature: https://www.freedesktop.org/software/systemd/man/sd_notify.html.
READY=1 and STATUS=foo should be used as a starting point.
It should be also explored wether using systemd as an optional dependency.
Create the structure to receive the CreateContainerRequest and publish the AvailableContainers property.
{
"interface_name": "io.edgehog.devicemanager.apps.CreateContainerRequest",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"aggregation": "object",
"mappings": [
{
"endpoint": "/container/id",
"type": "string"
},
{
"endpoint": "/container/hostname",
"type": "string"
},
{
"endpoint": "/container/imageId",
"type": "string"
},
{
"endpoint": "/container/restartPolicy",
"type": "string"
},
{
"endpoint": "/container/env",
"type": "stringarray",
"doc": "Array of KEY=value environment variables"
},
{
"endpoint": "/container/binds",
"type": "stringarray",
"doc": "Array of binds"
},
{
"endpoint": "/container/networks",
"type": "stringarray"
},
{
"endpoint": "/container/portBindings",
"type": "stringarray",
"doc": "Array of ip:[host_port:]container_port[/protocol] | [hostPort:]containerPort[/protocol]. protocol is tcp by default"
},
{
"endpoint": "/container/privileged",
"type": "boolean"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.AvailableContainers",
"version_major": 0,
"version_minor": 1,
"type": "properties",
"ownership": "device",
"mappings": [
{
"endpoint": "/%{container_id}/hostname",
"type": "string"
},
{
"endpoint": "/%{container_id}/imageId",
"type": "string"
},
{
"endpoint": "/%{container_id}/restartPolicy",
"type": "string"
},
{
"endpoint": "/%{container_id}/env",
"type": "stringarray",
"doc": "Array of KEY=value environment variables"
},
{
"endpoint": "/%{container_id}/binds",
"type": "stringarray",
"doc": "Array of binds"
},
{
"endpoint": "/%{container_id}/networks",
"type": "stringarray"
},
{
"endpoint": "/%{container_id}/portBindings",
"type": "stringarray",
"doc": "Array of ip:[host_port:]container_port[/protocol] | [hostPort:]containerPort[/protocol]. protocol is tcp by default"
},
{
"endpoint": "/%{container_id}/privileged",
"type": "boolean"
},
{
"endpoint": "/%{container_id}/status",
"type": "string"
}
]
}Implements the following commands and functionalities for the container:
The message hub still doesn't support the MSRV 1.66.1, so we have conflicting dependencies for zbus and flate2, we would need to update those dependencies when the message hub has a release for the newer rust version.
Create the structure to receive the CreateVolumeRequest and publish the AvailableVolumes property.
{
"interface_name": "io.edgehog.devicemanager.apps.CreateVolumeRequest",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"aggregation": "object",
"mappings": [
{
"endpoint": "/volume/id",
"type": "string"
},
{
"endpoint": "/volume/driver",
"type": "string"
},
{
"endpoint": "/volume/options",
"type": "stringarray",
"doc": "An array of key=value options to set for the drive"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.AvailableVolumes",
"version_major": 0,
"version_minor": 1,
"type": "properties",
"ownership": "device",
"mappings": [
{
"allow_unset": true,
"endpoint": "/%{volume_id}/created",
"type": "boolean"
},
{
"allow_unset": true,
"endpoint": "/%{volume_id}/driver",
"type": "string"
},
{
"allow_unset": true,
"endpoint": "/%{volume_id}/options",
"type": "stringarray",
"doc": "An array of key=value options to set for the drive"
}
]
}Download an image from a registry
ref https://docs.docker.com/engine/reference/commandline/pull/
Get real time events from the server
The storage usage information returns the device name, on the interface the parameter is called label. We should define what this parameter should be if the device label is missing
The OTA update of Edgehog OS not only uses Rauc for the update mechanism, but also needs to call a sysdata binary to switch on the right partition after reboot.
Since we don't want to bind to this mechanism, the ideal would be to wrap the sys-data binary in a Dbus-service and call it from the Runtime side.
fw_sysdata command info:
fw_sysdata -t switchslot -p -d /dev/mmcblk1
Switchslot - current state:
Boot from slot @: 00002
Boot from slot A: 00000
Current boot slot: A
Previous boot slot:
Consecutive fail boot: 0
Boot fail counter state: disabledfw_sysdata command switch partition:
fw_sysdata -t switchslot -s -d /dev/mmcblk1
Switchslot: switch slot... OK (slot B)Edgehog Device Manager should load interfaces from a "canonical installation path". Such as when installed to /usr/bin/ it should look for interfaces on /usr/share/edgehog-device-runtime/astarte-interfaces/ (or even /usr/share/edgehog/astarte-interfaces/).
When installation prefix is changed, it shoud behave accordingly (e.g. /usr/local/share/edgehog-device-runtime/astarte-interfaces/` etc...)
Start one or more stopped containers
The option should set the ignore ssl errrors option on the Astarte SDK Rust.
Add an option in the config to be able to use the SQLite store with the Astarte SDK.
The database would be store in the already present store_directory, we should add a boolean option to the AstarteDeviceSdkConfigOptions to enable the SQLite store.
Some information such as the ip/port/secrect etc for connecting to the websocket will be received through an Astarte interface.
Create the structure to receive the CreateImageRequest and publish the AvailableImages property.
{
"interface_name": "io.edgehog.devicemanager.apps.CreateImageRequest",
"version_major": 0,
"version_minor": 1,
"type": "datastream",
"ownership": "server",
"aggregation": "object",
"mappings": [
{
"endpoint": "/image/id",
"type": "string"
},
{
"endpoint": "/image/repo",
"type": "string"
},
{
"endpoint": "/image/name",
"type": "string"
},
{
"endpoint": "/image/tag",
"type": "string"
}
]
}{
"interface_name": "io.edgehog.devicemanager.apps.AvailableImages",
"version_major": 0,
"version_minor": 1,
"type": "properties",
"ownership": "device",
"mappings": [
{
"allow_unset": true,
"endpoint": "/%{image_id}/pulled",
"type": "boolean"
}
]
}Create and run a new container from an image
ref https://docs.docker.com/engine/reference/commandline/run/
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.