ceph/src/pybind/mgr/dashboard/README.rst

   1
   2 =========================
   3 ceph-mgr dashboard module
   4 =========================
   5
   6 Dependencies
   7 ============
   8
   9 On Ubuntu Xenial:
  10
  11 ::
  12
  13     apt-get install python-cherrypy3
  14
  15 On Fedora:
  16
  17 ::
  18
  19     dnf install -y python-cherrypy
  20
  21
  22 If you had already enabled the module, restart ceph-mgr after installing dependencies to reload the module.
  23
  24 Enabling
  25 ========
  26
  27 Add this to your ceph.conf on nodes where you run ceph-mgr:
  28
  29 ::
  30
  31     [mgr]
  32         mgr modules = dashboard
  33
  34 If you use any other ceph-mgr modules, make sure they're in the list too.
  35
  36 Restart the ceph-mgr daemon after modifying the setting to load the module.
  37
  38 Accessing
  39 =========
  40
  41 Point your browser at port 7000 on the server where ceph-mgr is running.
  42
  43 FAQs
  44 ====
  45
  46 Q: Aargh there's no authentication!  Are you crazy?
  47 A: At present this module only serves read-only status information, and it is disabled by default.  Administrators can make a decision
  48    at the point of enabling the module whether they want to limit access to the port, and/or put it behind an authenticating HTTP proxy
  49    such as Apache+digest auth.
  50    A motivated person could totally build in some authentication stuff though: that would probably only be worth the effort at the point
  51    that non-readonly features were added.
  52
  53 Q: Aargh there's no SSL!  Are you crazy?
  54 A: See the authentication question.  You can always configure your own SSL gateway on top of this if you need it.
  55
  56 Q: Why CherryPy?
  57 A: ceph-mgr is a pure CPython environment, which means that anything gevent based doesn't work (gevent relies on C-level hacks).  CherryPy
  58    includes a web server based on standard python threads, making it a convenient choice.  There are other web frameworks of course.
  59
  60 Q: Does this use the `restful` module?
  61 A: No.  This module loads everything it needs directly via the interfaces available to ceph-mgr modules, and sends it straight to your browser.
  62
  63 Q: My browser says "connection refused"
  64 A: Check that you have a running ceph-mgr daemon.  Look in the ceph-mgr log (/var/log/ceph/ceph-mgr...) for errors loading modules.  Check
  65    that you have enabled the module (see "Enabling" above)
  66
  67 Q: My log contains an error like "ImportError: No module named cherrypy"
  68 A: See "Dependencies" above.  Make sure you installed a 3.x version of cherrypy, many distros have multiple cherrypy packages.
  69
  70 Q: I want to add something to the UI, how do I do it?
  71 A: See HACKING.rst
  72