From 7ad61cc032882ba4fd2bc26396054cd4586c2ccd Mon Sep 17 00:00:00 2001 From: John Spray Date: Tue, 7 Aug 2018 09:54:19 -0400 Subject: [PATCH] doc: Rook/orchestrator doc fixes Signed-off-by: John Spray --- doc/dev/index.rst | 2 +- doc/dev/kubernetes.rst | 10 +++++----- src/pybind/mgr/orchestrator.py | 3 +-- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/doc/dev/index.rst b/doc/dev/index.rst index 0b3bf953b2b6a..db176517f124e 100644 --- a/doc/dev/index.rst +++ b/doc/dev/index.rst @@ -206,7 +206,7 @@ See :doc:`/dev/quick_guide`. Kubernetes/Rook development cluster ----------------------------------- -See :doc:`/dev/kubernetes`. +See :ref:`kubernetes-dev` Backporting ----------- diff --git a/doc/dev/kubernetes.rst b/doc/dev/kubernetes.rst index ef88500a545ff..fc9373c89894c 100644 --- a/doc/dev/kubernetes.rst +++ b/doc/dev/kubernetes.rst @@ -5,7 +5,7 @@ Hacking on Ceph in Kubernetes with Rook ======================================= -.. warning: +.. warning:: This is *not* official user documentation for setting up production Ceph clusters with Kubernetes. It is aimed at developers who want @@ -67,7 +67,7 @@ Make sure you check how much it's costing you before you spin up a big cluster! =========================== Ideally, run this somewhere accessible from both your workstation and your -kubernetes cluster (i.e. so that "docker push/pull" just works everywhere). +kubernetes cluster (i.e. so that ``docker push/pull`` just works everywhere). This is likely to be the same host you're using as your kubernetes master. 1. Install the ``docker-distribution`` package. @@ -83,7 +83,7 @@ This is likely to be the same host you're using as your kubernetes master. 3. Build Rook ============= -.. info: +.. note:: Work within your $GOPATH -- here we assume it's ~/go @@ -151,7 +151,7 @@ binaries: build$ REPO=: sh ../src/script/kubejacker/kubejacker.sh -.. info: +.. note:: You can also set ``BASEIMAGE`` to control that Rook image used as the base -- by default this is set to any "ceph-amd64" image. @@ -166,7 +166,7 @@ build, and the Ceph build too. 5. Run a Rook cluster ===================== -.. info: +.. note:: This is just some basic instructions: the Rook documentation is much more expansive, at https://github.com/rook/rook/tree/master/Documentation diff --git a/src/pybind/mgr/orchestrator.py b/src/pybind/mgr/orchestrator.py index 0660f05e970e0..43eee7da630d7 100644 --- a/src/pybind/mgr/orchestrator.py +++ b/src/pybind/mgr/orchestrator.py @@ -127,7 +127,7 @@ class Orchestrator(object): status to return: the default None, None return value is used to indicate that a module is unable to indicate its availability. - @return two-tuple of boolean, string + :return: two-tuple of boolean, string """ return None, None @@ -175,7 +175,6 @@ class Orchestrator(object): compression/encryption, etc). :param osd_spec: OsdCreationSpec - :return: """ raise NotImplementedError() -- 2.39.5