summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2017-10-27ci/deploy.sh: Add PDF parsing dependenciesAlexandru Avadanii1-7/+21
The following packages are required for PDF parsing: - python - python-ipaddress - python-jinja2 Note that `python-ipaddress` is not available on older Ubuntu distributions (e.g. Trusty), in which case `pip` should be used to install it. An alternative would be to use python3 packages. Update the installation instructions to specify minimum expected requirements on the jump server. JIRA: FUEL-292 Change-Id: I19fdcc163dcfdee45ac6fa3f5e09a28638d6035c Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
2017-10-27Merge "docs: Add more info about virtual deployment"Michael Polenchuk1-0/+7
2017-10-26docs: Add more info about virtual deploymentTaseer Ahmed1-0/+7
Change-Id: I82f639f380092ea6800ed1e7c86a415b7979ec44 Signed-off-by: Taseer Ahmed <taseer94@gmail.com>
2017-10-24fix for documentation: correct git checkout tag is opnfv-5.0.2Mika Rautakumpu1-1/+1
Change-Id: I2c4192d4dc299d167ba6b1b9db91c6d73c87c417 Signed-off-by: Mika Rautakumpu <mika.rautakumpu@nokia.com>
2017-10-23Minor updates to documentationCristina Pauna2-4/+4
Change-Id: I35b8069a0239858dad3b446f683d64140964fb42 Signed-off-by: Cristina Pauna <cristina.pauna@enea.com>
2017-10-19Update the reference for scenariosCristina Pauna2-2/+2
Modified the reference link for the scenarios as it colides with another installer. To be used with https://gerrit.opnfv.org/gerrit/#/c/45795 Change-Id: I7b55cfdb877715ec4fa0292adc11e36b7cf4ae53 Signed-off-by: Cristina Pauna <cristina.pauna@enea.com>
2017-10-18Add documentation for scenariosCristina Pauna5-1/+116
Added documents for feature scenarios supported by fuel. The nofeature scenarions don't require documentation. Change-Id: I574e42b60125b4a59c8d921fa45e4c4fbf09137f Signed-off-by: Cristina Pauna <cristina.pauna@enea.com>
2017-10-12Merge "docs: Update release documentation"Alexandru Avadanii1-59/+43
2017-10-12docs: Update release documentationCristina Pauna1-59/+43
JIRA: FUEL-276 Change-Id: I09799b2dde3c992d229864757e655c108d33608a Signed-off-by: Cristina Pauna <cristina.pauna@enea.com>
2017-10-12docs: Update installation instructionsCristina Pauna24-490/+175
This documentation contains the updated procedure on how to use Fuel to deploy openstack. JIRA: FUEL-276 Change-Id: I38dc9c57ea386a628cd363f5bcef3818739b9122 Signed-off-by: Cristina Pauna <cristina.pauna@enea.com>
2017-09-15Remove build instruction from documentationCristina Pauna2-309/+0
Fuel/MCP no longer packages the installer in an iso, therefore these building instructions are obsolete. JIRA: FUEL-276 Change-Id: Iee587be89078707cf0cf748212b94d69f1769e12 Signed-off-by: Cristina Pauna <cristina.pauna@enea.com>
2017-05-04docs: Refresh reference for Danube 2.0Alexandru Avadanii3-9/+9
Change-Id: If786099581cf8bf685cc2076c21d4c3041610bf7 Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
2017-03-10docs: Adding LabelsShubhamRathi2-0/+4
Labels serve as anchors/ refs when referenced from other documents This patch adds labels to docs/*/*/index.rst Change-Id: I50572f9300e4be91e5fd35b96383d9075b229be2 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-28Update documentation for DanubeSerg Melikyan41-438/+318
Change-Id: I535eb87bfa980cffc8e091b896b505884ed12d32 Signed-off-by: Serg Melikyan <smelikyan@mirantis.com>
2016-11-30Update documentation for Colorado 3.0Fedor Zhadaev3-23/+23
JIRA: FUEL-235 Change-Id: I6dd3a290179bd2b29e07dd0b72c2c007acd8682d Signed-off-by: Fedor Zhadaev <fzhadaev@mirantis.com>
2016-10-31Update documentation for Colorado 2.0Fedor Zhadaev3-27/+27
JIRA: FUEL-215 Change-Id: Ie922ff794e686e1824483a91a9571252adc2b1e2 Signed-off-by: Fedor Zhadaev <fzhadaev@mirantis.com>
2016-09-21Emergency patch - fixed broken linksJonas Bjurel2-11/+11
Change-Id: I7aea7c06775cac3efeb22d2256c7acf6fbb137d5 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-09-16Final updates of release notesJonas Bjurel1-13/+23
-Added filters for fixes, issues and work-arounds Change-Id: Id76545fd7837c83145bd8d87b309c23849da6f7e Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-09-14Merge "Use Boron RC3.5 for sfc scenarion"Michal Skalski1-1/+1
2016-09-14Use Boron RC3.5 for sfc scenarionMichal Skalski1-1/+1
It should fix problems with vm communication through floating IPs. Change-Id: Icadc71f2b99c28715c15389e59111272a21440fb Signed-off-by: Michal Skalski <mskalski@mirantis.com>
2016-09-13Update local mirrors defintionsMichal Skalski1-3/+3
If we only use main section, not all required packages are discovered. Change-Id: I2eaa4a7bfc659b820901ce55a4ab799c3281df3b Signed-off-by: Michal Skalski <mskalski@mirantis.com>
2016-09-06Final Colorado document review.Jonas Bjurel6-140/+137
- Please review the rendered HTML document (See Jenkins references below) - Please verify the documented procedures and instructions READY TO MERGE Change-Id: Idff52212ca68ce2b97f203043e18a18c582589a7 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com> Signed-off-by: Michal Skalski <mskalski@mirantis.com>
2016-08-31docs: build req: Remove p7zip-fullAlexandru Avadanii1-2/+0
p7zip-full is not required for building, as stated in the current version of the docs. I think this bogus requirement was introduced by Armband (by me, more precisely) because our build process was happening outside docker. Sorry for the useless code churn. Change-Id: Id0a3c5b9016706535ca159e1da261e83c8d36d31 Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
2016-08-25[DOC] Do not create mailto link for Fuel@OPNFV nameMichal Skalski3-9/+9
Change-Id: Ib130e8a2440531c3b9c484c9e516c72d5b20301b Signed-off-by: Michal Skalski <mskalski@mirantis.com>
2016-08-25Final updates of the Installation instructions:Jonas Bjurel18-34/+35
- Images updated - Updated reference URIs Change-Id: Ieeefbd8a3ef9bbd6c3a0e767f770097ab8a98f9d Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-08-24Final Updates of the build instructionsJonas Bjurel1-3/+3
- Updated references Change-Id: I2a6cfdec0de6afa41ea8af59f415439b7ab7056d Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-08-18update release-notes for coloradoGuo Ruijing1-31/+31
1. take care of Alexandru's comments 2. update liberty to mitaka 3. update ODL Beryllium SR1 to SR3 Change-Id: I7ae590333e781730e462c797270282e8e51fff01 Signed-off-by: Guo Ruijing <ruijing.guo@intel.com>
2016-08-17REVISED DOCUMENT STRUCTUREJonas Bjurel30-370/+29
Documentation structure changed according to docs team directions: - Configuration guide removed (only aplicable for features/scenarios) - Installation instructions moved to a separate directory - Build instructions moved to a separate directory - Release notes moved to a separate directory NOTE: Content not updated to the Colorado baseline Change-Id: I47f3bee0cf91bab6ed5c4a7f371b10347a917857 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-08-16Prepared for Fuel release documentationSofia Wallin2-0/+13
Helping project with the new structure, added a fuel/docs/installationprocedure and relevant templates. If you dont need this feel free to abandon this patch. Change-Id: Ia704aa0b2e66c62241ef0a5eb769ea8f538caa1f Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-08-12docs: Add code-block markupCristina Pauna2-20/+48
Add bash code-block markup for: - instalation instruction guides - build instruction guides Change-Id: If7a0f4cfc17e8cabe5d5ff59a7b2fe80ca0bb66b Signed-off-by: Cristina Pauna <cristina.pauna@enea.com> Signed-off-by: cristinapauna <cristina.pauna@enea.com>
2016-08-12Merge "Update instructions with references to C-release"Michal Skalski1-11/+11
2016-08-12Update installation guide for ColoradoMichael Polenchuk1-28/+28
Change-Id: Ie0fb45a570c59588429b167c4d83109ebf670ba7 Signed-off-by: Michael Polenchuk <mpolenchuk@mirantis.com>
2016-08-12Update instructions with references to C-releaseMichal Skalski1-11/+11
Change-Id: I7682e7cffcafdec3c42ca5a090662df9ccc431e2 Signed-off-by: Michal Skalski <mskalski@mirantis.com>
2016-06-16Clarify docker installation instructionsPeter Barabas1-1/+3
Change-Id: I8738798eac64c44a66e4fcab9758094e26a5a69f Signed-off-by: Peter Barabas <peter.barabas@ericsson.com>
2016-06-01docs: Mitaka Build req: Add p7zip-full.Alexandru Avadanii1-0/+2
Build system uplift to Fuel 9.0/Mitaka now requires `7z` cmd utility also on the builder host (not only inside docker containers), so document this as a prereq in the build instructions. [1] https://gerrit.opnfv.org/gerrit/#/c/13919/ Change-Id: Icb57ac58c499272fce0a27bb2d25383e933c7814 Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
2016-05-13docs/install-instr: Add target specific cfg sect.Alexandru Avadanii3-1/+50
Fuel 8.0 adds support for setting up "Offloading Modes" for target nodes. Document how this features should be used (and why/when it's necessary), and also its common limitation of not being applied during Verify Networks step (see related Fuel bug report [1]). While at it, fix minor reference to branch in git tag checkout instructions, as we'd be in detached HEAD and not on a new branch. [1] https://jira.opnfv.org/browse/FUEL-134 [Alexandru.Avadanii@enea.com] Only minor edits and prepared for upstreaming, this is mostly based on previous work from Florin. Change-Id: If7a8ca44541903dbeb6db36bc64fe56b132165cb Signed-off-by: Florin Dumitrascu <florin.dumitrascu@enea.com> Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
2016-05-12Merge "docs/release-notes: Add protocol handler to ref."Jonas Bjurel2-2/+2
2016-05-12docs/release-notes: Add protocol handler to ref.Alexandru Avadanii2-2/+2
Doc build fails to create a link for www.opnfv.org because it does not explicitly specify the protocol handler. Make doc build happy by adding "http://" prefix. Change-Id: I7dc9c362f13bac1687d139942826eb1208556a37 Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
2016-05-12docs/install-instr: Fix git clone URL for HTTPS.Alexandru Avadanii1-2/+2
Drop unnecessary <user>@, not needed for http downloads. Also, fix typo (missing letter) in opnfv.org domain name. While we're at it, fix small typo in Ceilometer name too. Change-Id: I2c3341689b7a7808863906700342e62e707246e9 Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
2016-05-11docs/build-instr: Fix git clone URL for HTTPS.Alexandru Avadanii1-4/+11
Fix wrong https git clone URL, 29418 port should be used only for SSH. While we're at it, add some bash code-block markup to bash commands. Change-Id: Ie95a4c170b70bcc3da5d4d59260d61fbd5f2a9f3 Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
2016-04-27Updated documentation for Brahmaputra 3.0 follow-up releaseJonas Bjurel5-44/+58
READY TO MERGE Change-Id: Ic481f02375af9be1642791fa6d96856a453c4f29 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-02-24Merge "docs: fix figure placement and old format"Jonas Bjurel6-34/+38
2016-02-23Merge "Final release notes for Fuel Brahmaputra SR0"Jonas Bjurel1-9/+8
2016-02-23Final Fuel Brahmaputra SR0 documentation updateJonas Bjurel1-3/+3
Change-Id: Iee51378f3689c32e82ce179885c2be1bb07ac2ae Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-02-23docs: fix figure placement and old formatRyota MIBU6-34/+38
This patch makes figures in the same place written in source rst files, and also fixes old format of rst files and logo images. Note: lisence headers should be added in another change with relevant copyrights. Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com> Change-Id: Ibc5ca44031ef5946079bdf251935100f762a87b6
2016-02-23Final release notes for Fuel Brahmaputra SR0Jonas Bjurel1-9/+8
Change-Id: Id5286c2a7e11eb29d7a7f187decfe475ae6acd6c Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-02-16Final documentation review for Brahmaputra releaseJonas Bjurel5-127/+240
Issue of the Fuel documentation for Brahmaputra for final review as proposed by Sofia and me. This patch will constantly be amended with improvements, corrections, etc as we go. From time to time we will, merge this patch to generate consolidated scraped results. But we will re-issue a review patch with the same topic-branch and commit headline until we have a taged Brahmaputra release. To view/review the entire files from gerrit, click the settings icon almost at the top right, and select "lines of context: entire file" - Note: There is still unknowns highlighted by <TODO> - Please comment on disposition, content, directory placing, etc. - You can find the rendered versions of the Fuel@OPNFV specific docs from the CI-job for this patch. These include: - installation-instruction.rst - build-instruction.rst - release-notes.rst - Scraped document composit rendering are placed - TBD. These include: - installerconfig.rst - postinstall.rst Change-Id: I5e28141cf03d80e5da9c5e10f5e75a3a26994f38 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-02-10Documentation according to new template provided by the Docs teamJonas Bjurel27-527/+677
- The Config guide is not an atonomos document, but will be scraped into a bigger context. - The post install guide is not an atonomos document, but will be scraped into a bigger context. - Installation instructions is an atonomos document describing details on how to install Fuel@OPNFV - Build instructions is an atonomos document describing how to build Fuel@OPNFV - Release notes - Agreed with the community that binary image files shall be in the repo, as much as I hate it. DO NOT MERGE JIRA: FUEL-38 Change-Id: I88a93e20ef2c67a2c973147a7a1e332e3da55674 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-02-04Correcting license and copyright terms throughout the repoJonas Bjurel3-0/+17
Please review this carefully! Strategy: 1) No strict research on copyright/who did what (if you want it changed contact the Fuel team or Jonas Bjurel) 2) Licence statements will not be added to the following file types: - Patch files or orig files for patches - Config files generated by ordinary tools, like libvirt/visrsh - GIT dierctive file - Other auto-generated files Change-Id: I48504c6f27925445dc44683a27a575bcab78d828 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
2016-01-22Added template for postinstallSofia Wallin1-0/+26
Added template for postinstall as part of the configuration guide. Change-Id: I212baa59b071fd785e70a9f018dc004ba79ec9fa Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>