doc: lifecycle of the CSIAddonsNode

added a document for the lifecycle of the CSIAddonsNode object. Signed-off-by: Madhu Rajanna <[email protected]>
csi-addons · Oct 31, 2024 · 9c7da84 · 9c7da84
1 parent dc55478
commit 9c7da84
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/csiaddonsnode.md b/docs/csiaddonsnode.md
@@ -18,3 +18,7 @@ spec:
   - `name` contains the name of the driver. The name of the driver is in the format: `driver.csi.example.io`
   - `endpoint` contains the URL that contains the name of the Pod and its Namespace that can be used by the controller to connect to.
   - `nodeID` contains the ID of node to identify on which node the side-car is running.
+
+## Lifecycle of CSIAddonsNode CR
+
+The CSIAddonsNode custom resource (CR) is created by the sidecar that runs with the CSI driver. The owner of the CSIAddonsNode CR is the main owner of the sidecar pod, whether it's a DaemonSet or a Deployment. When the sidecar pod is deleted, the CSIAddonsNode CR is not removed; instead, it gets updated with new informations when the pod is recreated. The CSIAddonsNode CR is deleted only when the CSI driver’s Deployment or DaemonSet is deleted.