Add a job consideration doc

Discuss about the dual-engine usage consideration and
add suggestions around how this can be alleviated when
a jobboard is used to claim & perform work.

(Removed from gate, zuul lost this change and it log
jammed the gate.)

Change-Id: I0c2460fc3ff7e9d34b7578d2e967f6bfa489e770
Fix documentation spelling errors

Change-Id: Ic5a06195cba7c27ff7664fcb8e8b514d7dc31cb7
Add a example that activates a future when a result is ready

To allow for an engine to continue to run while at the same time
returning from a function when a component of that engine finishes
a pattern can be used that ties and engines listeners to the function
return, allowing for both to be used simulatenously.

Change-Id: Iab49e0c7b233138bc2d02247ab7aa3d99a82cd67
Add a persistence backend fetching context manager

Allow the persistence backends to be fetched using a new
helper method that can be used as a context manager, it will
fetch the backend, ensure it's upgraded and upon context manager
exit will close the backend automatically.

Change-Id: I1bf8e43dcce25c02823cca92e3e7ed3ef254a847
Skip loading (and failing to load) lock files

Ignore lock files (and other hidden files) that zookeeper
will notify the jobboard about and avoid reading these as
potential jobs (which they are not).

Fixes bug 1312843

Change-Id: Ifa1ed31e22aed838f9baf883a6faaec00187663a
Merge "Add a job consideration doc"
Docs and cleanups for test_examples runner

- Ensure test method name is safe to use
- Add docs to explain what the functions are doing
- Skip no_test files (as well as utils files)

Change-Id: I5d0c9f354f1c5c7be36575a1e2288442a160129b
Add a resumption strategy doc

Move docs from wiki to developer docs and
add on and adjust to reflect the current
state of things.

Change-Id: I50ab1ebeb33074d1fbc7493749d0d518b66de69e
Fix spelling error

Fix 'ans' -> 'and' in atom detail.

Change-Id: I0c33b03d3b475791960f63450acf2e639184ae1f
Documentation tune-ups

Change-Id: Iac0ddd4948ab364e1905327978bf449b52294388
Fix "occured" -> "occurred"

Change-Id: I96383a4cd436a6b923a1c951ee41a28f5b73a14b
Integrate urlparse for configuration augmentation

Allow the uri passed to various entrypoints to itself
contain most of the configuration for that entrypoint
by using the RFC 3986 uri format to allow for additional
parameters to be used in configuring and selecting those
entrypoints.

Also bring over network_utils from oslo since it provides
a more compliant url splitting support.

Part of blueprint persistence-uris

Change-Id: I8e5d8584d2cac4f9b338fa155f220cdfd52bb7d9
Load engines with defined args and provided kwargs

To match the other fetch() functions, make the engine
load and run methods take in kwargs which can be used
by a specific engine if needed. Instead of the previous
passing engine args by invoke_kwds, use the invoke_args
with the specific kwargs being placed in invoke_kwds.

Change-Id: I7974ed774909de82a8b48615dfe29836ca8d809d
Merge "Fix spelling error"
Merge "Documentation tune-ups"
Remove persistence wiki page link

All of the relevant docs have been moved over to the
developer docs and the only thing left on the wiki
page is a high-level intro and a link to the developer
docs.

Change-Id: I1fcc5d34586bad3d92fa8bb5043c55249e1c9bdd
Merge "Add a resumption strategy doc"
Merge "Skip loading (and failing to load) lock files"
Synced jsonutils from oslo-incubator

The sync includes change that drastically enhances performance on Python
2.6 with fresh simplejson library installed.

The latest commit in oslo-incubator:
- 732bdb6297eb9de81667f7713ebcb1ccc2ee45a7

Change-Id: Ib3dc0b713ed90396919feba018772243b3b9c90f
Closes-Bug: 1314129
Merge "Remove persistence wiki page link"