https://github.com/openstack/rbd-iscsi-client
REST client that talks to ceph-iscsi's rbd-target-api to export rbd images/volumes to an iSCSI initiator. Mirror of code maintained at opendev.org.
https://github.com/openstack/rbd-iscsi-client
Last synced: about 1 month ago
JSON representation
REST client that talks to ceph-iscsi's rbd-target-api to export rbd images/volumes to an iSCSI initiator. Mirror of code maintained at opendev.org.
- Host: GitHub
- URL: https://github.com/openstack/rbd-iscsi-client
- Owner: openstack
- License: apache-2.0
- Created: 2021-02-05T06:07:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-19T14:50:49.000Z (about 2 years ago)
- Last Synced: 2025-03-02T18:50:40.650Z (over 1 year ago)
- Language: Python
- Homepage: https://opendev.org/openstack/rbd-iscsi-client
- Size: 78.1 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: ChangeLog
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
================
RBD iSCSI Client
================
.. image:: https://img.shields.io/pypi/v/rbd-iscsi-client.svg
:target: https://pypi.python.org/pypi/rbd-iscsi-client
.. image:: https://img.shields.io/pypi/pyversions/rbd-iscsi-client.svg
:target: https://pypi.python.org/pypi/rbd-iscsi-client
.. image:: https://img.shields.io/:license-apache-blue.svg
:target: http://www.apache.org/licenses/LICENSE-2.0
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.
.. _ceph-iscsi: https://github.com/ceph/ceph-iscsi
This package was originally created with Cookiecutter_ and the
`audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage