From d702a61589b3c02d3fa95816c1cac4f61c0a0baa Mon Sep 17 00:00:00 2001 From: David Wilson Date: Thu, 7 Sep 2017 17:56:51 +0530 Subject: [PATCH] More doc updates. --- docs/howitworks.rst | 8 ++++---- docs/index.rst | 19 ++++++++++--------- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/howitworks.rst b/docs/howitworks.rst index 54153f3c..2fd663b3 100644 --- a/docs/howitworks.rst +++ b/docs/howitworks.rst @@ -425,10 +425,10 @@ Example .. image:: images/context-tree.png -In the diagram, when ``master`` is establishing a connection to -``sudo:node12b:webapp``, it must send ``ADD_ROUTE`` messages to ``rack12``, -``dc1``, and ``bastion``; `node12b` does not require an ``ADD_ROUTE`` message -since it has a stream directly connected to the new context. +In the diagram, when ``master`` is creating the ``sudo:node12b:webapp`` +context, it must send ``ADD_ROUTE`` messages to ``rack12``, ``dc1``, and +``bastion``; `node12b` does not require an ``ADD_ROUTE`` message since it has a +stream directly connected to the new context. When ``sudo:node22a:webapp`` wants to send a message to ``sudo:node12b:webapp``, the message will be routed as follows: diff --git a/docs/index.rst b/docs/index.rst index db922ea8..7de0c4ed 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,15 +8,14 @@ Python Execution Contexts Introduction ------------ -The Python ``econtext`` package implements external *execution contexts*: an -execution context is somewhere you can run Python functions external to your -main process, even on a remote machine. +``econtext`` is a library for building distributed self-replicating programs in +Python. -There is **no requirement for installing packages, copying files around, -writing shell scripts, upfront configuration, or providing any secondary link -to the remote machine**. Due to its origins for use in managing potentially -damaged infrastructure, the **remote machine need not even have free disk space -or a writeable filesystem**. +There is no requirement for installing packages, copying files around, writing +shell snippets, upfront configuration, or providing any secondary link to the +remote machine aside from an SSH connection. Due to its origins for use in +managing potentially damaged infrastructure, the **remote machine need not even +have free disk space or a writeable filesystem**. It is not intended as a generic RPC framework; the goal is to provide a robust and efficient low-level API on which tools like `Salt`_ or `Ansible`_ can be @@ -29,7 +28,9 @@ ultimately it should not be used directly by consumer software. The focus is to centralize and perfect the intricate dance required to run Python code safely and efficiently on a remote machine, while avoiding -temporary files or large chunks of error-prone shell scripts. +temporary files or large chunks of error-prone shell scripts, and supporting +common privilege escalation techniques like `sudo`, potentially in combination +with exotic connection methods such as WMI, `telnet`, or console-over-IPMI. Automatic Bootstrap