From 1fecff0e2dbcac3d5db76aeeaa2d71f17f86dd52 Mon Sep 17 00:00:00 2001 From: John Spray Date: Tue, 31 Jul 2018 16:18:33 +0100 Subject: [PATCH] doc: add page for Rook module This is pretty sparse because users don't really interact with the module, they interact with other modules that use it. Signed-off-by: John Spray --- doc/dev/kubernetes.rst | 2 ++ doc/mgr/index.rst | 1 + doc/mgr/rook.rst | 36 ++++++++++++++++++++++++++++++++++++ 3 files changed, 39 insertions(+) create mode 100644 doc/mgr/rook.rst diff --git a/doc/dev/kubernetes.rst b/doc/dev/kubernetes.rst index b7b19d5a83b3d..ef88500a545ff 100644 --- a/doc/dev/kubernetes.rst +++ b/doc/dev/kubernetes.rst @@ -1,4 +1,6 @@ +.. _kubernetes-dev: + ======================================= Hacking on Ceph in Kubernetes with Rook ======================================= diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst index e640292f40f4d..ff85b8de4d7a9 100644 --- a/doc/mgr/index.rst +++ b/doc/mgr/index.rst @@ -40,3 +40,4 @@ sensible. Iostat plugin Crash plugin Devicehealth plugin + Rook plugin diff --git a/doc/mgr/rook.rst b/doc/mgr/rook.rst new file mode 100644 index 0000000000000..f99470791d7b0 --- /dev/null +++ b/doc/mgr/rook.rst @@ -0,0 +1,36 @@ + +============================= +Rook orchestrator integration +============================= + +Rook (https://rook.io/) is an orchestration tool that can run Ceph inside +a Kubernetes cluster. + +The ``rook`` module provides integration between Ceph's orchestrator framework +(used by modules such as ``dashboard`` to control cluster services) and +Rook. + +Orchestrator modules only provide services to other modules, which in turn +provide user interfaces. To try out the rook module, you might like +to use the :ref:`Orchestrator CLI ` module. + +Requirements +------------ + +- Running ceph-mon and ceph-mgr services that were set up with Rook in + Kubernetes. +- A sufficiently recent version of Rook. (**TODO: update once required Rook + tweaks are in a release**) + +If you are a developer, please see :ref:`kubernetes-dev` for instructions +on setting up a development environment to work with this. + +Configuration +------------- + +Because a Rook cluster's ceph-mgr daemon is running as a Kubernetes pod, +the ``rook`` module can connect to the Kubernetes API without any explicit +configuration. + + + -- 2.39.5