add description for app

Author: alexandredevely

controllers/manager_controller.py

@@ -519,17 +519,29 @@ def handle_desktop_GET( self, args ):
                     return resource
 
             if args[1]=="pod":
+
+                if len(args)==2 :
+                    # list container for a desktop
+                    # /API/manager/desktop/hermes-8a49ca1a-fcc6-4b7b-960f-5a27debd4773/container
+                    applications = oc.od.composer.list_applications_by_name_and_type(desktop_name, 'pod_application')
+                    return applications
+                 
+                if len(args)==3:
+                    app_name = args[2]
+                    # describe container for a desktop
+                    # /API/manager/desktop/hermes-8a49ca1a-fcc6-4b7b-960f-5a27debd4773/container/container_id
+                    application = oc.od.composer.describe_application_byname( desktop_name, app_name )
+                    return application
+                
                 # /API/manager/desktop/hermes-8a49ca1a-fcc6-4b7b-960f-5a27debd4773/pod/pod_id/resources_usage
-                 if len(args)==4 and args[3]=="resources_usage":
+                if len(args)==4 and args[3]=="resources_usage":
                     #
                     # args[0] -> desktop_name
                     # args[1] -> pod
                     # args[2] -> pod_name or pod_id
                     # args[3] -> resources_usage
                     # /API/manager/desktop/hermes-8a49ca1a-fcc6-4b7b-960f-5a27debd4773/pod/pod_id/resources_usage
                     pod_name = args[2]
-                    if not isinstance( pod_name, str):
-                        raise cherrypy.HTTPError(status=400, message='Invalid parameters Bad Request')
                     self.logger.debug(f'get pod resources usage for {desktop_name} {pod_name}')
                     resource = oc.od.composer.get_pod_resources_usage(desktop_name=desktop_name, pod_name=pod_name)
                     return resource
@@ -541,16 +553,14 @@ def handle_desktop_GET( self, args ):
                 if len(args)==2 :
                     # list container for a desktop
                     # /API/manager/desktop/hermes-8a49ca1a-fcc6-4b7b-960f-5a27debd4773/container
-                    container = oc.od.composer.list_container_byname(desktop_name)
-                    return container
+                    applications = oc.od.composer.list_applications_by_name_and_type(desktop_name, 'ephemeral_container')
+                    return applications
 
                 if len(args)==3:
-                    container_id = args[2]
-                    if not isinstance( container_id, str):
-                        raise cherrypy.HTTPError(status=400, message='Invalid parameters Bad Request')
+                    app_name = args[2]
                     # describe container for a desktop
                     # /API/manager/desktop/hermes-8a49ca1a-fcc6-4b7b-960f-5a27debd4773/container/container_id
-                    container = oc.od.composer.describe_container( desktop_name, container=container_id )
+                    container = oc.od.composer.describe_application_byname( desktop_name, app_name=app_name )
                     return container
 
                 if len(args)==4 and args[3]=="resources_usage":

oc/od/composer.py

@@ -225,17 +225,28 @@ def list_container_byname( desktop_name:str ):
         raise ODError( status=404, message='desktop not found')
     return myOrchestrator.listContainerApps(authinfo, userinfo, myDesktop, services.apps )
 
+
+def list_applications_by_name_and_type( desktop_name:str, type_of_application:str ):
+    myOrchestrator = selectOrchestrator()    
+    (authinfo, userinfo, myDesktop) = myOrchestrator.find_userinfo_authinfo_desktop_by_desktop_name( name=desktop_name )
+    if not isinstance( myDesktop, oc.od.desktop.ODDesktop) :
+        raise ODError( status=404, message='desktop not found')
+    if not isinstance( authinfo, AuthInfo) or not isinstance( userinfo, AuthUser) :
+        raise ODError( status=404, message='desktop not found')
+    return myOrchestrator.list_application_by_type_of_application(authinfo, userinfo, myDesktop, type_of_application, services.apps )
+
 def describe_desktop_byname( desktop_name:str ):
     myOrchestrator = selectOrchestrator()    
     myPod = myOrchestrator.describe_desktop_byname( desktop_name )
     if not isinstance( myPod, dict ):
         raise ODError( status=404, message='desktop not found')
     return myPod
 
-def describe_container_byname( desktop_name:str , container_id:str ):
-    myOrchestrator = selectOrchestrator()    
-    container = myOrchestrator.describe_container( desktop_name, container_id )
-    return container
+def describe_application_byname( desktop_name:str, app_name:str ):
+    myOrchestrator = selectOrchestrator()
+    (authinfo, userinfo) = myOrchestrator.find_userinfo_authinfo_by_desktop_name( name=desktop_name )
+    description = myOrchestrator.describe_application( authinfo, userinfo, desktop_name, app_name )
+    return description
 
 def remove_container_byname(desktop_name:str, container:str):
     myOrchestrator = selectOrchestrator()    
