summaryrefslogtreecommitdiffstats
path: root/glustolibs-gluster/glustolibs/gluster/geo_rep_libs.py
blob: a850681ce996dc97755976494f0f73c15a168479 (plain)
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
#  Copyright (C) 2017-2018  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: Library for gluster geo-replication operations.
"""

from time import sleep
from glusto.core import Glusto as g
from glustolibs.gluster.gluster_init import restart_glusterd
from glustolibs.gluster.peer_ops import is_peer_connected
from glustolibs.gluster.geo_rep_ops import (georep_mountbroker_setup,
                                            georep_mountbroker_add_user,
                                            georep_create_pem,
                                            georep_create,
                                            georep_set_pem_keys,
                                            georep_config_set)
from glustolibs.gluster.shared_storage_ops import (enable_shared_storage,
                                                   is_shared_volume_mounted,
                                                   check_gluster_shared_volume)
from glustolibs.gluster.lib_utils import (group_add, ssh_copy_id,
                                          ssh_keygen, add_user, set_passwd,
                                          is_group_exists, is_user_exists,
                                          is_passwordless_ssh_configured)
from glustolibs.gluster.glusterdir import get_dir_contents


def georep_prerequisites(mnode, snode, passwd, user="root", group=None,
                         mntbroker_dir="/var/mountbroker-root",
                         nonrootpass=None):
    """
    Sets up all the prerequisites for geo-rep.

    Args:
        mnode(str): The primary master node where the commands are executed
        snode(str|list): slave nodes on which setup has to be completed.
        passwd(str): Password of the root user.

    Kwargs:
        user(str): User to be used to setup the geo-rep session.
                   (Default: root)
        mntbroker_dir(str): Mountbroker mount directory.
                            (Default: /var/mountbroker-root)
        group(str): Group under which geo-rep useraccount is setup.
                    (Default: None)
        nonrootpass(str): Password of the non-root user.(Default: None)

    Returns:
        bool : True if all the steps are successful, false if there are
              any failures in the middle

    """
    # Converting snode to list if string.
    if not isinstance(snode, list):
        snode = [snode]

    # Checking for blank username.
    if not user.strip():
        g.log.error("Blank username isn't possible.")
        return False

    # Checking if non-root user is given without userpassword.
    if user != "root" and nonrootpass is None:
        g.log.error("Non-root user specified without password.")
        return False

    # Checking and enabling shared storage on master cluster.
    ret = is_shared_volume_mounted(mnode)
    if not ret:

        ret = enable_shared_storage(mnode)
        if not ret:
            g.log.error("Failed to set cluster"
                        ".enable-shared-storage to enable.")
            return False

        # Check volume list to confirm gluster_shared_storage is created
        ret = check_gluster_shared_volume(mnode)
        if not ret:
            g.log.error("gluster_shared_storage volume not"
                        " created even after enabling it.")
            return False

    # Running prerequisites for non-root user.
    if user != "root" and group is not None:

        if len(snode) < 2:
            g.log.error("A list of all slave nodes is needed for non-root"
                        " setup as every slave node will have a non-root"
                        " user.")
            return False

        # Checking and creating a  group on all slave nodes.
        if not is_group_exists(snode, group):
            ret = group_add(snode, group)
            if not ret:
                g.log.error("Creating group: %s on all slave nodes failed.",
                            group)
                return False

        # Checking and creating a non-root user on all the nodes.
        if not is_user_exists(snode, user):
            ret = add_user(snode, user, group)
            if not ret:
                g.log.error("Creating user: %s in group: %s on all slave nodes"
                            " failed,", user, group)
                return False

            # Setting password for user on all the nodes.
            ret = set_passwd(snode, user, nonrootpass)
            if not ret:
                g.log.error("Setting password failed on slaves")
                return False

            # Setting up mount broker on first slave node.
            ret, _, _ = georep_mountbroker_setup(snode[0], group,
                                                 mntbroker_dir)
            if ret:
                g.log.error("Setting up of mount broker directory"
                            " failed on node: %s", snode[0])
                return False

    # Checking if ssh keys are present.
    ret = get_dir_contents(mnode, "~/.ssh/")
    if "id_rsa" not in ret or "id_rsa.pub" not in ret:
        ret = ssh_keygen(mnode)
        if not ret:
            g.log.error("Failed to create a common pem pub file.")
            return False

    # Setting up passwordless ssh to primary slave node.
    if not is_passwordless_ssh_configured(mnode, snode[0], user):
        if user != "root":
            ret = ssh_copy_id(mnode, snode[0], nonrootpass, user)
        else:
            ret = ssh_copy_id(mnode, snode[0], passwd, user)
        if not ret:
            g.log.error("Failed to setup passwordless ssh.")
            return False

    # Checking if pem files else running gsec_create.
    ret = get_dir_contents(mnode, "/var/lib/glusterd/geo-replication/")
    list_of_pem_files = [
        "common_secret.pem.pub", "secret.pem",
        "tar_ssh.pem", "gsyncd_template.conf",
        "secret.pem.pub", "tar_ssh.pem.pub"
        ]
    if ret != list_of_pem_files:
        ret, _, _ = georep_create_pem(mnode)
        if ret:
            g.log.error("Failed exeucte gluster system:: execute gsec_create.")
            return False
    return True


def georep_create_session(mnode, snode, mastervol, slavevol,
                          user="root", force=False, sync="rsync"):
    """ Create a geo-replication session between the master and
        the slave.

    Args:
        mnode(str): The primary master node where the commands are executed
        snode(str|list): slave node where the commande are executed
        mastervol(str): The name of the master volume
        slavevol(str): The name of the slave volume

    Kwargs:
        user (str): User to be used to create geo-rep session.(Default: root)
        force (bool) : Set to true if session needs to be created with force
                       else it remains false as the default option.
                       (Default: False)
        sync (str): Sync method to be used for geo-rep session.(Default:rsync)
    Returns:
        bool : True if all the steps are successful, false if there are
              any failures in the middle
    """
    # Converting snode to list if string.
    if not isinstance(snode, list):
        snode = [snode]

    # Checking for blank username.
    if not user.strip():
        g.log.error("Blank username isn't possible.")
        return False

    if sync not in ["rsync", "tarssh"]:
        g.log.error("Invalid sync method used. "
                    "%s is not a valid sync method.", sync)
        return False

    # Setting up root geo-rep session.
    if user == "root":
        g.log.debug("Creating root geo-rep session.")
        ret, _, _ = georep_create(mnode, mastervol, snode[0],
                                  slavevol, user, force)
        if ret:
            g.log.error("Failed to create geo-rep session")
            return False

        g.log.debug("Enabling meta-volume for master volume.")
        ret, _, _ = georep_config_set(mnode, mastervol, snode[0],
                                      slavevol, "use_meta_volume", "True")
        if ret:
            g.log.error("Failed to set up meta-volume for root "
                        "geo-rep session from %s to %s",
                        (mastervol, slavevol))
            return False

        # Setting up sync method if not rsync.
        g.log.debug("Enabling tarssh for master volume.")
        if sync == "tarssh":
            ret, _, _ = georep_config_set(mnode, mastervol, snode[0],
                                          slavevol, "sync_method", "tarssh")
            if ret:
                g.log.error("Failed to set sync method to tarssh for root "
                            "geo-rep session from %s to %s",
                            (mastervol, slavevol))
                return False
        return True

    # Setting up non-root geo-rep session.
    else:
        # Glusterd has to be restarted on all the slave nodes.
        if len(snode) < 2:
            g.log.error("A list of all slave nodes is needed for non-root"
                        " session to restart glusterd on all slaves after"
                        " adding it to mountbroker.")
            return False

        # Adding volume to mountbroker.
        g.log.debug("Creating a non-root geo-rep session.")
        ret, _, _ = georep_mountbroker_add_user(snode[0], slavevol, user)
        if ret:
            g.log.error("Failed to setup mountbroker.")
            return False

        # Restarting glusterd on all nodes.
        ret = restart_glusterd(snode)
        if not ret:
            g.log.error("Restarting glusterd failed.")
            return False

        # Checking if peers are in connected state or not.
        ret = is_peer_connected(snode[0], snode)
        if not ret:

            counter = 20
            while counter > 0:

                ret = is_peer_connected(snode[0], snode)
                if ret:
                    break
                sleep(3)
                counter += 1

        # Creating a geo-rep session.
        ret, _, _ = georep_create(mnode, mastervol, snode[0], slavevol,
                                  user, force)
        if ret:
            g.log.error("Failed to create geo-rep session.")
            return False

        # Setting up pem keys between master and slave node.
        g.log.debug("Copy geo-rep pem keys onto all slave nodes.")
        ret, _, _ = georep_set_pem_keys(snode[0], user, mastervol, slavevol)
        if ret:
            g.log.error("Failed to copy geo-rep pem keys onto all slave nodes")
            return False

        # Setting use_meta_volume to true.
        g.log.debug("Setting use_meta_volume to true.")
        ret, _, _ = georep_config_set(mnode, mastervol, snode[0], slavevol,
                                      "use_meta_volume", "true", user)
        if ret:
            g.log.error("Failed to set up meta-volume for %s "
                        "geo-rep session from %s to %s.",
                        (user, mastervol, slavevol))
            return False

        # Setting up sync method if not rsync.
        g.log.debug("Setting sync method to tarssh.")
        if sync == "tarssh":
            ret, _, _ = georep_config_set(mnode, mastervol, snode[0],
                                          slavevol, "sync_method", "tarssh",
                                          user)
            if ret:
                g.log.error("Failed to set sync method to tarssh for %s "
                            "geo-rep session from %s to %s",
                            (user, mastervol, slavevol))
                return False
        return True