From: Sebastian Wagner Date: Tue, 9 Feb 2021 11:02:02 +0000 (+0100) Subject: doc/mgr/orchestrator_modules: adapt to now orch interface X-Git-Tag: v17.1.0~2786^2~2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=d529f1db8242d683df7ec0f405dc695f8203357d;p=ceph.git doc/mgr/orchestrator_modules: adapt to now orch interface Signed-off-by: Sebastian Wagner --- diff --git a/doc/mgr/orchestrator_modules.rst b/doc/mgr/orchestrator_modules.rst index 0fd1f4bbcbb4..4e021fddff37 100644 --- a/doc/mgr/orchestrator_modules.rst +++ b/doc/mgr/orchestrator_modules.rst @@ -98,9 +98,6 @@ Bootstrapping hosts and adding them to the underlying orchestration system is outside the scope of Ceph's orchestrator interface. Ceph can only work on hosts when the orchestrator is already aware of them. -Calls to orchestrator modules are all asynchronous, and return *completion* -objects (see below) rather than returning values immediately. - Where possible, placement of stateless services should be left up to the orchestrator. @@ -108,11 +105,7 @@ Completions and batching ------------------------ All methods that read or modify the state of the system can potentially -be long running. To handle that, all such methods return a *Completion* -object. Orchestrator modules -must implement the *process* method: this takes a list of completions, and -is responsible for checking if they're finished, and advancing the underlying -operations as needed. +be long running. Therefore the module needs to schedule those operations. Each orchestrator module implements its own underlying mechanisms for completions. This might involve running the underlying operations @@ -121,19 +114,6 @@ in one go in the background. If implementing such a batching pattern, the module would do no work on any operation until it appeared in a list of completions passed into *process*. -Some operations need to show a progress. Those operations need to add -a *ProgressReference* to the completion. At some point, the progress reference -becomes *effective*, meaning that the operation has really happened -(e.g. a service has actually been started). - -.. automethod:: Orchestrator.process - -.. autoclass:: Completion - :members: - -.. autoclass:: ProgressReference - :members: - Error Handling --------------