openstack/rbd-iscsi-client
Code Issues Proposed changes
REST client that talks to ceph-iscsi's rbd-target-api to export rbd images/volumes to an iSCSI initiator
27 Commits 1 Branch 4 Tags 232 KiB
Python 95%
Shell 5%
ec06206754
Go to file
Brian Rosmaita ec06206754 Set a language in sphinx doc config 
Sphinx has disallowed the practice of setting language = None [0],
which is generating a warning that the docs job interprets as an
error.  Stop this by setting the language to 'en', which is the
Sphinx default.

[0] 3596590317/sphinx/config.py (L183)

Change-Id: Ibd71783419a3eb0620e15796087e46e936964ae2
2023-11-21 18:31:34 -05:00
.github Create python-package.yml 2020-10-01 11:19:03 -04:00
doc Set a language in sphinx doc config 2023-11-21 18:31:34 -05:00
rbd_iscsi_client Address G002 in flake8-logging-format 0.7.4 2022-08-17 14:31:54 +00:00
releasenotes/source Format as a Cinder-related OpenStack project 2021-04-20 22:08:33 -04:00
tools Format as a Cinder-related OpenStack project 2021-04-20 22:08:33 -04:00
.gitignore Format as a Cinder-related OpenStack project 2021-04-20 22:08:33 -04:00
.gitreview Format as a Cinder-related OpenStack project 2021-04-20 22:08:33 -04:00
.readthedocs.yml more 2019-06-14 14:53:30 +00:00
.stestr.conf Initial commit 2019-06-12 18:41:16 +00:00
.zuul.yaml Support Python 3.10 2023-04-18 13:35:08 +00:00
babel.cfg Format as a Cinder-related OpenStack project 2021-04-20 22:08:33 -04:00
ChangeLog Updated .travis.yml 2020-07-30 10:19:29 -04:00
CONTRIBUTING.rst Format as a Cinder-related OpenStack project 2021-04-20 22:08:33 -04:00
HACKING.rst Format as a Cinder-related OpenStack project 2021-04-20 22:08:33 -04:00
LICENSE Format as a Cinder-related OpenStack project 2021-04-20 22:08:33 -04:00
README.rst [trivial] Add two missing periods 2021-07-01 15:07:43 -04:00
requirements.txt Format as a Cinder-related OpenStack project 2021-04-20 22:08:33 -04:00
setup.cfg Support Python 3.10 2023-04-18 13:35:08 +00:00
setup.py Initial commit 2019-06-12 18:41:16 +00:00
test-requirements.txt Format as a Cinder-related OpenStack project 2021-04-20 22:08:33 -04:00
tox.ini Support Python 3.10 2023-04-18 13:35:08 +00:00

README.rst

RBD iSCSI Client

image

image

image

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.