doc/orch: Host labels

Fixes: https://tracker.ceph.com/issues/45833
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
(cherry picked from commit 4cb501416da0f89648f4f075b447a35f45feed7f)

diff --git a/doc/mgr/orchestrator.rst b/doc/mgr/orchestrator.rst
index e434bf490cd271755d3f76076b8463aa34535006..8240076c4913f68b03a0302cd9845bd31a205d8f 100644 (file)
--- a/doc/mgr/orchestrator.rst
+++ b/doc/mgr/orchestrator.rst
@@ -107,6 +107,25 @@ Many hosts can be added at once using
 
 This can be combined with service specifications (below) to create a cluster spec file to deploy a whole cluster in one command.  see ``cephadm bootstrap --apply-spec`` also to do this during bootstrap. Cluster SSH Keys must be copied to hosts prior to adding them.
 
+.. _orchestrator-host-labels:
+
+Host labels
+-----------
+
+The orchestrator supports assigning labels to hosts. Labels
+are free form and have no particular meaning by itself and each host
+can have multiple labels. They can be used to specify placement
+of daemons. See :ref:`orch-placement-by-labels`
+
+To add a label, run::
+
+  ceph orch host label add my_hostname my_label
+
+To remove a label, run::
+
+  ceph orch host label rm my_hostname my_label
+
+
 OSD Management
 ==============
 
@@ -804,6 +823,8 @@ MONs and other services may require some enhanced network specifications::
 where ``[v2:1.2.3.4:3300,v1:1.2.3.4:6789]`` is the network address of the monitor
 and ``=name`` specifies the name of the new monitor.
 
+.. _orch-placement-by-labels:
+
 Placement by labels
 -------------------
 
@@ -819,6 +840,8 @@ Or in YAML:
     placement:
       label: "mylabel"
 
+* See :ref:`orchestrator-host-labels`
+
 
 Placement by pattern matching
 -----------------------------