summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-09-18Local Documentation BuildsHEADmasterAric Gardner3-0/+6
This adds configuration for performing local documentation builds with the following simple command: tox -e docs Change-Id: I79094867657cda83c231949c52ba9eee1cd54eeb Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2017-03-30Added details to the installation instructionsGeorg Kunz1-4/+21
Change-Id: I311e8c7c1d559f6267b194bb55e7fb99c4555635 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2017-03-28Fixing broken links in documentationGeorg Kunz6-27/+24
Using rst references to link to other documentation pages instead of relative HTML links. Change-Id: Id8164a4f50f4fd39c996f5ae354b22f3c960fb08 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2017-03-13Adding further documentation for the Gluon scenarioGeorg Kunz5-453/+135
Change-Id: I4926ab30223312b91b6349b798f652615d70001e Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2017-03-08Adding LabelsShubhamRathi5-0/+10
Labels serve as anchors/ refs when referenced from other documents This patch adds labels to docs/*/*/index.rst Change-Id: Id94de3677f0d7849b5f2e1fd528266b238be6e5c Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-08Feature description for Gluon scenarioGeorg Kunz1-5/+59
Change-Id: Ib4867b3b9cd47b8e974a6d28f6c4de7b72242ff7 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2017-03-03Draft of Gluon User Guide for NetReadyBin Hu1-9/+226
Change-Id: I1bcfe2191c7126bd324f4f7c392f27bb219a158a Signed-off-by: Bin Hu <bh526r@att.com>
2017-02-24Adding missing licence headers to filesGeorg Kunz1-13/+9
Change-Id: I9eedd2f3e21305a27fe09a116dec9d8dbcc6df5e Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2017-02-17Adding template framework for Danube documentationGeorg Kunz11-0/+645
Change-Id: I0960f3538163e2609db9a196d665f148967ab454 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2017-02-15Correction of comments to Georedundancycsatari2-3/+3
This change contains the corrections to the comments of Prakash to change 28243. Change-Id: I80f2767815c6d1507b133368c4638a0733a64636 Signed-off-by: csatari <gergely.csatari@nokia.com>
2017-02-07Moving requirements documentation for DanubeGeorg Kunz31-0/+0
Moving the requirements documentation in order to comply to the new structure for Danube. Change-Id: Ifbf87b49ce2308d082510ca761bb7bc6479fce58 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-11-11More intro to retired use casescsatari1-1/+4
Some more sentences added to the intro part of the retired use cases chapter. Link to programmable_provisioning.rst is corrected. Change-Id: Ib1d0b9ca0d11f660b9b195fdd677fa2badd0a8e5 Signed-off-by: csatari <gergely.csatari@nokia.com>
2016-11-05Formatting changes and fixing of build warningsGeorg Kunz9-67/+125
Applying a different sphinx rendering theme to make the document more readable (in my opinion). The Sphinx config file is based on the config file of the Copper project. Moreover, this change fixes a few build-time warnings. Change-Id: I78f5268436edcfa8c71b8e85a99c7caa54a0e099 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-11-04Retiring the "provisioning of provider networks" use caseGeorg Kunz5-5/+43
The gap identified along with this use case has been addressed ini the upstream community. Hence, moving to this use case to a separate section of the requirements document. Change-Id: I9cd95f1128a9845cda4ec42fe1692f22cdc03a9d Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-10-31Global review of the NetReady requirements documentGeorg Kunz16-0/+1534
This patchset enables a global review of the entire NetReady requirements document. Changes to the document shall be pushed as new patches to this patchset. Change-Id: I7cc9290c9260aad5b687253b02d60efbc8a64bb2 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-10-31Preparing files for global reviewGeorg Kunz16-1539/+0
Change-Id: I5db23e973f936aace0123eb40ac24084ff1bdbce Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-08-02Explanatory figurescsatari6-0/+23
Based on the comments of Fathemeh I've added 3 explanatory figures. Change-Id: Ica4a373ab88979162f064740c6020d0789b20cfe Signed-off-by: csatari <gergely.csatari@nokia.com>
2016-07-23updated version history: first version of the doc readyGeorg Kunz1-0/+1
Change-Id: Ie0cfef81071f23684b88d5a28aa079508ef3be8d Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-22Added conclusion on Neutron network semantics to summaryGeorg Kunz1-0/+8
This conclusion is based on input from Ian Wells. Change-Id: If050df74141ee8ec47c306e690576562f4c932b7 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-22Incorporating further review commentsGeorg Kunz7-38/+45
Change-Id: I65fa2036f32c018c3d9cda46a82c6f1e2d4e6323 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-22Working on comments and document cleanupGeorg Kunz9-90/+56
Commenting out some of my previous comments so that they are not part of the final document but remain in the source code. Added conclusion to L3VPN use cases. Change-Id: I1f51cbce1fb496d05d005cfd440cc16a52eab0d8 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-21Summary changescsatari2-4/+20
- Link to Netready wiki added - Time is scoped to OPNFV C release - Link to the document added - Summary of programable provisioning and georedundancy cases added Change-Id: Id5ed642a238661c3d186853953ff638ee5948d4d Signed-off-by: csatari <gergely.csatari@nokia.com>
2016-07-20Correction of a typocsatari3-3/+3
Tricicle changed to tricircle. Change-Id: I83c43645536684f59d1248a28dc7561663306168 Signed-off-by: csatari <gergely.csatari@nokia.com>
2016-07-18Multi-back-ends: Added gap analysisGeorg Kunz1-8/+103
Integrating Bin's text into the overall document by adding a gap analysis and a conclusion. Change-Id: I958f3206cc6176520ef635271208e35c7f5c6306 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-15Add new use case of multiple back-ends, which is separate from L3VPNBin Hu2-0/+38
Change-Id: Ife3a9c29057f6055f1db07168d06c46910d759d6 Signed-off-by: Bin Hu <bh526r@att.com>
2016-07-15Add general, future-looking statement in Problem Description, Goals,Bin Hu2-0/+33
and Summary. Change-Id: I9b30ed7f6acc317f813259e8124e3e520504465b Signed-off-by: Bin Hu <bh526r@att.com>
2016-07-14Renamed and extended port abstraction modelGeorg Kunz3-12/+72
The former port abstraction use case has been rename (again) to better highlight that it represents a design pattern for APIs and data models. In line with this, the text has been extended. Change-Id: I49c3f153dc7b75b000acacd8436b41d9d1219e2a Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-13Correcting a typocsatari1-1/+1
Change-Id: I04a57e7af915a4ba39c560cfd220eee23237e29a Signed-off-by: csatari <gergely.csatari@nokia.com>
2016-07-12L3VPN Any-to-any: polishing terminology and figuresGeorg Kunz6-22/+33
Added a powerpoint slide deck including the L3VPN figures. This allows for editing the figures. Change-Id: Iee4c4e8a587bcfac4dc404895809af1b5f1163d5 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-12L3VPN Hub-and-Spoke: more in depth gap analysisGeorg Kunz2-48/+151
- better description of the actual problem - better problem description in the gap analysis - extended work flow description using BGPVPN API Change-Id: I76320f5b9c9e5a519bf53d3d0afd73db32e27cc2 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-12Added stub for summary and conclusion sectionGeorg Kunz1-3/+12
Added a basic introductory text for the summary and conlusion section. In this section, a summary of all gaps shall be given and corresponding conclusions shall be drawn. These conclusions shall state whether Neutron can/shall be extended or if some other networking framework is more suitable. Change-Id: I78c811bb7611beade2d436f34e672ff8424fcda4 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-12L3VPN Any-2-Any: more detailed usage of BGPVPN APIGeorg Kunz2-36/+84
Adding more details on how to use the existing BGPVPN API to realize the use case. There are currently no gaps identified for this particular use case. Change-Id: I5f973609ab6951bc31ae499430762827dfddd003 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-12Precisly name Neutron L3 network services in introGeorg Kunz1-7/+7
Swapping two paragraphs in the introduction to better incorporate existing Neutron L3 network services. Change-Id: Ie05faa9b3209a8876582e976c5205d60ac698cc1 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-12L3VPN: Added placeholder for conclusionGeorg Kunz1-0/+7
Change-Id: I36d2925711537c09a0030e4fd9c4124cab6467a2 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-11L3VPN ECMP: Adding 2nd API example and conclusionGeorg Kunz1-24/+85
Further polishing the section by adding a second API usage example showing how to realize the use case by means of the BGPVPN project. Furthermore, added a conclusion section summarizing based on the identified gaps if an extension or an alternative to Neutron is needed. Change-Id: I55974dbd4aca7b26c7f7d7d4de06c0a5491bee2e Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-11L3VPN ECMP: more detailed usage of BGPVPN APIGeorg Kunz1-3/+51
Adding more details on how to use the existing BGPVPN API to realize the use case. Note: work in progress - don't merge yet Change-Id: I2c41bad79602d9f8e9de0581495e0ceb93a1b4c6 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-07OpenStack networking guide link addedcsatari2-8/+5
The provires networks use case restructured to follow the common structure and a link to the OpenStack networking guide is added. Change-Id: I1181c1484580f74e64d602e0d8518972b11bfe48 Signed-off-by: csatari <gergely.csatari@nokia.com>
2016-07-07Polishing of the glossary and introductionGeorg Kunz2-14/+19
Change-Id: Ibe84dc68c3caa5911c5398dc04692452d49cca44 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-07Cleanup of document structureGeorg Kunz1-4/+0
This is a proposal to remove the dedicated sections "current solitions", "gap analysis", and "implementation" from the document structure because we handle those aspects directly witin the "use case" section. Change-Id: Iad9cf10821809b7d8c139d780818d84ae17182d6 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-07-05Polishing of georedundancy and provider network uc-scsatari5-77/+118
Adding the final touch to my use cases: - Clarification of the introduction text in the general georedundancy capter - Clarification of the description of both the georedundancy and the provider networks use cases - Adding references. Change-Id: I9734154dc7fbb5f3a86af17c451b02cca839a741 Signed-off-by: csatari <gergely.csatari@nokia.com>
2016-06-28Updating the list of authorsGeorg Kunz1-1/+2
Change-Id: I49ee1711c9818682e0e666261a4fca74cbcec9b3 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-06-23Georedundancy reorganization and enhancement to the introductioncsatari4-57/+69
- Use case structure reorganized again - A new, georedundancy.rst has been created (as in L3VPN case) - Parent chapter (2.4) for all geuredundancy usecases added (as in L3VPN case) - Introduction moved to the parent chapter (2.4) - Learnings of the OPNFV Summit netready breakout added to the intro of the use cases Change-Id: I8260269f6a2b981e9a0f226e11bed5f3cecf8b3b Signed-off-by: csatari <gergely.csatari@nokia.com>
2016-06-21Adding explanatory images to the introduction.csatari3-0/+18
Adding the images and separating the usecases to separate files. Change-Id: Ic45a5d3f15bf3a2b38695e94b6910ec60455727d Signed-off-by: csatari <gergely.csatari@nokia.com>
2016-06-17Data model and NB API for shared service function use caseGeorg Kunz3-84/+141
The use case has been renamed from "shared service functions" to "port abstraction" Change-Id: I1b5ec4b97af434814b88b824d02e98d46fd1979f Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-06-17Separating the georedundancy use cases to separate files.csatari4-48/+56
Small corrections to both georedundancy and progamable provisioning. Change-Id: I8ec6eeece4cb94f5aae230ef1d25a1bb76fc9db4 Signed-off-by: csatari <gergely.csatari@nokia.com>
2016-06-04Revised description of gap analysis of Hub and Spoke of L3VPNBin Hu1-29/+28
Change-Id: I221249751a4ce91746b718700e4de18ef20332ef Signed-off-by: Bin Hu <bh526r@att.com>
2016-06-05Add current implementation and gap analysis for Hub and Spoke caseBin Hu1-11/+105
Change-Id: Iddc5482b23b1c1ad3ad521700fed595d498d6367 Signed-off-by: Bin Hu <bh526r@att.com>
2016-06-04Intial text on analysis of L3VPN ECMP use caseGeorg Kunz2-8/+40
Change-Id: I5ae30328ec55130d3d654b0cc358de681971592f Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2016-05-30Add Networking-sfc refereceBin Hu1-0/+1
Change-Id: I2e522e4e55f9f9c528c44847b56eb504a64b60a7 Signed-off-by: Bin Hu <bh526r@att.com>
2016-05-25Splitting L3VPN use cases into separate files for conflict free editingGeorg Kunz5-139/+153
Change-Id: I6df2b672c6a67e4c06536075101212cddce2cb63 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>