1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
|
# Copyright (C) 2015-2020 Red Hat, Inc. <http://www.redhat.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
""" Description: Module for gluster brick related helper functions. """
import random
from math import floor
import time
from glusto.core import Glusto as g
from glustolibs.gluster.brickmux_ops import is_brick_mux_enabled
from glustolibs.gluster.gluster_init import restart_glusterd
from glustolibs.gluster.volume_ops import (get_volume_info, get_volume_status)
from glustolibs.gluster.volume_libs import (get_subvols,
get_client_quorum_info,
get_volume_type_info)
from glustolibs.gluster.lib_utils import (get_extended_attributes_info)
def get_all_bricks(mnode, volname):
"""Get list of all the bricks of the specified volume.
Args:
mnode (str): Node on which command has to be executed
volname (str): Name of the volume
Returns:
list: List of all the bricks of the volume on Success.
NoneType: None on failure.
"""
volinfo = get_volume_info(mnode, volname)
if volinfo is None:
g.log.error("Unable to get the volinfo of %s.", volname)
return None
# Get bricks from a volume
all_bricks = []
if 'bricks' in volinfo[volname]:
if 'brick' in volinfo[volname]['bricks']:
for brick in volinfo[volname]['bricks']['brick']:
if 'name' in brick:
all_bricks.append(brick['name'])
else:
g.log.error("brick %s doesn't have the key 'name' "
"for the volume: %s", brick, volname)
return None
return all_bricks
g.log.error("Bricks not found in Bricks section of volume "
"info for the volume %s", volname)
return None
g.log.error("Bricks not found for the volume %s", volname)
return None
def bring_bricks_offline(volname, bricks_list,
bring_bricks_offline_methods=None):
"""Bring the bricks specified in the bricks_list offline.
Args:
volname (str): Name of the volume
bricks_list (list): List of bricks to bring them offline.
Kwargs:
bring_bricks_offline_methods (list): List of methods using which bricks
will be brought offline. The method to bring a brick offline is
randomly selected from the bring_bricks_offline_methods list.
By default all bricks will be brought offline with
'service_kill' method.
Returns:
bool : True on successfully bringing all bricks offline.
False otherwise
"""
if bring_bricks_offline_methods is None:
bring_bricks_offline_methods = ['service_kill']
elif not isinstance(bring_bricks_offline_methods, list):
bring_bricks_offline_methods = [bring_bricks_offline_methods]
if not isinstance(bricks_list, list):
bricks_list = [bricks_list]
node_list = []
for brick in bricks_list:
node, _ = brick.split(":")
node_list.append(node)
if is_brick_mux_enabled(node_list[0]):
_rc = True
failed_to_bring_offline_list = []
for brick in bricks_list:
brick_node, brick_path = brick.split(":")
cmd = ("pgrep glusterfsd")
_, out, _ = g.run(brick_node, cmd)
if len(out.split()) > 1:
cmd = ("ps -eaf | grep glusterfsd | "
" grep %s.%s | grep -o '/var/run/gluster/.*' | "
" awk '{ print $3 }' | grep -v 'awk' "
% (volname, brick_node))
else:
cmd = ("ps -eaf | grep glusterfsd | "
"grep -o '/var/run/gluster.*' | "
" awk '{ print $3 }' | grep -v 'awk'")
_, socket_path, _ = g.run(brick_node, cmd)
uds_path = socket_path.strip()
kill_cmd = ("gf_attach -d %s %s"
% (uds_path, brick_path))
ret, _, _ = g.run(brick_node, kill_cmd)
if ret != 0:
g.log.error("Unable to kill the brick %s", brick)
failed_to_bring_offline_list.append(brick)
_rc = False
if not _rc:
g.log.error("Unable to bring some of the bricks %s offline",
failed_to_bring_offline_list)
return False
g.log.info("All the bricks : %s are brought offline", bricks_list)
return True
_rc = True
failed_to_bring_offline_list = []
for brick in bricks_list:
bring_brick_offline_method = (random.choice
(bring_bricks_offline_methods))
if bring_brick_offline_method == 'service_kill':
brick_node, brick_path = brick.split(":")
brick_path = brick_path.replace("/", "-")
kill_cmd = ("pid=`ps -ef | grep -ve 'grep' | "
"grep -e '%s%s.pid' | awk '{print $2}'` && "
"kill -15 $pid || kill -9 $pid" %
(brick_node, brick_path))
ret, _, _ = g.run(brick_node, kill_cmd)
if ret != 0:
g.log.error("Unable to kill the brick %s", brick)
failed_to_bring_offline_list.append(brick)
_rc = False
else:
g.log.error("Invalid method '%s' to bring brick offline",
bring_brick_offline_method)
return False
if not _rc:
g.log.error("Unable to bring some of the bricks %s offline",
failed_to_bring_offline_list)
return False
g.log.info("All the bricks : %s are brought offline", bricks_list)
return True
def bring_bricks_online(mnode, volname, bricks_list,
bring_bricks_online_methods=None):
"""Bring the bricks specified in the bricks_list online.
Args:
mnode (str): Node on which commands will be executed.
volname (str): Name of the volume.
bricks_list (list): List of bricks to bring them online.
Kwargs:
bring_bricks_online_methods (list): List of methods using which bricks
will be brought online. The method to bring a brick online is
randomly selected from the bring_bricks_online_methods list.
By default all bricks will be brought online with
['glusterd_restart', 'volume_start_force'] methods.
If 'volume_start_force' command is randomly selected then all the
bricks would be started with the command execution. Hence we break
from bringing bricks online individually
Returns:
bool : True on successfully bringing all bricks online.
False otherwise
"""
if bring_bricks_online_methods is None:
bring_bricks_online_methods = ['glusterd_restart',
'volume_start_force']
elif not isinstance(bring_bricks_online_methods, list):
bring_bricks_online_methods = [bring_bricks_online_methods]
g.log.info("Bringing bricks '%s' online with '%s'",
bricks_list, bring_bricks_online_methods)
_rc = True
failed_to_bring_online_list = []
for brick in bricks_list:
bring_brick_online_method = random.choice(bring_bricks_online_methods)
if is_brick_mux_enabled(mnode):
bring_bricks_online_command = ("gluster volume start %s force" %
volname)
ret, _, _ = g.run(mnode, bring_bricks_online_command)
if ret != 0:
g.log.error("Unable to start the volume %s with force option",
volname)
_rc = False
else:
g.log.info("Successfully restarted volume %s to bring all "
"the bricks '%s' online", volname, bricks_list)
elif bring_brick_online_method == 'glusterd_restart':
brick_node, _ = brick.split(":")
ret = restart_glusterd(brick_node)
if not ret:
g.log.error("Unable to restart glusterd on node %s",
brick_node)
_rc = False
failed_to_bring_online_list.append(brick)
else:
g.log.info("Successfully restarted glusterd on node %s to "
"bring back brick %s online", brick_node, brick)
elif bring_brick_online_method == 'volume_start_force':
bring_brick_online_command = ("gluster volume start %s force" %
volname)
ret, _, _ = g.run(mnode, bring_brick_online_command)
if ret != 0:
g.log.error("Unable to start the volume %s with force option",
volname)
_rc = False
else:
g.log.info("Successfully restarted volume %s to bring all "
"the bricks '%s' online", volname, bricks_list)
break
else:
g.log.error("Invalid method '%s' to bring brick online",
bring_brick_online_method)
return False
g.log.info("Waiting for 30 seconds for all the bricks to be online")
time.sleep(30)
return _rc
def are_bricks_offline(mnode, volname, bricks_list):
"""Verify all the specified list of bricks are offline.
Args:
mnode (str): Node on which commands will be executed.
volname (str): Name of the volume.
bricks_list (list): List of bricks to verify offline status.
Returns:
bool : True if all bricks offline. False otherwise.
NoneType: None on failure in getting volume status
"""
_rc = True
online_bricks_list = []
volume_status = get_volume_status(mnode, volname)
if not volume_status:
g.log.error("Unable to check if bricks are offline for the volume %s",
volname)
return None
for brick in bricks_list:
brick_node, brick_path = brick.split(":")
status = int(volume_status[volname][brick_node][brick_path]['status'])
if status != 0:
g.log.error("BRICK : %s is not offline", brick)
online_bricks_list.append(brick)
_rc = False
if not _rc:
g.log.error("Some of the bricks %s are not offline",
online_bricks_list)
return False
g.log.info("All the bricks in %s are offline", bricks_list)
return True
def are_bricks_online(mnode, volname, bricks_list):
"""Verify all the specified list of bricks are online.
Args:
mnode (str): Node on which commands will be executed.
volname (str): Name of the volume.
bricks_list (list): List of bricks to verify online status.
Returns:
bool : True if all bricks online. False otherwise.
NoneType: None on failure in getting volume status
"""
_rc = True
offline_bricks_list = []
volume_status = get_volume_status(mnode, volname)
if not volume_status:
g.log.error("Unable to check if bricks are online for the volume %s",
volname)
return None
for brick in bricks_list:
brick_node, brick_path = brick.split(":")
status = int(volume_status[volname][brick_node][brick_path]['status'])
if status != 1:
g.log.error("BRICK : %s is not online", brick)
offline_bricks_list.append(brick)
_rc = False
if not _rc:
g.log.error("Some of the bricks %s are not online",
offline_bricks_list)
return False
g.log.info("All the bricks %s are online", bricks_list)
return True
def get_offline_bricks_list(mnode, volname):
"""Get list of bricks which are offline.
Args:
mnode (str): Node on which commands will be executed.
volname (str): Name of the volume.
Returns:
list : List of bricks in the volume which are offline.
NoneType: None on failure in getting volume status
"""
offline_bricks_list = []
volume_status = get_volume_status(mnode, volname)
if not volume_status:
g.log.error("Unable to get offline bricks_list for the volume %s",
volname)
return None
bricks_list = get_all_bricks(mnode, volname)
for brick in bricks_list:
brick_node, brick_path = brick.split(":")
status = int(volume_status[volname][brick_node][brick_path]['status'])
if status != 1:
offline_bricks_list.append(brick)
return offline_bricks_list
def get_online_bricks_list(mnode, volname):
"""Get list of bricks which are online.
Args:
mnode (str): Node on which commands will be executed.
volname (str): Name of the volume.
Returns:
list : List of bricks in the volume which are online.
NoneType: None on failure in getting volume status
"""
online_bricks_list = []
volume_status = get_volume_status(mnode, volname)
if not volume_status:
g.log.error("Unable to get online bricks_list for the volume %s",
volname)
return None
bricks_list = get_all_bricks(mnode, volname)
for brick in bricks_list:
brick_node, brick_path = brick.split(":")
try:
status = int(volume_status[volname]
[brick_node][brick_path]['status'])
except KeyError:
continue
if status == 1:
online_bricks_list.append(brick)
return online_bricks_list
def delete_bricks(bricks_list):
"""Deletes list of bricks specified from the brick nodes.
Args:
bricks_list (list): List of bricks to be deleted.
Returns:
bool : True if all the bricks are deleted. False otherwise.
"""
_rc = True
for brick in bricks_list:
brick_node, brick_path = brick.split(":")
_, _, _ = g.run(brick_node, "rm -rf %s" % brick_path)
ret, _, _ = g.run(brick_node, "ls %s" % brick_path)
if ret == 0:
g.log.error("Unable to delete brick %s on node %s",
brick_path, brick_node)
_rc = False
return _rc
def select_bricks_to_bring_offline(mnode, volname):
"""Randomly selects bricks to bring offline without affecting the cluster
Args:
mnode (str): Node on which commands will be executed.
volname (str): Name of the volume.
Returns:
dict: On success returns dict. Value of each key is list of bricks to
bring offline.
If volume doesn't exist returns dict with value of each item
being empty list.
Example:
brick_to_bring_offline = {
'volume_bricks': []
}
"""
# Defaulting the values to empty list
bricks_to_bring_offline = {
'volume_bricks': []
}
volinfo = get_volume_info(mnode, volname)
if volinfo is None:
g.log.error("Unable to get the volume info for volume %s", volname)
return bricks_to_bring_offline
# Select bricks from the volume.
volume_bricks = select_volume_bricks_to_bring_offline(mnode, volname)
bricks_to_bring_offline['volume_bricks'] = volume_bricks
return bricks_to_bring_offline
def select_volume_bricks_to_bring_offline(mnode, volname):
"""Randomly selects bricks to bring offline without affecting the cluster
from a volume.
Args:
mnode (str): Node on which commands will be executed.
volname (str): Name of the volume.
Returns:
list: On success returns list of bricks that can be brough offline.
If volume doesn't exist returns empty list
"""
volume_bricks_to_bring_offline = []
# get volume type
volume_type_info = get_volume_type_info(mnode, volname)
volume_type = volume_type_info['volume_type_info']['typeStr']
# get subvols
subvols_dict = get_subvols(mnode, volname)
volume_subvols = subvols_dict['volume_subvols']
# select bricks from distribute volume
if volume_type == 'Distribute':
volume_bricks_to_bring_offline = []
# select bricks from replicated, distributed-replicated volume
elif (volume_type == 'Replicate' or
volume_type == 'Distributed-Replicate'):
# Get replica count
volume_replica_count = (volume_type_info['volume_type_info']
['replicaCount'])
# Get quorum info
quorum_info = get_client_quorum_info(mnode, volname)
volume_quorum_info = quorum_info['volume_quorum_info']
# Get list of bricks to bring offline
volume_bricks_to_bring_offline = (
get_bricks_to_bring_offline_from_replicated_volume(
volume_subvols, volume_replica_count, volume_quorum_info))
# select bricks from Disperse, Distribured-Disperse volume
elif (volume_type == 'Disperse' or
volume_type == 'Distributed-Disperse'):
# Get redundancy count
volume_redundancy_count = (volume_type_info['volume_type_info']
['redundancyCount'])
# Get list of bricks to bring offline
volume_bricks_to_bring_offline = (
get_bricks_to_bring_offline_from_disperse_volume(
volume_subvols, volume_redundancy_count))
return volume_bricks_to_bring_offline
def get_bricks_to_bring_offline_from_replicated_volume(subvols_list,
replica_count,
quorum_info):
"""Randomly selects bricks to bring offline without affecting the cluster
for a replicated volume.
Args:
subvols_list: list of subvols.
For example:
subvols = volume_libs.get_subvols(mnode, volname)
volume_subvols = subvols_dict['volume_subvols']
replica_count: Replica count of a Replicate or Distributed-Replicate
volume.
quorum_info: dict containing quorum info of the volume. The dict should
have the following info:
- is_quorum_applicable, quorum_type, quorum_count
For example:
quorum_dict = get_client_quorum_info(mnode, volname)
volume_quorum_info = quorum_info['volume_quorum_info']
Returns:
list: List of bricks that can be brought offline without affecting the
cluster. On any failure return empty list.
"""
list_of_bricks_to_bring_offline = []
try:
is_quorum_applicable = quorum_info['is_quorum_applicable']
quorum_type = quorum_info['quorum_type']
quorum_count = quorum_info['quorum_count']
except KeyError:
g.log.error("Unable to get the proper quorum data from quorum info: "
"%s", quorum_info)
return list_of_bricks_to_bring_offline
# offline_bricks_limit: Maximum Number of bricks that can be offline
# without affecting the cluster
if is_quorum_applicable:
if 'fixed' in quorum_type:
if quorum_count is None:
g.log.error("Quorum type is 'fixed' for the volume. But "
"Quorum count not specified. Invalid Quorum")
return list_of_bricks_to_bring_offline
else:
offline_bricks_limit = int(replica_count) - int(quorum_count)
elif 'auto' in quorum_type:
offline_bricks_limit = floor(int(replica_count) // 2)
elif quorum_type is None:
offline_bricks_limit = int(replica_count) - 1
else:
g.log.error("Invalid Quorum Type : %s", quorum_type)
return list_of_bricks_to_bring_offline
for subvol in subvols_list:
random.shuffle(subvol)
# select a random count.
random_count = random.randint(1, offline_bricks_limit)
# select random bricks.
bricks_to_bring_offline = random.sample(subvol, random_count)
# Append the list with selected bricks to bring offline.
list_of_bricks_to_bring_offline.extend(bricks_to_bring_offline)
return list_of_bricks_to_bring_offline
def get_bricks_to_bring_offline_from_disperse_volume(subvols_list,
redundancy_count):
"""Randomly selects bricks to bring offline without affecting the cluster
for a disperse volume.
Args:
subvols_list: list of subvols.
For example:
subvols = volume_libs.get_subvols(mnode, volname)
volume_subvols = subvols_dict['volume_subvols']
redundancy_count: Redundancy count of a Disperse or
Distributed-Disperse volume.
Returns:
list: List of bricks that can be brought offline without affecting the
cluster.On any failure return empty list.
"""
list_of_bricks_to_bring_offline = []
for subvol in subvols_list:
random.shuffle(subvol)
# select a random value from 1 to redundancy_count.
random_count = random.randint(1, int(redundancy_count))
# select random bricks.
bricks_to_bring_offline = random.sample(subvol, random_count)
# Append the list with selected bricks to bring offline.
list_of_bricks_to_bring_offline.extend(bricks_to_bring_offline)
return list_of_bricks_to_bring_offline
def wait_for_bricks_to_be_online(mnode, volname, timeout=300):
"""Waits for the bricks to be online until timeout
Args:
mnode (str): Node on which commands will be executed.
volname (str): Name of the volume.
Kwargs:
timeout (int): timeout value in seconds to wait for bricks to be
online
Returns:
True if all bricks are online within timeout, False otherwise
"""
all_bricks = get_all_bricks(mnode, volname)
if not all_bricks:
return False
counter = 0
flag = 0
while counter < timeout:
status = are_bricks_online(mnode, volname, all_bricks)
if status:
flag = 1
break
if not status:
time.sleep(10)
counter = counter + 10
if not flag:
g.log.error("All Bricks of the volume '%s' are not online "
"even after %d minutes", volname, timeout/60.0)
return False
else:
g.log.info("All Bricks of the volume '%s' are online ", volname)
return True
def is_broken_symlinks_present_on_bricks(mnode, volname):
""" Checks if the backend bricks have broken symlinks.
Args:
mnode(str): Node on which command has to be executed
volname(str): Name of the volume
Retruns:
(bool):Returns True if present else returns False.
"""
brick_list = get_all_bricks(mnode, volname)
for brick in brick_list:
brick_node, brick_path = brick.split(":")
cmd = ("find %s -xtype l | wc -l" % brick_path)
ret, out, _ = g.run(brick_node, cmd)
if ret:
g.log.error("Failed to run command on node %s", brick_node)
return True
if out:
g.log.error("Error: Broken symlink found on brick path: "
"%s on node %s.", (brick_path, brick_node))
return True
return False
def validate_xattr_on_all_bricks(bricks_list, file_path, xattr):
"""Checks if the xattr of the file/dir is same on all bricks.
Args:
bricks_list (list): List of bricks.
file_path (str): The path to the file/dir.
xattr (str): The file attribute to get from file.
Returns:
True if the xattr is same on all the fqpath. False otherwise
Example:
validate_xattr_on_all_bricks("bricks_list",
"dir1/file1",
"xattr")
"""
time_counter = 250
g.log.info("The heal monitoring timeout is : %d minutes",
(time_counter // 60))
while time_counter > 0:
attr_vals = {}
for brick in bricks_list:
brick_node, brick_path = brick.split(":")
attr_vals[brick] = (
get_extended_attributes_info(brick_node,
["{0}/{1}".format(brick_path,
file_path)],
attr_name=xattr))
ec_version_vals = [list(val.values())[0][xattr] for val in
list(attr_vals.values())]
if len(set(ec_version_vals)) == 1:
return True
else:
time.sleep(120)
time_counter -= 120
return False
|