Commit Graph

48 Commits

Author SHA1 Message Date
Dr. Jens Harbott 2b75e2bfdc doc: Add IPv6 usecase
This practical example shows a typical deployment usecase that provides
global IPv6 prefixes for tenant networks.

Change-Id: I15c0970f06abb2a710a4c3cfd7bcdb626dafd9cf
2023-08-11 13:15:40 +02:00
shanyunfan33 627695cf53 remove unicode from code
remove unicode from code

Change-Id: Ibb3478ebbb234e76748db17e3d86eb9da86cc54b
2021-12-24 14:38:26 +08:00
Dr. Jens Harbott 8a0ddf6051
Add a StaticScheduler without automatic scheduling
The automatic scheduling that was introduced in [0] is having some
issues. Add a StaticScheduler that can be used as an alternative for
deployments that want explicit control over where their BGP speakers are
getting scheduled.

Add a job that runs with the new scheduler.

[0] https://review.opendev.org/c/openstack/neutron-dynamic-routing/+/478455

Depends-On: https://review.opendev.org/c/openstack/neutron-tempest-plugin/+/815294
Closes-Bug: 1920065
Signed-off-by: Dr. Jens Harbott <harbott@osism.tech>
Change-Id: Ib7fcd0c7371bc75089b10024ee1b6e75c98f0188
2021-11-04 15:21:51 +01:00
elajkat c021b106d9 Use bgp api-def from neutron-lib
As neutron-dynamic-routing is a Neutron stadium project the api-def
and the api-ref should be in neutron-lib.

Change-Id: Idccc69f025a0d1ec0453d13a7d81b94e3a15149d
Depends-On: https://review.opendev.org/c/openstack/neutron-lib/+/788322
2021-05-31 12:32:55 +00:00
Bernard Cafarelli 638dadb7a5
Update testing doc to use OSC commands
Also fix quagga configuration file (router line needs to be before its
parameters), restart step for systemd, and REMOTE_AS incorrect hint

Change-Id: I899aef63608f76907a3f28d67004af3fb5d0d8e6
2020-08-31 09:48:02 +02:00
Andreas Jaeger 8f8a4ea4ec Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I9f2636a01516ae757b17d47081c890f855c3eb5d
2020-05-23 17:47:58 +02:00
Akihiro Motoki b6d13bdce5 PDF documentation build
Note that toctree_only option [1] is set to True in latex_documents
in doc/source/conf.py to get a better document structure in
the generated PDF file.

The above solution also helps us avoid a filename conflict between
the generated PDF file name and a PDF file converted from an SVG image
of the project badge where both files would be neutron-dynamic-routing.pdf.

Change-Id: I809040e0a4def90451f9a80c02c6f811af330bc9
Story: 2006099
Task: 35128
2019-09-04 13:13:45 +00:00
gujin dace47cc07 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: Ied57440e9e9f918ca685bd3738716cd52f7719b2
2019-05-13 21:09:03 +08:00
Akihiro Motoki a3a5470538 doc: Add policy reference
Partially Implements: blueprint neutron-policy-in-code

Change-Id: Iad80250e52e2347b0f6844ebaeb5a51cd314daf0
2019-02-14 09:13:52 +00:00
Ryan Tidwell 34655a8e6e
Migrate neutron-dynamic-routing from Ryu to os-ken
This change causes neutron-dynamic-routing to stop consuming Ryu
in favor of os-ken. os-ken becomes the reference implementation
for BGP services and neutron-dynamic-routing no longer has a
dependency on Ryu.

Partially-Implements: blueprint ryu-framework-maintenace-transition
Change-Id: I4a68440809cad5de2d6d191f7211d68b542672e5
2018-12-18 14:03:13 -06:00
Brian Haley f358d7922f Fix _get_config_generator_config_definition() typo
Argument is config_file, but conf is used in method, just
change definition.  Necessary if using python3.

Change-Id: I6d92b3718810589c35974571278574d0906fce36
2018-11-06 04:04:42 +00:00
Zuul 78573e7158 Merge "Fix some minor issues in testing doc" 2018-03-23 10:20:34 +00:00
Zuul 810b87ec85 Merge "Update docs" 2018-03-20 22:25:21 +00:00
Jens Harbott 356e109614 Fix some minor issues in testing doc
Some small errors prevent 1:1 following of the doc.

Change-Id: Idbf9d44c687e80efd27bb67c136faf870a1332ad
2018-03-09 09:44:10 +01:00
Jens Harbott 1e5d33f80e Update docs
- Start using OSC instead of neutron CLI
- Fix description of speaker scheduling
- Increase readability
- Fix some minor issues

