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.
Zuul 2027e50020 Merge "Fix Zaza's expected Ubuntu workload status" 2 weeks ago
src Merge "Permit Four Gateways" 6 months ago
templates Create default rbd pool 9 months ago
tests Fix Zaza's expected Ubuntu workload status 2 weeks ago
unit_tests More tolerant ceph client relation unit test 6 months ago
.gitignore Add .gitreview and .zuul.yaml 10 months ago
.gitmodules Switch charm to use charmcraft for building 11 months ago
.gitreview Add .gitreview and .zuul.yaml 10 months ago
.jujuignore Add .gitreview and .zuul.yaml 10 months ago
.stestr.conf Add unit tests and update tox 1 year ago
.zuul.yaml Add .gitreview and .zuul.yaml 10 months ago
README.md Merge "Fix VMware links in README again" 6 months ago
actions.yaml Create default rbd pool 9 months ago
build-requirements.txt Pin charmcraft to 0.10.2 2 weeks ago
config.yaml Add bluestore compression support 8 months ago
copyright Add .gitreview and .zuul.yaml 10 months ago
metadata.yaml Add impish to metadata.yaml 3 weeks ago
requirements.txt Fix an incorrect module name in requirements 8 months ago
test-requirements.txt Add bluestore compression support 8 months ago
tox.ini Pin pip < 20.3 4 months 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.



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

Ceph BlueStore compression

This charm supports [BlueStore inline compression][ceph-bluestore-compression] for its associated Ceph storage pool(s). The feature is enabled by assigning a compression mode via the bluestore-compression-mode configuration option. The default behaviour is to disable compression.

The efficiency of compression depends heavily on what type of data is stored in the pool and the charm provides a set of configuration options to fine tune the compression behaviour.

Note: BlueStore compression is supported starting with Ceph Mimic.


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 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 theoretically 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. To display action descriptions run juju actions ceph-iscsi. If the charm is not deployed then see file actions.yaml.

  • 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 VMware integration in the Charmed Ceph documentation.


Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.