Refactor agent followup (#700)

* Add some in-depth documentation about the discovery handler registry Signed-off-by: Nicolas Belouin <[email protected]> * Remove mentions of crictl dependency New slot reconciliation system doesn't need crictl anymore, removing everything related to that Signed-off-by: Nicolas Belouin <[email protected]> * Apply suggestions from code review Signed-off-by: Kate Goldenring <[email protected]> Signed-off-by: Nicolas Belouin <[email protected]> Co-authored-by: Kate Goldenring <[email protected]> * Update patch version Signed-off-by: Nicolas Belouin <[email protected]> * Fix version.sh to account for CRD version not always first item in dict Signed-off-by: Nicolas Belouin <[email protected]> --------- Signed-off-by: Nicolas Belouin <[email protected]> Co-authored-by: Kate Goldenring <[email protected]>
project-akri · Sep 4, 2024 · 7c8242a · 7c8242a
1 parent 3050186
commit 7c8242a
Show file tree

Hide file tree

Showing 27 changed files with 116 additions and 105 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/agent/Cargo.toml b/agent/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "agent"
-version = "0.13.1"
+version = "0.13.2"
 license = "Apache-2.0"
 authors = ["Kate Goldenring <[email protected]>", "<[email protected]>"]
 edition = "2021"
@@ -35,6 +35,7 @@ serde = "1.0.104"
 serde_derive = "1.0.104"
 serde_json = "1.0.45"
 serde_yaml = { version = "0.8.11", optional = true }
+simple-mermaid = "0.1" # used for docs
 thiserror = "1.0.50"
 tokio = { version = "1.0", features = ["rt-multi-thread", "time", "fs", "macros", "net"] }
 tokio-stream = { version =  "0.1", features = ["net", "sync"] }
@@ -65,4 +66,4 @@ default = []
 onvif-feat = [ "akri-onvif"]
 opcua-feat = ["akri-opcua"]
 udev-feat = ["akri-udev"]
-agent-full = ["serde_yaml", "akri-debug-echo"]
+agent-full = ["serde_yaml", "akri-debug-echo"]
diff --git a/agent/src/discovery_handler_manager/diagrams/dh_device.mmd b/agent/src/discovery_handler_manager/diagrams/dh_device.mmd
@@ -0,0 +1,14 @@
+sequenceDiagram
+    Discovery Handler ->> DiscoveryHandlerRequest: send discovered devices
+    DiscoveryHandlerRequest ->> DiscoveryHandlerRequest: Updates aggregated list of discovered devices
+    DiscoveryHandlerRequest -) Device Manager: Notifies and updates list of discovered devices
+    DiscoveryHandlerRequest -) Configuration Controller: Requests reconciliation of Configuration linked to Request
+    note over Configuration Controller: The following is Configuration Controller behavior
+    activate Configuration Controller
+    Configuration Controller ->> Configuration Controller: Reconcile Configuration
+    Configuration Controller ->> DiscoveryHandlerRegistry: get_request()
+    DiscoveryHandlerRegistry ->> Configuration Controller: 
+    Configuration Controller ->> DiscoveryHandlerRequest: get_instances()
+    DiscoveryHandlerRequest ->> Configuration Controller: Returns list of discovered devices as bare Instances
+    Configuration Controller ->> Kubernetes API: Apply Instances
+    deactivate Configuration Controller
diff --git a/agent/src/discovery_handler_manager/diagrams/dh_query.mmd b/agent/src/discovery_handler_manager/diagrams/dh_query.mmd
@@ -0,0 +1,18 @@
+sequenceDiagram
+    Configuration Controller -) DiscoveryHandlerRegistry: new_request()
+    alt a Handler exists for the Request
+        DiscoveryHandlerRegistry ->> DiscoveryHandlerRequest: Creates with filtered list of endpoints
+        DiscoveryHandlerRegistry ->> DiscoveryHandlerRegistry: Add request to tracked request list
+        loop over DiscoveryHandlerEndpoints with this name
+            DiscoveryHandlerRequest ->>+ Kubernetes API: Solve discovery properties
+            Kubernetes API ->>- DiscoveryHandlerRequest: 
+            DiscoveryHandlerRequest ->>+ Discovery Handler: query discovery handler
+            loop 
+                Discovery Handler ->> DiscoveryHandlerRequest: send discovered devices
+                note over DiscoveryHandlerRequest,DiscoveryHandlerRegistry: See other diagram for what happens here
+            end
+            deactivate Discovery Handler
+        end
+    else
+        DiscoveryHandlerRegistry -x Configuration Controller: DiscoveryError::NoHandler
+    end
diff --git a/agent/src/discovery_handler_manager/diagrams/dh_registration.mmd b/agent/src/discovery_handler_manager/diagrams/dh_registration.mmd
@@ -0,0 +1,20 @@
+sequenceDiagram
+    Discovery Handler ->> Registration endpoint: Registers
+    Registration endpoint->> DiscoveryHandlerRegistry: register_endpoint()
+    DiscoveryHandlerRegistry ->> DiscoveryHandlerRegistry: Add endpoint to registered handlers list
+    DiscoveryHandlerRegistry ->> DiscoveryHandlerRequest: notify all DiscoveryHandlerRequest
+    alt Discovery Handler name is the same as in Request
+        DiscoveryHandlerRequest ->>+ Kubernetes API: Solve discovery properties
+        Kubernetes API ->>- DiscoveryHandlerRequest: 
+        DiscoveryHandlerRequest ->>+ Discovery Handler: query discovery handler
+        loop 
+            Discovery Handler ->> DiscoveryHandlerRequest: send discovered devices
+            note over DiscoveryHandlerRequest,DiscoveryHandlerRegistry: See other diagram for what happens here
+        end
+        deactivate Discovery Handler
+    end
+    break on Discovery Handler connection error
+        Registration endpoint -x DiscoveryHandlerRegistry: close endpoint
+        DiscoveryHandlerRegistry ->> DiscoveryHandlerRegistry: Remove endpoint from registered handlers list
+        note over DiscoveryHandlerRequest,Discovery Handler: The DiscoveryHandlerRequest request will handle termination by itself
+    end
diff --git a/agent/src/discovery_handler_manager/discovery_handler_registry.rs b/agent/src/discovery_handler_manager/discovery_handler_registry.rs
@@ -1,3 +1,22 @@
+//! This module is the heart of the discovery process handled by the agent, it is based around the [DiscoveryHandlerRegistry]
+//! and uses several other structure to represent and help handle discovery related operations.
+//!
+//! The [DiscoveryHandlerRegistry] keeps track of registered discovery handlers. Note, multiple endpoints/instances of a given
+//! handler can be registered at the same time.
+//!
+//! The [DiscoveryHandlerRegistry] also keeps track of ongoing discovery requests against those discovery handlers. There is one discovery request (a [DiscoveryHandlerRequest] object) per Configuration.
+//!   
+//! Here are some simple diagrams showing how the components interact with each other in different situations:
+//!   
+//! A new DiscoverHandler gets registered (after it connects to and registers with the agent registration Unix socket):
+#![doc=simple_mermaid::mermaid!("diagrams/dh_registration.mmd")]
+//!
+//! A new query is made by the Configuration Controller:
+#![doc=simple_mermaid::mermaid!("diagrams/dh_query.mmd")]
+//!
+//! A Discovery Handler's instance/endpoint sends a new list of discovered devices for a Request:
+#![doc=simple_mermaid::mermaid!("diagrams/dh_device.mmd")]
+
 use std::collections::HashMap;
 use std::sync::Arc;
 

