spec for import cluster

specs/import-cluster-view.adoc

@@ -0,0 +1,133 @@
+= Import cluster workflow by using tendrl-frontend UI
+
+The intent of import cluster workflow is to provide a mechanism to add an existing storage cluster(gluster, ceph etc) into tendrl for management using tendrl-frontend UI.
+
+* Assumption: Only 1 cluster can be imported at a time using the Import Cluster workflow.
+
+== Problem description
+
+This specification describes import cluster workflow using UI which is a mechanism to add an existing storage cluster(gluster, ceph etc) into tendrl for management. This specification addresses the import use-cases of both ceph and gluster storage.
+
+== Use Cases
+
+This addresses the use case of importing existing clusters(ceph. gluster etc.) into tendrl for management.
+
+The workflow is as follows:
+
+* "Import Cluster" can be triggered from 
+
+	- Landing page (First Time Experience) if no cluster is present in tendrl
+	  (https://redhat.invisionapp.com/share/6T900V2ZX#/screens/198042644)
+
+	- Cluster List View if minimum one cluster is present in tendrl.
+	  (https://redhat.invisionapp.com/share/BR8JDCGSQ#/screens/185937524)
+
+* User clicks on "Import Cluster". 
+
+* It will take to host list page where user will select the hosts he wants to import.
+  (https://redhat.invisionapp.com/share/6T900V2ZX#/screens/198042641) 
+
+* After selecting the hosts, user will click on "Import" button.
+
+* On success, a successful message will be displayed to user.
+  (https://redhat.invisionapp.com/share/6T900V2ZX#/screens/198651334)
+
+== Proposed change
+
+Front-end related changes:
+
+	* Create views for Landing page (First Time Experience), Import cluster page and page where successful message will be displayed.
+	* Implement client side filer and sorting functionality using angular's filter and orderby components.
+	* Send API call for host list whenevr users click "Refresh" button.
+	* Show total count of hosts which can be imported.
+	* When user clicks on "Import" button, a API call should go backend with the data of hosts(which user selected for importing).
+	* When user clicks on "Cancel" button, the operation should be stopped and user will be landed to - 
+		* Landing page (First Time Experience) if no cluster is present in tendrl.
+		* Cluster List View if minimum one cluster is present in tendrl.
+	* Primary navigation should be hidden until user completes import cluster operation.
+
+
+=== Alternatives
+
+None
+
+=== Data model impact:
+
+=== Impacted Modules:
+
+==== Tendrl API impact:
+
+Not yet decided.
+
+==== Tendrl frontend impact:
+
+   * Needs to add one more routing for import cluster view.
+   * Needs to be update the test case according code changes.
+
+==== Tendrl Backend impact:
+
+This is discussed in a different specification - https://github.com/Tendrl/specifications/issues/54
+
+
+=== Security impact:
+
+None.
+
+=== Other end user impact:
+
+None.
+
+=== Performance impact:
+
+
+None.
+
+=== Other deployer impact:
+
+
+None.
+
+=== Developer impact:
+
+
+None.
+
+
+== Implementation:
+
+
+=== Assignee(s):
+
+
+Primary assignee:
+  kamleshverma1, gnehapk
+
+Other contributors:
+  None
+
+=== Work Items:
+
+https://github.com/Tendrl/tendrl_frontend/issues/63
+
+== Dependencies:
+
+* https://github.com/Tendrl/specifications/issues/54
+
+
+== Testing:
+
+=== Unit tests needs to be tested -
+
+* Should set the initialization properties correct.
+* Should set the details of imported cluster from the view.
+* Should display proper notification message once import cluster workflow initiated.
+
+
+== Documentation impact:
+
+== References:
+
+* https://redhat.invisionapp.com/share/6T900V2ZX#/screens/198042644
+* https://redhat.invisionapp.com/share/BR8JDCGSQ#/screens/185937524
+* https://redhat.invisionapp.com/share/6T900V2ZX#/screens/198042641
+* https://redhat.invisionapp.com/share/6T900V2ZX#/screens/198651334