Supported by the National Science Foundation Collaborator: University of Michigan Collaborator: Michigan State University Collaborator: Wayne State University Collaborator: Indiana University

The CephProvisioner plugin provisions storage for COmanage COU and identities with the capabilities to use that storage. It works by directly running ‘ceph auth’ and ‘radosgw-admin’ commands.

The plugin source is on github:

The plugin handles the following

  • COU - When new COU are created the plugin creates data pools in Ceph for that COU and associates them with the appropriate application (CephFS, RGW). It also creates data placement targets and tags for the RGW pool. The Ceph credentials menu in COmnage allows users to select a default bucket placement target if they belong to multiple COU.
  • RGW - A RGW user is created matching COperson UID identifier. The Ceph credentials menu in COmanage allows users to create additional userid and additional access/secret pairs for their userid.
  • CephFS - COmanage provisions LDAP posixUser information used by systems which mount CephFS, and it provisions default COU groups to Grouper where they they are provisioned to LDAP along with any user-created groups. This plugin creates a ceph client key with appropriate access capabilities to access the COU directory path and COU data pool dedicated to CephFS. We use an external script to create a directory for each COU and set the file layout for the directory to be the COU CephFS data pool. The key created by this plugin also includes capabilities to access COU data pools for rados and rbd.

Basic requirements

You have installed COmanage according to their instructions.

A Ceph client configuration and key with sufficient capabilities is required on the host running COmanage.

ceph auth get-or-create client.comanage mon 'allow *' osd 'allow * pool=.rgw.root, allow *  \ 
pool=default.rgw.users.uid, allow * pool=default.rgw.meta, allow * pool=default.rgw.control, \
allow *, allow * pool=default.rgw.users.keys, \
allow *, allow * pool=default.rgw.log, \
allow * pool=default.rgw.users.swift'
The key created above should be installed in /etc/ceph/ceph.client.comanage.keyring


  1. Clone our repository from Github:
  2. Switch to the ceph_provisioner branch
  3. Copy app/AvailablePlugin/CephProvisioner to the same directory in your installation.
  4. Alternately: Use the osiris_master branch of our repository when installing your COmanage instance - it will include the CephProvisioner plugin in the appropriate directory. Instead of downloading their source tarball clone our repo (or download as zip) into your installation directory.
  5. Link the plugin into local/Plugin:
    cd /srv/comanage/registry-current/local/Plugin
    ln -s ../../app/AvailablePlugin/CephProvisioner .
  6. Setup the plugin schema (replace 'apache' with your httpd user if different):
    cd /srv/comanage/registry-current/app
    su -c "./Console/cake database" apache


  1. In COmanage registry under the CO you have created (not under the COmanage internal CO) open the Configuration -> Provisioning Targets settings
  2. Add a new provisioning target. Choose CephProvisioner as plugin type. Optionally set it to be Manual if you would like the opportunity to test on a small scale by manually provisioning single COU or User (recommended)
  3. On the provising targets screen click the "Configure" button to set some required settings (details below)

Configuration reference

Many settings are available but may be obsolete or not yet implemented. Here is a list of settings that are available and how you might use them.
  • RGW URL: Marked as required but not used. Insert any URL here, preferably your actual RGW url for future use
  • Ceph Client ID: Required, should be the client id of the key you created to allow comanage access to the cluster. Do not include the client. prefix. For example, if they key was created following the example in this document then the client id is simply 'comanage'.
  • RGW Access Key: Marked as required but not used. Any string will do.
  • Create COU Data Pools: If set then COmanage will use the 'ceph' command to create data pools for new COU. They will follow a pattern like 'cou.CouName.fs' and 4 pools will be created: .fs, .rgw, .rados, .rbd.
  • COU Data Pool PG count: Number of placement groups to specify for new COU data pools. Set this low enough that your expected number of COU will not end up putting too many PG on your cluster. You can always increase PG count later outside of COmanage
  • LDAP Lookup Target / Grouper Lookup Target: Obsolete feature, ignored. It used to be possible to create client keys with uid/gid restrictions but we no longer support creating user keys with direct CephFS mount access in the plugin. Grouper or LDAP would be used to discover the posix uid/gid.
  • Use RGW LDAP Auth: Obsolete feature, ignored: At one time we provisioned RGW users into LDAP. This is no longer true. The feature was of little benefit since it is still necessary to create a RGW user to hold metadata, and the LDAP token format used for client credentials was confusing since it is unique to Ceph RGW
  • Ceph User Prefix: When creating ceph client keys they will be prefixed with this string. The default is 'comanage' so new Ceph client keys are created as 'client.comanage.uid'
  • Create COU data directory: If enabled then COmanage will attempt to run an external script that creates a directory for new COU and sets attributes to place it on the 'cou.Name.fs' pool.
  • COU dir create command: The command to run if the above setting is checked. The default is to use 'sudo' to run /usr/local/bin/ This script is included in the CephProvisioner/Lib directory and should be copied or symlinked into /usr/local/bin. You will also need to set sudo permissions for the Apache user.
  • CephFS mountpoint: If COU data directory creation is enabled, specify the path to create COU data directories
  • CephFS Name: Name of CephFS. Will be needed to add new data pools for FS usage
  • Set key uid/gid limitations: Obsolete, ignored
Note: The relevant code for enabling user keys to have CephFS access with uid and path restrictions is still in place but commented out - it most likely would work if enabled. Key caps would be set to limit the path to their COU data directory and UID to those belonging to the COU. In the context of our project the feature was not needed as we do not provide direct CephFS mounts but instead used NFSv4 to provide this service and the requisite UID mapping. In general it is not safe to hand out client keys allowing external users to access the CephFS data pools directly but this is required if they use the keys to mount.

Plugin Architecture

These diagrams give a rough overview of plugin provisioning flow for storage and users. The user flow is mainly focused on initial provisioning and does not cover every scenario in detail for group updates, identifier changes, reprovision, etc.
COmanage Ceph Storage Provisioning OSiRIS COmanage Ceph storage provisioning flow

COmanage Ceph User Provisioning OSiRIS COmanage Ceph user provisioning and credential management flow