REST client that talks to ceph-iscsi's rbd-target-api to export rbd images/volumes to an iSCSI initiator
f56f42dcd8
Add a CI job to run tests on Python 3.10, which is supported in 2023.2 [0]. As rbd-iscsi-client is on an independent release model, it still supports Python 3.8, so adjust .zuul.yaml and tox.ini to use the 2023.1 upper constraints when running py38 tests. [0] https://governance.openstack.org/tc/reference/runtimes/2023.2.html Change-Id: I7fa0189dac8d980aa4fd5a7c8bac2f6f84ceb6d5 |
||
---|---|---|
.github | ||
doc | ||
rbd_iscsi_client | ||
releasenotes/source | ||
tools | ||
.gitignore | ||
.gitreview | ||
.readthedocs.yml | ||
.stestr.conf | ||
.zuul.yaml | ||
babel.cfg | ||
ChangeLog | ||
CONTRIBUTING.rst | ||
HACKING.rst | ||
LICENSE | ||
README.rst | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
RBD iSCSI Client
Overview
This python package is a client that talks to the ceph-iscsi rbd-target-api. The rbd-target-api coordinates the rbd volume exports via iSCSI.
Requirements
This package requires a running ceph cluster that has the ceph-iscsi gateway tools installed properly and running. The rbd-target-api must be configured and running.
Installation
pip install rbd-iscsi-client
Features
This is a REST client that talks to ceph-iscsi's rbd-target-api to export rbd images/volumes to an iSCSI initiator.
- get_api - Get all the api endpoints
- get_config - get the entire gateway config
- get_targets - Get all of the target_iqn's defined in the gateways
- create_target_iqn - create a new target_iqn
- delete_target_iqn - delete a target_iqn
- get_clients - get the clients (initiators) defined in the gateways
- get_client_info - get the client information
- create_client - Register a new client (initiator) with the gateways
- delete_client - unregister a client (initiator) from the gateways
- set_client_auth - set CHAP credentials for the client (initiator)
- get_disks - get list of volumes defined to the gateways
- create_disk - create a new volume/disk that the gateways can export
- find_disk - Find a disk that the gateway knows about
- delete_disk - delete a disk from the gateway and pool
- register_disk - Make the disk available to export to a client.
- unregister_disk - Make a disk unavailable to export to a client.
- export_disk - Export a registered disk to a client (initiator)
- unexport_disk - unexport a disk from a client (initiator)
Credits
This package makes use of the rbd-target-api from ceph-iscsi package.
This package was originally created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.