diff --git a/build/containers/Dockerfile.rust b/build/containers/Dockerfile.rust
@@ -24,10 +24,7 @@ ARG AKRI_COMPONENT
 RUN PROFILE=$(echo "${EXTRA_CARGO_ARGS}" | grep -q -- --release && echo "release" || echo "debug"); \
     xx-verify ./target/$(xx-cargo --print-target-triple)/${PROFILE}/${AKRI_COMPONENT}\ 
     && cp ./target/$(xx-cargo --print-target-triple)/${PROFILE}/${AKRI_COMPONENT} /build/bin/akri
-# Prepare crictl for agent
-RUN VERSION=v1.25.0; if [ "x${AKRI_COMPONENT}" = "xagent" ]; then wget \ 
-    "https://github.com/kubernetes-sigs/cri-tools/releases/download/$VERSION/crictl-$VERSION-linux-$(xx-info arch).tar.gz" -O crictl.tar.gz\ 
-    && tar zxvf crictl.tar.gz -C /build/bin; fi
+
 
 
 FROM scratch

diff --git a/controller/Cargo.toml b/controller/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "controller"
-version = "0.13.1"
+version = "0.13.2"
 license = "Apache-2.0"
 authors = ["<[email protected]>", "<[email protected]>"]
 edition = "2021"

diff --git a/deployment/helm/Chart.yaml b/deployment/helm/Chart.yaml
@@ -16,9 +16,9 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.13.1
+version: 0.13.2
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
-appVersion: 0.13.1
+appVersion: 0.13.2
diff --git a/deployment/helm/templates/agent.yaml b/deployment/helm/templates/agent.yaml
@@ -67,12 +67,6 @@ spec:
           - name: DEBUG_ECHO_INSTANCES_SHARED
             value: {{ .Values.debugEcho.configuration.shared | quote }}
           {{- end }}
-          - name: HOST_CRICTL_PATH
-            value: /usr/local/bin/crictl
-          - name: HOST_RUNTIME_ENDPOINT
-            value: unix:///host/run/containerd/containerd.sock
-          - name: HOST_IMAGE_ENDPOINT
-            value: unix:///host/run/containerd/containerd.sock
           - name: AGENT_NODE_NAME
             valueFrom:
               fieldRef:
@@ -86,8 +80,6 @@ spec:
             mountPath: /var/lib/kubelet/device-plugins
           - name: pod-resources
             mountPath: /var/lib/kubelet/pod-resources