@@ -420,7 +431,7 @@ def prepareressources( authinfo: AuthInfo, userinfo: AuthUser ):
     myOrchestrator.prepareressources( authinfo=authinfo, userinfo=userinfo )
 
 
-def stopContainerApp(authinfo: AuthInfo, userinfo: AuthUser, podname:str, containerid:str):
+def stopContainerApp(authinfo: AuthInfo, userinfo: AuthUser, podname:str, app_name:str):
     """stop container application if the container belongs to the user 
     Args:
         authinfo (AuthInfo): authentification data
@@ -444,7 +455,7 @@ def stopContainerApp(authinfo: AuthInfo, userinfo: AuthUser, podname:str, contai
         services.fail2ban.fail_login( userinfo.userid )
         raise ODError( status=401, message='stopcontainer::invalid user')
 
-    result = myOrchestrator.stopContainerApp( authinfo, userinfo, podname, containerid )
+    result = myOrchestrator.stopContainerApp( authinfo, userinfo, podname, app_name )
     return result
 
 

oc/od/orchestrator.py

@@ -638,9 +638,6 @@ def is_instance_app( self, appinstance ):
     def execwaitincontainer( self, desktop, command, timeout=1000):
         raise NotImplementedError(f"{type(self)}.removedesktop")
 
-    def getappinstance( self, authinfo, userinfo, app ):        
-        raise NotImplementedError(f"{type(self)}.getappinstance")
-
     def get_auth_env_dict( self, authinfo, userinfo  ):
         return {}
 
@@ -2423,6 +2420,21 @@ def countRunningAppforUser( self, authinfo:AuthInfo, userinfo:AuthUser, myDeskto
             count += len( myappinstance.list(authinfo, userinfo, myDesktop ) )
         return count
 
+
+    def list_application_by_type_of_application( self, authinfo:AuthInfo, userinfo:AuthUser, myDesktop:ODDesktop, application_type:str, apps:ODApps=None ):
+        assert isinstance(authinfo, AuthInfo),   f"authinfo has invalid type {type(authinfo)}"
+        assert isinstance(userinfo, AuthUser),   f"userinfo has invalid type {type(userinfo)}"
+        assert isinstance(myDesktop, ODDesktop), f"myDesktop has invalid type {type(myDesktop)}"
+        self.logger.debug('')
+        list_apps = []
+        if application_type == self.pod_application :
+            myappinstance = ODAppInstanceKubernetesPod( self )
+            list_apps += myappinstance.list(authinfo, userinfo, myDesktop, phase_filter=self.all_phases_status, apps=apps)
+        if application_type == self.ephemeral_container :
+            myappinstance = ODAppInstanceKubernetesEphemeralContainer( self )
+            list_apps += myappinstance.list(authinfo, userinfo, myDesktop, phase_filter=self.all_phases_status, apps=apps)
+        return list_apps
+
     def listContainerApps( self, authinfo:AuthInfo, userinfo:AuthUser, myDesktop:ODDesktop, apps:ODApps=None ):
         """listContainerApps
 
