Add controller docs (#46)

Signed-off-by: Matej Feder <[email protected]>

Author: matofeder

README.md

@@ -149,6 +149,13 @@ kubectl --kubeconfig kubeconfig.yaml get nodes
 
 Refer to the [doc page](./docs/develop.md) to find more information about how to develop this operator.
 
+# Controllers
+
+CSPO consists of two controllers. They should ensure that the desired node images are present in the targeted OpenStack project.
+Refer to the documentation for the CSPO controllers:
+- [OpenStackClusterStackRelease controller](./docs/openstackclusterstackrelease-controller.md)
+- [OpenStackNodeImageRelease controller](./docs/openstacknodeimagerelease-controller.md)
+
 # API Reference
 
 CSPO currently exposes the following APIs:

docs/develop.md

@@ -14,7 +14,7 @@ Next, configure your environment variables. Once that's done, you can initiate d
 
 ## Developing with Tilt
 
-![tilt](./pics/tilt.png "Tilt")
+![tilt](./images/tilt.png "Tilt")
 
 Operator development requires a lot of iteration, and the “build, tag, push, update deployment” workflow can be very tedious. Tilt makes this process much simpler by watching for updates and automatically building and deploying them. To build a kind cluster and to start Tilt, run:
 

docs/images/openstackclusterstackrelease-controller.plantuml

@@ -0,0 +1,46 @@
+@startuml openstack-clusterstack-release-controller
+
+start;
+:OpenStackClusterStackRelease controller;
+
+repeat
+  :OpenStackClusterStackRelease controller enqueues a Reconcile call;
+  :Create GitHub client;
+  if (Release assets have been download into the CSPO container) then (no)
+    #LightBlue:Download Release assets;
+    #Pink:Return RequeueError;
+    note left: make sure that Release can be accessed
+  else (yes)
+  endif
+  :Load list of required NodeImages from downloaded Release assets;
+  repeat
+    #LightBlue:Create OpenStackNodeImageRelease;
+    if (OpenStackNodeImageRelease already exists) then (yes)
+      #LightBlue:Ensure addoption of OpenStackNodeImageRelease \n /OpenStackNodeImageRelease could be shared/;
+    else (no)
+      #LightBlue:Create OpenStackNodeImageRelease;
+    endif
+  repeat while (More NodeImages) is (yes)
+  :List all owned OpenStackNodeImageReleases in namespace;
+  if (No owned OpenStackNodeImageReleases found) then (yes)
+    #Pink:Return RequeueError;
+    note left: waiting for OpenStackNodeImageRelease to be created
+  else (no)
+  endif
+  repeat
+    if (OpenStackNodeImageRelease is ready) then (yes)
+    else (no)
+      #LightBlue:Set OpenStackClusterStackRelease status to not ready;
+      #Pink:Return RequeueError;
+      note left: waiting for OpenStackNodeImageRelease to be ready
+    endif
+  repeat while (More owned OpenStackNodeImageReleases) is (yes)
+  #LightBlue:Set OpenStackClusterStackRelease status to ready;
+repeat while (Reconcile returned RequeueError?) is (yes)
+if (Reconcile returned error) then (yes)
+  #Pink:Error reconciling OpenStackClusterStackRelease;
+else (no)
+endif
+stop;
+
+@enduml

docs/images/openstackclusterstackrelease-controller.png

@@ -0,0 +1,45 @@
+@startuml openstack-nodeimage-release-controller
+
+start;
+:OpenStackNodeImageRelease controller;
+
+repeat
+  :OpenStackNodeImageRelease controller enqueues a Reconcile call;
+  :Load OpenStack Cloud configuration from Secret referenced in spec.IdentityRef;
+  :Create an OpenStack provider client;
+  :Create an OpenStack image service client;
+  if (Is the image specified in spec.Image already part of the OpenStack project?) then (no)
+    #LightBlue: Create an Image based on the spec.Image.CreateOpts;
+    #LightBlue: Import an Image using Glance's web-download method;
+    #Pink:Return RequeueError;
+    note left: make sure that Image has been created
+  else (yes)
+  endif
+  :Get Image details;
+
+  if (Is ImageImportTimeout set?) then (yes)
+    if (Has the Image a non-Active Status, and has the import elapsed time been exceeded?) then (yes)
+      #LightBlue:Image Import Timeout;
+      stop;
+    else (no)
+    endif
+  else (no)
+  endif
+  switch (Image Status?)
+  case ( Active )
+    #LightBlue:Set OpenStackNodeImageRelease status to ready;
+  case ( Deactivated or \n Killed or \n Unknown )
+    #LightBlue:Set OpenStackNodeImageRelease status to not ready;
+  case ( Queued or \n Saving or \n Deleted or \n PendingDelete or \n Importing )
+    #LightBlue:Set OpenStackNodeImageRelease status to not ready;
+    #Pink:Return RequeueError;
+    note left: wait for image to become active
+  endswitch
+repeat while (Reconcile returned RequeueError?) is (yes)
+if (Reconcile returned error) then (yes)
+  #Pink:Error reconciling OpenStackNodeImageRelease;
+else (no)
+endif
+stop;
+
+@enduml

docs/images/openstacknodeimagerelease-controller.plantuml

@@ -0,0 +1,11 @@
+
+# OpenStackClusterStackRelease controller
+
+The OpenStackClusterStackRelease controller’s main responsibilities are:
+
+- Download release assets into the CSPO container
+- Create OpenStackNodeImageRelease resources based on the required NodeImages defined in the downloaded release asset `node-images.yaml`
+- Set an OwnerReference on the existing OpenStackNodeImageRelease resources that could be utilized by the ClusterStack release (multiple versions of one ClusterStack could share an image)
+- Update the OpenStackClusterStackRelease status to `ready` once all related OpenStackNodeImageReleases are also `ready`
+
+![OSCSR controller](./images/openstackclusterstackrelease-controller.png "OSCSR controller")

docs/images/openstacknodeimagerelease-controller.png

@@ -0,0 +1,9 @@
+# OpenStackNodeImageRelease controller
+
+The OpenStackNodeImageRelease controller’s main responsibilities are:
+- Load the OpenStack Cloud configuration from the Secret referenced in `spec.IdentityRef`
+- Create an Image as defined by `spec.Image` if it does not already exist in the specified OpenStack project
+- Instruct the OpenStack Glance service to import an Image from the provided URL
+- Set the OpenStackNodeImageRelease status to `ready` once the image achieves an Active status
+
+![OSNIR controller](./images/openstacknodeimagerelease-controller.png "OSNIR controller")