Commit 2ab09603 authored by Cesar Cajas's avatar Cesar Cajas
Browse files

feature/add-gsma-schemas-to-edgecloud-adapters: add schemas for onboard, artefact and deploy

parent 725be77e

src/sunrise6g_opensdk/edgecloud/adapters/aeros/client.py

+1 −1
Changes for src/sunrise6g_opensdk/edgecloud/adapters/aeros/client.py: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -549,7 +549,7 @@ class EdgeApplicationManager(EdgeCloudManagementInterface): 
        """

        pass



    def get_all_deployed_apps_gsma(self, app_id: str, app_provider: str) -> List:

    def get_all_deployed_apps_gsma(self) -> Response:

        """

        Retrieves all instances for a given application of partner OP

src/sunrise6g_opensdk/edgecloud/adapters/i2edge/client.py

+140 −100

File changed.

Preview size limit exceeded, changes collapsed.

src/sunrise6g_opensdk/edgecloud/adapters/kubernetes/client.py

+1 −1
Changes for src/sunrise6g_opensdk/edgecloud/adapters/kubernetes/client.py: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -389,7 +389,7 @@ class EdgeApplicationManager(EdgeCloudManagementInterface): 
        """

        pass



    def get_all_deployed_apps_gsma(self, app_id: str, app_provider: str) -> List:

    def get_all_deployed_apps_gsma(self) -> Response:

        """

        Retrieves all instances for a given application of partner OP

src/sunrise6g_opensdk/edgecloud/core/edgecloud_interface.py

+1 −1
Changes for src/sunrise6g_opensdk/edgecloud/core/edgecloud_interface.py: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -278,7 +278,7 @@ class EdgeCloudManagementInterface(ABC): 
        pass



    @abstractmethod

    def get_all_deployed_apps_gsma(self, app_id: str, app_provider: str) -> Response:

    def get_all_deployed_apps_gsma(self) -> Response:

        """

        Retrieves all instances for a given application of partner OP

src/sunrise6g_opensdk/edgecloud/core/gsma_schemas.py

+96 −1
Changes for src/sunrise6g_opensdk/edgecloud/core/gsma_schemas.py: 96 added lines, 1 removed line.
Original line number Diff line number Diff line 
from typing import List, Literal, Optional



from pydantic import BaseModel, Field, RootModel

from pydantic import BaseModel, Field, HttpUrl, RootModel



# ---------------------------

# FederationManagement
@@ -121,11 +121,106 @@ class ZoneRegisteredDataList(RootModel[List[ZoneRegisteredData]]): 
# ---------------------------





class ArtefactRepoLocation(BaseModel):

    repoURL: HttpUrl

    userName: Optional[str] = None

    password: Optional[str] = None

    token: Optional[str] = None





class Artefact(BaseModel):

    artefactId: str

    appProviderId: str = None

    artefactName: str

    artefactDescription: Optional[str] = None

    artefactVersionInfo: str

    artefactVirtType: Literal["VM_TYPE", "CONTAINER_TYPE"]

    artefactFileName: Optional[str] = None

    artefactFileFormat: Optional[Literal["ZIP", "TAR", "TEXT", "TARGZ"]] = None

    artefactDescriptorType: Literal["HELM", "TERRAFORM", "ANSIBLE", "SHELL", "COMPONENTSPEC"]

    repoType: Optional[Literal["PRIVATEREPO", "PUBLICREPO", "UPLOAD"]] = None

    artefactRepoLocation: Optional[ArtefactRepoLocation] = None





# ---------------------------

# ApplicationOnboardingManagement

# ---------------------------





class AppDeploymentZone(BaseModel):

    countryCode: str

    zoneInfo: str





class AppMetaData(BaseModel):

    appName: str

    version: str

    appDescription: Optional[str] = None

    mobilitySupport: bool = False

    accessToken: str

    category: Optional[

        Literal[

            "IOT",

            "HEALTH_CARE",

            "GAMING",

            "VIRTUAL_REALITY",

            "SOCIALIZING",

            "SURVEILLANCE",

            "ENTERTAINMENT",

            "CONNECTIVITY",

            "PRODUCTIVITY",

            "SECURITY",

            "INDUSTRIAL",

            "EDUCATION",

            "OTHERS",

        ]

    ] = None





class AppQoSProfile(BaseModel):

    latencyConstraints: Literal["NONE", "LOW", "ULTRALOW"]

    bandwidthRequired: int = Field(..., ge=1)

    multiUserClients: Literal["APP_TYPE_SINGLE_USER", "APP_TYPE_MULTI_USER"]

    noOfUsersPerAppInst: int = 1

    appProvisioning: bool = True





class AppComponentSpec(BaseModel):

    serviceNameNB: str

    serviceNameEW: str

    componentName: str

    artefactId: str





class ApplicationModel(BaseModel):

    appId: str

    appProviderId: str

    appDeploymentZones: List[AppDeploymentZone] = Field(..., min_length=1)

    appMetaData: AppMetaData

    appQoSProfile: AppQoSProfile

    appComponentSpecs: List[AppComponentSpec] = Field(..., min_length=1)

    onboardStatusInfo: Literal["PENDING", "ONBOARDED", "DEBOARDING", "REMOVED", "FAILED"]





# ---------------------------

# ApplicationDeploymentManagement

# ---------------------------





class AppInstance(BaseModel):

    zoneId: str

    appInstIdentifier: str





class AppInstanceStatus(BaseModel):

    appInstanceState: Literal["PENDING", "READY", "FAILED", "TERMINATING", "DEPLOYED"]

    accesspointInfo: List[dict]





class ZoneIdentifier(BaseModel):

    zoneId: str

    appInstanceInfo: List[dict]





class ZoneIdentifierList(RootModel[List[ZoneIdentifier]]):

    pass