aboutsummaryrefslogtreecommitdiffstats
path: root/runtime/models/api
diff options
context:
space:
mode:
authorvrvarma <vikas.varma@att.com>2020-03-03 22:22:28 -0500
committervrvarma <vikas.varma@att.com>2020-03-04 20:55:57 -0500
commitde5fdaafad9fccba0b9a7f308d72f26816dd1a0f (patch)
treee8e683e21002c20f3d743375d742bf0819d82409 /runtime/models/api
parent7d4f37c45d50c56dfe438c04dbecea3ca9f7c9d2 (diff)
Adding the generic solver code
Add docker file for optim engine Run pods as a non-root user Fix docker tag script Change-Id: If25fe66b839a70e83e35292031a2da012e81fe47 Signed-off-by: vrvarma <vikas.varma@att.com> Issue-ID: OPTFRA-712
Diffstat (limited to 'runtime/models/api')
-rw-r--r--runtime/models/api/__init__.py17
-rw-r--r--runtime/models/api/model_request.py48
-rw-r--r--runtime/models/api/model_response.py31
-rw-r--r--runtime/models/api/optim_request.py60
-rw-r--r--runtime/models/api/optim_response.py30
5 files changed, 186 insertions, 0 deletions
diff --git a/runtime/models/api/__init__.py b/runtime/models/api/__init__.py
new file mode 100644
index 0000000..2aa67d8
--- /dev/null
+++ b/runtime/models/api/__init__.py
@@ -0,0 +1,17 @@
+# -------------------------------------------------------------------------
+# Copyright (c) 2020 AT&T Intellectual Property
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# -------------------------------------------------------------------------
+#
diff --git a/runtime/models/api/model_request.py b/runtime/models/api/model_request.py
new file mode 100644
index 0000000..710da4b
--- /dev/null
+++ b/runtime/models/api/model_request.py
@@ -0,0 +1,48 @@
+# -------------------------------------------------------------------------
+# Copyright (c) 2020 AT&T Intellectual Property
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# -------------------------------------------------------------------------
+#
+
+from schematics.types import StringType
+from schematics.types.compound import ModelType
+
+from osdf.models.api.common import OSDFModel
+
+
+class RequestInfo(OSDFModel):
+ """Info for northbound request from client such as PCI-mS Handler"""
+ transactionId = StringType(required=True)
+ requestID = StringType(required=True)
+ sourceId = StringType(required=True)
+
+
+class OptimModelInfo(OSDFModel):
+ """Optimizer request info details."""
+ # ModelId from the database
+ modelId = StringType()
+ # type of solver (mzn, or-tools, etc.)
+ solver = StringType(required=True)
+ # Description of the model
+ description = StringType()
+ # a large blob string containing the model (which is not that
+ # problematic since models are fairly small).
+ modelContent = StringType()
+
+
+class OptimModelRequestAPI(OSDFModel):
+ """Request for Optimizer API (specific to optimization and additional metadata"""
+ requestInfo = ModelType(RequestInfo, required=True)
+ modelInfo = ModelType(OptimModelInfo, required=True)
diff --git a/runtime/models/api/model_response.py b/runtime/models/api/model_response.py
new file mode 100644
index 0000000..e4a41a5
--- /dev/null
+++ b/runtime/models/api/model_response.py
@@ -0,0 +1,31 @@
+# -------------------------------------------------------------------------
+# Copyright (c) 2020 AT&T Intellectual Property
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# -------------------------------------------------------------------------
+#
+
+from schematics.types import StringType
+
+from osdf.models.api.common import OSDFModel
+
+
+class OptimModelResponse(OSDFModel):
+ modelId = StringType()
+ # type of solver (mzn, or-tools, etc.)
+ solver = StringType()
+ # a large blob string containing the model
+ modelContent = StringType()
+ # statusMessage
+ statusMessage = StringType()
diff --git a/runtime/models/api/optim_request.py b/runtime/models/api/optim_request.py
new file mode 100644
index 0000000..4a046d2
--- /dev/null
+++ b/runtime/models/api/optim_request.py
@@ -0,0 +1,60 @@
+# -------------------------------------------------------------------------
+# Copyright (c) 2020 AT&T Intellectual Property
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# -------------------------------------------------------------------------
+#
+
+from schematics.types import BaseType, DictType, StringType, IntType
+from schematics.types.compound import ModelType
+
+from osdf.models.api.common import OSDFModel
+
+"""
+"""
+class RequestInfo(OSDFModel):
+ """Info for northbound request from client """
+ transactionId = StringType(required=True)
+ requestID = StringType(required=True)
+ callbackUrl = StringType()
+ sourceId = StringType(required=True)
+ timeout = IntType()
+
+
+class DataInfo(OSDFModel):
+ """Optimization data info"""
+ text = StringType()
+ json = DictType(BaseType)
+
+
+class OptimInfo(OSDFModel):
+ """Optimizer request info details."""
+ # ModelId from the database, if its not populated,
+ # assume that solverModel will be populated.
+ modelId = StringType()
+ # type of solver (mzn, or-tools, etc.)
+ solver = StringType()
+ # Arguments for solver
+ solverArgs = DictType(BaseType)
+ # NOTE: a large blob string containing the model (which is not that
+ # problematic since models are fairly small).
+ modelContent = StringType()
+ # Data Payload, input data for the solver
+ optData = ModelType(DataInfo)
+
+
+class OptimizationAPI(OSDFModel):
+ """Request for Optimizer API (specific to optimization and additional metadata"""
+ requestInfo = ModelType(RequestInfo, required=True)
+ optimInfo = ModelType(OptimInfo, required=True)
diff --git a/runtime/models/api/optim_response.py b/runtime/models/api/optim_response.py
new file mode 100644
index 0000000..6fd0f6b
--- /dev/null
+++ b/runtime/models/api/optim_response.py
@@ -0,0 +1,30 @@
+# -------------------------------------------------------------------------
+# Copyright (c) 2020 AT&T Intellectual Property
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# -------------------------------------------------------------------------
+#
+
+from schematics.types import StringType, BaseType
+from schematics.types.compound import DictType
+
+from osdf.models.api.common import OSDFModel
+
+
+class OptimResponse(OSDFModel):
+ transactionId = StringType(required=True)
+ requestID = StringType(required=True)
+ requestStatus = StringType(required=True)
+ statusMessage = StringType()
+ solutions = DictType(BaseType)