summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-11-07Add tox env to generate documentationVictor Morales1-0/+40
The process to generate HTML documentation can be automated with tox. This chage covers the basics instructions. In order to test this is necessary to have python tox module and run the following command in the multivimbroker folder $ tox -e docs Change-Id: I9540f6234a85e4775a482efd9dda9da1ec615591 Signed-off-by: Victor Morales <victor.morales@intel.com> Issue-ID: DOC-300
2018-11-07Fix VIO docEthan Lynn1-2/+2
Lower VIO Simulated API document title level. Change-Id: Ib79f03e9257a865a663d5aa497cdd8f1f86ea3a5 Issue-ID: MULTICLOUD-395 Signed-off-by: Ethan Lynn <ethanlynnl@vmware.com>
2018-11-06Organize VIO plugin documentsEthan Lynn3-12/+96
This patch adds user guide for MultiCloud VIO plugin and re-organize current VIO documents. Change-Id: Idbe4357b760fbdbc734df19511771d7487d199d9 Issue-ID: MULTICLOUD-395 Signed-off-by: Ethan Lynn <ethanlynnl@vmware.com>
2018-11-03Refactor the docsBin Yang9-219/+682
Dedicated sections for APIs, User guides, and specs Change-Id: Icf57b4b14d775507b40b65681be2aba9a8e2e62f Issue-ID: MULTICLOUD-309 Signed-off-by: Bin Yang <bin.yang@windriver.com>
2018-10-11API reference for v1Bin Yang1-0/+2556
Upgrade API version from v0 to v1 Add Infra_workload LCM APIs Change-Id: I72a486aebe4a4884d02c8c3e17067152e9e4e257 Issue-ID: MULTICLOUD-309 Signed-off-by: Bin Yang <bin.yang@windriver.com>
2018-08-27Use python rstcheck to validate syntaxVictor Morales5-23/+21
Given that this repository contains multiple documents for specifications is necessary to implement a mechanism to validate its syntax. The rstchecker tool ensures that it meets the reStructured Text guidelines. Change-Id: I6a5d30c78718ae83265f9302f3d514eacaff2ae1 Issue-ID: DOC-300 Signed-off-by: Victor Morales <victor.morales@intel.com>
2018-08-24Merge "Multicloud infra workload Delete and Get"Bin Hu1-12/+149
2018-08-23Merge "Onappylog library improvement"Bin Hu1-22/+51
2018-08-23Multicloud infra workload Delete and GetHuang Haibin1-12/+149
Adding two API: - Delete infra workload - Get infra workload Change-Id: Ie458bb2f6170e57df29a76f06ea21dfe2b6250b7 Issue-ID: MULTICLOUD-250 Signed-off-by: Huang Haibin <haibin.huang@intel.com>
2018-08-22Onappylog library improvementliangke1-22/+51
Change-Id: I782785733a79e328b7d8abab77c70035e30b706f Issue-ID: MULTICLOUD-326 Signed-off-by: liangke <lokyse@163.com>
2018-08-20Fix Multicloud infra workload API FormatHuang Haibin1-5/+3
Change-Id: I810681a8d0c54697d3b6480cafb4416dd73b0960 Issue-ID: MULTICLOUD-250 Signed-off-by: Huang Haibin <haibin.huang@intel.com>
2018-08-17Add Multicloud infra workload APIHuang Haibin1-0/+135
Change-Id: I5cb04c4ae11278a4c675edaa3ee32e459fcf6e0a Issue-ID: MULTICLOUD-250 Signed-off-by: Huang Haibin <haibin.huang@intel.com>
2018-08-15Merge "Fix registry/unregistry doc"Bin Yang1-2/+2
2018-08-14Proposal on security communication featureBin Yang1-0/+48
Change-Id: I5eecc0c9966836d17e6118e6b85e26042a3bf195 Issue-ID: MULTICLOUD-266 Signed-off-by: Bin Yang <bin.yang@windriver.com>
2018-08-14Proposal to automate heatbridgeBin Yang1-0/+47
Describe how to automate AAI with heat stack by multicloud Change-Id: Icb0330abd3975102827bddb3f681c0a8ab869657 Issue-ID: MULTICLOUD-282 Signed-off-by: Bin Yang <bin.yang@windriver.com>
2018-08-14Propose automating multi-region on-boardingBin Yang1-0/+77
This proposal describe how multicloud plugin helps automating of on-boarding the OpenStack secondary regions Change-Id: Icba078a6ff1462901e7e5240507925ac6f76edb9 Issue-ID: MULTICLOUD-279 Signed-off-by: Bin Yang <bin.yang@windriver.com>
2018-07-31Add design spec for API upgrading and ID alignmentBin Yang1-0/+131
This is to propose the changes for enabling consistent ID of a cloud region Change-Id: Ia25f60ba14d28d02559a9902972a3cff6ca814c2 Issue-ID: MULTICLOUD-280 Signed-off-by: Bin Yang <bin.yang@windriver.com>
2018-07-13Fix registry/unregistry docEthan Lynn1-2/+2
url for registry/unregistry is not correct. Change-Id: I3d799ef175b87cfcb358e77434e8cd0ccedfa4b0 Issue-ID: MULTICLOUD-239 Signed-off-by: Ethan Lynn <ethanlynnl@vmware.com>
2018-06-14Add HPA deployment guideYun Huang1-0/+211
Change-Id: I896eac7b7c715326fbd1f86af1dd0e1ad1cf4d8c Issue-ID: MULTICLOUD-248 Signed-off-by: Yun Huang <yun.huang@windriver.com>
2018-06-07Remove ToC in API documentEthan Lynn1-231/+0
Remove ToC Change-Id: Ib09f46987bf8975f28016b30935d920d8d23523c Issue-ID: MULTICLOUD-239 Signed-off-by: Ethan Lynn <ethanlynnl@vmware.com>
2018-06-07Update Release Note for BeijingLi Xinhui1-3/+6
This patch is to update the RN for Beijing. Change-Id: I3e84691c2982dec44dc07eb4fdf4f833ab28bc41 Issue-ID: MULTICLOUD-243 Signed-off-by: Xinhui Li <lxinhui@vmware.com>
2018-06-05Update API docv1.1.22.0.0-ONAPbeijing2.0.0-ONAPEthan Lynn18-984/+1205
Fix style Change-Id: Ifee26b7453de51f63bd37b0289ab3ccdc0697ec2 Issue-ID: MULTICLOUD-239 Signed-off-by: Ethan Lynn <ethanlynnl@vmware.com>
2018-05-30Document Security section of the Release NotesGildas Lanilis1-41/+37
Change-Id: I773a5b7c603bea24681843b3a1c219859638bb1c Issue-ID: DOC-271 Signed-off-by: Gildas Lanilis <gildas.lanilis@huawei.com>
2018-05-17Revise docsLi Xinhui1-0/+65
This patch is to revise the documents. Change-Id: I3b47254d3dbae6c6067daefd44780ad370922558 Issue-ID: MULTICLOUD-211 Signed-off-by: Xinhui Li <lxinhui@vmware.com>
2018-05-17Revise release dateLi Xinhui1-2/+2
This patch is to revise the release date. Change-Id: I122360486e559b5dee69f05ccf64cabe77c5769e Issue-ID: MULTICLOUD-211 Signed-off-by: Xinhui Li <lxinhui@vmware.com>
2018-05-17Add release note for R2Li Xinhui1-16/+14
This patch is to add release note for R2 release. Change-Id: I0110aec66a64cca949b7592385fa2ad2d45c63e6 Issue-ID: MULTICLOUD-211 Signed-off-by: Xinhui Li <lxinhui@vmware.com>
2018-04-16Correct File NameLi Xinhui1-0/+18
Change-Id: I6012a95b145f203fcfbb7fd567a064a472dcd9c3 Issue-ID: MULTICLOUD-211 Signed-off-by: Xinhui Li <lxinhui@vmware.com>
2018-04-16Revise Admin DocsLi Xinhui1-3/+3
Change-Id: Ic5abf68b5ed17b8c00fcf1c4ea2658c71d614a04 Issue-ID: MULTICLOUD-211 Signed-off-by: Xinhui Li <lxinhui@vmware.com>
2018-04-16Correct license usage for Deployment StepsLi Xinhui1-3/+3
Change-Id: Ie54f6027c06f368c50d0d9308d547ffbc79ac0af Issue-ID: MULTICLOUD-211 Signed-off-by: Xinhui Li <lxinhui@vmware.com>
2018-04-16Revise license for Fake Cloud DesciptionLi Xinhui1-3/+3
Change-Id: Id6aba2caee429bb48a68d94c72ffc9790db587a5 Issue-ID: MULTICLOUD-211 Signed-off-by: Xinhui Li <lxinhui@vmware.com>
2018-04-16Revise license for Description fileLi Xinhui1-3/+3
Change-Id: I994155bcb6f44dc7ebcb37a518df9909d104de37 Issue-ID: MULTICLOUD-211 Signed-off-by: Xinhui Li <lxinhui@vmware.com>
2018-04-11Add license into doc fileLi Xinhui1-3/+3
Change-Id: I19ce1d0037343b74a4d1bc9bcc240019a6324732 Issue-ID: MULTICLOUD-211 Signed-off-by: Xinhui Li <lxinhui@vmware.com>
2018-04-11Add license into doc fileLi Xinhui1-3/+3
Change-Id: I56fe906b0f6d0e24d280cd93bacf4b482f9ba8e6 Issue-ID: MULTICLOUD-211 Signed-off-by: Xinhui Li <lxinhui@vmware.com>
2018-03-25Update Multi VIM/Cloud CSIT docLi Xinhui1-0/+18
This patch is to add CSIT document. Change-Id: I25a506d6d6bf97e9b74eb007087715dc7aea03fb Issue-ID: MULTICLOUD-127 Signed-off-by: Xinhui Li <lxinhui@vmware.com>
2018-03-25Merge "Spec for elastic API exposure"zhang ab1-0/+240
2018-03-23Spec for elastic API exposureHong Hui Xiao1-0/+240
Change-Id: I22b018b060f3d3f0f7fea88af32eff44f2a49ff3 Issue-ID: MULTICLOUD-152 Signed-off-by: Hong Hui Xiao <honghui_xiao@yeah.net>
2018-03-23Fix wrong wordBin Sun1-1/+1
The parameter is wrong in the spec. Change-Id: I4bb5c790a38518bc164b8f8ccfcddc0695b610ad Issue-ID: MULTICLOUD-150 Signed-off-by: Bin Sun <bins@vmware.com>
2018-03-22Specs for image serviceBin Sun1-0/+117
Change-Id: I7dade73cab501e20df9885cfe8996c5f09551776 Issue-ID: MULTICLOUD-155 Signed-off-by: Bin Sun <bins@vmware.com>
2018-03-22Merge "Specs for Event Federation"zhang ab1-0/+145
2018-03-22Specs for Event FederationBin Sun1-0/+145
Change-Id: Ibc4d931aee7e300cca9c005bc628c8a7d3bc30dc Issue-ID: MULTICLOUD-149 Signed-off-by: Bin Sun <bins@vmware.com>
2018-03-22Spec for parallelism improvment of multicloudHong Hui Xiao1-0/+199
Change-Id: If07bd4690014f19ff202ca6ad23ebdab227305fe Issue-ID: MULTICLOUD-150 Signed-off-by: Hong Hui Xiao <honghui_xiao@yeah.net>
2018-03-05Merge "spec for Container based network service/function"Bin Hu1-0/+700
2018-03-02spec for Container based network service/functionIsaku Yamahata1-0/+700
TODO: issue id should be updated once JIRA item is created. Change-Id: I38d1f2503fd47f838d2f0de15e17e6497fdf712a Issue-ID: MULTICLOUD-148 Signed-off-by: Isaku Yamahata <isaku.yamahata@intel.com>
2018-03-01Add test plan for check_vim_capacity specEthan Lynn1-1/+7
Add unit test and CSIT tests plan Change-Id: I1c99d4cdd89e792046f3e8dcc4d4389c4b98e674 Issue-ID: MULTICLOUD-160 Signed-off-by: Ethan Lynn <ethanlynnl@vmware.com>
2018-02-28Merge " Logging Specs for S3P"Liang Ke1-0/+83
2018-01-29 Logging Specs for S3Pliangke1-0/+83
Change-Id: Ie2e39d56eb7ca2be0d50dd9b3b37b8134cf7b230 Issue-ID: MULTICLOUD-151 Signed-off-by: liangke <lokyse@163.com>
2018-01-29Merge "Spec for MultiCloud HPA Discovery and Represent"zhang ab1-0/+109
2018-01-29Spec for MultiCloud HPA Discovery and RepresentBin Yang1-0/+109
Change-Id: I8a98dd8d76f5dd1767de7cf8000481bb182e6464 Issue-ID: MULTICLOUD-157 Signed-off-by: Bin Yang <bin.yang@windriver.com>
2018-01-29Design spec of resource capacity check APIEthan Lynn1-0/+101
This is the design spec for resource capacity check API between OOF and MultiCloud. Change-Id: If2213b95a3ce3a807c1ce21cac13fdb57bd86caa Issue-ID: MULTICLOUD-160 Issue-ID: MULTICLOUD-156 Signed-off-by: Ethan Lynn <ethanlynnl@vmware.com>
2018-01-22Add specs directory for design discussion/reviewLi Xinhui1-0/+28
This change is to add a new directory under docs to contain all design drafts. Issue-ID: MULTICLOUD-159 Signed-off-by: Xinhui Li <lxinhui@vmware.com> Change-Id: I91092f34c53579ea3752eb6150c1dbb6e5e117f7