diff --git a/doc/source/conf.py b/doc/source/conf.py index 7da91fd6..0e03c9ac 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -78,7 +78,8 @@ release = '0.0.1' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = [] +exclude_patterns = ['feature_request/README.rst', 'samples/README.rst', + '**/README.rst'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None diff --git a/doc/source/feature_request b/doc/source/feature_request new file mode 120000 index 00000000..4b5d7cf8 --- /dev/null +++ b/doc/source/feature_request @@ -0,0 +1 @@ +../feature_request/ \ No newline at end of file diff --git a/doc/source/feature_requests.rst b/doc/source/feature_requests.rst new file mode 100644 index 00000000..2a2bb449 --- /dev/null +++ b/doc/source/feature_requests.rst @@ -0,0 +1,6 @@ +.. include:: feature_request/README.rst + +.. toctree:: + :glob: + + feature_request/* diff --git a/doc/source/index.rst b/doc/source/index.rst index ed4a0082..1a912c2c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -33,7 +33,7 @@ The OpenStack QA team mostly works on CI/CD that ensures that new patches don't Deeper in Rally: ---------------- .. toctree:: - :maxdepth: 3 + :maxdepth: 2 overview concepts @@ -42,21 +42,16 @@ Deeper in Rally: verify installation usage + feature_requests + user_stories Development information: ------------------------ .. toctree:: - :maxdepth: 3 + :maxdepth: 2 cmds implementation improve_rally rally_gatejob - -Indices and tables ------------------- - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/doc/user_stories/keystone/authenticate.rst b/doc/user_stories/keystone/authenticate.rst index dc881f05..7a3543e9 100644 --- a/doc/user_stories/keystone/authenticate.rst +++ b/doc/user_stories/keystone/authenticate.rst @@ -1,6 +1,6 @@ -========= -Benchmark -========= + +Keystone token creation benchmark +================================= Authenticate users with keystone to get tokens. Goal @@ -45,10 +45,12 @@ Results 1. Concurrency = 4 +.. code-block:: none + {'context': {'users': {'concurrent': 30, - | 'tenants': 12, - | 'users_per_tenant': 512}}, - | 'runner': {'concurrency': 4, 'times': 10000, 'type': 'constant'}} + 'tenants': 12, + 'users_per_tenant': 512}}, + 'runner': {'concurrency': 4, 'times': 10000, 'type': 'constant'}} +--------+-----------+-----------+-----------+---------------+---------------+---------+-------+-----------------------+--------------+ @@ -64,10 +66,12 @@ Results 2. Concurrency = 16 +.. code-block:: none + {'context': {'users': {'concurrent': 30, - | 'tenants': 12, - | 'users_per_tenant': 512}}, - | 'runner': {'concurrency': 16, 'times': 10000, 'type': 'constant'}} + 'tenants': 12, + 'users_per_tenant': 512}}, + 'runner': {'concurrency': 16, 'times': 10000, 'type': 'constant'}} +--------+-----------+-----------+-----------+---------------+---------------+---------+-------+-----------------------+--------------+ | action | min (sec) | avg (sec) | max (sec) | 90 percentile | 95 percentile | success | count |apache enabled keystone|public_workers| @@ -82,10 +86,12 @@ Results 3. Concurrency = 32 +.. code-block:: none + {'context': {'users': {'concurrent': 30, - | 'tenants': 12, - | 'users_per_tenant': 512}}, - | 'runner': {'concurrency': 32, 'times': 10000, 'type': 'constant'}} + 'tenants': 12, + 'users_per_tenant': 512}}, + 'runner': {'concurrency': 32, 'times': 10000, 'type': 'constant'}} +--------+-----------+-----------+-----------+---------------+---------------+---------+-------+-----------------------+--------------+ | action | min (sec) | avg (sec) | max (sec) | 90 percentile | 95 percentile | success | count |apache enabled keystone|public_workers|