openstack/octavia
Code Issues Proposed changes
ada92f7c0b
octavia/doc/source/index.rst

117 lines
1.4 KiB
ReStructuredText
Raw Normal View History

Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
.. octavia-specs documentation master file
Fix the docs page title Currently the title for the octavia docs page is "Main". This updates the title to be more descriptive. This patch also updates the index for Anchor documentation and our version 1.0 specs. Change-Id: I1258503b7a778789b77c7ec6c4db1fbd310b6133
2017-01-19 21:30:25 +00:00
=====================
Octavia Documentation
=====================
Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
Getting started
---------------
Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
.. toctree::
:maxdepth: 1
Adding introduction and developer quick start docs Octavia is currently missing any documentation designed to help new developers and operators understand what we're doing with the project or how to get started using and contributing to it. This patch set aims to correct this problem. Co-Authored-By: Michael Johnson <johnsomor@gmail.com> Co-Authored-By: Leslie Lundquist <llundquist@us.ibm.com> Closes-Bug: #1558368 Change-Id: Idaa37277bd342b644a463d4a0884ea40c2e8d4f5
2015-10-07 12:47:11 -07:00
main/introduction.rst
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
main/glossary.rst
Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
Add L7 user guides This includes both an overall description of L7 load balancing as implemented in Octavia, as well as a cookbook for common L7 usage. Both of these documents are aimed at end-users. Change-Id: I01c4484e2276257c97cfb6ba02d6224a25cdbc80 Closes-Bug: 1558377
2016-08-26 00:22:18 -07:00
For users
---------
.. toctree::
:maxdepth: 1
Add a cookbook for basic load balancing While Octavia is capable of doing many things, we presently lack a simple, straight-forward guide for doing some of the simpler end-user tasks with load balancing. This commit adds just such a guide. Change-Id: I30628484893ae9c043e5833f480b99d185e4d362 Closes-Bug: #1558372
2016-09-23 22:53:38 -07:00
guides/basic-cookbook.rst
Add L7 user guides This includes both an overall description of L7 load balancing as implemented in Octavia, as well as a cookbook for common L7 usage. Both of these documents are aimed at end-users. Change-Id: I01c4484e2276257c97cfb6ba02d6224a25cdbc80 Closes-Bug: 1558377
2016-08-26 00:22:18 -07:00
guides/l7.rst
guides/l7-cookbook.rst
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
For developers
--------------
Octavia v0.5 component design This design represents the overall layout of components that will make up the first major milestone release of Octavia (v0.5). The intent here is to have a scalable service delivery layer, to get communication with external components right, and not yet worry about making the command and control layer scalable. Change-Id: I09ab7185683b66ec2567119616bc54cf9d8cc000
2014-08-12 00:41:43 -07:00
.. toctree::
:maxdepth: 1
Adding introduction and developer quick start docs Octavia is currently missing any documentation designed to help new developers and operators understand what we're doing with the project or how to get started using and contributing to it. This patch set aims to correct this problem. Co-Authored-By: Michael Johnson <johnsomor@gmail.com> Co-Authored-By: Leslie Lundquist <llundquist@us.ibm.com> Closes-Bug: #1558368 Change-Id: Idaa37277bd342b644a463d4a0884ea40c2e8d4f5
2015-10-07 12:47:11 -07:00
guides/dev-quick-start.rst
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
main/CONSTITUTION.rst
main/HACKING.rst
Adds a process to generate key flow documentation Octavia extensively uses TaskFlow flows for orchestration. To make it easier for developers to understand these flows, this patch adds a mechanism for generating graphviz representations of the key Octavia TaskFlow flows. It also updates our tox docs task to generate this documentation. This patch depends on a fix to the TaskFlow export_to_dot method. Added into conf.py as first step of configuration Closes-Bug: #1561063 Change-Id: I914e1c062b400148565def37ccf618b3d2ea2573 Depends-On: I99f87af0b2bed959fcb43ef611b3186e23bd9549
2016-03-24 18:03:27 +00:00
devref/flows.rst
Update config reference to use auto generate This patch updates Octavia docs to use the oslo_config.sphinxext integration to generate the configuration reference. This patch also links in the "guru meditation report" document. This document has been present, but was not linked. I also reorganized the specs to reflect the correct release versions. Change-Id: Icaf710c1c61277f3ca51efac45a3a80a0d3cce8f
2016-08-25 15:27:05 +00:00
main/gmr.rst
For operators
-------------
.. toctree::
:maxdepth: 1
Adding introduction and developer quick start docs Octavia is currently missing any documentation designed to help new developers and operators understand what we're doing with the project or how to get started using and contributing to it. This patch set aims to correct this problem. Co-Authored-By: Michael Johnson <johnsomor@gmail.com> Co-Authored-By: Leslie Lundquist <llundquist@us.ibm.com> Closes-Bug: #1558368 Change-Id: Idaa37277bd342b644a463d4a0884ea40c2e8d4f5
2015-10-07 12:47:11 -07:00
guides/dev-quick-start.rst
Update config reference to use auto generate This patch updates Octavia docs to use the oslo_config.sphinxext integration to generate the configuration reference. This patch also links in the "guru meditation report" document. This document has been present, but was not linked. I also reorganized the specs to reflect the correct release versions. Change-Id: Icaf710c1c61277f3ca51efac45a3a80a0d3cce8f
2016-08-25 15:27:05 +00:00
main/configref.rst
Fix the docs page title Currently the title for the octavia docs page is "Main". This updates the title to be more descriptive. This patch also updates the index for Anchor documentation and our version 1.0 specs. Change-Id: I1258503b7a778789b77c7ec6c4db1fbd310b6133
2017-01-19 21:30:25 +00:00
main/Anchor.rst
Octavia v0.5 component design This design represents the overall layout of components that will make up the first major milestone release of Octavia (v0.5). The intent here is to have a scalable service delivery layer, to get communication with external components right, and not yet worry about making the command and control layer scalable. Change-Id: I09ab7185683b66ec2567119616bc54cf9d8cc000
2014-08-12 00:41:43 -07:00
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
====
APIs
====
Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
.. toctree::
:glob:
:maxdepth: 1
Add quota support to Octavia Octavia has no quota definitions, but needs them for parity with Neutron LBaaS. This will provide an endpoint and support for retrieving, updating, and deleting quotas for projects, as well as adding enforcement of those those quotas. Adds scenario test that simply validates quotas in a lb graph. Co-Authored-By: Michael Johnson <johnsomor@gmail.com> Co-Authored-By: Phillip Toohill <phillip.toohill@rackspace.com> Co-Authored-By: Adam Harwell <flux.adam@gmail.com> Change-Id: Ia1d85dcd931a57a2fa3f6276d3fe6dabfeadd15e Closes-Bug: #1596652
2016-08-25 16:01:21 -05:00
api/octaviaapi.rst
api/haproxy-amphora-api.rst
Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
Adding initial glossary of terms Along with defining terms, this commit cleans up some of the documentation structure so the auto-generated docs are a bit cleaner. Change-Id: I6445f86a6746956d8227d2a587509fe08b27d26d
2014-09-17 21:08:20 -07:00
====================
Design Documentation
====================
Octavia v0.5 component design This design represents the overall layout of components that will make up the first major milestone release of Octavia (v0.5). The intent here is to have a scalable service delivery layer, to get communication with external components right, and not yet worry about making the command and control layer scalable. Change-Id: I09ab7185683b66ec2567119616bc54cf9d8cc000
2014-08-12 00:41:43 -07:00
Update config reference to use auto generate This patch updates Octavia docs to use the oslo_config.sphinxext integration to generate the configuration reference. This patch also links in the "guru meditation report" document. This document has been present, but was not linked. I also reorganized the specs to reflect the correct release versions. Change-Id: Icaf710c1c61277f3ca51efac45a3a80a0d3cce8f
2016-08-25 15:27:05 +00:00
Version 0.5 (liberty)
---------------------
Octavia v0.5 component design This design represents the overall layout of components that will make up the first major milestone release of Octavia (v0.5). The intent here is to have a scalable service delivery layer, to get communication with external components right, and not yet worry about making the command and control layer scalable. Change-Id: I09ab7185683b66ec2567119616bc54cf9d8cc000
2014-08-12 00:41:43 -07:00
.. toctree::
:glob:
:maxdepth: 1
design/version0.5/*
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
======================
Project Specifications
======================
Update config reference to use auto generate This patch updates Octavia docs to use the oslo_config.sphinxext integration to generate the configuration reference. This patch also links in the "guru meditation report" document. This document has been present, but was not linked. I also reorganized the specs to reflect the correct release versions. Change-Id: Icaf710c1c61277f3ca51efac45a3a80a0d3cce8f
2016-08-25 15:27:05 +00:00
Version 0.5 (liberty)
---------------------
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
.. toctree::
:glob:
:maxdepth: 1
specs/version0.5/*
Update config reference to use auto generate This patch updates Octavia docs to use the oslo_config.sphinxext integration to generate the configuration reference. This patch also links in the "guru meditation report" document. This document has been present, but was not linked. I also reorganized the specs to reflect the correct release versions. Change-Id: Icaf710c1c61277f3ca51efac45a3a80a0d3cce8f
2016-08-25 15:27:05 +00:00
Version 0.8 (mitaka)
--------------------
.. toctree::
:glob:
:maxdepth: 1
specs/version0.8/*
Version 0.9 (newton)
--------------------
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
.. toctree::
:glob:
:maxdepth: 1
Update config reference to use auto generate This patch updates Octavia docs to use the oslo_config.sphinxext integration to generate the configuration reference. This patch also links in the "guru meditation report" document. This document has been present, but was not linked. I also reorganized the specs to reflect the correct release versions. Change-Id: Icaf710c1c61277f3ca51efac45a3a80a0d3cce8f
2016-08-25 15:27:05 +00:00
specs/version0.9/*
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
Fix the docs page title Currently the title for the octavia docs page is "Main". This updates the title to be more descriptive. This patch also updates the index for Anchor documentation and our version 1.0 specs. Change-Id: I1258503b7a778789b77c7ec6c4db1fbd310b6133
2017-01-19 21:30:25 +00:00
Version 1.0
-----------
.. toctree::
:glob:
:maxdepth: 1
specs/version1/*
Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
==================
Indices and tables
==================
* :ref:`search`
Copy Permalink