feat(mlops): add modal deployment (#548)

* add modal deployment

* able to save modal information

Author: Mubangizi

api_docs.yml

@@ -2511,7 +2511,7 @@ paths:
           name: project_type
           type: string
           description: Shows the type of project. Corresponds to the predifined types like Research, Student, Personal, Commercial or Other.
-
+        - in: query
           name: series
           type: boolean
           description: Returns graph data when set to true
@@ -2782,6 +2782,55 @@ paths:
         500:
           description: "Internal Server Error"
 
+  "/projects/{project_id}/apps/ml":
+    post:
+      tags:
+        - apps
+      consumes:
+        - application/json
+      parameters:
+        - in: header
+          name: Authorization
+          required: true
+        - in: path
+          name: project_id
+          required: true
+          type: string
+        - in: body
+          name: project
+          schema:
+            required:
+              - name
+              - is_notebook
+            properties:
+              name:
+                type: string
+              is_notebook:
+                type: boolean
+              is_modal:
+                type: boolean
+                example: false
+              model_image_uri:
+                type: string
+                example: ""
+              api_type:
+                type: string
+                example: "REST"
+              model_server:
+                type: string
+                example: "MLFLOW_SERVER"
+      produces:
+        - application/json
+      responses:
+        201:
+          description: "Success"
+        400:
+          description: "Bad request"
+        409:
+          description: "Error"
+        500:
+          description: "Internal Server Error"
+
   "/projects/{project_id}/billing/info":
     post:
       tags:
@@ -3267,44 +3316,6 @@ paths:
         500:
           description: "Internal Server Error"
 
-  "/projects/{project_id}/apps/ml":
-    post:
-      tags:
-        - apps
-      consumes:
-        - application/json
-      parameters:
-        - in: header
-          name: Authorization
-          required: true
-        - in: path
-          name: project_id
-          required: true
-          type: string
-        - in: body
-          name: project
-          schema:
-            required:
-              - name
-              - is_notebook
-            properties:
-              name:
-                type: string
-              is_notebook:
-                type: boolean
-
-      produces:
-        - application/json
-      responses:
-        201:
-          description: "Success"
-        400:
-          description: "Bad request"
-        409:
-          description: "Error"
-        500:
-          description: "Internal Server Error"
-
   "/apps/{app_id}":
     get:
       tags:

app/controllers/app.py

@@ -480,8 +480,7 @@ def post(self, project_id):
         project_data, errors = project_schema.dumps(project)
         cluster_data, errors = cluster_schema.dumps(cluster)
         data = dict(
-            name=validated_app_data.get('name', None),
-            is_notebook=validated_app_data.get('is_notebook', True),
+            **validated_app_data,
             project=json.loads(project_data),
             # user=user
             cluster=json.loads(cluster_data)
@@ -501,6 +500,7 @@ def post(self, project_id):
             return dict(status='fail', message=response.json().get('message')), response.status_code
 
         response_data = response.json().get('app', {})
+
         new_app = App(**response_data)
 
         saved_app = new_app.save()

app/models/app.py

@@ -13,7 +13,7 @@ class App(ModelMixin):
     id = db.Column(UUID(as_uuid=True), primary_key=True,
                    server_default=sa_text("uuid_generate_v4()"))
     name = db.Column(db.String(256), nullable=True)
-    image = db.Column(db.String(256), nullable=False)
+    image = db.Column(db.String(256), nullable=True)
     project_id = db.Column(UUID(as_uuid=True), db.ForeignKey(
         'project.id'), nullable=False)
     url = db.Column(db.String(256), nullable=True)
@@ -31,3 +31,7 @@ class App(ModelMixin):
         "AppState", backref='app_state', lazy=True)
     is_ai = db.Column(db.Boolean, default=False)
     is_notebook = db.Column(db.Boolean, default=False)
+    is_modal = db.Column(db.Boolean, default=False)
+    model_image_uri = db.Column(db.String(256), nullable=True)
+    api_type = db.Column(db.String(256), nullable=True)
+    model_server = db.Column(db.String(256), nullable=True)

app/schemas/app.py

@@ -8,14 +8,14 @@ class AppSchema(Schema):
 
     id = fields.String(dump_only=True)
 
-    name = fields.String(required=True, error_messgae={
+    name = fields.String(required=True, error_messages={
         "required": "name is required"},
         validate=[
             validate.Regexp(
                 regex=r'^(?!\s*$)', error='name should be a valid string'
             ),
     ])
-    image = fields.String(required=True, error_message={
+    image = fields.String(required=True, error_messages={
         "required": "image is required"},
         validate=[
             validate.Regexp(
@@ -47,6 +47,10 @@ class AppSchema(Schema):
     app_status = fields.Nested(AppStateSchema, many=True, dump_only=True)
     is_ai = fields.Boolean(required=False)
     is_notebook = fields.Boolean(required=False)
+    is_modal = fields.Bool(required=False)
+    model_image_uri = fields.Str(required=False)
+    api_type = fields.Str(required=False)
+    model_server = fields.Str(required=False)
 
     def get_age(self, obj):
         return get_item_age(obj.date_created)
@@ -79,3 +83,20 @@ class AppDeploySchema(AppSchema):
 class MLAppDeploySchema(Schema):
     name = fields.String(required=True)
     is_notebook = fields.Boolean(required=True)
+    is_modal = fields.Bool(required=False)
+    model_image_uri = fields.Str(required=False)
+    api_type = fields.Str(required=False, default="REST", validate=validate.OneOf(
+        ["REST", "GRPC"]
+    ))
+    model_server = fields.Str(required=False, default="MLFLOW_SERVER", validate=validate.OneOf(
+        [
+            "SKLEARN_SERVER",
+            "TENSORFLOW_SERVER",
+            "XGBOOST_SERVER",
+            "MLFLOW_SERVER",
+            "TRITON_SERVER",
+            "TEMPO_SERVER",
+            "HUGGINGFACE_SERVER",
+            "CUSTOM_INFERENCE_SERVER"
+        ]
+    ))

migrations/versions/701f36199305_.py

@@ -0,0 +1,40 @@
+"""empty message
+
+Revision ID: 701f36199305
+Revises: 1bf24f39f11e
+Create Date: 2025-03-05 03:27:46.282625
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '701f36199305'
+down_revision = '1bf24f39f11e'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('app', sa.Column('api_type', sa.String(length=256), nullable=True))
+    op.add_column('app', sa.Column('is_modal', sa.Boolean(), nullable=True))
+    op.add_column('app', sa.Column('model_image_uri', sa.String(length=256), nullable=True))
+    op.add_column('app', sa.Column('model_server', sa.String(length=256), nullable=True))
+    op.alter_column('app', 'image',
+               existing_type=sa.VARCHAR(length=256),
+               nullable=True)
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.alter_column('app', 'image',
+               existing_type=sa.VARCHAR(length=256),
+               nullable=False)
+    op.drop_column('app', 'model_server')
+    op.drop_column('app', 'model_image_uri')
+    op.drop_column('app', 'is_modal')
+    op.drop_column('app', 'api_type')
+    # ### end Alembic commands ###