Skip to content

Commit 20387ad

Browse files
committed
Enhance README.md
1 parent 1353d02 commit 20387ad

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

packages/service-integration/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,11 @@ This is the o2sparc's service integration library or ``ooil`` in short
55

66

77
SEE how is it used in Makefiles in https://github.com/ITISFoundation/cookiecutter-osparc-service
8+
9+
10+
#### What is the .osparc folder and its content?
11+
'osparc config' is a set of stardard file forms (yaml) that the user fills provides in order to describe how her service works and integrates with osparc. It may contain:
12+
- config files are stored under '.osparc/' folder in the root repo folder (analogous to other configs like .github, .vscode, etc)
13+
- configs are parsed and validated into pydantic models
14+
- models can be serialized/deserialized into label annotations on images. This way, the config is attached to the service during it's entire lifetime.
15+
- config should provide enough information about that context to allow building an image and running a container on a single command call.

0 commit comments

Comments
 (0)