Juju Charm - Ceph iSCSI
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Peter Matulis a6d2fbc623 Update README 2 days ago
src Create default rbd pool 3 days ago
templates Create default rbd pool 3 days ago
tests Create default rbd pool 3 days ago
unit_tests Create default rbd pool 3 days ago
.gitignore Add .gitreview and .zuul.yaml 1 month ago
.gitmodules Switch charm to use charmcraft for building 1 month ago
.gitreview Add .gitreview and .zuul.yaml 1 month ago
.jujuignore Add .gitreview and .zuul.yaml 1 month ago
.stestr.conf Add unit tests and update tox 4 months ago
.zuul.yaml Add .gitreview and .zuul.yaml 1 month ago
README.md Update README 2 days ago
actions.yaml Create default rbd pool 3 days ago
build-requirements.txt Add .gitreview and .zuul.yaml 1 month ago
config.yaml Create default rbd pool 3 days ago
copyright Add .gitreview and .zuul.yaml 1 month ago
metadata.yaml Update deps and fix fallout 2 months ago
requirements.txt Remove charmhelper and ops framework pins 6 days ago
test-requirements.txt Add .gitreview and .zuul.yaml 1 month ago
tox.ini Add .gitreview and .zuul.yaml 1 month ago



The ceph-iscsi charm deploys the Ceph iSCSI gateway service. The charm is intended to be used in conjunction with the ceph-osd and ceph-mon charms.

Warning: This charm is in a preview state and should not be used in production. See the OpenStack Charm Guide for more information on preview charms.



See file config.yaml for the full list of options, along with their descriptions and default values.


We are assuming a pre-existing Ceph cluster.

To provide multiple data paths to clients deploy exactly two ceph-iscsi units:

juju deploy -n 2 cs:~openstack-charmers-next/ceph-iscsi

Then add a relation to the ceph-mon application:

juju add-relation ceph-iscsi:ceph-client ceph-mon:client


  • Deploying four ceph-iscsi units is theoretical possible but it is not an officially supported configuration.

  • The ceph-iscsi application cannot be containerised.

  • Co-locating ceph-iscsi with another application is only supported with ceph-osd, although doing so with other applications may still work.


This section covers Juju actions supported by the charm. Actions allow specific operations to be performed on a per-unit basis.

  • add-trusted-ip
  • create-target
  • pause
  • resume
  • security-checklist

To display action descriptions run juju actions ceph-iscsi. If the charm is not deployed then see file actions.yaml.

iSCSI target management

Create an iSCSI target

An iSCSI target can be created easily with the charm’s create-target action:

juju run-action --wait ceph-iscsi/0 create-target \
   client-initiatorname=iqn.1993-08.org.debian:01:aaa2299be916 \
   client-username=myiscsiusername \
   client-password=myiscsipassword \
   image-size=5G \
   image-name=small \

In the above, all option values are generally user-defined with the exception of the initiator name (client-initiatorname). An iSCSI initiator is essentially an iSCSI client and so its name is client-dependent. Some initiators may impose policy on credentials (client-username and client-password).

Important: The underlying machines for the ceph-iscsi units must have internal name resolution working (i.e. the machines must be able to resolve each other’s hostnames).

The gwcli utility

The management of targets, beyond the target-creation action described above, can be accomplished via the gwcli utility. This CLI tool has its own shell, and is available from any ceph-iscsi unit:

juju ssh ceph-iscsi/1
sudo gwcli
/> help

VMWare integration

Ceph can be used to back iSCSI targets for VMWare initiators. This is documented under Ceph iSCSI in the OpenStack Charms Deployment Guide.


Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.