Change-Id: I354c33bb825a8ec58e46a13a0a9e9f412ec01541
Closes-Bug: 1750562
2018-02-20 12:38:57 +00:00
Guoqiang Ding aebe78405e Update the doc link
Change-Id: Ibb60cff222cb9ac947467dbed160d6d5e7231ff5
2017-11-24 15:33:46 +08:00
melissaml 90fed21d8f Fix to use "." to source script files
Adhering to coding conventions. Refer to ``Code conventions`` at
https://docs.openstack.org/contributor-guide/ for details.

Change-Id: I8168ae0eda632b146d5d7fe09542d6a77c9d00ae
2017-08-29 01:44:48 +08:00
Jenkins bdd72c6ede Merge "Add auto-generated config reference" 2017-08-02 19:57:09 +00:00
Akihiro Motoki c314db081e Add auto-generated config reference
oslo.config provides sphinx extensions to generate config reference
and sample config files. This commit enables the auto-generation of
the networking config reference.

Note that this commit just adds the configuration references
for existing genconfig entries. I haven't checked there are options
uncovered. If any, this will be a potential future work.

Part of doc-migration work

Change-Id: I4e150b6045e5e9c56cbe7262b31ee0d82dcb6c69
2017-07-22 18:05:11 +00:00
Akihiro Motoki 1c9168176c Update the documentation link for doc migration
Change-Id: Ic57e6ddbc8407fb2ceb7a7b8995486bf06390258
2017-07-20 03:58:14 +00:00
Akihiro Motoki 40ca013fab rearrange content to fit the new standard layout
Part of doc-migration work

The proposed document strucutre is documented at:
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I3b774ae8c55e5d980e82ae4e81ade75f79074197
2017-07-07 08:21:11 +00:00
Akihiro Motoki 70c3da917b switch from oslosphinx to openstackdocstheme
Change-Id: Iae3df0dd597cc75f19a2ce792ee0807d858e883e
2017-07-05 06:17:59 +09:00
Akihiro Motoki 6580d73811 Enable warning-is-error in doc build
Change-Id: I1ec46ed4e479e602f69695ba60ebb6968b2aa6b8
2017-07-01 20:45:11 +00:00
Jenkins abeee2df89 Merge "Optimize the link address for fetching git code" 2017-04-06 11:01:04 +00:00
zoushilin f136e7dd7f Delete non-existent file in index.rst
others/alembic_migration does not exist, need to delete

Change-Id: If4424fbffae6c94564538fb9a45fd053d4c85567
2017-04-01 10:58:51 +08:00
zhangyanxian 528c3c1941 Optimize the link address for fetching git code
Use https instead of http to ensure the safety without containing
our account/password information

Change-Id: I9476e6052081d1638642f5cbd177e3e736001aef
2017-03-24 07:00:15 +00:00
Boden R 9869b08da5 Fix broken doc links
This patch fixes broken doc links as follows:
- Removes the ref to generate the 'modindex' as this only
applies to source that provides module level documentation
with class refs. For example [1]. Today we don't have any such
module doc in this project; and thus this generates a dead link.
It can be added later (if needed) and the modindex ref can be
added back in.
- Fixes various internal links that are using '.rst'; this needs to be
'.html' in order to link to the generated doc html files.
- Fixes an incorrect link; missing a space and has an unneeded
leading underscore.

For more details please see the bug report associated with this
fix.

[1] https://github.com/openstack/neutron/blob/
master/neutron/neutron_plugin_base_v2.py#L19

Change-Id: I12e227ae1a3682a7268b75c844825d3f7464941b
Closes-Bug: #1656403
2017-01-30 07:06:38 -07:00
melissaml dffe6f9d8b Removes unnecessary utf-8 encoding
The following file(s) added utf-8 encoding but never used. So we can
remove them at all.

doc/source/conf.py
releasenotes/source/conf.py

TrivialFix

Change-Id: I9e9d4e54cbd6eb92b2b9bd0fb5221becb4ff3604
2017-01-06 07:37:23 +08:00
vikram.choudhary 29882d27fa Removing Alembic migration devref document
This patch removes unwanted devref documents w.r.t. alembic migration.
IMO, separate devref for sub-project is not required as it's already
documented @
http://docs.openstack.org/developer/neutron/devref/alembic_migrations.html#independent-sub-project-tables

Change-Id: Ida41846ff5d1be0058fd6881cceaa834c37268d7
Partial-Bug: #1560003
2016-10-25 04:20:06 +00:00
Jenkins 58e3e42894 Merge "Add bgp speaker and route advertisement doc" 2016-07-19 15:33:18 +00:00
ZhaoBo 73a8f8cc14 Add bgp speaker and route advertisement doc
This patch add bpg-speaker.rst and route-advertisement.rst into
neutron-dynamic-routing project.

