aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-10-31Update docs for GambiaHarry Huang10-41/+39
JIRA: - Change-Id: I5c2c404f74b91c12cccd6b085e75415a6f38eb62 Signed-off-by: Harry Huang <huangxiangyu5@huawei.com>
2018-09-21Remove VIRT_NUMBER in docopnfv-7.0.0Harry Huang1-4/+0
JIRA: - Change-Id: I4cbf8cb66120b8fe40401ba04694d4450f7e59be Signed-off-by: Harry Huang <huangxiangyu5@huawei.com>
2018-09-13docs: update arm deployment docYibo Cai1-17/+27
Change-Id: I09558eea301f7823d37b9303a46420dacd411569 Signed-off-by: Yibo Cai <yibo.cai@arm.com>
2018-09-12Add licenseHarry Huang3-0/+8
Change-Id: I139c48ca3498a5a1e399abb3ef999da67a47c921 Signed-off-by: Harry Huang <huangxiangyu5@huawei.com>
2018-03-27Documentation Update for Fraser releaseYifei Xue11-102/+90
JIRA: - Update the document for the latest Fraser release. Change-Id: Ifec8630ba7a87e2245ae6294b1f39b09ee2a8b6f Signed-off-by: Yifei Xue <xueyifei@huawei.com>
2018-02-14doc: add arm deployment guideYibo Cai1-0/+106
Change-Id: Ib66003003ea4697e9634201802e9169bc53a8ade Signed-off-by: Yibo Cai <yibo.cai@arm.com>
2017-11-01URL correction for quickstartYifei Xue2-2/+3
JIRA: COMPASS-564 The current quickstart URL for stable/euphrates branch is not correct. This patch is proposed to fix this mistake. Change-Id: I36883480f2af43baca81f6107d2c2281362104d2 Signed-off-by: Yifei Xue <xueyifei@huawei.com>
2017-10-19Update testresult link to Euphrates in release notes.chigang1-6/+1
JIRA: - Change-Id: If9f8bcd5774060bb3cbee30a0cff1e1b9031f822 Signed-off-by: chigang <chigang@huawei.com>
2017-10-18Update the Euphrates docs for kubernetes scenarioYifei Xue13-27/+416
JIRA: - In the Euphrates release, compass has supported kubernates deployment now. However, there is no k8s related description in docs of compass4nfv. So we add k8s related description in this patch including the k8s architeture, k8s networking in Compass, k8s virtual deployment and k8s bare metel deployment. Change-Id: I3bea3ae06b1c73076ba44d10caf89602928b7021 Signed-off-by: Yifei Xue <xueyifei@huawei.com>
2017-10-03Doc updates for EuphratesSofia Wallin2-30/+1
Change-Id: Ibf2a41a7e651e0a611a9721e7ebac29e181ad635 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2017-09-30SFC scenario release notes and bug fix for SFC switchYifei Xue1-1/+10
JIRA: COMPASS-562 Because of the inventory file modification, the sfc switch cannot be enabled. Add a sperate sfc role to fix this bug. Change-Id: If583d10ebbe78d0abe9078add24beb5f506dbda8 Signed-off-by: Yifei Xue <xueyifei@huawei.com>
2017-09-15Update the documents for compass E releaseYifei Xue18-286/+372
JIRA: - 1. Rewrite vm and bm deployment docs to satisfy the new release 2. add some images for network architecture 3. Update release name, version, etc. Change-Id: I1e9d305de5edf60d937868d49966c153d85fd2b5 Signed-off-by: Yifei Xue <xueyifei@huawei.com>
2017-08-24Docs update for E releaseYifei Xue8-14/+78
JIRA: - Update the structure of docs directory. Update the docs for E release. Add some new docs for E release. Change-Id: Ib4b6aced3d6ac88404d8518b5461e20d26e017e1 Signed-off-by: Yifei Xue <xueyifei@huawei.com>
2017-08-09Edit Expansion Guideliyuenan1-1/+20
JIRA: - mgmt and storage's network ip_ranges start ip needs update as the first 6 IPs are already taken by the first deployment. Change-Id: Iee01852c04ea7638999f664d567caaea060bdaf9 Signed-off-by: liyuenan <liyuenan@huawei.com>
2017-04-12Change the default packages url from compass http server to opnfv artifactsYifei Xue1-1/+2
JIRA: COMPASS-544 Currently compass4nfv uses compass http server to store those packages used in building ISO. This is not propriate in OPNFV community. So we push all the packages into opnfv artifacts repo and change the package url used in compass to opnfv artifacts repo url. Change-Id: I9661f2d893767e18c037ba9de5f54933f48ce466 Signed-off-by: Yifei Xue <xueyifei@huawei.com>
2017-03-30Update release notes for Danube releaseJustin chi2-23/+20
JIRA: - 1. Add known issues and workaroud instructions 2. Update Danube release date Change-Id: I6058dcf7db478d680999f451f5959ec4f998036f Signed-off-by: Justin chi <chigang@huawei.com> Signed-off-by: chigang <chigang@huawei.com>
2017-03-24[compass-docs] correct some minor mistakemeimei3-6/+5
Change-Id: I0e065552cbcaeffde83daeac9d1c27445f6cfcbb Signed-off-by: meimei <meimei@huawei.com>
2017-03-07Adding LabelsShubhamRathi4-0/+8
Labels serve as anchors/ refs when referenced from other documents This patch adds labels to docs/*/*/index.rst Change-Id: I66414622edcb73d22142d03d55c2040c3ff70d68 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-28Development documentations updateYifei Xue5-0/+186
JIRA: DOCS-165 Add the document for feature integration which introduces how to integrate a feature into compass4nfv including creating a role, making repo and building a feature included ISO. Change-Id: I8ea70a298cbf079ed30e318ce2cfc4b803218434 Signed-off-by: Yifei Xue <xueyifei@huawei.com>
2017-02-22Installation and release documentations updateQingyu Wang21-1100/+1125
JIRA: DOCS-165 update document for Danube release according to new doc guide; https://wiki.opnfv.org/display/DOC/Documentation+Guide add network topology for virtual and bm deployment; add a section for network_cfg.yaml configuration; add feature section, listing supported openstack version and features update installation for deployment and expansion. Change-Id: If43d94554bebc78bbd56cdf889c8c34dda926218 Signed-off-by: Qingyu <qingyuwang33@gmail.com> Signed-off-by: Justin <chigang@huawei.com>
2016-11-15DOC: offline-deploy.rstHarry Huang3-1/+48
JIRA: COMPASS-456 Change-Id: Id5897550b7a8fcdd0f1cfea1d35b4f844e298ad6 Signed-off-by: Harry Huang <huangxiangyu5@huawei.com>
2016-11-03Edit the deploy.shliyuenan3-74/+135
Change-Id: I611abbd6a1265fc397c8af4f2131e5e073ad91bb Signed-off-by: liyuenan <liyuenan@huawei.com>
2016-10-26Adjusted the FAQ structureliyuenan6-64/+30
JIRA: DOCS-165 Change-Id: I1b9740f644d109277006a7991f5e9b56edc33e2e Signed-off-by: liyuenan <liyuenan@huawei.com>
2016-09-28Merge "Add the expansion instruction"Justin chi2-0/+303
2016-09-20Adjusting the URL of the release notes to the colorado standard.ChristopherPrice2-3/+3
Change-Id: I5c9c302e7f190496b699dfec6cabdc31d8427e63 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-09-20Merge "Added a link to the relese notes in the installation document"Justin chi1-0/+2
2016-09-19Modify the release-notes for Coloradoliyuenan9-41/+48
JIRA: DOCS-159 Change-Id: I27b34186b436cbf0c49e070c6e2dd22eb31c6498 Signed-off-by: liyuenan <liyuenan@huawei.com>
2016-09-19Added a link to the relese notes in the installation documentSofia Wallin1-0/+2
Change-Id: Ieaa32ba194b2dfc9548ffa971037f7e7cf083e72 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-09-18Add the expansion instructionliyuenan2-0/+303
The expansion.rst shows how to increase a new compute node when other nodes are working. JIRA: DOCS-159 Change-Id: I36366940a2b67256319dc2a362ff5e81c17be243 Signed-off-by: liyuenan <liyuenan@huawei.com>
2016-09-13Adjusted the docs structureliyuenan9-177/+168
JIRA:DOCS-159 Change-Id: I30b655740634fc5a46fec3be707cb3abc9274502 Signed-off-by: liyuenan <liyuenan@huawei.com>
2016-09-12Add a run.shliyuenan3-128/+199
Add a run.sh for deploy openstack and edit instruction Change-Id: I3937ca59c12c53a7a1828138b3d70d8cb42a8fbe Signed-off-by: liyuenan <liyuenan@huawei.com>
2016-08-25Adjusted the docs structure according to directivesSofia Wallin2-0/+17
Added a sub directory /installationprocedure. 2 files has been created index.rst and installation.instrucution.rst Change-Id: Idc2472ce4e90ddac87685a585057a7edc7752291 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-08-17Update a how-to doc about jumphost offline preparationYifei Xue1-0/+10
JIRA: DOCS-141 Change-Id: I4365494273cd9d86bfcda9fa52e9d2a72e82595a Signed-off-by: Yifei Xue <xueyifei@huawei.com>
2016-08-16modify compass4nfv configuration documentationQiLiang7-237/+503
JIRA: DOCS-141 Change-Id: I136ae88163d4290e5fb2485ae6b58f723237f0df Signed-off-by: QiLiang <liangqi1@huawei.com>
2016-03-25update network connection recovery howtocarey.xu1-0/+7
Change-Id: Ib05175bf14a6af720c31700f6a8dfa2e057d4254 Signed-off-by: carey.xu <carey.xuhan@huawei.com>
2016-03-09fix a invalid role in installerconfig.rst.wu.zhihui1-1/+1
JIRA: COMPASS-334 Change-Id: I935002df80590c2e197ead41595b68d52cb1ddc9 Signed-off-by: wu.zhihui <wu.zhihui1@zte.com.cn>
2016-03-02Add FAQ file for Compass4nfvJustin-chi2-0/+121
Add Faq for B-release Change-Id: I6ae7335219b21c0f57090f26a4f6f6aa96121d6a Signed-off-by: Justin-chi <chigang@huawei.com>
2016-02-25Update release notes and installation instructionsJustin-chi4-35/+25
Final update for Brahmaputra 1.0 release Removal faq from Brahmaputra 1.0 Update ODL version Change-Id: I82b39ff09b934b6527fb539d2b1efd74ea62b533 Signed-off-by: Justin-chi <chigang@huawei.com>
2016-02-24Reducing header levels as the do not render correctly in composite docs.ChristopherPrice1-4/+6
Change-Id: I452b1f0f5d736a7d6a894db517442d2cce7dc2ca Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-23Adding aligned structure and segmenting the configguide.ChristopherPrice16-917/+577
Also set heading levels for readability and added missing licence headers. Copied the header where I copied content, so please be mindful and inform me if you disagree. Removal parts of userguide duplicated with configguide. Take the others into faq.rst Removal duplicated references in installerconfig. Removal redundant png files. Release notes update for Brahmaputra release. Change-Id: I6e1a101107752f4bc7b6e3bbaea0738690d07af8 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com> Signed-off-by: Justin-chi <chigang@huawei.com>
2016-02-17Document update for Brahmaputra release(WIP)Justin-chi2-9/+147
Add Network configuration for deploy Change-Id: Ief7863b3c4764949f31bca9e1a4c8aaea5306f8f Signed-off-by: Justin-chi <chigang@huawei.com>
2016-02-10Altering the directory structures to fit the release plan, added template ↵ChristopherPrice8-66/+160
info for release notes. Moved the folders from Brahmaputra to docs. The toolchain for stable/brahmaputra will add the Brahmaputra directory automatically. Added template information for the release-notes document Change-Id: Id77cce6f53a6e7a9567b0651f3ce68e1518851f1 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-01-21Document update for BrahmaputraJustin-chi8-42/+527
JIRA: COMPASS-75 add installation instruction add FAQ.rst(draft) and release-notes(draft) add some correction Change-Id: I8fc48c79eeea06bc2efafce2eca72ebd9b71be16 Signed-off-by: Justin-chi <chigang@huawei.com>
2016-01-19Templates for configuration guideSofia Wallin2-0/+49
Please use the installerconfig.rst to describe the configuration for each installer. Removed configoptions from the patch, we will provide patches for the post install procedures template during the day. Postinstall.rst is added, please use this to describe the post install activities. Change-Id: I37cae1344346b154017e3dc8b1a7acdb436114cd Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-01-04amend docs index file and delete some needless filesMatthewLi7-241/+132
JIRA: COMPASS-205 Change-Id: Id234519c95e94ca571580cc1fb3cd62c72ec8347 Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
2015-09-20Documentation Improvement: add baremetal deployment in cluster mode into How ↵chenshuai@huawei.com1-10/+9
to use Compass4nfv JIRA: COMPASS-65 Change-Id: I20d21d9a968aac268e4f9fdc2da88a83f966a650 Signed-off-by: chenshuai@huawei.com <chenshuai@huawei.com>
2015-09-18Documentation Improvement: add baremetal deployment in HA mode into How to ↵chenshuai@huawei.com2-14/+36
use Compass4nfv JIRA: COMPASS-59 Change-Id: I01f47776bcc9e5c6479c638beffcac97e4cc8a79 Signed-off-by: chenshuai@huawei.com <chenshuai@huawei.com>
2015-09-17Documentation Improvement: add network configuration into How to use compass4nfvchenshuai@huawei.com2-19/+96
JIRA: COMPASS-58 Change-Id: Ibee619494b17b30603b16343b91862defc171bc0 Signed-off-by: chenshuai@huawei.com <chenshuai@huawei.com>
2015-09-15Documentation:How to use compass4nfvchenshuai@huawei.com2-0/+462
JIRA: COMPASS-48 Change-Id: Ide1fd64b4d15d4319b562dfde62461cbbfbb7608 Signed-off-by: chenshuai@huawei.com <chenshuai@huawei.com>
2015-09-10Example as code, documentation template for sphinx buildAric Gardner4-0/+150
This code will be pushed to each project creating a docs/ directory This servers as an example and template for you (the developers) to create your own project documentation Change-Id: I84ebd8c99008eec2b31f705df3cc0462f66f7816 JIRA:RELENG-15 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>