Commit Graph

17 Commits

Author SHA1 Message Date
Joshua Harlow
b5e3fbebc6 Expand toctree to three levels
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
2014-09-25 00:10:41 -07:00
Joshua Harlow
dbf117aaf5 Documentation cleanups and tweaks
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
2014-09-23 15:16:13 -07:00
Joshua Harlow
7b5dad30ed Rename the graph analyzer to analyzer
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
2014-06-03 01:22:47 +00:00
Joshua Harlow
7f525de0f9 Finish factoring apart the graph_action module
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
2014-05-29 13:03:16 -07:00
Joshua Harlow
1a226baa89 Add engine state diagram
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
2014-05-21 18:49:06 -07:00
Ivan A. Melnikov
f986a82731 Check documentation for simple style requirements
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
2014-05-08 12:11:18 +04:00
Joshua Harlow
8ebce5b027 Pass executor via kwargs instead of config
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
2014-05-04 18:21:17 -07:00
Joshua Harlow
7d441555ef Adjust doc linking
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
2014-05-03 23:55:25 -07:00
Jenkins
f97217c7f7 Merge "Medium-level docs on engines" 2014-05-04 03:03:56 +00:00
Jenkins
162c683397 Merge "Add docs for the worker based engine (WBE)" 2014-05-03 19:14:25 +00:00
Joshua Harlow
c6c57cd14e Medium-level docs on engines
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
2014-05-03 11:43:33 -07:00
Joshua Harlow
bb64df0b15 Add docs for the worker based engine (WBE)
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
2014-05-03 10:15:34 -07:00
Joshua Harlow
964a37df9a Documentation tune-ups
Change-Id: Iac0ddd4948ab364e1905327978bf449b52294388
2014-04-26 19:54:17 -07:00
Stanislav Kudriashev
ef72c4dcde Fix documentation spelling errors
Change-Id: Ic5a06195cba7c27ff7664fcb8e8b514d7dc31cb7
2014-04-23 23:45:57 +02:00
Joshua Harlow
f2c82f0929 Doc adjustments
- 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
2014-04-11 12:36:26 -07:00
Ivan A. Melnikov
470b2b8946 Improve documentation for engines
Partially implements blueprint sphinx-docs.

Change-Id: I75428a42ff2a53ea50304be6a497c6a17a45db16
2014-03-31 22:42:24 +04:00
Ivan A. Melnikov
b5347054aa Rework sphinx documentation
- 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
2014-02-14 16:25:15 +04:00