Change-Id: I67ea3461402aa5395c125ac4b577901d35eaedba
Partially-Implements: blueprint bgp-spinout
2016-07-18 15:58:09 +00:00
yuyangbj 3db1097c07 Document about how to test dynamic routing
Partially-Implements: blueprint bgp-spinout
Partial-Bug: #156000
Change-Id: I49f3ba285a4b66766e1f04103fd08798e3c0628b
2016-07-08 13:11:32 +08:00
Jenkins ac14672612 Merge "Fix API document" 2016-06-20 16:55:11 +00:00
Gary Kotton 68b28a5a7d Fix API document
Add in some fixes in the API document

TrivialFix

Change-Id: I2891b97cb60d3a6404e2f055cc027b90fe9eaef3
2016-06-16 06:51:51 -07:00
Paul Carver afb407807b Trivial documentation change to trigger publish job
Change https://review.openstack.org/#/c/323961/ has merged but docs
won't publish to http://docs.openstack.org/developer/neutron-dynamic-routing/
until at least one change merges into the repo in order to trigger
Jenkins/Zuul to run the publish job. Right now there is no change in Gerrit
that looks ready to merge immediately so I have made a trivial correction
(capitalizing the acronym API) in order to trigger the docs publishing.

Change-Id: I3cc8097210a86e08b6250d7d3f69d1cd4c24e974
2016-06-14 19:38:25 +00:00
Jenkins 785a2aa6e4 Merge "BGP dynamic routing CLI" 2016-06-08 18:21:06 +00:00
Jenkins a274f54607 Merge "Add neutron-dynamic-routing DrAgent & Scheduler document" 2016-06-08 15:40:18 +00:00
Gary Kotton ff0bd977ae Fix typo in the installation documentation
TrivialFix

Change-Id: I8578daaed8988edcbc84803d995cdaa99b8d7bcc
2016-06-06 23:17:57 -07:00
Jenkins 08f9ae3229 Merge "Add drivers document for neutron dynamic routing" 2016-06-07 03:26:09 +00:00
yuyangbj ea38cf8e9e BGP dynamic routing CLI
This doc describes how BGP CLI works.

Change-Id: I550bcf13be35c8aa464876032e1483e5ceb2f5a5
Partially-Implements: blueprint bgp-spinout
Partial-Bug: #156000
2016-06-06 16:23:12 +08:00
Na 6e78541edc Add drivers document for neutron dynamic routing
This patch add document about neutron dynamic routing
drivers.

Change-Id: Iccba29b89ef542a973efe4a10a0b8fef2365f745
Partially-Implements: blueprint bgp-spinout
Partial-Bug: #156000
2016-06-04 09:02:23 +00:00
Na 8304964d4f Add system design for neutron dynamic routing
This patch add document about neutron dynamic routing
system design.

Change-Id: Idf6fa7bb9202f1f40ae669a9980f624f2c855294
Partially-Implements: blueprint bgp-spinout
Partial-Bug: #1560003
2016-06-04 08:12:07 +00:00
steve.ruan 6841dfae3a Add neutron-dynamic-routing DrAgent & Scheduler document
This document introduces how DrAgent and Scheduler works,
and how to use it.

Change-Id: Ib44426868cdc326ef4c92cc310a4f11409581f8d
Partially-Implements: blueprint bgp-spinout
Partial-Bug: #1560003
2016-06-02 02:45:33 -05:00
yuyangbj 3644441146 BGP dynamic routing api documentation
This is for how to use the BGP dynamic routing API.

Change-Id: I235e2def28c307cd5b4ba10374674a166a953e3a
Partially-Implements: blueprint bgp-spinout
Partial-Bug: #156000
2016-05-30 11:58:50 +08:00
Jenkins c3f815baf5 Merge "Documentation" 2016-05-06 00:31:12 +00:00
vikram.choudhary cf6cf44e4b Documentation
This patch restructures existing documents for better user
experience.

Below changes are done as part of this patch-set:
 - Re-structured/Reworded existing documents.
 - Identified and added dummy documents for required devrefs.

Implements: blueprint bgp-spinout
Partial-Bug: #1560003

Change-Id: I71d9f6107bca165d72b6f6e710ac6e0e6108fcf9
2016-05-05 15:29:45 +00:00
ZhiQiang Fan d28d6f26f8 [Trivial] Remove executable privilege of doc/source/conf.py
It is a configuration file, rather than a script.

Change-Id: Ifa446f4c517b98d2e511729a1517433c119339cf
2016-04-29 20:05:36 +08:00
vikram.choudhary 4ba80f3f1c Prepare initial sandbox for neutron-dynamic-routing
This patch-set prepares the basic code structure with all
the tools required for running static and unit tests.

Note: All the imported code from the seed repo is being removed
      temporarily and will be added after the required re-factoring
      needed as per the new repo in the subsequent patch-sets.

Co-Authored-By: Ryan Tidwell <ryan.tidwell@hpe.com>
Implements: blueprint bgp-spinout
Partial-Bug: #1560003

Change-Id: I9bff3d916279c4f335b309e7a2c2e943ac6f6cde
2016-04-23 04:11:57 +00:00