Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-30 04:01:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

examples and copy

Browse Source
This commit is contained in:
Lucy Cifferello
2021-02-08 08:15:13 -07:00
parent eb31531c7f
commit a099290fc7
18 changed files with 315 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
source/contributing/services/overview.rst
View File

@@ -1,15 +1,43 @@
.. _service_sdk_overview:
.. _service_package_overview:
********************
Service SDK Overview
********************
************************
Service Package Overview
************************
Let's start at a high level. What actually is a service, in the technical sense, on the Embassy?
Let's start at a high level. What actually is a service, in a technical sense, on the Embassy?
Each service is an image. An image is a snapshot of linux environment in which an application runs. All service application data is stored in a volume directory. This volume is persisted across updates. The image is immutable: when the service is updated, the image is replaced with the complete new image containing the updated features.
Each service is an image. An image is a snapshot of a linux environment in which an application runs. All service application data is stored in a volume directory. This volume is persisted across updates. The image is immutable: when the service is updated, the image is replaced with the complete new image containing the updated features.
The volume directory (for seeding data into the volume) is typically: ``/root/volumes/<appId>``. With the caveat that any files that are in the image at that path will be overwritten.
The volume directory (for seeding data into the volume) is typically: ``/root/volumes/<serviceId>``.
A service is mounted to the OS image. Each service application gets a volume allocated to it by the OS. Within the Docker container that encompasses the service image, a path is specified as to where it should mount on the OS. This path is specified in the :ref:`manifest <_service_manifest>`.
.. important::
Any files that are in the image at the volume path will be overwritten when a backup restore occurs.
The config spec, config rules, and manifest get bundled into the ``.s9pk`` package when built using `appmgr <https://github.com/Start9Labs/appmgr>`_. Thus, each new version release will have these files updated and re-bundled into a new binary.
A service is mounted to the EmbassyOS image. Each service application gets a volume allocated to it by EmbassyOS. Within the Docker container that encompasses the service image, a path is specified as to where it should mount on EmbassyOS. This path is specified in the :ref:`manifest <service_manifest>`.
The config spec, config rules, and manifest get bundled into the ``.s9pk`` package when built using `appmgr <https://github.com/Start9Labs/appmgr>`_. Each new version release should include the updated version of these files re-bundled into a new binary.
.. note::
Due to tech debt, code in appmgr may reference ``app-id`` instead of ``service-id``.
Environment Setup
=================
At minimum, docker, docker-builx, and appmgr are required to package a service for EmbassyOS.
Recommended Dependencies
------------------------
`docker <https://docs.docker.com/get-docker>`_
`docker-buildx <https://docs.docker.com/buildx/working-with-buildx/>`_
`appmgr <https://github.com/Start9Labs/embassy-os/tree/master/appmgr>`_
`cargo <https://doc.rust-lang.org/cargo/>`_
`yq (version 4) <https://mikefarah.gitbook.io/yq>`_
`make <https://www.gnu.org/software/make/>`_
`musl <https://github.com/Start9Labs/rust-musl-cross>`_