@@ -2491,40 +2503,41 @@ def getAppInstanceKubernetes( self, authinfo:AuthInfo, userinfo:AuthUser, pod_na
 
         return myappinstance
 
-    def logContainerApp( self, authinfo:AuthInfo, userinfo:AuthUser, pod_name:str, containerid:str):
+    def logContainerApp( self, authinfo:AuthInfo, userinfo:AuthUser, pod_name:str, app_name:str):
         assert isinstance(pod_name, str), f"podname has invalid type {type(pod_name)}"
         log_app = None
-        myappinstance = self.getAppInstanceKubernetes(authinfo, userinfo, pod_name, containerid)
+        myappinstance = self.getAppInstanceKubernetes(authinfo, userinfo, pod_name, app_name)
         if isinstance( myappinstance, ODAppInstanceBase ):
-            log_app = myappinstance.logContainerApp(pod_name, containerid)
+            log_app = myappinstance.logContainerApp(pod_name, app_name)
         return log_app
 
-    def envContainerApp( self, authinfo:AuthInfo, userinfo:AuthUser, pod_name:str, containerid:str):
+    def envContainerApp( self, authinfo:AuthInfo, userinfo:AuthUser, pod_name:str, app_name:str):
         assert isinstance(pod_name, str), f"podname has invalid type {type(pod_name)}"
         env_result = None
-        myappinstance = self.getAppInstanceKubernetes(authinfo, userinfo, pod_name, containerid)
+        myappinstance = self.getAppInstanceKubernetes(authinfo, userinfo, pod_name, app_name)
         if isinstance( myappinstance, ODAppInstanceBase ):
-            env_result = myappinstance.envContainerApp(authinfo, userinfo, pod_name, containerid)
+            env_result = myappinstance.envContainerApp(authinfo, userinfo, pod_name, app_name)
         return env_result
 
-    def stopContainerApp( self, authinfo:AuthInfo, userinfo:AuthUser, pod_name:str, containerid:str)->bool:
+    def stopContainerApp( self, authinfo:AuthInfo, userinfo:AuthUser, pod_name:str, app_name:str)->bool:
         assert isinstance(pod_name, str), f"podname has invalid type {type(pod_name)}"
         stop_result = None
-        myappinstance = self.getAppInstanceKubernetes(authinfo, userinfo, pod_name, containerid)
+        myappinstance = self.getAppInstanceKubernetes(authinfo, userinfo, pod_name, app_name)
         if isinstance( myappinstance, ODAppInstanceBase ):
-            stop_result = myappinstance.stop(pod_name, containerid)
+            stop_result = myappinstance.stop(pod_name, app_name)
         return stop_result
 
-    def removeContainerApp( self, authinfo:AuthInfo, userinfo:AuthUser, pod_name:str, containerid:str):
-        return self.stopContainerApp( authinfo, userinfo, pod_name, containerid)
+    def describe_application( self, authinfo:AuthInfo, userinfo:AuthUser, pod_name:str, app_name:str)->dict:
+        assert isinstance(pod_name, str), f"podname has invalid type {type(pod_name)}"
+        assert isinstance(app_name, str), f"app_name has invalid type {type(app_name)}"
+        app_description = None
+        myappinstance = self.getAppInstanceKubernetes(authinfo, userinfo, pod_name, app_name)
+        if isinstance( myappinstance, ODAppInstanceBase ):
+            app_description = myappinstance.describe(pod_name, app_name)
+        return app_description
 
-    def getappinstance( self, authinfo, userinfo, app ):    
-        self.logger.debug('')
-        for app_class in self.appinstance_classes.values():
-            app_object = app_class( orchestrator=self )
-            appinstance = app_object.findRunningAppInstanceforUserandImage( authinfo, userinfo, app )
-            if app_object.isinstance( appinstance ):
-                return appinstance
+    def removeContainerApp( self, authinfo:AuthInfo, userinfo:AuthUser, pod_name:str, app_name:str)->bool:
+        return self.stopContainerApp( authinfo, userinfo, pod_name, app_name)
 
     """
     def read_configmap( self, name, entry ):
@@ -4452,8 +4465,11 @@ def find_userinfo_authinfo_desktop_by_desktop_name( self, name:str )->tuple:
             # not found
             pass
         return (authinfo,userinfo,myDesktop)
-
+    
     def describe_desktop_byname( self, name:str )->dict:
+        return self.describe_pod_byname( name )
+
+    def describe_pod_byname( self, name:str )->dict:
         """describe_desktop_byname
 
         Args:
@@ -5491,6 +5507,18 @@ def create(self, myDesktop:ODDesktop, app, authinfo:AuthInfo, userinfo:AuthUser=
     return appinstancestatus
     """
 
+    def describe( self, pod_name:str, app_name:str ):
+        description = None
+        pod = self.orchestrator.kubeapi.read_namespaced_pod(namespace=self.orchestrator.namespace,name=pod_name)
+        if  isinstance( pod, V1Pod ) and \
+            isinstance( pod.spec, V1PodSpec ) and \
+            isinstance( pod.spec.ephemeral_containers, list):
+                for c in pod.spec.ephemeral_containers:
+                    if isinstance( c, V1EphemeralContainer ) :
+                        if c.name == app_name:
+                            description = c.to_dict()
+                            break
+        return description
 
     def findRunningAppInstanceforUserandImage( self, authinfo:AuthInfo, userinfo:AuthUser, app):
         self.logger.debug('')
@@ -5561,6 +5589,9 @@ def get_nodeSelector( self ):
         nodeSelector = oc.od.settings.desktop_pod.get(self.type, {}).get('nodeSelector',{})
         return nodeSelector
 
+    def describe( self, pod_name:str, app_name:str ):
+        return self.orchestrator.describe_pod_byname( app_name )
+    
     def get_appnodeSelector( self, authinfo:AuthInfo, userinfo:AuthUser,  app:dict ):
         """get_appnodeSelector
             get the node selector merged data from