-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This plugin allows to create raid, logical volume store and logical volumes on the Kalray DPU. It also allows the deletion of a volume. Currently restrications are due to the Kalray DPU. Next generation of the DPU will allow more volumes and won't be restricted on volume name. See the REAMDE for details. Signed-off-by: Guillaume <[email protected]>
- Loading branch information
Showing
3 changed files
with
280 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,168 @@ | ||
#!/usr/bin/python3 | ||
"""XAPI plugin to manage Kalray DPU.""" | ||
|
||
import json | ||
import XenAPIPlugin # pylint: disable=import-error | ||
|
||
from kalray.acs.spdk import rpc # pylint: disable=import-error | ||
from xcpngutils import error_wrapped | ||
|
||
class KalrayCmd: | ||
"""Describe a command to be ran on the Kalray DPU.""" | ||
|
||
def __init__(self, rpc_name: str, updates: dict): | ||
self.server = 'localhost' | ||
self.port = 8080 | ||
self.username = None | ||
self.password = None | ||
self.timeout = 60.0 | ||
self.rpc_name = rpc_name | ||
self.rpc_params = {} # will be updated using add_rpc_params | ||
|
||
for k, v in updates.items(): | ||
if hasattr(self, k): | ||
setattr(self, k, v) | ||
|
||
# Check that username & password are well set | ||
if self.username is None: | ||
raise XenAPIPlugin.Failure("-1", ["'username' is required"]) | ||
if self.password is None: | ||
raise XenAPIPlugin.Failure("-1", ["'password' is required"]) | ||
|
||
def add_rpc_params(self, key, value): | ||
"""Adds a parameter that will be passed to the RPC.""" | ||
self.rpc_params[key] = value | ||
|
||
def call_rpc(self): | ||
"""Do the RPC call.""" | ||
try: | ||
client = rpc.client.HTTPJSONRPCClient( | ||
self.server, | ||
self.port, | ||
self.timeout, | ||
self.username, | ||
self.password, | ||
log_level="ERROR") | ||
message = client.call(self.rpc_name, self.rpc_params) | ||
except rpc.client.JSONRPCException as exc: | ||
raise XenAPIPlugin.Failure("-1", [exc.message]) | ||
|
||
return json.dumps(message) | ||
|
||
@error_wrapped | ||
def get_devices(_session, args): | ||
"""Get the list of devices available on the Kalray DPU.""" | ||
kc = KalrayCmd("bdev_get_bdevs", args) | ||
return kc.call_rpc() | ||
|
||
@error_wrapped | ||
def get_raids(_session, args): | ||
"""Get the list of raids available on the Kalray DPU.""" | ||
kc = KalrayCmd("bdev_raid_get_bdevs", args) | ||
kc.add_rpc_params("category", "all") | ||
return kc.call_rpc() | ||
|
||
@error_wrapped | ||
def get_lvs(_session, args): | ||
"""Get the list of logical volume stores available on the Kalray DPU.""" | ||
kc = KalrayCmd("bdev_lvol_get_lvstores", args) | ||
return kc.call_rpc() | ||
|
||
@error_wrapped | ||
def raid_create(_session, args): | ||
"""Create a raid.""" | ||
kc = KalrayCmd("bdev_raid_create", args) | ||
try: | ||
raid_name = args["raid_name"] | ||
raid_level = args["raid_level"] | ||
base_bdevs = args["base_bdevs"].split(',') | ||
except KeyError as msg: | ||
raise XenAPIPlugin.Failure("-1", [f"Key {msg} is missing"]) | ||
|
||
# == Sanity checks == | ||
# Check supported raids | ||
if raid_level not in ["raid0", "raid1", "raid10"]: | ||
raise XenAPIPlugin.Failure("-1", ["Only raid0, raid1 and raid10 are supported"]) | ||
# Check that bdevs are "NVMe disk" | ||
devices = json.loads(get_devices(_session, args)) | ||
for bdev_name in base_bdevs: | ||
bdev_type = [dev['product_name'] for dev in devices if dev['name'] == bdev_name] | ||
if len(bdev_type) == 0 or bdev_type[0] != 'NVMe disk': | ||
raise XenAPIPlugin.Failure("-1", | ||
[f"Device ${bdev_name} is not an NVMe disk"]) | ||
|
||
kc.add_rpc_params("name", raid_name) | ||
kc.add_rpc_params("raid_level", raid_level) | ||
kc.add_rpc_params("base_bdevs", base_bdevs) | ||
kc.add_rpc_params("strip_size_kb", 128) | ||
kc.add_rpc_params("persist", True) | ||
kc.add_rpc_params("split_dp", True) | ||
return kc.call_rpc() | ||
|
||
@error_wrapped | ||
def lvs_create(_session, args): | ||
"""Create a logical volume store.""" | ||
kc = KalrayCmd("bdev_lvol_lvs_createtore", args) | ||
try: | ||
lvs_name = args["lvs_name"] | ||
bdev_name = args["bdev_name"] | ||
except KeyError as msg: | ||
raise XenAPIPlugin.Failure("-1", [f"Key {msg} is missing"]) | ||
|
||
kc.add_rpc_params("lvs_name", lvs_name) | ||
kc.add_rpc_params("bdev_name", bdev_name) | ||
|
||
return kc.call_rpc() | ||
|
||
@error_wrapped | ||
def lvol_create(_session, args): | ||
"""Create a new lvol on the Kalray DPU.""" | ||
kc = KalrayCmd("bdev_lvol_create", args) | ||
|
||
try: | ||
lvol_name = args["lvol_name"] | ||
lvol_size = int(args["lvol_size_mb"]) | ||
lvs_name = args["lvs_name"] | ||
except KeyError as msg: | ||
raise XenAPIPlugin.Failure("-1", [f"Key {msg} is missing"]) | ||
except ValueError as msg: | ||
raise XenAPIPlugin.Failure("-1", [f"Wrong size: {msg}"]) | ||
|
||
kc.add_rpc_params("lvol_name", lvol_name) | ||
kc.add_rpc_params("size", lvol_size) | ||
kc.add_rpc_params("lvs_name", lvs_name) | ||
return kc.call_rpc() | ||
|
||
@error_wrapped | ||
def lvol_delete(_session, args): | ||
"""Delete the lvol passed as parameter on the Kalray DPU if exists.""" | ||
kc = KalrayCmd("bdev_lvol_delete", args) | ||
|
||
try: | ||
lvol_name = args["lvol_name"] | ||
except KeyError as msg: | ||
raise XenAPIPlugin.Failure("-1", [f"Key {msg} is missing"]) | ||
|
||
kc.add_rpc_params("name", lvol_name) | ||
return kc.call_rpc() | ||
|
||
def test(_session, args): | ||
devices = json.loads(get_devices(_session, args)) | ||
dev_name = args["name"] | ||
for dev in devices: | ||
if dev['name'] == dev_name and dev['product_name'] == 'NVMe disk': | ||
return json.dumps(True) | ||
|
||
return json.dumps(False) | ||
|
||
if __name__ == "__main__": | ||
XenAPIPlugin.dispatch({ | ||
"get_devices": get_devices, | ||
"get_raids": get_raids, | ||
"get_lvs": get_lvs, | ||
"raid_create": raid_create, | ||
"lvs_create": lvs_create, | ||
"lvol_create": lvol_create, | ||
"lvol_delete": lvol_delete, | ||
"test": test, | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
import mock | ||
|
||
from kalray_dpu import get_devices | ||
|
||
@mock.patch('KalrayCmd.call_rpc', autospec=True) | ||
class TestKalrayDPU: | ||
def test_get_devices(self): | ||
args = { | ||
"username": "user", | ||
"password": "pass", | ||
} | ||
get_devices(None, args) | ||
|
||
assert True |