✨ Personalized resources: Allow override of computational service needed resources

packages/models-library/src/models_library/docker.py

@@ -5,17 +5,9 @@
 from models_library.projects import ProjectID
 from models_library.projects_nodes import NodeID
 from models_library.users import UserID
-from pydantic import BaseModel, ConstrainedStr, Field, constr
+from pydantic import BaseModel, ConstrainedStr, Field
 
-from .basic_regex import (
-    DOCKER_GENERIC_TAG_KEY_RE,
-    DOCKER_IMAGE_KEY_RE,
-    DOCKER_IMAGE_VERSION_RE,
-    DOCKER_LABEL_KEY_REGEX,
-)
-
-DockerImageKey = constr(regex=DOCKER_IMAGE_KEY_RE)
-DockerImageVersion = constr(regex=DOCKER_IMAGE_VERSION_RE)
+from .basic_regex import DOCKER_GENERIC_TAG_KEY_RE, DOCKER_LABEL_KEY_REGEX
 
 
 class DockerLabelKey(ConstrainedStr):

packages/models-library/src/models_library/projects_nodes.py

@@ -18,7 +18,6 @@
     validator,
 )
 
-from .basic_regex import VERSION_RE
 from .basic_types import EnvVarKey
 from .projects_access import AccessEnum
 from .projects_nodes_io import (
@@ -30,7 +29,7 @@
 )
 from .projects_nodes_ui import Position
 from .projects_state import RunningState
-from .services import PROPERTY_KEY_RE, SERVICE_KEY_RE
+from .services import PROPERTY_KEY_RE, ServiceKey, ServiceVersion
 
 # NOTE: WARNING the order here matters
 
@@ -100,20 +99,18 @@ class Config:
 
 
 class Node(BaseModel):
