diff --git a/doc/mgr/orchestrator.rst b/doc/mgr/orchestrator.rst index 0d1b4192e5a..b09610d9c81 100644 --- 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 ============== @@ -802,6 +821,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 ------------------- @@ -817,6 +838,8 @@ Or in YAML: placement: label: "mylabel" +* See :ref:`orchestrator-host-labels` + Placement by pattern matching -----------------------------