projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 11fdf7f2 | 1 | |
| a4b75251 TL |
2 | .. _mgr-rook: |
| 3 | ||
| 4 | ==== | |
| 5 | Rook | |
| 6 | ==== | |
| 11fdf7f2 TL |
7 | |
| 8 | Rook (https://rook.io/) is an orchestration tool that can run Ceph inside | |
| 9 | a Kubernetes cluster. | |
| 10 | ||
| 11 | The ``rook`` module provides integration between Ceph's orchestrator framework | |
| 12 | (used by modules such as ``dashboard`` to control cluster services) and | |
| 13 | Rook. | |
| 14 | ||
| 15 | Orchestrator modules only provide services to other modules, which in turn | |
| 16 | provide user interfaces. To try out the rook module, you might like | |
| 17 | to use the :ref:`Orchestrator CLI <orchestrator-cli-module>` module. | |
| 18 | ||
| 19 | Requirements | |
| 20 | ------------ | |
| 21 | ||
| 22 | - Running ceph-mon and ceph-mgr services that were set up with Rook in | |
| 23 | Kubernetes. | |
| 24 | - Rook 0.9 or newer. | |
| 25 | ||
| 26 | Configuration | |
| 27 | ------------- | |
| 28 | ||
| 29 | Because a Rook cluster's ceph-mgr daemon is running as a Kubernetes pod, | |
| 30 | the ``rook`` module can connect to the Kubernetes API without any explicit | |
| 31 | configuration. | |
| 32 | ||
| 33 | Development | |
| 34 | ----------- | |
| 35 | ||
| 36 | If you are a developer, please see :ref:`kubernetes-dev` for instructions | |
| 37 | on setting up a development environment to work with this. | |
| 38 | ||
| 39 |