5g emerge

.gitignore

@@ -41,3 +41,5 @@ downloads/*
 
 .clj-kondo
 test-reports/
+docs/5g-emerge/ETSI-MEC/submitted/5G-EMERGE_P2_TN_2.3.2\ Compliance_of_the_orchestration_software\ v06-pre-release.md
+docs/5g-emerge/ETSI-MEC/submitted/5G-EMERGE_P2_TN_2.3.2\ Compliance_of_the_orchestration_software\ v06-pre-release.pdf

README.md

@@ -8,6 +8,24 @@ This repository contains the code and configuration for the Nuvla API
 server, packaged as a Docker container.  The API is inspired by the
 CIMI specification from DMTF.
 
+## MEC Orchestrator (MEO) Positioning
+
+The Nuvla API Server functions as a **MEC Orchestrator (MEO)** as defined in 
+[ETSI GS MEC 003](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/003/). 
+It provides system-level orchestration for edge applications across distributed 
+Multi-access Edge Computing (MEC) infrastructure.
+
+**Key MEC Capabilities:**
+- **System Orchestration** - Multi-host application lifecycle management
+- **Application Package Management** - On-boarding, validation, and distribution
+- **Resource Management** - Placement decisions and infrastructure coordination
+- **Standard Interfaces** - MEC-compliant APIs (Mm2, Mm3, Mm5, Mm9)
+
+For detailed MEC architecture mapping and implementation documentation, see:
+- [MEC 003 Architectural Mapping](docs/5g-emerge/MEC-003-architectural-mapping.md)
+- [MEC Terminology Guide](docs/5g-emerge/MEC-terminology-guide.md)
+- [MEC Implementation Plans](docs/5g-emerge/)
+
 ## Artifacts
 
  - `nuvla/api:<version>`. A Docker container that can be obtained from

code/project.clj

@@ -95,9 +95,10 @@
                              [org.clojars.konstan/kinsky-test-jar ~kinsky-version]]}
 
    :test     {:dependencies      [[me.raynes/fs "1.4.6"]
-                                  [org.testcontainers/testcontainers "1.20.4"]
+                                  [org.testcontainers/testcontainers "1.21.4"]
                                   [peridot "0.5.4"]
                                   [clj-test-containers "0.7.4"]
+                                  [ring/ring-jetty-adapter "1.12.2"]
                                   [org.clojure/test.check "1.1.1"]
                                   [com.cemerick/url "0.1.1"]
                                   [org.clojars.konstan/kinsky-test-jar ~kinsky-version]

code/src/com/sixsq/nuvla/server/app/routes.clj

@@ -4,6 +4,7 @@
     [com.sixsq.nuvla.server.resources.common.crud :as crud]
     [com.sixsq.nuvla.server.resources.common.dynamic-load :as dyn]
     [com.sixsq.nuvla.server.resources.common.event-context :as ec]
+    [com.sixsq.nuvla.server.resources.mec :as mec]
     [com.sixsq.nuvla.server.util.response :as r]
     [compojure.core :refer [ANY DELETE GET let-routes OPTIONS PATCH POST PUT routes]]
     [compojure.route :as route]
@@ -87,6 +88,7 @@
    classpath."
   []
   (apply routes (doall (concat [cors-preflight-check-route
-                                (route/resources (str p/service-context "static"))]
+                                (route/resources (str p/service-context "static"))
+                                mec/routes]
                                (dyn/resource-routes)
                                final-routes))))

code/src/com/sixsq/nuvla/server/app/server.clj

@@ -153,3 +153,5 @@
       (reset! server-stop-fn nil)
       (println "stopped"))
     (println "Server not started")))
+
+

code/src/com/sixsq/nuvla/server/resources/common/dynamic_load.clj

@@ -17,6 +17,16 @@
       (not (.contains ns-name "test"))
       sym)))
 
+(defn mec-resource-link?
+  "Returns the namespace symbol for nested MEC resource collections that should
+   be exposed in the cloud-entry-point collections list."
+  [sym]
+  (let [ns-name (name sym)]
+    (and
+      (re-matches #"^com\.sixsq\.nuvla\.server\.resources\.mec\.[\w-]+$" ns-name)
+      (not (.contains ns-name "test"))
+      sym)))
+
 
 (defn resource-namespaces
   "Returns sequence of the resource namespaces on the classpath."
@@ -29,8 +39,9 @@
    keyword associated with the relative URL for the resource. Function returns
    nil if 'resource-type' cannot be found in the resource."
   [resource-ns]
-  (when-let [vtag (ns-util/resolve "resource-type" resource-ns)]
-    [(keyword (deref vtag)) {:href (deref vtag)}]))
+  (when (ns-util/resolve "query-impl" resource-ns)
+    (when-let [vtag (ns-util/resolve "resource-type" resource-ns)]
+      [(keyword (deref vtag)) {:href (deref vtag)}])))
 
 
 (def ^:private initialize-data-fns (atom []))
@@ -70,7 +81,8 @@
   "Returns a lazy sequence of all of the resource links for resources
    discovered on the classpath."
   []
-  (->> (resource-namespaces)
+  (->> (concat (resource-namespaces)
+               (ns-util/load-filtered-namespaces mec-resource-link?))
        (map get-resource-link)
        (remove nil?)))
 

code/src/com/sixsq/nuvla/server/resources/deployment.clj

@@ -15,6 +15,7 @@ a container orchestration engine.
     [com.sixsq.nuvla.server.resources.deployment.utils :as utils]
     [com.sixsq.nuvla.server.resources.job.interface :as job-interface]
     [com.sixsq.nuvla.server.resources.job.utils :as job-utils]
+    [com.sixsq.nuvla.server.resources.mec.job-notifications :as mec-job-notifications]
     [com.sixsq.nuvla.server.resources.module.utils :as module-utils]
     [com.sixsq.nuvla.server.resources.nuvlabox.status-utils :as nuvlabox-status-utils]
     [com.sixsq.nuvla.server.resources.resource-metadata :as md]
@@ -308,6 +309,8 @@ a container orchestration engine.
           user-rights?   (get-in deployment [:module :content :requires-user-rights])
           data?          (some? (:data deployment))
           execution-mode (:execution-mode deployment)
+          job-attrs      (get-in request [:body :job-attrs])
+          mec-operate?   (= "OPERATE" (:mec-operation-type job-attrs))
           state          (if (= execution-mode "pull") "PENDING" "STARTING")
           new-deployment (-> deployment
                              (assoc :state state)
@@ -318,18 +321,25 @@ a container orchestration engine.
                                                                  user-rights?)
                                                          (auth/current-authentication request))))
                              (edit-deployment request))]
-      (when stopped?
+      ;; A stopped MEC deployment must keep its persisted southbound MM3 app instance id
+      ;; so the subsequent OPERATE->STARTED job can act on the same instance.
+      (when (and stopped? (not mec-operate?))
         (utils/delete-child-resources "deployment-parameter" id))
-      (utils/create-job new-deployment request "start_deployment" execution-mode))
+      (utils/create-job new-deployment request "start_deployment" execution-mode
+                        :job-attrs job-attrs))
     (catch Exception e
       (or (ex-data e) (throw e)))))
 
 (defmethod crud/do-action [resource-type "stop"]
   [{{uuid :uuid} :params body :body :as request}]
   (try
-    (let [deployment     (-> (str resource-type "/" uuid)
-                             (crud/retrieve-by-id-as-admin)
-                             (u/throw-cannot-do-action-invalid-state utils/can-stop? "stop"))
+    (let [deployment-id   (str resource-type "/" uuid)
+          job-attrs       (:job-attrs body)
+          mec-terminate?  (= "TERMINATE" (:mec-operation-type job-attrs))
+          deployment0     (crud/retrieve-by-id-as-admin deployment-id)
+          deployment      (if (and mec-terminate? (= "STOPPED" (:state deployment0)))
+                            deployment0
+                            (u/throw-cannot-do-action-invalid-state deployment0 utils/can-stop? "stop"))
           execution-mode (:execution-mode deployment)
           params         (cond-> {}
                                  (:delete body) (assoc :delete true)
@@ -338,7 +348,9 @@ a container orchestration engine.
       (-> deployment
           (assoc :state "STOPPING")
           (edit-deployment request)
-          (utils/create-job request "stop_deployment" execution-mode :payload params)))
+          (utils/create-job request "stop_deployment" execution-mode
+                            :payload params
+                            :job-attrs job-attrs)))
     (catch Exception e
       (or (ex-data e) (throw e)))))
 
@@ -441,19 +453,48 @@ a container orchestration engine.
   (utils/get-context resource false))
 
 (defmethod job-interface/on-cancel ["deployment" "start_deployment"]
-  [resource]
-  (utils/on-cancel resource))
+  [job]
+  (let [response (utils/on-cancel job)]
+    (mec-job-notifications/dispatch-mec-job-finalization! job)
+    response))
 
 (defmethod job-interface/on-cancel ["deployment" "update_deployment"]
-  [resource]
-  (utils/on-cancel resource))
+  [job]
+  (let [response (utils/on-cancel job)]
+    (mec-job-notifications/dispatch-mec-job-finalization! job)
+    response))
 
 (defmethod job-interface/on-cancel ["deployment" "stop_deployment"]
-  [resource]
-  (utils/on-cancel resource))
+  [job]
+  (let [response (utils/on-cancel job)]
+    (mec-job-notifications/dispatch-mec-job-finalization! job)
+    response))
+
+(defmethod job-interface/on-timeout ["deployment" "start_deployment"]
+  [job]
+  (let [response (utils/on-cancel job)]
+    (mec-job-notifications/dispatch-mec-job-finalization! job)
+    response))
+
+(defmethod job-interface/on-timeout ["deployment" "update_deployment"]
+  [job]
+  (let [response (utils/on-cancel job)]
+    (mec-job-notifications/dispatch-mec-job-finalization! job)
+    response))
+
+(defmethod job-interface/on-timeout ["deployment" "stop_deployment"]
+  [job]
+  (let [response (utils/on-cancel job)]
+    (mec-job-notifications/dispatch-mec-job-finalization! job)
+    response))
+
+(defmethod job-interface/on-done ["deployment" "start_deployment"]
+  [job]
+  (mec-job-notifications/dispatch-mec-job-finalization! job))
 
 (defmethod job-interface/on-done ["deployment" "stop_deployment"]
-  [{:keys [target-resource state payload] :as _job}]
+  [{:keys [target-resource state payload] :as job}]
+  (mec-job-notifications/dispatch-mec-job-finalization! job)
   (when-let [deployment (and (= state job-utils/state-success)
                              (-> payload j/read-value (get "delete" false))
                              (some-> target-resource :href crud/retrieve-by-id-as-admin))]

code/src/com/sixsq/nuvla/server/resources/deployment/utils.clj

@@ -112,7 +112,7 @@
 
 (defn create-job
   [{:keys [id nuvlabox deployment-set] :as resource} request action execution-mode
-   & {:keys [payload]}]
+   & {:keys [payload job-attrs]}]
   (a/throw-cannot-manage resource request)
   (let [active-claim (auth/current-active-claim request)
         low-priority (get-in request [:body :low-priority] false)
@@ -131,7 +131,8 @@
                                        :parent-job parent-job
                                        :priority (if low-priority 999 50)
                                        :execution-mode execution-mode
-                                       :payload (when (seq payload) (j/write-value-as-string payload)))
+                                       :payload (when (seq payload) (j/write-value-as-string payload))
+                                       :job-attrs job-attrs)
         job-msg      (str action " " id " with async " job-id)]
     (when (not= job-status 201)
       (throw (r/ex-response

code/src/com/sixsq/nuvla/server/resources/job/utils.clj

@@ -126,7 +126,7 @@
 (defn create-job
   [target-resource action acl created-by & {:keys [priority affected-resources
                                                    execution-mode payload
-                                                   parent-job]}]
+                                                   parent-job job-attrs]}]
   (let [job-map        (cond-> {:action          action
                                 :target-resource {:href target-resource}
                                 :acl             acl
@@ -135,7 +135,8 @@
                                parent-job (assoc :parent-job parent-job)
                                affected-resources (assoc :affected-resources affected-resources)
                                execution-mode (assoc :execution-mode execution-mode)
-                               payload (assoc :payload payload))
+                               payload (assoc :payload payload)
+                               (seq job-attrs) (merge job-attrs))
         create-request {:params      {:resource-name "job"}
                         :body        job-map
                         :nuvla/authn auth/internal-identity}]