Ceph Object Storage Admin API python library bindings.
rgwadmin
rgwadmin is a Python library to access the Ceph Object Storage Admin API.
http://docs.ceph.com/docs/master/radosgw/adminops/
API Example Usage
from rgwadmin import RGWAdmin
rgw = RGWAdmin(accesskey='XXX', secretkey='XXX', server='obj.example.com') rgw.create_user( uid='liam', display_name='Liam Monahan', email='liam@umiacs.umd.edu', user_caps='usage=read, write; users=read', max_buckets=1000) rgw.setuserquota( uid='liam', quota_type='user', maxsizekb=1024*1024, enabled=True) rgw.removeuser(uid='liam', purgedata=True)
User Example Usage
from rgwadmin import RGWAdmin, RGWUser
RGWAdmin.connect(accesskey='XXX', secretkey='XXX', server='obj.example.com') u = RGWUser.create(userid='test', displayname='Test User') u.user_quota.size = 1024 * 1024 # in bytes u.user_quota.enabled = True u.save() u.delete()
Requirements
rgwadmin requires the following Python packages:
* requests * requests-aws4auth
Additionally, you need to have a Ceph Object Storage instance with a user that has appropriate caps (capabilities) on the parts of the API that you want to access. See the Ceph Object Storage page for more information.
Version 2.3.1 was the last to support Python 2. As of version 2.4.0 we support using V4 signing for requests to the Ceph RGW Admin server only.
Compatibility
rgwadmin implements all documented Admin API operations or recent versions of Ceph. We also implement some of the undocumented ones, too...Installation
install rgwadminLicense
rgwadmin - a Python interface to the Rados Gateway Admin API Copyright (C) 2015 UMIACS
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Email: github@umiacs.umd.edu