-    key: str = Field(
+    key: ServiceKey = Field(
         ...,
         description="distinctive name for the node based on the docker registry path",
-        regex=SERVICE_KEY_RE,
         examples=[
             "simcore/services/comp/itis/sleeper",
             "simcore/services/dynamic/3dviewer",
             "simcore/services/frontend/file-picker",
         ],
     )
-    version: str = Field(
+    version: ServiceVersion = Field(
         ...,
         description="semantic version number of the node",
-        regex=VERSION_RE,
         examples=["1.0.0", "0.0.1"],
     )
     label: str = Field(

packages/models-library/src/models_library/services.py

@@ -4,13 +4,15 @@
     python -c "from models_library.services import ServiceDockerData as cls; print(cls.schema_json(indent=2))" > services-schema.json
 """
 
+import re
 from datetime import datetime
 from enum import Enum
 from typing import Any, Optional, Union
 from uuid import UUID
 
 from pydantic import (
     BaseModel,
+    ConstrainedStr,
     EmailStr,
     Extra,
     Field,
@@ -54,8 +56,14 @@
 ServicePortKey = constr(regex=PROPERTY_KEY_RE)
 FileName = constr(regex=FILENAME_RE)
 
-ServiceKey = constr(regex=KEY_RE)
-ServiceVersion = constr(regex=VERSION_RE)
+
+class ServiceKey(ConstrainedStr):
+    regex = re.compile(SERVICE_KEY_RE)
+
+
+class ServiceVersion(ConstrainedStr):
+    regex = re.compile(VERSION_RE)
+
 
 RunID = UUID
 

packages/models-library/src/models_library/services_resources.py

@@ -1,13 +1,15 @@
 import logging
-from typing import Any, Final, Union
+from enum import auto
+from typing import Any, Final, Optional, Union
 
+from models_library.docker import DockerGenericTag
+from models_library.utils.enums import StrAutoEnum
 from pydantic import (
     BaseModel,
     ByteSize,
     Field,
     StrictFloat,
     StrictInt,
-    constr,
     parse_obj_as,
     root_validator,
 )
@@ -16,13 +18,14 @@
 
 logger = logging.getLogger(__name__)
 
-DockerImage = constr(regex=r"[\w/-]+:[\w.@]+")
-DockerComposeServiceName = constr(regex=r"^[a-zA-Z0-9._-]+$")
+
 ResourceName = str
 
 # NOTE: replace hard coded `container` with function which can
 # extract the name from the `service_key` or `registry_address/service_key`
-DEFAULT_SINGLE_SERVICE_NAME: Final[DockerComposeServiceName] = "container"
+DEFAULT_SINGLE_SERVICE_NAME: Final[DockerGenericTag] = parse_obj_as(
+    DockerGenericTag, "container"
+)
 
 MEMORY_50MB: Final[int] = parse_obj_as(ByteSize, "50mib")
 MEMORY_250MB: Final[int] = parse_obj_as(ByteSize, "250mib")
@@ -57,8 +60,14 @@ class Config:
 ResourcesDict = dict[ResourceName, ResourceValue]
 
 
+class BootMode(StrAutoEnum):
+    CPU = auto()
+    GPU = auto()
+    MPI = auto()
+
+
 class ImageResources(BaseModel):
-    image: DockerImage = Field(
+    image: DockerGenericTag = Field(
         ...,
         description=(
             "Used by the frontend to provide a context for the users."
@@ -68,6 +77,10 @@ class ImageResources(BaseModel):
         ),
     )
     resources: ResourcesDict
+    boot_modes: list[BootMode] = Field(
+        default=[BootMode.CPU],
+        description="describe how a service shall be booted, using CPU, MPI, openMP or GPU",
+    )
 
     class Config:
         schema_extra = {
@@ -87,23 +100,33 @@ class Config:
         }
 
 
-ServiceResourcesDict = dict[DockerComposeServiceName, ImageResources]
+ServiceResourcesDict = dict[DockerGenericTag, ImageResources]
 
 
 class ServiceResourcesDictHelpers:
     @staticmethod
     def create_from_single_service(
-        image: DockerComposeServiceName, resources: ResourcesDict
+        image: DockerGenericTag,
+        resources: ResourcesDict,
+        boot_modes: Optional[list[BootMode]] = None,
     ) -> ServiceResourcesDict:
+        if boot_modes is None:
+            boot_modes = [BootMode.CPU]
         return parse_obj_as(
             ServiceResourcesDict,
-            {DEFAULT_SINGLE_SERVICE_NAME: {"image": image, "resources": resources}},
+            {
+                DEFAULT_SINGLE_SERVICE_NAME: {
+                    "image": image,
+                    "resources": resources,
+                    "boot_modes": boot_modes,
+                }
+            },
         )
 
     @staticmethod
     def create_jsonable(
         service_resources: ServiceResourcesDict,
-    ) -> dict[DockerComposeServiceName, Any]:
+    ) -> dict[DockerGenericTag, Any]:
         return jsonable_encoder(service_resources)
 
     class Config:

packages/models-library/tests/test_service_resources.py

@@ -5,9 +5,8 @@
 from typing import Any
 
 import pytest
+from models_library.docker import DockerGenericTag
 from models_library.services_resources import (
-    DockerComposeServiceName,
-    DockerImage,
     ImageResources,
     ResourcesDict,
     ResourceValue,
@@ -28,7 +27,7 @@
     ),
 )
 def test_compose_image(example: str) -> None:
-    parse_obj_as(DockerImage, example)
+    parse_obj_as(DockerGenericTag, example)
 
 
 @pytest.fixture
@@ -39,8 +38,8 @@ def resources_dict() -> ResourcesDict:
 
 
 @pytest.fixture
-def compose_image() -> DockerImage:
-    return parse_obj_as(DockerImage, "image:latest")
+def compose_image() -> DockerGenericTag:
+    return parse_obj_as(DockerGenericTag, "image:latest")
 
 
 def _ensure_resource_value_is_an_object(data: ResourcesDict) -> None:
@@ -74,7 +73,7 @@ def test_image_resources_parsed_as_expected() -> None:
     "example", ServiceResourcesDictHelpers.Config.schema_extra["examples"]
 )
 def test_service_resource_parsed_as_expected(
-    example: dict[DockerComposeServiceName, Any], compose_image: DockerImage
+    example: dict[DockerGenericTag, Any], compose_image: DockerGenericTag
 ) -> None:
     def _assert_service_resources_dict(
         service_resources_dict: ServiceResourcesDict,
@@ -103,7 +102,7 @@ def _assert_service_resources_dict(
 @pytest.mark.parametrize(
     "example", ServiceResourcesDictHelpers.Config.schema_extra["examples"]
 )
-def test_create_jsonable_dict(example: dict[DockerComposeServiceName, Any]) -> None:
+def test_create_jsonable_dict(example: dict[DockerGenericTag, Any]) -> None:
     service_resources_dict: ServiceResourcesDict = parse_obj_as(
         ServiceResourcesDict, example
     )