🐛 Started dynamic services do not take the correct Reservation (ITISFoundation#3047)

Author: sanderegg

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

@@ -2,7 +2,13 @@
 
 from pydantic import Field, validator
 
-from .generated_models.docker_rest_api import ContainerSpec, ServiceSpec, TaskSpec
+from .generated_models.docker_rest_api import (
+    ContainerSpec,
+    ResourceObject,
+    Resources1,
+    ServiceSpec,
+    TaskSpec,
+)
 from .utils.converters import to_snake_case
 
 
@@ -26,11 +32,27 @@ def convert_list_to_dict(cls, v):
         return v
 
 
+class AioDockerResources1(Resources1):
+    # NOTE: The Docker REST API documentation is wrong!!!
+    # Do not set that back to singular Reservation.
+    Reservation: Optional[ResourceObject] = Field(
+        None, description="Define resources reservation.", alias="Reservations"
+    )
+
+    class Config(Resources1.Config):
+        allow_population_by_field_name = True
+
+
 class AioDockerTaskSpec(TaskSpec):
     ContainerSpec: Optional[AioDockerContainerSpec] = Field(
         None,
     )
 
+    Resources: Optional[AioDockerResources1] = Field(
+        None,
+        description="Resource requirements which apply to each individual container created\nas part of the service.\n",
+    )
+
 
 class AioDockerServiceSpec(ServiceSpec):
 

services/catalog/src/simcore_service_catalog/api/routes/services_resources.py

@@ -26,9 +26,6 @@
 logger = logging.getLogger(__name__)
 
 
-# TODO: Reservation and not Reservations https://github.com/ITISFoundation/osparc-simcore/issues/3044
-
-
 def _parse_generic_resource(
     generic_resources: list[Any], service_resources: ServiceResources
 ) -> None:

services/director-v2/src/simcore_service_director_v2/modules/dynamic_sidecar/docker_service_specs/settings.py

@@ -100,12 +100,8 @@ def inject_settings_to_create_service_params(
                     "NanoCPUs"
                 ] = param.value["cpu_reservation"]
             # REST-API compatible
-            if (
-                "Limits" in param.value
-                or "Reservation" in param.value
-                or "Reservations" in param.value
-            ):
-                # NOTE: Reservations is incorrect. It's Reservation but we keep it for backwards compatibility
+            if "Limits" in param.value or "Reservations" in param.value:
+                # NOTE: The Docker REST API reads Reservation when actually it's Reservations
                 create_service_params["task_template"]["Resources"].update(param.value)
 
         # publishing port on the ingress network.
@@ -157,27 +153,6 @@ def inject_settings_to_create_service_params(
         create_service_params["task_template"]["Resources"]["Limits"]["MemoryBytes"]
     )
 
-    _clean_reservation_field(create_service_params)
-
-
-def _clean_reservation_field(service_spec: dict[str, Any]) -> None:
-    WRONG_FIELD = "Reservations"
-    RIGHT_FIELD = "Reservation"
-    if WRONG_FIELD not in service_spec["task_template"].get("Resources", {}):
-        return
-    # NOTE: in old services, there is a typo in the field. There is no s in Reservation in
-    # the Docker API (see https://docs.docker.com/engine/api/v1.41/#operation/ServiceCreate)
-    new_reservation = service_spec["task_template"]["Resources"][WRONG_FIELD]
-    if (
-        current_reservation := service_spec["task_template"]
-        .get("Resources", {})
-        .get(RIGHT_FIELD)
-    ):
-        new_reservation = current_reservation | new_reservation
-
-    service_spec["task_template"]["Resources"][RIGHT_FIELD] = new_reservation
-    service_spec["task_template"]["Resources"].pop(WRONG_FIELD)
-
 
 def _assemble_key(service_key: str, service_tag: str) -> str:
     return f"{service_key}:{service_tag}"

services/director-v2/tests/unit/test_modules_dynamic_sidecar_docker_service_specs.py

@@ -271,7 +271,7 @@ def expected_dynamic_sidecar_spec() -> dict[str, Any]:
             "Placement": {"Constraints": ["node.platform.os == linux"]},
             "Resources": {
                 "Limits": {"MemoryBytes": 8589934592, "NanoCPUs": 4000000000},
-                "Reservation": {
+                "Reservations": {
                     "GenericResources": [
                         {"DiscreteResourceSpec": {"Kind": "VRAM", "Value": 1}}
                     ],