-          - name: var-run-dockershim
-            mountPath: /host/run/containerd/containerd.sock
           {{- if .Values.agent.host.udev }}
           - name: devices
             mountPath: /run/udev
@@ -111,23 +103,6 @@ spec:
       - name: pod-resources
         hostPath:
           path: "{{ .Values.agent.host.kubeletPodResources }}"
-      - name: var-run-dockershim
-        hostPath:
-          {{- if ne "" .Values.agent.host.containerRuntimeSocket }}
-          path: {{.Values.agent.host.containerRuntimeSocket }}
-          {{- else if eq .Values.kubernetesDistro "microk8s" }}
-          path: "/var/snap/microk8s/common/run/containerd.sock"
-          {{- else if eq .Values.kubernetesDistro "k3s" }}
-          path: "/run/k3s/containerd/containerd.sock"
-          {{- else if eq .Values.kubernetesDistro "k8s" }}
-          path: "/run/containerd/containerd.sock"
-          {{- else }}
-          # Please set container runtime socket by either selecting the appropriate K8s distro `kubernetesDistro=<k8s|k3s|microk8s>` 
-          # or setting `agent.host.containerRuntimeSocket=/container/runtime.sock`. 
-          # See https://docs.akri.sh/user-guide/cluster-setup for more information.
-          # Using K8s default "/run/containerd/containerd.sock" for now.
-          path: "/run/containerd/containerd.sock"
-          {{- end }}
       {{- if .Values.agent.host.udev }}
       - name: devices
         hostPath:

diff --git a/deployment/helm/values.yaml b/deployment/helm/values.yaml
@@ -16,10 +16,6 @@ useDevelopmentContainers: true
 # This can be set from the helm command line using `--set imagePullSecrets[0].name="mysecret"`
 imagePullSecrets: []
 
-# kubernetesDistro describes the Kubernetes distro Akri is running on. It is used to conditionally set
-# distribution specific values such as container runtime socket. Options: microk8s | k3s | k8s
-kubernetesDistro: ""
-
 # generalize references to `apiGroups` and `apiVersion` values for Akri CRDs
 crds:
   group: akri.sh
@@ -109,11 +105,6 @@ agent:
     kubeletDevicePlugins: /var/lib/kubelet/device-plugins
     # kubeletPodResources is the location of the kubelet pod-resources socket
     kubeletPodResources: /var/lib/kubelet/pod-resources
-    # containerRuntimeSocket is the default node path of the container runtime socket. 
-    # For MicroK8s, set to "/var/snap/microk8s/common/run/containerd.sock"
-    # For K3s, set to "/run/k3s/containerd/containerd.sock"
-    # For standard K8s, set to "/run/containerd/containerd.sock"
-    containerRuntimeSocket: ""
     # udev is the node path of udev, usually at `/run/udev`
     udev:
   # allowDebugEcho dictates whether the Akri Agent will allow DebugEcho Configurations

diff --git a/discovery-handler-modules/debug-echo-discovery-handler/Cargo.toml b/discovery-handler-modules/debug-echo-discovery-handler/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "debug-echo-discovery-handler"
-version = "0.13.1"
+version = "0.13.2"
 license = "Apache-2.0"
 authors = ["Kate Goldenring <[email protected]>"]
 edition = "2021"

diff --git a/discovery-handler-modules/onvif-discovery-handler/Cargo.toml b/discovery-handler-modules/onvif-discovery-handler/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "onvif-discovery-handler"
-version = "0.13.1"
+version = "0.13.2"
 license = "Apache-2.0"
 authors = ["Kate Goldenring <[email protected]>"]
 edition = "2021"

diff --git a/discovery-handler-modules/opcua-discovery-handler/Cargo.toml b/discovery-handler-modules/opcua-discovery-handler/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "opcua-discovery-handler"
-version = "0.13.1"
+version = "0.13.2"
 license = "Apache-2.0"
 authors = ["Kate Goldenring <[email protected]>"]
 edition = "2021"

diff --git a/discovery-handler-modules/udev-discovery-handler/Cargo.toml b/discovery-handler-modules/udev-discovery-handler/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "udev-discovery-handler"
-version = "0.13.1"
+version = "0.13.2"
 license = "Apache-2.0"
 authors = ["Kate Goldenring <[email protected]>"]
 edition = "2021"

diff --git a/discovery-handlers/debug-echo/Cargo.toml b/discovery-handlers/debug-echo/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "akri-debug-echo"
-version = "0.13.1"
+version = "0.13.2"
 license = "Apache-2.0"
 authors = ["Kate Goldenring <[email protected]>"]
 edition = "2021"

diff --git a/discovery-handlers/onvif/Cargo.toml b/discovery-handlers/onvif/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "akri-onvif"
-version = "0.13.1"
+version = "0.13.2"
 license = "Apache-2.0"
 authors = ["Kate Goldenring <[email protected]>"]
 edition = "2021"