Update RMS models and API

.github/workflows/nightly.yml

@@ -100,6 +100,8 @@ jobs:
         with:
           report_paths: '**/test*.xml'
           check_name: Test Report ${{ matrix.os }}:${{ matrix.cfg.python-version }} 
+          detailed_summary: true
+          include_passed: true
 
       - name: Stop services
         if: always()

ansys/hps/client/rms/api/base.py

@@ -10,15 +10,13 @@
 from ansys.hps.client.exceptions import ClientError
 
 from ..models import (
-    Cluster,
     ComputeResourceSet,
     EvaluatorConfigurationUpdate,
     EvaluatorRegistration,
     ScalerRegistration,
 )
 
 OBJECT_TYPE_TO_ENDPOINT = {
-    Cluster: "clusters",
     EvaluatorRegistration: "evaluators",
     EvaluatorConfigurationUpdate: "configuration_updates",
     ScalerRegistration: "scalers",

ansys/hps/client/rms/api/rms_api.py

@@ -3,7 +3,7 @@
 
 from ansys.hps.client.client import Client
 from ansys.hps.client.rms.models import (
-    Cluster,
+    ClusterInfo,
     ComputeResourceSet,
     EvaluatorConfiguration,
     EvaluatorConfigurationUpdate,
@@ -145,14 +145,12 @@ def get_compute_resource_set(self, id, as_object=True) -> ComputeResourceSet:
             from_collection=True,
         )
 
-    def get_compute_resurce_set_cluster_info(self, id, as_object=True) -> Cluster:
+    def get_cluster_info(self, compute_resource_set_id, as_object=True) -> ClusterInfo:
         """Returns cluster info of a compute resource set."""
 
-        clusters = get_objects(
+        return get_object(
             self.client.session,
-            self.url,
-            ComputeResourceSet,
-            as_object,
-            crs_id=id,
+            f"{self.url}/compute_resource_sets/{compute_resource_set_id}/cluster_info",
+            ClusterInfo,
+            as_object=as_object,
         )
-        return clusters[0]

ansys/hps/client/rms/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  rms_openapi.json
-#   timestamp: 2023-11-17T08:04:07+00:00
+#   timestamp: 2023-12-22T09:38:15+00:00
 
 from __future__ import annotations
 
@@ -34,17 +34,13 @@ class ApplicationInfo(BaseModel):
     )
 
 
-class ClustersCountResponse(BaseModel):
-    num_clusters: Optional[int] = Field(0, title='Num Clusters')
-
-
 class EvaluatorTaskDirectoryCleanup(Enum):
     always = 'always'
     on_success = 'on_success'
     never = 'never'
 
 
-class Context(BaseModel):
+class ContextUpdate(BaseModel):
     custom: Optional[Dict[str, Optional[Union[int, bool, str, float]]]] = Field(
         {}, description='Custom runtime properties.', title='Custom'
     )
@@ -146,11 +142,6 @@ class KubernetesKedaBackend(BaseModel):
     memory_limit: Optional[str] = Field(
         '250M', description='Memory limit applied to each evaluator instance', title='Memory Limit'
     )
-    persistent_volume_claim_name: Optional[str] = Field(
-        'pvc-rep-files',
-        description='Persistent volume claim name to be mounted as volume for each evaluator instance ',
-        title='Persistent Volume Claim Name',
-    )
     namespace: Optional[str] = Field(
         'default',
         description='Kubernetes namespace to be used to scale evaluators',
@@ -185,6 +176,11 @@ class LocalBackend(BaseModel):
     )
 
 
+class Machine(BaseModel):
+    name: str = Field(..., description='Name of the machine', title='Name')
+    num_cores: int = Field(..., description='Number of cores available', title='Num Cores')
+
+
 class MaxAvailableResourceScaling(BaseModel):
     plugin_name: Literal['max_available_resource_scaling'] = Field(..., title='Plugin Name')
     match_all_requirements: Optional[bool] = Field(
@@ -203,13 +199,17 @@ class MockupBackend(BaseModel):
 
 class Node(BaseModel):
     name: Optional[str] = Field(None, description='Node name', title='Name')
-    total_memory_mb: int = Field(..., description='Total memory', title='Total Memory Mb')
-    used_memory_mb: int = Field(..., description='Memory in use', title='Used Memory Mb')
-    total_cores: int = Field(..., description='Number of cores', title='Total Cores')
-    used_cores: int = Field(..., description='Cores in use', title='Used Cores')
+    total_memory_mb: Optional[int] = Field(..., description='Total memory', title='Total Memory Mb')
+    total_cores: Optional[int] = Field(..., description='Number of cores', title='Total Cores')
     additional_props: Optional[Dict[str, Any]] = Field({}, title='Additional Props')
 
 
+class NodeGroup(BaseModel):
+    node_names: List[str] = Field(..., title='Node Names')
+    total_memory_mb: Optional[int] = Field(..., description='Total memory', title='Total Memory Mb')
+    total_cores: Optional[int] = Field(..., description='Number of cores', title='Total Cores')
+
+
 class PlatformEnum(Enum):
     windows = 'windows'
     linux = 'linux'
@@ -251,6 +251,11 @@ class ProcessLauncherProcessRunner(BaseModel):
 
 class Queue(BaseModel):
     name: Optional[str] = Field(None, description='Queue name', title='Name')
+    node_groups: Optional[List[NodeGroup]] = Field(
+        None,
+        description='List of node groups associated with the queue (If available)',
+        title='Node Groups',
+    )
     additional_props: Optional[Dict[str, Any]] = Field({}, title='Additional Props')
 
 
@@ -275,17 +280,11 @@ class Resources(BaseModel):
 
 class RestLauncherProcessRunner(BaseModel):
     plugin_name: Literal['process_launcher_service'] = Field(..., title='Plugin Name')
-    default_user: Optional[str] = Field(
-        None, description='The user to use when none is specified', title='Default User'
-    )
     launcher_url: Optional[str] = Field(
         'http://localhost:4911',
         description='The url to use when none is specified',
         title='Launcher Url',
     )
-    require_auth: Optional[bool] = Field(
-        False, description='Only make authenticated calls to the launcher', title='Require Auth'
-    )
     verify_ssl: Optional[bool] = Field(
         True, description='Check the SSL certificate for HTTPS launchers', title='Verify Ssl'
     )
@@ -395,7 +394,7 @@ class Status(BaseModel):
     build: Dict[str, Any] = Field(..., title='Build')
 
 
-class Cluster(BaseModel):
+class ClusterInfo(BaseModel):
     id: Optional[str] = Field(None, description='Unique identifier for database', title='Id')
     crs_id: Optional[str] = Field(None, description='Compute resource set ID', title='Crs Id')
     name: Optional[str] = Field(None, description='Cluster name', title='Name')
@@ -404,12 +403,15 @@ class Cluster(BaseModel):
     additional_props: Optional[Dict[str, Dict[str, Any]]] = Field({}, title='Additional Props')
 
 
-class ClustersRequest(BaseModel):
-    clusters: List[Cluster] = Field(..., description='Cluster details', title='Clusters')
-
-
-class ClustersResponse(BaseModel):
-    clusters: List[Cluster] = Field(..., description='Cluster details', title='Clusters')
+class Context(BaseModel):
+    custom: Optional[Dict[str, Optional[Union[int, bool, str, float]]]] = Field(
+        {}, description='Custom runtime properties.', title='Custom'
+    )
+    machines_list: Optional[List[Machine]] = Field(
+        None,
+        description='List of machines for distributed parallel processing.',
+        title='Machines List',
+    )
 
 
 class EvaluatorResources(BaseModel):
@@ -512,13 +514,13 @@ class ComputeResourceSet(BaseModel):
         discriminator='plugin_name',
         title='Backend',
     )
-    scaling_strategy: Optional[
-        Union[MaxAvailableResourceScaling, KubernetesResourceScaling]
-    ] = Field(
-        {'match_all_requirements': False, 'plugin_name': 'max_available_resource_scaling'},
-        description='Scaling strategy to use in this compute resource set',
-        discriminator='plugin_name',
-        title='Scaling Strategy',
+    scaling_strategy: Optional[Union[MaxAvailableResourceScaling, KubernetesResourceScaling]] = (
+        Field(
+            {'match_all_requirements': False, 'plugin_name': 'max_available_resource_scaling'},
+            description='Scaling strategy to use in this compute resource set',
+            discriminator='plugin_name',
+            title='Scaling Strategy',
+        )
     )
     available_resources: Optional[Resources] = Field(
         {'custom': {}}, description='Available resources in the compute resource set'
@@ -536,6 +538,16 @@ class ComputeResourceSet(BaseModel):
         description='Cleanup policy for task directories passed to evaluators',
         title='Evaluator Task Directory Cleanup',
     )
+    evaluator_auto_shutdown_time: Optional[int] = Field(
+        20,
+        description='Time after which to shutdown the evaluator if not running any jobs.',
+        title='Evaluator Auto Shutdown Time',
+    )
+    evaluator_loop_interval: Optional[int] = Field(
+        5,
+        description='The main evaluator loop is repeated every loop_interval seconds',
+        title='Evaluator Loop Interval',
+    )
 
 
 class ComputeResourceSetsRequest(BaseModel):
@@ -568,13 +580,10 @@ class EvaluatorConfiguration(BaseModel):
     task_directory_cleanup: Optional[TaskDirectoryCleanupEnum] = Field(
         None, title='Task Directory Cleanup'
     )
-    context: Optional[Context] = Field(
-        {'custom': {}}, description='Runtime properties to be passed to executed tasks'
-    )
     resources: Optional[EvaluatorResources] = {'custom': {}}
     task_manager_type: Optional[str] = Field(None, title='Task Manager Type')
     loop_interval: Optional[float] = Field(
-        5,
+        5.0,
         description='The main evaluator loop is repeated every loop_interval seconds',
         title='Loop Interval',
     )
@@ -601,6 +610,9 @@ class EvaluatorConfiguration(BaseModel):
         description='Specifies how the evaluator selects projects to work on.             One of: disabled, all_active, list',
         title='Project Assignment Mode',
     )
+    context: Optional[Context] = Field(
+        {'custom': {}}, description='Runtime properties to be passed to executed tasks'
+    )
 
 
 class EvaluatorConfigurationUpdate(BaseModel):
@@ -621,9 +633,6 @@ class EvaluatorConfigurationUpdate(BaseModel):
     task_directory_cleanup: Optional[TaskDirectoryCleanupEnum] = Field(
         None, title='Task Directory Cleanup'
     )
-    context: Optional[Context] = Field(
-        {'custom': {}}, description='Runtime properties to be passed to executed tasks'
-    )
     resources: Optional[EvaluatorResources] = {'custom': {}}
     name: Optional[str] = Field(
         None, description='Update the name of Evaluator (updating the registration)', title='Name'
@@ -651,15 +660,24 @@ class EvaluatorConfigurationUpdate(BaseModel):
         description='Specifies how the evaluator selects projects to work on.             One of: disabled, all_active, list',
         title='Project Assignment Mode',
     )
+    context: Optional[ContextUpdate] = Field(
+        {'custom': {}}, description='Runtime properties to be passed to executed tasks'
+    )
 
 
 class EvaluatorConfigurationUpdatesRequest(BaseModel):
-    updates: List[EvaluatorConfigurationUpdate] = Field(
-        ..., description='Configuration update details', title='Updates'
+    configuration_updates: List[EvaluatorConfigurationUpdate] = Field(
+        ..., description='Configuration update details', title='Configuration Updates'
     )
 
 
 class EvaluatorConfigurationUpdatesResponse(BaseModel):
-    updates: List[EvaluatorConfigurationUpdate] = Field(
-        ..., description='Configuration update details', title='Updates'
+    configuration_updates: List[EvaluatorConfigurationUpdate] = Field(
+        ..., description='Configuration update details', title='Configuration Updates'
+    )
+
+
+class EvaluatorConfigurationsResponse(BaseModel):
+    configurations: List[EvaluatorConfiguration] = Field(
+        ..., description='Evaluator configurations', title='Configurations'
     )

requirements/requirements_build.txt

@@ -1,4 +1,4 @@
 build==1.0.3
 twine==4.0.2
 wheel
-datamodel-code-generator==0.25.1
+datamodel-code-generator==0.24.2

tests/rms/test_compute_resource_sets.py

@@ -65,6 +65,13 @@ def test_crs_integration(self):
             rs = rms_api.get_compute_resource_set(resource_sets[0].id)
             assert rs.scaler_id == resource_sets[0].scaler_id
 
+            cluster_info = rms_api.get_cluster_info(rs.id)
+            assert cluster_info.crs_id == rs.id
+            if cluster_info.queues is not None and len(cluster_info.queues) > 0:
+                for queue in cluster_info.queues:
+                    assert queue.name is not None
+                    log.info(f"Compure resource set {rs.name} has queue {queue.name}")
+
 
 if __name__ == "__main__":
     unittest.main()