Skip to content

Commit b843478

Browse files
OstrokrzewOstrokrzew
committed
Add few management requirements
Add the requirements for the `casadm` commands (including the script commands): * remove-core * remove-inactive * detach * try-add Signed-off-by: Slawomir Jankowski <slawomir.jankowski@intel.com>
1 parent 09b7af8 commit b843478

File tree

1 file changed

+134
-0
lines changed

1 file changed

+134
-0
lines changed

‎doc/requirements/management‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
group: Management
3+
---
4+
5+
Management operations allows the user to control and maintain Open CAS.
6+
They are performed from console line with `casadm` management tool.
7+
8+
--------------------------------------------------------------------------------
9+
--------------------------------------------------------------------------------
10+
title: Remove active cache volume with dirty data with flush
11+
id: remove_cache_volume_active_flush
12+
---
13+
14+
While cache volume is active and contains dirty data, the management tool shall
15+
allow to remove cache volume with flush.
16+
17+
--------------------------------------------------------------------------------
18+
--------------------------------------------------------------------------------
19+
title: Interrupt removing active cache volume with dirty data with flush
20+
id: interrupt_removing_cache_volume_active_flush
21+
---
22+
23+
When active cache volume that contains dirty data is removed with flush,
24+
the management tool shall allow to interrupt the removal operation
25+
and the cache volume shall remain its previous state and proper information
26+
shall be displayed.
27+
28+
--------------------------------------------------------------------------------
29+
--------------------------------------------------------------------------------
30+
title: Remove active cache volume with dirty data without flush
31+
id: remove_cache_volume_active_no_flush
32+
---
33+
34+
While cache volume is active and contains dirty data, the management tool shall
35+
not allow to remove cache volume without flush without explicitly specify to do
36+
that by adding _force_ option to command.
37+
38+
--------------------------------------------------------------------------------
39+
--------------------------------------------------------------------------------
40+
title: Disallow to interrupt removing active cache volume with dirty data
41+
without flush
42+
id: interrupt_removing_cache_volume_active_no_flush_disallow
43+
---
44+
45+
When active cache volume that contains dirty data is removed without flush,
46+
the management tool shall not allow to interrupt the removal operation and the
47+
cache volume shall be successfully removed with proper warning about displayed.
48+
49+
--------------------------------------------------------------------------------
50+
--------------------------------------------------------------------------------
51+
title: Detach active cache volume with dirty data with flush
52+
id: detach_cache_volume_active_flush
53+
---
54+
55+
While cache volume is active and contains dirty data, the management tool shall
56+
allow to detach cache volume with flush.
57+
58+
--------------------------------------------------------------------------------
59+
--------------------------------------------------------------------------------
60+
title: Interrupt detaching active cache volume with dirty data with flush
61+
id: interrupt_detaching_cache_volume_active_flush
62+
---
63+
64+
When active cache volume that contains dirty data is detached with flush,
65+
the management tool shall allow to interrupt the detaching operation
66+
and the cache volume shall remain its previous state and proper information
67+
shall be displayed.
68+
69+
--------------------------------------------------------------------------------
70+
--------------------------------------------------------------------------------
71+
title: Detach active cache volume with dirty data without flush
72+
id: detach_cache_volume_active_no_flush
73+
---
74+
75+
While cache volume is active and contains dirty data, the management tool shall
76+
not allow to detach cache volume without flush without explicitly specify to do
77+
that by adding _no-flush_ option to command.
78+
79+
--------------------------------------------------------------------------------
80+
--------------------------------------------------------------------------------
81+
title: Disallow to interrupt detaching active cache volume with dirty data
82+
without flush
83+
id: interrupt_detaching_cache_volume_active_no_flush_disallow
84+
---
85+
86+
When active cache volume that contains dirty data is detached without flush,
87+
the management tool shall not allow to interrupt the detaching operation and the
88+
cache volume shall be successfully detached with proper warning about displayed.
89+
90+
--------------------------------------------------------------------------------
91+
--------------------------------------------------------------------------------
92+
title: Remove inactive cache volume with dirty data with flush
93+
id: remove_cache_volume_inactive
94+
---
95+
96+
While cache volume is inactive, the management tool shall allow to remove cache
97+
volume.
98+
99+
--------------------------------------------------------------------------------
100+
--------------------------------------------------------------------------------
101+
title: Disallow to interrupt removing inactive cache volume
102+
id: interrupt_removing_cache_volume_inactive_disallow
103+
---
104+
105+
When inactive cache volume removed, the management tool shall not allow to
106+
interrupt the removal operation and the cache volume shall be successfully
107+
removed.
108+
109+
--------------------------------------------------------------------------------
110+
--------------------------------------------------------------------------------
111+
title: Attach inactive cache volume
112+
id: attach_cache_volume_inactive
113+
---
114+
115+
While cache volume is inactive, the management tool shall allow to attach cache
116+
volume to its cache instance.
117+
118+
--------------------------------------------------------------------------------
119+
--------------------------------------------------------------------------------
120+
title: Attach inactive cache volume to other cache instance
121+
id: attach_cache_volume_inactive_other_cache_instance
122+
---
123+
124+
While cache volume is inactive, the management tool shall allow to attach cache
125+
volume to other than its own cache instance.
126+
127+
--------------------------------------------------------------------------------
128+
--------------------------------------------------------------------------------
129+
title: Disallow to attach active cache volume
130+
id: attach_cache_volume_active_disallow
131+
---
132+
133+
While cache volume is active, the management tool shall not allow to attach
134+
cache volume to any cache instance.

0 commit comments

Comments
 (0)