Python Rados Gateway Admin API
rgwadmin is a Python library to access the Ceph Object Storage Admin API.
API Example Usage
from rgwadmin import RGWAdmin rgw = RGWAdmin(access_key='XXX', secret_key='XXX', server='obj.example.com') rgw.create_user( uid='liam', display_name='Liam Monahan', email@example.com', user_caps='usage=read, write; users=read', max_buckets=1000) rgw.set_user_quota( uid='liam', quota_type='user', max_size_kb=1024*1024, enabled=True) rgw.remove_user(uid='liam', purge_data=True)
User Example Usage
from rgwadmin import RGWAdmin, RGWUser RGWAdmin.connect(access_key='XXX', secret_key='XXX', server='obj.example.com') u = RGWUser.create(user_id='test', display_name='Test User') u.user_quota.size = 1024 * 1024 # in bytes u.user_quota.enabled = True u.save() u.delete()
rgwadmin requires the following Python packages:
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.
rgwadmin implements all documented Admin API operations or recent versions of Ceph. We also implement some of the undocumented ones, too...
pip install rgwadmin
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: firstname.lastname@example.org
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.