From daeca276aba47541bf408f71b50efe276bdbdd86 Mon Sep 17 00:00:00 2001 From: John Spray Date: Wed, 27 Aug 2014 22:19:52 +0100 Subject: [PATCH] orchestra: more docstring Signed-off-by: John Spray --- teuthology/orchestra/daemon.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/teuthology/orchestra/daemon.py b/teuthology/orchestra/daemon.py index 70892b4b5f..c35882ca11 100644 --- a/teuthology/orchestra/daemon.py +++ b/teuthology/orchestra/daemon.py @@ -184,11 +184,13 @@ class DaemonGroup(object): :: # Passing None (i.e. user left config blank) defaults to all roles (filtered by ``types``) - None -> ['osd.0', 'osd.1', 'osd.2', 'mds.a', mds.b', 'mon.a'] + None, types=['osd', 'mds', 'mon'] -> ['osd.0', 'osd.1', 'osd.2', 'mds.a', mds.b', 'mon.a'] # Wildcards are expanded - roles=['mds.*', 'osd.0'] -> ['mds.a', 'mds.b', 'osd.0'] + roles=['mds.*', 'osd.0'], types=['osd', 'mds', 'mon'] -> ['mds.a', 'mds.b', 'osd.0'] # Boring lists are unaltered - roles=['osd.0', 'mds.a'] -> ['osd.0', 'mds.a'] + roles=['osd.0', 'mds.a'], types=['osd', 'mds', 'mon'] -> ['osd.0', 'mds.a'] + # Entries in role list that don't match types result in an exception + roles=['osd.0', 'mds.a'], types=['osd'] -> RuntimeError :param roles: List (of roles or wildcards) or None (select all suitable roles) :param types: List of acceptable role types, for example ['osd', 'mds']. -- 2.39.5