You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/service-integration/README.md
+8
Original file line number
Diff line number
Diff line change
@@ -5,3 +5,11 @@ This is the o2sparc's service integration library or ``ooil`` in short
5
5
6
6
7
7
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