summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2017-09-14Modify title and structure to fit release docopnfv-5.0.0stable/euphratesfuqiao2-11/+4
Modify title and structure to fit release doc JIRA: HA 30 Change-Id: I01ca0dadac011224eeaaf137f13760aaf7b82c23 Signed-off-by: fuqiao@chinamobile.com
2017-09-14Merge "Updating HA GUEST API OVERVIEW DOCUMENT based on Bertrand Souville's ↵Qiao Fu4-314/+56
comments. - adding standard Doctor / Vitrage Fault Mgmt Architecture Diagram, and - refering to Doctor SB API"
2017-04-25Added optional SPDX license header for Creative Commons plus rephrased ↵Ray Paik1-4/+4
"proposal" Change-Id: I3f3cfc82af5c93ad959dc41305d9341072b67ac3 Signed-off-by: Ray Paik <rpaik@linuxfoundation.org>
2017-03-30Modify format issuesfuqiao3-23/+18
Modify format issues JIRA: HA-28 Change-Id: I5ab2bee17801d3b0741b83497391935f28602057 Signed-off-by: fuqiao@chinamobile.com
2017-03-30Modify formatfuqiao2-17/+17
Modify format JIRA: HA-28 Change-Id: I93cedf87f1a6d5aeee8adb63a5491294768afc8f Signed-off-by: fuqiao@chinamobile.com
2017-03-30Modify format error in overview docfuqiao2-64/+343
Modify format error in overview doc JIRA: HA-28 Change-Id: I580b5ede0457ed5d6f38f03cea8acea6dffa0646 Signed-off-by:fuqiao@chinamobile.com
2017-03-17Updating HA GUEST API OVERVIEW DOCUMENT based on Bertrand Souville's comments.gwaines4-314/+56
- adding standard Doctor / Vitrage Fault Mgmt Architecture Diagram, and - refering to Doctor SB API ------------- Updating HA GUEST API OVERVIEW Proposal after review with OPNFV DOCTOR Team. Minutes from meeting, that were addressed as part of this update are below. - VM Heartbeating & Health Checking * libvirt watchdog and its integration / use with OpenStack > https://blueprints.launchpad.net/nova/+spec/libvirt-watchdog > https://wiki.openstack.org/wiki/LibvirtWatchdog#Notifications > Need to review behaviour of this capability as compared to the proposed VM Heartbeating/Health-checking > i believe there is a bit of overlap but believe that VM Heartbeating / Health-checking provides a more complete solution > i'll update document with a NOTE on comparing the proposal with the libvirt watchdog * Update the architecture diagram to be consistent with the most current DOCTOR Architecture Diagrams > e.g. Vitrage & Congress are not necessrily deployed at same time > use DOCTOR terminology where applicable, e.g. "inspector modules" > OPNFV DOCTOR includes patches/components of AODH, NOVA, NEUTRON ... not just Vitrage and Congress, as shown in diagram - although also had comment that should remove OPNFV DOCTOR outline from diagram as OPNFV DOCTOR is a reuirement specification and not an implementation > indicate (possibly just in text below diagram) that the "Guest Heartbeat / Health-check Server' on Controller Node is possibly not required, as the Vitrage data source interface can be remotely reached by "Guest Heartbeat / Health-check Compute" on the Compute Node * In text, provide a little more detail on content of actual messaging e.g. PDUs and rough message content * OVERALL > believe there was a general agreement in the way that VM Heartbeating & Health-checking was integrated / inter-worked with OPNFV DOCTOR's Vitrage / Congress and overall OPNFV fault reporting architecture > key feedback was to understand and highlight the additional value of the VM Heartbeating & Health-checking functionality over the existing libvirt watchdog integration into OpenStack. - Server Group Messaging * suggestion that Rabbit MQ pub/sub messaging could be an alternative for routing of messages > this is an implementation detail though * general discussions on "HA use cases" for how this messaging could be leveraged > e.g. split-brain avoidance, faster peer VM state change notifications * OVERALL > agreement that the Server Group Messaging Architecture did NOT conflict with Doctor Architecture > need further review with OPNFV MANO Team as to how they would position this functionality e.g. - position it as an alternative for various HA use cases ? - versus - mandating that this service group messaging be used for specific HA user cases Change-Id: Icd54bbf8889017cfe3f617656ddf483cbb171e63 Signed-off-by: gwaines <greg.waines@windriver.com>
2017-03-16Sorting out git conflicts.gwaines7-34/+280
------------------------ Updating based on March 29 OPNFV HA Meeting. Had general consensus on Heartbeating/Health-checking section and the VM Messaging section as a "PROPOSAL". I re-worded Title, Doc Status, Introduction and Conclusion to position the document as PROPOSAL status. ( NOTE I removed the more controversial VM Notification and Feedback section as we could not get to consensus on this topic in timeframe. ) -------------------------- Updating Commit based on online comments. Mostly clarifications of information already discussed. AND added HTML and PDF version of document for easier reading. -------------------------- Updating Commit based on third round of review during OPNFV HA meetings, as well as submitted comments on the review. I updated the Overview document mostly with - specific deliverables for each capability - an indication in both the Introduction and the Conclusion that the intent or next steps for this proposal will be to review this document with the related teams of OPNFV (e.g. Doctor, Management & Orchestration) and OpenStack (Nova). I also removed the lower level documents from the commit since we need to focus on closing the high-level proposal first, and we haven't reviewed the lower level documents. -------------------------- Updating Commit based on second round of review during OPNFV HA meetings, as well as submitted comments on the review. NOTE - I have ONLY updated the Overview document, looking to gain consensus on that before fixing up the lower level documents. The major update was to include the higher level context of how the proposed functionality integrates into the overall NFV / OpenStack architecture. I have included such an Architecture Diagram for each of the major functionalities described in the document and updated the descriptions to describe this overall integration. -------------------------- Updating Commit based on initial review during OPNFV HA meeting, as well as submitted comments on the review. Major updates included: - provided a new OVERVIEW document that describes the full suite of HA Guest APIs and focuses on how these APIs can be used to improve the availability of the hosted guest. - split the original document into two documents * Base Host-to-Guest Messaging Layer (that is leveraged by several HA Guest APIs) * Server Group Messaging API, OpenStack Host Design and Reference Guest Design (the first HA Guest API being considered for D release) -------------------------- Committing draft version of HA Guest APIs - Server Group Messaging documentation for review. Word, PDF and rst versions of documentation are available. Change-Id: I1e44efe6052dfa84cdffd9bbebe8be86e4992121 Signed-off-by: gwaines <greg.waines@windriver.com>
2017-03-07Adding LabelsShubhamRathi2-0/+4
Labels serve as anchors/ refs when referenced from other documents This patch adds labels to docs/*/*/index.rst Change-Id: I8a8abab11d0c27d1d3f0de3097e0a1b7eca8b25e Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-13Danube MS6 adding document directivesfuqiao19-1466/+25
add overview doc and design docs JIRA: HA-28 Change-Id: I890d2056a0fe61ca6aa1297210a1028d38d1514d Signed-off-by: fuqiao@chinamobile.com
2016-10-31Documentation updateSofia Wallin2-6/+12
Index files updated to enable correct documentation rendering. Change-Id: I0576ea0c1cbcfe9d5f3b58bf9d609c7cafa9ca4f Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-09-21Delete how-to-use filesfuqiao4-156/+0
Delete how-to-use files JIRA: HA-24 Change-Id: I1c892062833f7540e2fc3314bf79de2a2daccba0 Signed-off-by:fuqiao@chinamobile.com
2016-09-21Update Deployment docfuqiao20-14/+465
Update the deployment doc with figures JIRA:HA-24 Change-Id: I111b456881ea362a0b90ed30e4e7882574754cb3 Signed-off-by:fuqiao@chinamobile.com
2016-09-21Update the docs folderfuqiao15-0/+1069
Update the docs folder to include the two release docs JIRA: HA-24 Change-Id: I2d50fb84b9e54ae6b6e05d0f9466e920a8dae1d4 Signed-off-by: fuqiao@chinamobile.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: Icd33fb5a155121e6a0376f3905e662fbbc6af8d7 JIRA:RELENG-15 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>