%{python_sitelib}/rbd.py*
%{python_sitelib}/cephfs.py*
%{python_sitelib}/ceph_argparse.py*
+%{python_sitelib}/ceph_rest_api.py*
#################################################################################
%files -n rest-bench
.. option:: -c/--conf *conffile*
- names the ceph.conf file to use for configuration. If -c
- is not specified, the configuration file is searched for in
- this order:
+ names the ceph.conf file to use for configuration. If -c is not
+ specified, the default depends on the state of the --cluster option
+ (default 'ceph'; see below). The configuration file is searched
+ for in this order:
* $CEPH_CONF
- * /etc/ceph/ceph.conf
- * ~/.ceph/ceph.conf
- * ceph.conf (in the current directory)
+ * /etc/ceph/${cluster}.conf
+ * ~/.ceph/${cluster}.conf
+ * ${cluster}.conf (in the current directory)
+
+ so you can also pass this option in the environment as CEPH_CONF.
+
+.. option:: --cluster *clustername*
+
+ set *clustername* for use in the $cluster metavariable, for
+ locating the ceph.conf file. The default is 'ceph'.
+ You can also pass this option in the environment as
+ CEPH_CLUSTER_NAME.
.. option:: -n/--name *name*
client-specific configuration options in the config file, and
also is the name used for authentication when connecting
to the cluster (the entity name appearing in ceph auth list output,
- for example). The default is 'client.restapi'.
-
+ for example). The default is 'client.restapi'. You can also
+ pass this option in the environment as CEPH_NAME.
+
Configuration parameters
========================
Supported configuration parameters include:
+* **restapi client name** the 'clientname' used for auth and ceph.conf
* **restapi keyring** the keyring file holding the key for 'clientname'
* **restapi public addr** ip:port to listen on (default 0.0.0.0:5000)
* **restapi base url** the base URL to answer requests on (default /api/v0.1)
of all known commands. The command set is very similar to the commands
supported by the **ceph** tool.
+Deployment as WSGI application
+==============================
+
+When deploying as WSGI application (say, with Apache/mod_wsgi,
+or nginx/uwsgi, or gunicorn, etc.), use the ``ceph_rest_api.py`` module
+(``ceph-rest-api`` is a thin layer around this module). The standalone web
+server is of course not used, so address/port configuration is done in
+the WSGI server. Also, configuration switches are not passed; rather,
+environment variables are used:
+
+* CEPH_CONF holds -c/--conf
+* CEPH_CLUSTER_NAME holds --cluster
+* CEPH_NAME holds -n/--name
+
+Any errors reading configuration or connecting to the cluster cause
+ImportError to be raised with a descriptive message on import; see
+your WSGI server documentation for how to see those messages in case
+of problem.
+
Availability
============
-.TH "CEPH-REST-API" "8" "July 10, 2013" "dev" "Ceph"
+.TH "CEPH-REST-API" "8" "July 12, 2013" "dev" "Ceph"
.SH NAME
ceph-rest-api \- ceph RESTlike administration server
.
.INDENT 0.0
.TP
.B \-c/\-\-conf *conffile*
-names the ceph.conf file to use for configuration. If \-c
-is not specified, the configuration file is searched for in
-this order:
+names the ceph.conf file to use for configuration. If \-c is not
+specified, the default depends on the state of the \-\-cluster option
+(default \(aqceph\(aq; see below). The configuration file is searched
+for in this order:
.INDENT 7.0
.IP \(bu 2
$CEPH_CONF
.IP \(bu 2
-/etc/ceph/ceph.conf
+/etc/ceph/${cluster}.conf
.IP \(bu 2
-~/.ceph/ceph.conf
+~/.ceph/${cluster}.conf
.IP \(bu 2
-ceph.conf (in the current directory)
+${cluster}.conf (in the current directory)
.UNINDENT
+.sp
+so you can also pass this option in the environment as CEPH_CONF.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-cluster *clustername*
+set \fIclustername\fP for use in the $cluster metavariable, for
+locating the ceph.conf file. The default is \(aqceph\(aq.
+You can also pass this option in the environment as
+CEPH_CLUSTER_NAME.
.UNINDENT
.INDENT 0.0
.TP
client\-specific configuration options in the config file, and
also is the name used for authentication when connecting
to the cluster (the entity name appearing in ceph auth list output,
-for example). The default is \(aqclient.restapi\(aq.
+for example). The default is \(aqclient.restapi\(aq. You can also
+pass this option in the environment as CEPH_NAME.
.UNINDENT
.SH CONFIGURATION PARAMETERS
.sp
Supported configuration parameters include:
.INDENT 0.0
.IP \(bu 2
+\fBrestapi client name\fP the \(aqclientname\(aq used for auth and ceph.conf
+.IP \(bu 2
\fBrestapi keyring\fP the keyring file holding the key for \(aqclientname\(aq
.IP \(bu 2
\fBrestapi public addr\fP ip:port to listen on (default 0.0.0.0:5000)
the value of \fBrestapi base url\fP, and that path will give a full list
of all known commands. The command set is very similar to the commands
supported by the \fBceph\fP tool.
+.SH DEPLOYMENT AS WSGI APPLICATION
+.sp
+When deploying as WSGI application (say, with Apache/mod_wsgi,
+or nginx/uwsgi, or gunicorn, etc.), use the \fBceph_rest_api.py\fP module
+(\fBceph\-rest\-api\fP is a thin layer around this module). The standalone web
+server is of course not used, so address/port configuration is done in
+the WSGI server. Also, configuration switches are not passed; rather,
+environment variables are used:
+.INDENT 0.0
+.IP \(bu 2
+CEPH_CONF holds \-c/\-\-conf
+.IP \(bu 2
+CEPH_CLUSTER_NAME holds \-\-cluster
+.IP \(bu 2
+CEPH_NAME holds \-n/\-\-name
+.UNINDENT
+.sp
+Any errors reading configuration or connecting to the cluster cause
+ImportError to be raised with a descriptive message on import; see
+your WSGI server documentation for how to see those messages in case
+of problem.
.SH AVAILABILITY
.sp
\fBceph\-rest\-api\fP is part of the Ceph distributed file system. Please refer to the Ceph documentation at
python_PYTHON = pybind/rados.py \
pybind/rbd.py \
pybind/cephfs.py \
- pybind/ceph_argparse.py
+ pybind/ceph_argparse.py \
+ pybind/ceph_rest_api.py
# headers... and everything else we want to include in a 'make dist'
# that autotools doesn't magically identify.
#!/usr/bin/python
# vim: ts=4 sw=4 smarttab expandtab
+import argparse
+import inspect
import os
import sys
os.execvp('python', ['python'] + sys.argv)
sys.path.insert(0, os.path.join(MYDIR, 'pybind'))
-from ceph_rest_api import api_setup, app
-addr, port = api_setup()
+def parse_args():
+ parser = argparse.ArgumentParser(description="Ceph REST API webapp")
+ parser.add_argument('-c', '--conf', help='Ceph configuration file')
+ parser.add_argument('--cluster', help='Ceph cluster name')
+ parser.add_argument('-n', '--name', help='Ceph client name')
-if __name__ == '__main__':
- import inspect
- files = [os.path.split(fr[1])[-1] for fr in inspect.stack()]
- if 'pdb.py' in files:
- app.run(host=addr, port=port, debug=True, use_reloader=False, use_debugger=False)
- else:
- app.run(host=addr, port=port, debug=True)
+ return parser.parse_args()
+
+
+# main
+
+parsed_args = parse_args()
+if parsed_args.conf:
+ os.environ['CEPH_CONF'] = parsed_args.conf
+if parsed_args.cluster:
+ os.environ['CEPH_CLUSTER_NAME'] = parsed_args.cluster
+if parsed_args.name:
+ os.environ['CEPH_NAME'] = parsed_args.name
+
+# import now that env vars are available to imported module
+
+try:
+ import ceph_rest_api
+except Exception as e:
+ print >> sys.stderr, "Error importing ceph_rest_api: ", str(e)
+ sys.exit(1)
+
+# importing ceph_rest_api has set module globals 'app', 'addr', and 'port'
+
+files = [os.path.split(fr[1])[-1] for fr in inspect.stack()]
+if 'pdb.py' in files:
+ ceph_rest_api.app.run(host=ceph_rest_api.addr, port=ceph_rest_api.port,
+ debug=True, use_reloader=False, use_debugger=False)
+else:
+ ceph_rest_api.app.run(host=ceph_rest_api.addr, port=ceph_rest_api.port,
+ debug=True)
'debug':logging.DEBUG,
}
-
# my globals, in a named tuple for usage clarity
-glob = collections.namedtuple('gvars',
- 'args cluster urls sigdict baseurl clientname')
-glob.args = None
+glob = collections.namedtuple('gvars', 'cluster urls sigdict baseurl')
glob.cluster = None
glob.urls = {}
glob.sigdict = {}
glob.baseurl = ''
-glob.clientname = ''
-
-def parse_args():
- parser = argparse.ArgumentParser(description="Ceph REST API webapp")
- parser.add_argument('-c', '--conf', help='Ceph configuration file')
- parser.add_argument('-n', '--name', help='Ceph client config/key name')
-
- return parser.parse_args()
-def load_conf(conffile=None):
+def load_conf(clustername='ceph', conffile=None):
import contextlib
+
class _TrimIndentFile(object):
def __init__(self, fp):
self.fp = fp
with contextlib.closing(f):
return parse(f)
- # XXX this should probably use cluster name
if conffile:
+ # from CEPH_CONF
return load(conffile)
- elif 'CEPH_CONF' in os.environ:
- conffile = os.environ['CEPH_CONF']
- elif os.path.exists('/etc/ceph/ceph.conf'):
- conffile = '/etc/ceph/ceph.conf'
- elif os.path.exists(os.path.expanduser('~/.ceph/ceph.conf')):
- conffile = os.path.expanduser('~/.ceph/ceph.conf')
- elif os.path.exists('ceph.conf'):
- conffile = 'ceph.conf'
else:
- return None
+ for path in [
+ '/etc/ceph/{0}.conf'.format(clustername),
+ os.path.expanduser('~/.ceph/{0}.conf'.format(clustername)),
+ '{0}.conf'.format(clustername),
+ ]:
+ if os.path.exists(path):
+ return load(path)
- return load(conffile)
+ raise EnvironmentError('No conf file found for "{0}"'.format(clustername))
-def get_conf(cfg, key):
+def get_conf(cfg, clientname, key):
try:
- return cfg.get(glob.clientname, 'restapi_' + key)
+ return cfg.get(clientname, 'restapi_' + key)
except ConfigParser.NoOptionError:
return None
-
# XXX this is done globally, and cluster connection kept open; there
# are facilities to pass around global info to requests and to
# tear down connections between requests if it becomes important
def api_setup():
"""
Initialize the running instance. Open the cluster, get the command
- signatures, module,, perms, and help; stuff them away in the glob.urls
+ signatures, module, perms, and help; stuff them away in the glob.urls
dict.
"""
- glob.args = parse_args()
+ conffile = os.environ.get('CEPH_CONF', '')
+ clustername = os.environ.get('CEPH_CLUSTER_NAME', 'ceph')
+ clientname = os.environ.get('CEPH_NAME', DEFAULT_CLIENTNAME)
+ try:
+ err = ''
+ cfg = load_conf(clustername, conffile)
+ except Exception as e:
+ err = "Can't load Ceph conf file: " + str(e)
+ app.logger.critical(err)
+ app.logger.critical("CEPH_CONF: %s", conffile)
+ app.logger.critical("CEPH_CLUSTER_NAME: %s", clustername)
+ raise EnvironmentError(err)
- conffile = glob.args.conf or ''
- if glob.args.name:
- glob.clientname = glob.args.name
- glob.logfile = '/var/log/ceph' + glob.clientname + '.log'
+ client_logfile = '/var/log/ceph' + clientname + '.log'
- glob.clientname = glob.args.name or DEFAULT_CLIENTNAME
- glob.cluster = rados.Rados(name=glob.clientname, conffile=conffile)
+ glob.cluster = rados.Rados(name=clientname, conffile=conffile)
glob.cluster.connect()
- cfg = load_conf(conffile)
- glob.baseurl = get_conf(cfg, 'base_url') or DEFAULT_BASEURL
+ glob.baseurl = get_conf(cfg, clientname, 'base_url') or DEFAULT_BASEURL
if glob.baseurl.endswith('/'):
glob.baseurl
- addr = get_conf(cfg, 'public_addr') or DEFAULT_ADDR
+ addr = get_conf(cfg, clientname, 'public_addr') or DEFAULT_ADDR
addrport = addr.rsplit(':', 1)
addr = addrport[0]
if len(addrport) > 1:
port = DEFAULT_ADDR.rsplit(':', 1)
port = int(port)
- loglevel = get_conf(cfg, 'log_level') or 'warning'
- logfile = get_conf(cfg, 'log_file') or glob.logfile
+ loglevel = get_conf(cfg, clientname, 'log_level') or DEFAULT_LOG_LEVEL
+ logfile = get_conf(cfg, clientname, 'log_file') or client_logfile
app.logger.addHandler(logging.handlers.WatchedFileHandler(logfile))
app.logger.setLevel(LOGLEVELS[loglevel.lower()])
for h in app.logger.handlers:
ret, outbuf, outs = json_command(glob.cluster,
prefix='get_command_descriptions')
if ret:
- app.logger.error('Can\'t contact cluster for command descriptions: %s',
- outs)
- sys.exit(1)
+ err = "Can't contact cluster for command descriptions: {0}".format(outs)
+ app.logger.error(err)
+ raise EnvironmentError(ret, err)
try:
glob.sigdict = parse_json_funcsigs(outbuf, 'rest')
except Exception as e:
- app.logger.error('Can\'t parse command descriptions: %s', e)
- sys.exit(1)
+ err = "Can't parse command descriptions: {}".format(e)
+ app.logger.error(err)
+ raise EnvironmentError(err)
# glob.sigdict maps "cmdNNN" to a dict containing:
# 'sig', an array of argdescs
contenttype = 'text/plain'
response.headers['Content-Type'] = contenttype
return response
+
+addr, port = api_setup()
projects / ceph.git / commitdiff