ceph/doc/mgr/restful.rst

   1 restful plugin
   2 ==============
   3
   4 RESTful plugin offers the REST API access to the status of the cluster. RESTful
   5 plugin enables you to secure the API endpoints via SSL. If you don't have a
   6 security certificate and key already, you need to create them first::
   7
   8   openssl req -new -nodes -x509 \
   9     -subj "/O=IT/CN=ceph-mgr-restful" \
  10     -days 3650 -keyout $PKEY -out $CERT -extensions v3_ca
  11
  12 where ``$PKEY`` and ``$CERT`` are the paths to the private key and the
  13 certificate. And then you need to import the keystore to the cluster using the
  14 configuration key facility, so RESTful plugin can read them at startup::
  15
  16   ceph config-key put mgr/restful/$name/crt -i $CERT
  17   ceph config-key put mgr/restful/$name/key -i $PKEY
  18
  19 Also, like other web applications, RESTful plugin is bound to the a hostname and
  20 a port::
  21
  22   ceph config-key put mgr/restful/$name/server_addr $IP
  23   ceph config-key put mgr/restful/$name/server_port $PORT
  24
  25 If not specified, the plugin uses ``127.0.0.1:8003`` by default.