Exports API

Author: jvstme

src/dstack/_internal/core/models/exports.py

@@ -0,0 +1,19 @@
+import uuid
+
+from dstack._internal.core.models.common import CoreModel
+
+
+class ExportImport(CoreModel):
+    project_name: str
+
+
+class ExportedFleet(CoreModel):
+    id: uuid.UUID
+    name: str
+
+
+class Export(CoreModel):
+    id: uuid.UUID
+    name: str
+    imports: list[ExportImport]
+    exported_fleets: list[ExportedFleet]

src/dstack/_internal/server/app.py

@@ -31,6 +31,7 @@
     auth,
     backends,
     events,
+    exports,
     files,
     fleets,
     gateways,
@@ -253,6 +254,7 @@ def register_routes(app: FastAPI, ui: bool = True):
     app.include_router(files.router)
     app.include_router(events.root_router)
     app.include_router(templates.router)
+    app.include_router(exports.project_router)
 
     @app.exception_handler(ForbiddenError)
     async def forbidden_error_handler(request: Request, exc: ForbiddenError):

src/dstack/_internal/server/models.py

@@ -49,6 +49,9 @@
 from dstack._internal.utils.logging import get_logger
 
 logger = get_logger(__name__)
+# Default options (save-update, merge) + delete-orphan + delete (required by delete-orphan)
+# delete-orphan allows to automatically delete entities removed from the relationship
+CASCADE_DEFAULT_WITH_DELETE_ORPHAN = "save-update, merge, delete-orphan, delete"
 
 
 class NaiveDateTime(TypeDecorator):
@@ -760,10 +763,7 @@ class InstanceModel(PipelineModelMixin, BaseModel):
 
     volume_attachments: Mapped[List["VolumeAttachmentModel"]] = relationship(
         back_populates="instance",
-        # Add delete-orphan option so that removing entries from volume_attachments
-        # automatically marks them for deletion.
-        # SQLAlchemy requires delete when using delete-orphan.
-        cascade="save-update, merge, delete-orphan, delete",
+        cascade=CASCADE_DEFAULT_WITH_DELETE_ORPHAN,
     )
 
     __table_args__ = (
@@ -1043,8 +1043,14 @@ class ExportModel(BaseModel):
     )
     project: Mapped["ProjectModel"] = relationship()
     created_at: Mapped[datetime] = mapped_column(NaiveDateTime, default=get_current_datetime)
-    imports: Mapped[List["ImportModel"]] = relationship(back_populates="export")
-    exported_fleets: Mapped[List["ExportedFleetModel"]] = relationship(back_populates="export")
+    imports: Mapped[List["ImportModel"]] = relationship(
+        back_populates="export",
+        cascade=CASCADE_DEFAULT_WITH_DELETE_ORPHAN,
+    )
+    exported_fleets: Mapped[List["ExportedFleetModel"]] = relationship(
+        back_populates="export",
+        cascade=CASCADE_DEFAULT_WITH_DELETE_ORPHAN,
+    )
 
 
 class ImportModel(BaseModel):

src/dstack/_internal/server/routers/exports.py

@@ -0,0 +1,84 @@
+from typing import Annotated
+
+from fastapi import APIRouter, Depends
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from dstack._internal.core.models.exports import Export
+from dstack._internal.server.db import get_session
+from dstack._internal.server.models import ProjectModel, UserModel
+from dstack._internal.server.schemas.exports import (
+    CreateExportRequest,
+    DeleteExportRequest,
+    UpdateExportRequest,
+)
+from dstack._internal.server.security.permissions import ProjectAdmin, ProjectMember
+from dstack._internal.server.services import exports as exports_services
+from dstack._internal.server.utils.routers import get_base_api_additional_responses
+
+project_router = APIRouter(
+    prefix="/api/project/{project_name}/exports",
+    tags=["exports"],
+    responses=get_base_api_additional_responses(),
+)
+
+
+@project_router.post("/create", response_model=Export)
+async def create_export(
+    body: CreateExportRequest,
+    session: Annotated[AsyncSession, Depends(get_session)],
+    user_project: Annotated[tuple[UserModel, ProjectModel], Depends(ProjectAdmin())],
+):
+    user, project = user_project
+    return await exports_services.create_export(
+        session=session,
+        project=project,
+        user=user,
+        name=body.name,
+        importer_project_names=body.importer_projects,
+        exported_fleet_names=body.exported_fleets,
+    )
+
+
+@project_router.post("/update", response_model=Export)
+async def update_export(
+    body: UpdateExportRequest,
+    session: Annotated[AsyncSession, Depends(get_session)],
+    user_project: Annotated[tuple[UserModel, ProjectModel], Depends(ProjectAdmin())],
+):
+    user, project = user_project
+    return await exports_services.update_export(
+        session=session,
+        project=project,
+        user=user,
+        name=body.name,
+        add_importer_project_names=body.add_importer_projects,
+        remove_importer_project_names=body.remove_importer_projects,
+        add_exported_fleet_names=body.add_exported_fleets,
+        remove_exported_fleet_names=body.remove_exported_fleets,
+    )
+
+
+@project_router.post("/delete")
+async def delete_export(
+    body: DeleteExportRequest,
+    session: Annotated[AsyncSession, Depends(get_session)],
+    user_project: Annotated[tuple[UserModel, ProjectModel], Depends(ProjectAdmin())],
+):
+    _, project = user_project
+    await exports_services.delete_export(
+        session=session,
+        project=project,
+        name=body.name,
+    )
+
+
+@project_router.post("/list", response_model=list[Export])
+async def list_exports(
+    session: Annotated[AsyncSession, Depends(get_session)],
+    user_project: Annotated[tuple[UserModel, ProjectModel], Depends(ProjectMember())],
+):
+    _, project = user_project
+    return await exports_services.list_exports(
+        session=session,
+        project=project,
+    )

src/dstack/_internal/server/schemas/exports.py

@@ -0,0 +1,19 @@
+from dstack._internal.core.models.common import CoreModel
+
+
+class CreateExportRequest(CoreModel):
+    name: str
+    importer_projects: list[str] = []
+    exported_fleets: list[str] = []
+
+
+class UpdateExportRequest(CoreModel):
+    name: str
+    add_importer_projects: list[str] = []
+    remove_importer_projects: list[str] = []
+    add_exported_fleets: list[str] = []
+    remove_exported_fleets: list[str] = []
+
+
+class DeleteExportRequest(CoreModel):
+    name: str