| Dir : /proc/self/root/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/ |
| Server: Linux ngx353.inmotionhosting.com 4.18.0-553.22.1.lve.1.el8.x86_64 #1 SMP Tue Oct 8 15:52:54 UTC 2024 x86_64 IP: 209.182.202.254 |
| Dir : //proc/self/root/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/glusterfs.py |
"""
Manage GlusterFS pool.
"""
import logging
import salt.utils.cloud as suc
import salt.utils.network
from salt.exceptions import SaltCloudException
log = logging.getLogger(__name__)
RESULT_CODES = [
"Peer {0} added successfully.",
"Probe on localhost not needed",
"Host {0} is already in the peer group",
"Host {0} is already part of another cluster",
"Volume on {0} conflicts with existing volumes",
"UUID of {0} is the same as local uuid",
'{0} responded with "unknown peer". This could happen if {0} doesn\'t have'
" localhost defined",
"Failed to add peer. Information on {0}'s logs",
"Cluster quorum is not met. Changing peers is not allowed.",
"Failed to update list of missed snapshots from {0}",
"Conflict comparing list of snapshots from {0}",
"Peer is already being detached from cluster.",
]
def __virtual__():
"""
Only load this module if the gluster command exists
"""
if "glusterfs.list_volumes" in __salt__:
return "glusterfs"
return (False, "glusterfs module could not be loaded")
def peered(name):
"""
Check if node is peered.
name
The remote host with which to peer.
.. code-block:: yaml
peer-cluster:
glusterfs.peered:
- name: two
peer-clusters:
glusterfs.peered:
- names:
- one
- two
- three
- four
"""
ret = {"name": name, "changes": {}, "comment": "", "result": False}
try:
suc.check_name(name, "a-zA-Z0-9._-")
except SaltCloudException:
ret["comment"] = "Invalid characters in peer name."
return ret
# Check if the name resolves to one of this minion IP addresses
name_ips = salt.utils.network.host_to_ips(name)
if name_ips is not None:
# if it is None, it means resolution fails, let's not hide
# it from the user.
this_ips = set(salt.utils.network.ip_addrs())
this_ips.update(salt.utils.network.ip_addrs6())
if any(
salt.utils.network.is_loopback(addr) for addr in name_ips
) or this_ips.intersection(name_ips):
ret["result"] = True
ret["comment"] = "Peering with localhost is not needed"
return ret
peers = __salt__["glusterfs.peer_status"]()
if peers and any(name in v["hostnames"] for v in peers.values()):
ret["result"] = True
ret["comment"] = f"Host {name} already peered"
return ret
if __opts__["test"]:
ret["comment"] = f"Peer {name} will be added."
ret["result"] = None
return ret
if not __salt__["glusterfs.peer"](name):
ret["comment"] = "Failed to peer with {}, please check logs for errors".format(
name
)
return ret
# Double check that the action succeeded
newpeers = __salt__["glusterfs.peer_status"]()
if newpeers and any(name in v["hostnames"] for v in newpeers.values()):
ret["result"] = True
ret["comment"] = f"Host {name} successfully peered"
ret["changes"] = {"new": newpeers, "old": peers}
else:
ret["comment"] = (
"Host {} was successfully peered but did not appear in the list of peers".format(
name
)
)
return ret
def volume_present(
name,
bricks,
stripe=False,
replica=False,
device_vg=False,
transport="tcp",
start=False,
force=False,
arbiter=False,
):
"""
Ensure that the volume exists
name
name of the volume
bricks
list of brick paths
replica
replica count for volume
arbiter
use every third brick as arbiter (metadata only)
.. versionadded:: 2019.2.0
start
ensure that the volume is also started
.. code-block:: yaml
myvolume:
glusterfs.volume_present:
- bricks:
- host1:/srv/gluster/drive1
- host2:/srv/gluster/drive2
Replicated Volume:
glusterfs.volume_present:
- name: volume2
- bricks:
- host1:/srv/gluster/drive2
- host2:/srv/gluster/drive3
- replica: 2
- start: True
Replicated Volume with arbiter brick:
glusterfs.volume_present:
- name: volume3
- bricks:
- host1:/srv/gluster/drive2
- host2:/srv/gluster/drive3
- host3:/srv/gluster/drive4
- replica: 3
- arbiter: True
- start: True
"""
ret = {"name": name, "changes": {}, "comment": "", "result": False}
if suc.check_name(name, "a-zA-Z0-9._-"):
ret["comment"] = "Invalid characters in volume name."
return ret
volumes = __salt__["glusterfs.list_volumes"]()
if name not in volumes:
if __opts__["test"]:
comment = f"Volume {name} will be created"
if start:
comment += " and started"
ret["comment"] = comment
ret["result"] = None
return ret
vol_created = __salt__["glusterfs.create_volume"](
name, bricks, stripe, replica, device_vg, transport, start, force, arbiter
)
if not vol_created:
ret["comment"] = f"Creation of volume {name} failed"
return ret
old_volumes = volumes
volumes = __salt__["glusterfs.list_volumes"]()
if name in volumes:
ret["changes"] = {"new": volumes, "old": old_volumes}
ret["comment"] = f"Volume {name} is created"
else:
ret["comment"] = f"Volume {name} already exists"
if start:
if __opts__["test"]:
# volume already exists
ret["comment"] = ret["comment"] + " and will be started"
ret["result"] = None
return ret
if int(__salt__["glusterfs.info"]()[name]["status"]) == 1:
ret["result"] = True
ret["comment"] = ret["comment"] + " and is started"
else:
vol_started = __salt__["glusterfs.start_volume"](name)
if vol_started:
ret["result"] = True
ret["comment"] = ret["comment"] + " and is now started"
if not ret["changes"]:
ret["changes"] = {"new": "started", "old": "stopped"}
else:
ret["comment"] = (
ret["comment"]
+ " but failed to start. Check logs for further information"
)
return ret
if __opts__["test"]:
ret["result"] = None
else:
ret["result"] = True
return ret
def started(name):
"""
Check if volume has been started
name
name of the volume
.. code-block:: yaml
mycluster:
glusterfs.started: []
"""
ret = {"name": name, "changes": {}, "comment": "", "result": False}
volinfo = __salt__["glusterfs.info"]()
if name not in volinfo:
ret["result"] = False
ret["comment"] = f"Volume {name} does not exist"
return ret
if int(volinfo[name]["status"]) == 1:
ret["comment"] = f"Volume {name} is already started"
ret["result"] = True
return ret
elif __opts__["test"]:
ret["comment"] = f"Volume {name} will be started"
ret["result"] = None
return ret
vol_started = __salt__["glusterfs.start_volume"](name)
if vol_started:
ret["result"] = True
ret["comment"] = f"Volume {name} is started"
ret["change"] = {"new": "started", "old": "stopped"}
else:
ret["result"] = False
ret["comment"] = f"Failed to start volume {name}"
return ret
def add_volume_bricks(name, bricks):
"""
Add brick(s) to an existing volume
name
Volume name
bricks
List of bricks to add to the volume
.. code-block:: yaml
myvolume:
glusterfs.add_volume_bricks:
- bricks:
- host1:/srv/gluster/drive1
- host2:/srv/gluster/drive2
Replicated Volume:
glusterfs.add_volume_bricks:
- name: volume2
- bricks:
- host1:/srv/gluster/drive2
- host2:/srv/gluster/drive3
"""
ret = {"name": name, "changes": {}, "comment": "", "result": False}
volinfo = __salt__["glusterfs.info"]()
if name not in volinfo:
ret["comment"] = f"Volume {name} does not exist"
return ret
if int(volinfo[name]["status"]) != 1:
ret["comment"] = f"Volume {name} is not started"
return ret
current_bricks = [brick["path"] for brick in volinfo[name]["bricks"].values()]
if not set(bricks) - set(current_bricks):
ret["result"] = True
ret["comment"] = f"Bricks already added in volume {name}"
return ret
bricks_added = __salt__["glusterfs.add_volume_bricks"](name, bricks)
if bricks_added:
ret["result"] = True
ret["comment"] = f"Bricks successfully added to volume {name}"
new_bricks = [
brick["path"]
for brick in __salt__["glusterfs.info"]()[name]["bricks"].values()
]
ret["changes"] = {"new": new_bricks, "old": current_bricks}
return ret
ret["comment"] = f"Adding bricks to volume {name} failed"
return ret
def op_version(name, version):
"""
.. versionadded:: 2019.2.0
Add brick(s) to an existing volume
name
Volume name
version
Version to which the cluster.op-version should be set
.. code-block:: yaml
myvolume:
glusterfs.op_version:
- name: volume1
- version: 30707
"""
ret = {"name": name, "changes": {}, "comment": "", "result": False}
try:
current = int(__salt__["glusterfs.get_op_version"](name))
except TypeError:
ret["result"] = False
ret["comment"] = __salt__["glusterfs.get_op_version"](name)[1]
return ret
if current == version:
ret["comment"] = "Glusterfs cluster.op-version for {} already set to {}".format(
name, version
)
ret["result"] = True
return ret
elif __opts__["test"]:
ret["comment"] = (
"An attempt would be made to set the cluster.op-version for {} to {}.".format(
name, version
)
)
ret["result"] = None
return ret
result = __salt__["glusterfs.set_op_version"](version)
if result[0] is False:
ret["comment"] = result[1]
return ret
ret["comment"] = result
ret["changes"] = {"old": current, "new": version}
ret["result"] = True
return ret
def max_op_version(name):
"""
.. versionadded:: 2019.2.0
Add brick(s) to an existing volume
name
Volume name
.. code-block:: yaml
myvolume:
glusterfs.max_op_version:
- name: volume1
- version: 30707
"""
ret = {"name": name, "changes": {}, "comment": "", "result": False}
try:
current = int(__salt__["glusterfs.get_op_version"](name))
except TypeError:
ret["result"] = False
ret["comment"] = __salt__["glusterfs.get_op_version"](name)[1]
return ret
try:
max_version = int(__salt__["glusterfs.get_max_op_version"]())
except TypeError:
ret["result"] = False
ret["comment"] = __salt__["glusterfs.get_max_op_version"]()[1]
return ret
if current == max_version:
ret["comment"] = (
"The cluster.op-version is already set to the cluster.max-op-version of {}".format(
current
)
)
ret["result"] = True
return ret
elif __opts__["test"]:
ret["comment"] = (
"An attempt would be made to set the cluster.op-version to {}.".format(
max_version
)
)
ret["result"] = None
return ret
result = __salt__["glusterfs.set_op_version"](max_version)
if result[0] is False:
ret["comment"] = result[1]
return ret
ret["comment"] = result
ret["changes"] = {"old": current, "new": max_version}
ret["result"] = True
return ret