Version: v1

Aos object identification

General information

AosEdge object represents a different type of entities. Each entity is identified by a bunch of properties. Such objects are called AosNamedObject

The list of named objects

Object type name	Description
aosService	Represent service create by a Service provider and run on AosUnit
aosLayer	Service layer that contains common libraries for `aosService`
aosComponent	A system component of an Aos unit. E.g. `boot`, `rootFileSystem`, `UEFI`, etc.
aosSubject	Entity that provides relations between components/services and units. In some cases can be treated as `subscription`
aosOEM	`Original Equipment Manufacturer`. Entity that owns and manages aosComponents, aosLayers, Unit fleets, Units, subject
aosSP	`Service provider`. Entity that owns and manages aosService.
aosFleet	Entity that owns and manages Aos units. Depends on an OEM

AosEdge has objects that can be shared across OEMs, Service providers, Fleets

Such objects as aosComponent, aosService, aosLayer can be executed or ran on aosRuntime. All running objects might have one or more dependencies

All executable objects can support one or more runtimes. E.g.: aosService and aosLayer can use runtimes: runc, crun, xrun, etc. aosComponent can use aosRuntime from the same aosOEM or from external one.

Example of JSON representation

Example shows Aos component "RootFS" that depends on "BootLoader" and "BIOS.another-oem.aoscloud.io"

[
    {
        "identifier": {
            "type": "aosComponent",
            "id": "00000000-0000-0000-0000-000000000001",
            "codename": "RootFS",
            "title": "Main file system",
            "urn": "urn:aos:component:demo-oem.aoscloud.io/rootfs",
            "description": "Root file system with AosCore modules and basic settings"
        },
        "version": "1.0.2",
        "archFamily": "ARM64",
        "arch": "ARMv7",
        "runtimes": [
            {
                "codename": "rt_RootFS"
            }
        ],
        "dependencies": [
            {
                "condition": "mustBeInstalled",
                "versions": ">=1.0.0,<2.0.0",
                "identifier": {
                    "type": "aosComponent",
                    "codename": "bootLoader"
                }
            },
            {
                "condition": "mustBeInstalled",
                "versions": ">=1.0.0,<2.0.0",
                "includePrerelease": true,
                "identifier": {
                    "urn": "urn:aos:component:another-oem.aoscloud.io/bios"
                }
            }
        ]
    },
    {
        "identifier": {
            "type": "aosComponent",
            "id": "00000000-0000-0000-0000-000000000002",
            "codename": "bootLoader"
        },
        "version": "1.0.0",
        "runtimes": [
            {
                "codename": "rt_Boot"
            }
        ]
    },
    {
        "identifier": {
            "urn": "urn:aos:component:another-oem.aoscloud.io/bios"
        },
        "version": "1.0.0",
        "runtimes": [
            {
                "urn": "urn:aos:runtime:another-oem.aoscloud.io/bios"
            }
        ]
    }
]