Skip to content

Commit 53fdc5d

Browse files
author
Shubhendu
committed
Added UI impact details to specification
tendrl-bug-id: #252 Signed-off-by: Shubhendu <shtripat@redhat.com>
1 parent eafcc91 commit 53fdc5d

File tree

1 file changed

+82
-9
lines changed

1 file changed

+82
-9
lines changed

specs/unmanage_cluster.adoc

Lines changed: 82 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ monitoring etc to be performed for that period.
1414

1515
There are situations when admin needs some critical maintenance of the cluster
1616
and during this period he doesn't want any monitoring etc taking place. Also
17-
of he decides to dismantle the cluster at some stage we should have a mechsnism
17+
if he decides to dismantle the cluster at some stage we should have a mechanism
1818
using which the cluster could be marked as un-managed from tendrl side.
1919

2020
Tendrl also should provide a provision to re-import the cluster at later stage
@@ -57,13 +57,13 @@ The logic here goes like
5757
** Start a flow in node-agent on tendrl server node for un-manage cluster
5858

5959
** The first atom of the above flow invokes child jobs on the storage node's
60-
node-agent to stop tendrl specific services and marking them dissabled
60+
node-agent to stop tendrl specific services and marking them disabled
6161

6262
** In the main atom of the un-manage cluster flow remove if any etcd details for
6363
the cluster and then mark the cluster is_managed flag as `False`
6464

6565
** One of the atoms now un-manage cluster flow, invokes a flow in
66-
monitoring-integration to archive the graphite data for the cluser
66+
monitoring-integration to archive the graphite data for the cluster
6767

6868
** Finally another atom invokes a flow in monitoring-integration to remove the
6969
grafana alert dashboards for the cluster and its dependent entities
@@ -103,7 +103,7 @@ None
103103
==== Tendrl API impact:
104104

105105
* Introduce an API `cluster/{int-id}/unmanage` for triggering an un-manage
106-
cluster fow
106+
cluster flow
107107

108108
==== Notifications/Monitoring impact:
109109

@@ -117,7 +117,7 @@ for old graphite data etc
117117

118118
==== Tendrl/common impact:
119119

120-
* A flow un-manage cluster to be tergetted at tendrl server node
120+
* A flow un-manage cluster to be targeted at tendrl server node
121121

122122
==== Tendrl/node_agent impact:
123123

@@ -129,16 +129,84 @@ None
129129

130130
==== Tendrl Dashboard impact:
131131

132-
* UX requirements for invoking an un-manage cluster flow for an existing cluster
133-
is captured at https://redhat.invisionapp.com/share/8QCOEVEY9
132+
* Following changes required in UI dashboards based on UX designs mentioned at
133+
https://redhat.invisionapp.com/share/8QCOEVEY9
134+
135+
** Add an option namely `Unmanage` under kebab menu for each successfully
136+
imported and managed cluster
137+
138+
** Add a dialog box which opens up on click event of `Unmanage` option from
139+
kebab menu of the cluster. This dialog box is for confirmation from user to
140+
start un-manage flow for the cluster
141+
142+
===== Workflow
143+
144+
* User clicks the `Unmanage` option from the kebab menu for a managed cluster
145+
146+
* The click event triggers a dialog box with appropriate message. A sample
147+
message is available at
148+
https://redhat.invisionapp.com/share/8QCOEVEY9#/screens/273239640
149+
150+
* There are 3 possible actions on this dialog
151+
152+
** `Close` icon to close the dialog and no action performed for un-managing the
153+
cluster. User would be directed back to clusters list page
154+
155+
** `Cancel` button to close the dialog and no action performed for un-managing the
156+
cluster. User would be directed back to clusters list page
157+
158+
** `Unmanage` button to start the un-manage cluster task in backend. A message
159+
with task details gets displayed on dialog box. Sample message available at
160+
https://redhat.invisionapp.com/share/8QCOEVEY9#/screens/273239844
161+
162+
** This final message after submission of the task for un-managing cluster would
163+
also provide a button to view the task details. A button `View Task Progress` is
164+
available for the same. User can opt to close this dialog and later user context
165+
menus to check the task updates
166+
167+
** Once a cluster is being moved to un-managed state, the changes in properties
168+
listed for cluster are as below
169+
170+
*** `Import Status` changed to `Unmanaging`
171+
172+
*** `Is Managed` changed to `no`
173+
174+
*** The columns `Volume Profiling`, `Volumes` and `Alerts` would be hidden
175+
176+
*** `View Details` link would be available to check the task details
177+
178+
*** `Dashboard` button would be disabled
179+
180+
*** Kebab menu for the un-managed cluster would be hidden
181+
182+
** Once the un-manage cluster task gets completed a global notification gets
183+
received
184+
185+
** If task was successful, the state of the cluster would be changed to ready to
186+
import
187+
188+
If task failed due to some issues, the cluster details would listed as below in
189+
190+
*** `Import Status` changed to `Unmanage failed`
191+
192+
*** `Is managed` changed to `no`
193+
194+
*** The columns `Volume Profiling`, `Volumes` and `Alerts` would be hidden
195+
196+
*** `View Details` link would be available to check the errors
197+
198+
*** `Dashboard` button would be disabled
199+
200+
*** Kebab menu for the un-managed cluster would be hidden
201+
134202

135203
=== Security impact:
136204

137205
None
138206

139207
=== Other end user impact:
140208

141-
User gets an option to un-mnaage an existing cluster and can re-import at later
209+
User gets an option to un-manage an existing cluster and can re-import at later
142210
stage
143211

144212
=== Performance impact:
@@ -167,6 +235,7 @@ None
167235
Primary assignee:
168236
shtripat
169237
mbukatov
238+
a2batic
170239

171240
=== Work Items:
172241

@@ -179,7 +248,7 @@ None
179248

180249
== Testing:
181250

182-
* Check if UI dashboard has an option to trigget un-manage cluster flow
251+
* Check if UI dashboard has an option to trigger un-manage cluster flow
183252

184253
* Check if the flow gets completed successfully and verify if the grafana
185254
dashboard reflects and cluster details available now for the selected cluster
@@ -224,3 +293,7 @@ clearly mentioned in documents
224293
* https://github.com/Tendrl/commons/pull/798
225294

226295
* https://github.com/Tendrl/monitoring-integration/pull/317
296+
297+
* https://github.com/Tendrl/ui/issues/801
298+
299+
* https://github.com/Tendrl/api/issues/349

0 commit comments

Comments
 (0)