ceph/doc/mgr/deepsea.rst

   1
   2 ================================
   3 DeepSea orchestrator integration
   4 ================================
   5
   6 DeepSea (https://github.com/SUSE/DeepSea) is a collection of `Salt
   7 <https://github.com/saltstack/salt>`_ state files, runners and modules for
   8 deploying and managing Ceph.
   9
  10 The ``deepsea`` module provides integration between Ceph's orchestrator
  11 framework (used by modules such as ``dashboard`` to control cluster services)
  12 and DeepSea.
  13
  14 Orchestrator modules only provide services to other modules, which in turn
  15 provide user interfaces.  To try out the deepsea module, you might like
  16 to use the :ref:`Orchestrator CLI <orchestrator-cli-module>` module.
  17
  18 Requirements
  19 ------------
  20
  21 - A salt-master node with DeepSea 0.9.9 or later installed, and the salt-api
  22   service running.
  23 - Ideally, several salt-minion nodes against which at least DeepSea's stages 0
  24   through 2 have been run (this is the minimum required for the orchestrator's
  25   inventory and status functions to return interesting information).
  26
  27 Configuration
  28 -------------
  29
  30 Four configuration keys must be set in order for the module to talk to
  31 salt-api:
  32
  33 - salt_api_url
  34 - salt_api_username
  35 - salt_api_password
  36 - salt_api_eauth (default is "sharedsecret")
  37
  38 These all need to match the salt-api configuration on the salt master (see
  39 eauth.conf, salt-api.conf and sharedsecret.conf in /etc/salt/master.d/ on the
  40 salt-master node).
  41
  42 Configuration keys
  43 ^^^^^^^^^^^^^^^^^^^
  44
  45 Configuration keys can be set on any machine with the proper cephx credentials,
  46 these are usually Monitors where the *client.admin* key is present.
  47
  48 ::
  49
  50     ceph deepsea config-set <key> <value>
  51
  52 For example:
  53
  54 ::
  55
  56     ceph deepsea config-set salt_api_url http://admin.example.com:8000/
  57     ceph deepsea config-set salt_api_username admin
  58     ceph deepsea config-set salt_api_password 12345
  59
  60 The current configuration of the module can also be shown:
  61
  62 ::
  63
  64    ceph deepsea config-show
  65
  66 Debugging
  67 ---------
  68
  69 Should you want to debug the deepsea module, increase the logging level for
  70 ceph-mgr and check the logs.
  71
  72 ::
  73
  74     [mgr]
  75         debug mgr = 20
  76
  77 With the log level set to 20, the module will print out all the data received
  78 from the salt event bus.  All log messages will be prefixed with *mgr[deepsea]*
  79 for easy filtering.