Three levels makes it easier to find content in the
main toctree so lets make it easier for folks to use
the table of contents to find what they are looking for
instead of making it harder...
This change makes three levels look readable as well as
fixes some discrepancies among the various sections...
Change-Id: I5fd7a062adec052c338790c9ba343dfbc51075e3
Apply some adjustments on the docs by rewording certain
statements, linking to the correct classes and methods and
linking to the correct exceptions to make it easier for
users to follow the docs and there associated types and links.
Change-Id: I03aac77c814fc4c376003f09a45559a0995b3c6c
Adjust the graph analyzer to be a more generic compilation
analyzer which analyzes compilation objects (which are now
changed to be an object and not a named tuple) and provides
utility functions ontop of that object. This helps it become
possible to provide other useful analysis functions that are
not directly tied to the execution graph component but can
be provided ontop of other compilation components.
Change-Id: I2ab08db4f566d5f329d7e79b1c50ed65aad9e4b3
Factor out the scheduling, running and completion components
of graph_action so that we can allow this to be plugged in with
other types of scheduling, running and completion strategies.
The newly added components are the following:
- A runtime container class (serves as a holder of some small
utility functions) and all the other runtime components.
- A runner class that acts as the action engines run loop.
- A scheduler class that schedules nodes using a provided executor
and returns futures that can be used to introspect there results as
they complete.
- A completer class that completes nodes and futures that the
scheduler started, persisting there results and doing any further
post-execution analysis.
Part of blueprint plug-engine
Change-Id: I1dbf46654377fc34e9d90eeabf7b0062020bdc5e
Add a nice visual representation of the states the action
engine yields back while executing (which are available from
its run_iter method) and give a brief overview of what these
states mean and how they are used (in diagram and in text).
Change-Id: Idc6abc83e0ed7510c0e4c58b7fcfc26cce3e98a2
What is checked:
- lines should not be longer than 79 characters, also
there are few exceptions;
- no tabulation for indentation;
- no trailing whitespace.
Change-Id: Id5b5dff380460d1fb4ffeeb23f00864e7fc158ed
Breaking change: moves from taking an executor
from configuration (it really is not configuration) and
instead takes that executor instead from the additional
kwargs which can be provided to a engine-specific type.
Change-Id: I475f33a63ebd08f6c20a16534423c8bc3502fa3f
Instead of linking to other topics (which then uses
the name of those topics as the link name) define a
name that makes more sense for the inline usage and
retain the link to the document using wording that
fits the surronding text.
Also adjust the futures/executor links to point to the
external links documenting these features.
Change-Id: I5a89e2f747dfec2505947f25c124b157271c07cf
Describe why engines exist and also describe at a
somewhat lower-level how an action engine goes
through its various stages when executing
and what each stages high-level goal is (and how it
is performed).
Change-Id: I79c4b90047826fb2c9f33da75044a9cb42cfe47d
Begin to rework the twiki docs into a developer doc,
moving items from the twiki to rst and adjusting examples
to make a unified place where the worker model can be
documented.
Change-Id: I43ed828be33351b9fb6606317011e7204f61a136
- Cleanup some grammar and adjust some wording usage.
- Add more docs to utils about what should and should
not be used.
- Add more engine docs about how each one is used and
tips and notes about each.
- Line length adjustments (might as well keep it somewhat
in the normal range of what openstack code expects)
Change-Id: Ice6711f00e2b50e0bee777388c0555d79cc6e1b0
- move all docs sources to docs/source;
- rework documentation structure and contents;
- update conf.py and clean it up;
- switch use oslosphinx;
- add sphinx and oslosphinx to test requrements.
Change-Id: Ied37f86e559516ef7a106e2870d4817ff01a8af4