From b3b9f82085c9538a58786e8501222a1d2cdfe7d3 Mon Sep 17 00:00:00 2001 From: David Wilson Date: Tue, 2 Apr 2019 12:46:30 +0100 Subject: [PATCH] docs: move confusing install step to noteworthy difference --- docs/ansible_detailed.rst | 17 +++++++++-------- docs/conf.py | 4 ++-- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/ansible_detailed.rst b/docs/ansible_detailed.rst index 5b541a14..aeaa5e7c 100644 --- a/docs/ansible_detailed.rst +++ b/docs/ansible_detailed.rst @@ -75,13 +75,7 @@ Installation ``mitogen_host_pinned`` strategies exists to mimic the ``free`` and ``host_pinned`` strategies. -4. If targets have a restrictive ``sudoers`` file, add a rule like: - - :: - - deploy = (ALL) NOPASSWD:/usr/bin/python -c* - -5. +4. .. raw:: html @@ -103,7 +97,6 @@ Installation - Demo ~~~~ @@ -172,6 +165,14 @@ Noteworthy Differences * The ``doas``, ``su`` and ``sudo`` become methods are available. File bugs to register interest in more. +* The ``sudo`` comands executed differ slightly compared to Ansible. In some + cases where the target has a ``sudo`` configuration that restricts the exact + commands allowed to run, it may be necessary to add a ``sudoers`` rule like: + + :: + + your_ssh_username = (ALL) NOPASSWD:/usr/bin/python -c* + * The `docker `_, `jail `_, `kubectl `_, diff --git a/docs/conf.py b/docs/conf.py index 7f03e451..80973c36 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -5,8 +5,8 @@ sys.path.append('..') import mitogen VERSION = '%s.%s.%s' % mitogen.__version__ -author = u'David Wilson' -copyright = u'2019, David Wilson' +author = u'Network Genomics' +copyright = u'2019, Network Genomics' exclude_patterns = ['_build'] extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinxcontrib.programoutput'] html_show_sourcelink = False