Rework the journey indexing
This patch propose a rework of the toctree so we have all configure resources available in a subfolder instead of only one page. This is also solving the issue introduced in 862100 (duplicate menu entry). Signed-off-by: Arnaud Morin <arnaud.morin@ovhcloud.com> Change-Id: I9b45309a981d0f0ddedc006b90499036b137360b
This commit is contained in:
Arnaud Morin
parent
a867b11375
commit
4d21656ba3
|
|
@ -1,12 +1,27 @@
|
|||
.. include:: ../../README.rst
|
||||
|
||||
Contents:
|
||||
Large-scale journey
|
||||
-------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
journey/index
|
||||
|
||||
Large-scale stories
|
||||
-------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
journey/index
|
||||
journey/configure/index
|
||||
stories/index
|
||||
|
||||
Other
|
||||
-----
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
other/index
|
||||
contributing
|
||||
|
||||
|
|
|
|||
|
|
@ -1,37 +0,0 @@
|
|||
------------------
|
||||
Stage 1: Configure
|
||||
------------------
|
||||
|
||||
The first stage in the :doc:`Scaling Journey <../index>` is Configure.
|
||||
|
||||
This stage is about fine-tuning configuration options and optimizing the parameters for your OpenStack cluster, so that it can handle additional load. The default values for configuration parameters in OpenStack are not always well-suited for handling scale, and OpenStack documentation does not always indicate which parameters to adjust with scale. This page aims to help answer those early questions.
|
||||
|
||||
Once your cluster is properly configured to handle scale, you can go to the second stage of the Scaling Journey: :doc:`Monitor <monitor>`.
|
||||
|
||||
|
||||
Resources
|
||||
---------
|
||||
|
||||
* :doc:`Large Scale Configuration guidelines for RabbitMQ </journey/configure/rabbitmq>`
|
||||
* :doc:`Large Scale Configuration guidelines for Database </journey/configure/database>`
|
||||
* :doc:`Large Scale Configuration guidelines (other/extra) </journey/configure/other>`
|
||||
|
||||
|
||||
External resources
|
||||
------------------
|
||||
|
||||
* Neutron backends performance comparison: https://thesaitech.wordpress.com/2019/02/15/a-comparative-study-of-openstack-networking-architectures/
|
||||
* Evaluation of performance before deployment
|
||||
|
||||
* https://superuser.openstack.org/articles/collaborations-cross-industries-openstack-neutron-and-discovery-open-science-initiative/
|
||||
* Enos: https://github.com/BeyondTheClouds/enos and Enoslib: https://gitlab.inria.fr/discovery/enoslib
|
||||
|
||||
|
||||
How to help
|
||||
-----------
|
||||
|
||||
* Document better configuration defaults for large scale
|
||||
|
||||
* Collect input at https://etherpad.opendev.org/p/large-scale-sig-documentation
|
||||
* Curate and add new content in configure resources
|
||||
* Push to official doc, pointing back to the guidelines page
|
||||
|
|
@ -1,12 +1,50 @@
|
|||
=================
|
||||
Other resources
|
||||
=================
|
||||
==================
|
||||
Stage 1: Configure
|
||||
==================
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:maxdepth: 1
|
||||
|
||||
rabbitmq
|
||||
database
|
||||
other
|
||||
|
||||
---------
|
||||
Configure
|
||||
---------
|
||||
|
||||
The first stage in the :doc:`Scaling Journey </journey/index>` is Configure.
|
||||
|
||||
This stage is about fine-tuning configuration options and optimizing the parameters for your OpenStack cluster, so that it can handle additional load. The default values for configuration parameters in OpenStack are not always well-suited for handling scale, and OpenStack documentation does not always indicate which parameters to adjust with scale. This page aims to help answer those early questions.
|
||||
|
||||
Once your cluster is properly configured to handle scale, you can go to the second stage of the Scaling Journey: :doc:`Monitor </journey/monitor>`.
|
||||
|
||||
|
||||
Resources
|
||||
---------
|
||||
|
||||
* :doc:`Large Scale Configuration guidelines for RabbitMQ </journey/configure/rabbitmq>`
|
||||
* :doc:`Large Scale Configuration guidelines for Database </journey/configure/database>`
|
||||
* :doc:`Large Scale Configuration guidelines (other/extra) </journey/configure/other>`
|
||||
|
||||
|
||||
External resources
|
||||
------------------
|
||||
|
||||
* Neutron backends performance comparison: https://thesaitech.wordpress.com/2019/02/15/a-comparative-study-of-openstack-networking-architectures/
|
||||
* Evaluation of performance before deployment
|
||||
|
||||
* https://superuser.openstack.org/articles/collaborations-cross-industries-openstack-neutron-and-discovery-open-science-initiative/
|
||||
* Enos: https://github.com/BeyondTheClouds/enos and Enoslib: https://gitlab.inria.fr/discovery/enoslib
|
||||
|
||||
|
||||
How to help
|
||||
-----------
|
||||
|
||||
* Document better configuration defaults for large scale
|
||||
|
||||
* Collect input at https://etherpad.opendev.org/p/large-scale-sig-documentation
|
||||
* Curate and add new content in configure resources
|
||||
* Push to official doc, pointing back to the guidelines page
|
||||
|
|
|
|||
|
|
@ -12,9 +12,9 @@ articles, presentations. When documentation or tools are missing, we help
|
|||
to produce them.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:maxdepth: 2
|
||||
|
||||
configure
|
||||
configure/index
|
||||
monitor
|
||||
scale_up
|
||||
scale_out
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
Stage 2: Monitor
|
||||
================
|
||||
|
||||
The second stage in the :doc:`Scaling Journey <../index>` is Monitor.
|
||||
The second stage in the :doc:`Scaling Journey </journey/index>` is Monitor.
|
||||
|
||||
Once you have properly :doc:`configured <configure>` your cluster to handle scale, you will need to properly monitor it for signs of load stress. Monitoring in OpenStack can be a bit overwhelming and it's sometimes hard to determine how to meaningfully monitor your deployment to get advance warning of when load is just too high. This page aims to help answer those questions.
|
||||
Once you have properly :doc:`configured </journey/configure/index>` your cluster to handle scale, you will need to properly monitor it for signs of load stress. Monitoring in OpenStack can be a bit overwhelming and it's sometimes hard to determine how to meaningfully monitor your deployment to get advance warning of when load is just too high. This page aims to help answer those questions.
|
||||
|
||||
Once meaningful monitoring is in place, you are ready to proceed to the third stage of the Scaling Journey: :doc:`Scale Up <scale_up>`.
|
||||
Once meaningful monitoring is in place, you are ready to proceed to the third stage of the Scaling Journey: :doc:`Scale Up </journey/scale_up>`.
|
||||
|
||||
|
||||
FAQ
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
Stage 4: Scale Out
|
||||
==================
|
||||
|
||||
The fourth stage in the :doc:`Scaling Journey <../index>` is Scale Out.
|
||||
The fourth stage in the :doc:`Scaling Journey </journey/index>` is Scale Out.
|
||||
|
||||
No matter how much you manage to :doc:`Scale up <scale_up>` a single cluster, at one point you will have to scale out to multiple clusters, zones, regions or cells. It can be difficult to navigate the various choices you have and pick the best architecture. This page aims to help answer those questions.
|
||||
No matter how much you manage to :doc:`Scale up </journey/scale_up>` a single cluster, at one point you will have to scale out to multiple clusters, zones, regions or cells. It can be difficult to navigate the various choices you have and pick the best architecture. This page aims to help answer those questions.
|
||||
|
||||
Once you are past that stage, you are ready to proceed to the final stage of the Scaling Journey: :doc:`Upgrade and Maintain <upgrade_and_maintain>`.
|
||||
Once you are past that stage, you are ready to proceed to the final stage of the Scaling Journey: :doc:`Upgrade and Maintain </journey/upgrade_and_maintain>`.
|
||||
|
||||
|
||||
FAQ
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
Stage 3: Scale Up
|
||||
=================
|
||||
|
||||
The third stage in the :doc:`Scaling Journey <../index>` is Scale Up.
|
||||
The third stage in the :doc:`Scaling Journey </journey/index>` is Scale Up.
|
||||
|
||||
As you :doc:`monitor <monitor>` your cluster at scale, you will see that it hits scaling limits within one cluster. All hope is not lost, though! There are things you can put in place push back how much a single cluster can handle, before having to resort to setting up a more complex deployment configuration. This page aims to help answer those questions.
|
||||
As you :doc:`monitor </journey/monitor>` your cluster at scale, you will see that it hits scaling limits within one cluster. All hope is not lost, though! There are things you can put in place push back how much a single cluster can handle, before having to resort to setting up a more complex deployment configuration. This page aims to help answer those questions.
|
||||
|
||||
Once you are past that stage, you are ready to proceed to next stage of the Scaling Journey: :doc:`Scale Out <scale_out>`.
|
||||
Once you are past that stage, you are ready to proceed to next stage of the Scaling Journey: :doc:`Scale Out </journey/scale_out>`.
|
||||
|
||||
|
||||
FAQ
|
||||
|
|
@ -36,7 +36,7 @@ A: If you found out that your rabbitmq queue keep piling up for a certain servic
|
|||
Resources
|
||||
---------
|
||||
|
||||
* A curated collection of :doc:`scaling stories <../stories/index>`, as we collect them
|
||||
* A curated collection of :doc:`scaling stories </stories/index>`, as we collect them
|
||||
|
||||
* Evaluation of internal messaging
|
||||
|
||||
|
|
@ -70,4 +70,4 @@ Other SIG work on that stage
|
|||
|
||||
* Submit scaling stories on https://etherpad.openstack.org/p/scaling-stories
|
||||
|
||||
* Curate them on :doc:`scaling stories <../stories/index>`
|
||||
* Curate them on :doc:`scaling stories </stories/index>`
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
Stage 5: Upgrade And Maintain
|
||||
=============================
|
||||
|
||||
The final stage in the :doc:`Scaling Journey <../index>` is Upgrade and Maintain.
|
||||
The final stage in the :doc:`Scaling Journey </journey/index>` is Upgrade and Maintain.
|
||||
|
||||
Once you have successfully :doc:`scaled out <scale_out>`, how to do you effectively upgrade and maintain your deployment going forward? This stage is about establishing regular operations to keep your deployment up to date and benefit from the latest bugfixes and operating system improvements. This page aims to help answer those questions.
|
||||
Once you have successfully :doc:`scaled out </journey/scale_out>`, how to do you effectively upgrade and maintain your deployment going forward? This stage is about establishing regular operations to keep your deployment up to date and benefit from the latest bugfixes and operating system improvements. This page aims to help answer those questions.
|
||||
|
||||
|
||||
FAQ
|
||||
|
|
|
|||
Loading…
Reference in New Issue