summaryrefslogtreecommitdiffstats
path: root/docs/Chapter8
AgeCommit message (Collapse)AuthorFilesLines
2021-01-20CommonEventSchema and VES spec - restrictive IPv4/IPv6 formatdeen19852-27/+3119
- Added a new CommonEventSchema_30.2.1_ONAP.json - Included more restrictive IPv4 and IPv6 address checks for pnfRegistration - Updated VES spec to 7.2.1 - to refer to CommonEvent...30.2.1 and its internals Change-Id: I4a07831c7f1e273082ee90ad742ffe68c14c93db Signed-off-by: Damian Nowak <damian.nowak@nokia.com> Issue-ID: VNFRQTS-933
2021-01-16Revert VES CommonEventSchema 30.2.1 merged as 30.2.0deen19851-12/+8
VES CommonEventSchema 30.2.1 was merged as version 30.2.0. This needs ot be reverted, and CommonEventSchema 30.2.1 needs to be added as a new file in next step. Change-Id: I77c60fa937fdc7bf8bf51ac75e13e3f084cfa9a2 Signed-off-by: Damian Nowak <damian.nowak@nokia.com> Issue-ID: VNFRQTS-938
2021-01-14[VES spec] Updated eventID uniqueness rqtsdeen19851-5/+14
Includes a use-case description, where the eventId uniqueness cannot be assured. - Updated document version to 7.2.1 - Updated the link to EventId use-case examples - Updated human-readable text to point to VES 7.2.1 Change-Id: I3d068c0a3ab693753b0439d17ec3ee6faf9dd998 Signed-off-by: Damian Nowak <damian.nowak@nokia.com> Issue-ID: VNFRQTS-938
2021-01-04[VES CommonEventSchema] More restrictive ipv4 and ipv6 checks for ↵deen19851-8/+12
pnfRegistration fields. pnfRegistrationFields.oamV4IpAddress and pnfRegistrationFields.oamV6IpAddress using format "ipv4" and "ipv6" respectively. Signed-off-by: Damian Nowak <damian.nowak@nokia.com> Change-Id: I81ad30ffa9616da76d4c932ee631e692256c3d3a Issue-ID: VNFRQTS-933
2020-11-17[VES spec] publishEventBatch support for stndDefineddeen19851-0/+5
publishEventBatch enhanced to support stndDefined events. All events in batch shall have teh same value of stndDefinedNamespace set. Change-Id: Ie038c000217d23965742f59e2e33c6e228260202 Signed-off-by: deen1985 <damian.nowak@nokia.com> Issue-ID: VNFRQTS-935
2020-08-26Update links to use intersphinx mappingLovett, Trevor1-1/+1
Issue-ID: VNFRQTS-908 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: Icac746788e218ba977dd6dc1cfdfaaeda608cd3f
2020-08-26Point to the license model in modelingLovett, Trevor1-486/+4
Issue-ID: VNFRQTS-484 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: I5a467982b52217627da87a50c9781f388d3df7c7
2020-07-12Requirement ID Generation and RST ValidationLovett, Trevor9-278/+277
The new check.py script will now perform a variety of actions to simplify updates and ensure specific practices are followed for each update. The script has been integrated with tox and will run whenever the documentation is created. It can also be ran separately by just invoking python check.py. The script will perform a variety of automatic updates where possible, and provide a warning where auto-updates are not possible. The expecation is that all warnings are addressed before submitting for review, but given it is a new feature warnings do not block validation at this time. Here is a summary of the warnings and updates: Warnings: - Requirement missing required attributes - Invalid values for attributes - Invalid section header usage in any file - :keyword: and requirement mismatch Auto Updates: - Assigning :id: on new requirements where an ID missing - Adding :introduced: attribute on new requirements - Adding/correcting :updated: attribute on changed requirements Issue-ID: VNFRQTS-896 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: I283441330a139aa1c6e2e79f0c54c5979bf44642
2020-06-30Merge "stndDefined added to vesEventListener spec"Trevor Lovett1-15/+96
2020-06-29stndDefined added to vesEventListener specdeen19851-15/+96
This includes (list might not be complete, as some editiorial updates have been done too): Adding a new "stndDefined" enum to VES Common Event Header "domain" property Adding a new VES Common Header property "stndDefinedNamespace" Adding stndDefinedFields structure to VES Common Event Change-Id: I8b327c850b1d6c18d252fc4f77e40df9c5672ce8 Signed-off-by: deen1985 <damian.nowak@nokia.com> Issue-ID: VNFRQTS-889 Signed-off-by: deen1985 <damian.nowak@nokia.com>
2020-06-26Merge "Issue-ID: VNFRQTS-886 optimization in git clone using --depth"Trevor Lovett1-1/+1
2020-06-22stndDefined domain added to VES schemadeen19851-1/+36
Change-Id: I8fec71a3fe3a77089fd558e87563e247966a5819 Signed-off-by: deen1985 <damian.nowak@nokia.com> Issue-ID: VNFRQTS-888 Signed-off-by: deen1985 <damian.nowak@nokia.com>
2020-06-15Splitting NF reqt from VES specLovett, Trevor5-608/+472
- Moved content in VES Event Listener spec that was specific to defining NF behavior to Monitoring requirements - Expanded requirements regarding protocol selection - Provided additional guidance for VES client configuration - Reorganized sections of Event Listener for a more logical flow - Fixed various small formatting issues in VES 7.2 spec Issue-ID: VNFRQTS-813 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: I4ca6fa4d846465c90520f8ebb133a1301d3509cf Signed-off-by: Lovett, Trevor <trevor.lovett@att.com>
2020-06-02Initial VES 7.2 Event Listener SpecLovett, Trevor2-0/+9272
This is just a copy of the 7.1.1 spec to enable tracking of changes Issue-ID: VNFRQTS-813 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: Ic09cc6da49181845ef3748d562821d01a6262906
2020-05-28Issue-ID: VNFRQTS-886 optimization in git clone using --depthPratik Raj1-1/+1
optimize the git clone using --depth flag in term of size of clone and also in term's of time taken to fetch the files and commit history of whole repository . Respective issue with Issue-ID: VNFRQTS-886 is created at https://jira.onap.org/browse/VNFRQTS-886 More detail can be found at blog https://www.atlassian.com/git/tutorials/big-repositories Signed-off-by: Pratik Raj <rajpratik71@gmail.com> Change-Id: I34b4820b36ed31a6f86f0b09cb8a5bad8ca1e402
2020-04-29Updating OPNFV Verified testing instructionsLovett, Trevor1-253/+6
Issue-ID: VNFRQTS-882 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: I991f539dd3ff321021db3973f18b738aa2ce4117 (cherry picked from commit ffb088b777bb6c10bd01b9a832e2439fb10c7994)
2020-04-08Clarify VES listener accepts all domainsLovett, Trevor1-3/+2
A concern was raised based on the prior wording that it left it open that there may be multiple listeners each handling different domains. The wording was updated to remove any ambiguity. Issue-ID: VNFRQTS-871 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: Id06ac6181a9cda086e9ada8a1880703cdd282788
2020-04-08Merge "Relax camel casing requirements in VES"Hagop Bozawglanian1-5/+7
2020-04-02Merge "Correction of requirement R-816745"Hagop Bozawglanian1-0/+2
2020-04-02Correction of requirement R-816745JunfengWang1-0/+2
Issue-ID: VNFRQTS-867 Signed-off-by: JunfengWang <junfeng.a.wang@ericsson.com> Change-Id: I6d56998e1817c889e9d26f0d04fb955787d13d1a
2020-04-01Relax camel casing requirements in VESLovett, Trevor1-5/+7
In 7.1, the VES spec added requirements that made it mandatory for event names and other fields to camel case the values of those fields. This had the negative side-effect of requiring vendor and operator updates for existing VES events and their associated processing. To avoid this, the requirements have been updated from must requirements to should Issue-ID: VNFRQTS-869 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: I8669e08f7c4cd2df44239ca2fa49421e011f2e1d
2020-03-31VNFRQTS - updating ansible examplesHagop Bozawglanian1-1/+7
Issue-ID: VNFRQTS-870 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com> Change-Id: Ic4cab74366f32ca41d166f3fc2ba3bbbbda0a2af
2020-03-30Correction of requirement R-025941JunfengWang1-0/+2
Issue-ID: VNFRQTS-866 Signed-off-by: JunfengWang <junfeng.a.wang@ericsson.com> Change-Id: I952e1256c0a544af2b7655499512a83b11c95e03
2020-03-26Fixed PublishEventBatch diagram in VES specLovett, Trevor3-13/+33
Since we no longer have the source images, I've converted them to either diagrams generated from Sphinx plugins or simple text representations. Issue-ID: VNFRQTS-862 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: Iafd346336ca8b5cec71bbeee9fad825da2a5d0bf
2020-03-24Updated VES publishAnyEvent HTTP Headers requirement to VES 7.1.1deen19851-1/+1
Includes a change in HTTP headers required in publishAnyEvent use-case. Authorization header "Required?" property set to "No" to align with publishEventBatch, and VES7.1.1 implementation. Signed-off-by: deen1985 <damian.nowak@nokia.com> Change-Id: Id7fc8bbc0b62044a2cf8524ca2bd8029763283ce Issue-ID: VNFRQTS-863
2020-03-20Removing client command from VES 5.4.1 Event ListenerLovett, Trevor3-481/+12
Commands for event sources was never implemented, but the spec was not updated. The information is being removed to prevent confusion. Issue-ID: VNFRQTS-861 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: I12ef1368e2a6f84af63611d0bb839f4c840b113f
2020-03-20Adding VES 5.4.1 Event Listener SpecLovett, Trevor6-0/+2428
The ONAP Frankfurt release still supports the VES 5.4.1 Event Listener format so this has been added back into the requirements, and R-570134 has been updated accordingly. Issue-ID: VNFRQTS-804 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: I24fb9d62314cc4e35c87b23ce57498363d2eb0f3
2020-03-18VNFRQTS - Update Ansible RequirementsHagop Bozawglanian1-68/+126
Issue-ID: VNFRQTS-859 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com> Change-Id: I27acd935b5c71a1243f1f68330b3515e70638576
2020-03-05Merge "Updated VES Event Listener Spec with 7.1.1 updates"Hagop Bozawglanian1-587/+584
2020-03-04Merge "Updated VES Event Reg to 3.2.1"Hagop Bozawglanian2-505/+481
2020-03-04Updated VES Event Listener Spec with 7.1.1 updatesLovett, Trevor2-587/+3635
Issue-ID: VNFRQTS-801 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: I8492e1eb4dd573f10f4b16148c2b19bdef9193cc
2020-03-03Updated VES Event Reg to 3.2.1Lovett, Trevor2-505/+481
Updates to formatting and performance metric schema Issue-ID: VNFRQTS-802 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: Ie525b7fca25d0d30ca69aacc450589d586438d10
2020-03-02Merge "Add OPNFV Verified VNF Badge test instructions"Hagop Bozawglanian6-0/+813
2020-02-20Adding Schema VES Common Event for 7.1.1Lovett, Trevor1-0/+3051
NOTE: Corresponding spec updates will be published under a separate review. This is to allow DCAE to move forward with updates for the ONAP Frankfurt release. This file was previously reviewed as part of VNFRQTS-802 and was broken out to allow further debate on the other review feedback on that ticket Issue-ID: VNFRQTS-814 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: Ie38c80a12106372d326db6cdca38e005857d85f5
2020-02-12Add OPNFV Verified VNF Badge test instructionsLovett, Trevor6-0/+813
Issue-ID: VNFRQTS-805 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: I82e858675787d0ba7000c37b8b2ef35512230354 (cherry picked from commit 9644680a4797e802abaa2009c8f888b9a5238669)
2019-09-26VNFRQTS - Doc8 error fixesHagop Bozawglanian1-4/+4
Issue-ID: VNFRQTS-729 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com> Change-Id: Iaac38137b7681b1d47bc86adfb20aea8bcf73cac
2019-09-18VNFRQTS - Adding link to ansibleHagop Bozawglanian1-0/+4
Issue-ID: VNFRQTS-529 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com> Change-Id: Iab38b6bd612bd76b00ffd557f1275a7eed192788
2019-08-12VNFRQTS - Fixing '\' usageHagop Bozawglanian3-20/+16
Issue-ID: VNFRQTS-696 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com> Change-Id: Ied87d2502cea2e1b29f75ff585efcadf76e6a300
2019-08-08VNFRQTS - Fixing VES FormattingHagop Bozawglanian2-5021/+6554
Issue-ID: VNFRQTS-658 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com> Change-Id: Id8842d38c699805f6ee3ce680a5ebd355424238d
2019-06-10VNRQTS - Removing irrelevant referencesHagop Bozawglanian1-4/+0
Issue-ID: VNFRQTS-652 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com> Change-Id: I5dff26434c6937862d8587b716379dc4b2979baa
2019-05-28VNFRQTS - fixing links and formatting in VESHagop Bozawglanian2-627/+600
Issue-ID: VNFRQTS-644 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com> Change-Id: I60a2619f5893db17cb8720f8aeb220e51c9c5981 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com>
2019-05-21Moved VES Specs to VNF Requirements AppendicesLovett, Trevor8-0/+10448
Change-Id: I77cd2f0ff31272e13ea1cf08a47cce0d411134b0 Issue-ID: VNFRQTS-545 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com>
2019-04-24VNFRQTS - Doc8 fixesHagop Bozawglanian2-14/+14
Change-Id: Ic39bc7aa3e8eab163a8123164f88f30df7ae616c Issue-ID: VNFRQTS-606 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com>
2019-04-17VNFRQTS - xNF to VNF or PNFHagop Bozawglanian2-3/+3
Change-Id: I4a6a445a6c713c4be53be8cd79e158a1a10bc975 Issue-ID: VNFRQTS-571 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com>
2018-10-30VNFRQTS - Updating Management RequirementsBozawglanian, Hagop (hb755d)3-349/+623
Issue-ID: VNFRQTS-260 Change-Id: Icc54a27ade829e92a9d23f716b167911301b196d Signed-off-by: Bozawglanian, Hagop (hb755d) <hagop.bozawglanian@att.com>
2018-10-23VNFRQTS - Fix incorrect metadata usageLovett, Trevor3-30/+30
Change-Id: Ic1cd85ae2afc5f3443f78365789228660fc8c3a2 Issue-ID: VNFRQTS-477 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com>
2018-08-20VNFRQTS - Updating licenses in filesBozawglanian, Hagop (hb755d)6-18/+83
Change-Id: Ia321de03676efe5c090249d62f5b7d1376c95b54 Issue-ID: VNFRQTS-301 Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
2018-07-30VNFRQTS - Fixing Doc8 errorsBozawglanian, Hagop (hb755d)6-38/+38
Reviewing all files to make sure no doc8 errors are present. Change-Id: Ic073a7fb4096269d6b1781cecfdb2c4c8aa7b552 Issue-ID: VNFRQTS-281 Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
2018-07-30VNFRQTS - Dynamic footnote generationBozawglanian, Hagop (hb755d)1-2/+2
Updating footnotes to be generated more dynamically. Change-Id: If0f18874009cc981e73db99ea95cbd9bc5fb6299 Issue-ID: VNFRQTS-279 Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
2018-07-27VNFRQTS - Fixing JSON example in CH 8Bozawglanian, Hagop (hb755d)1-8/+10
Fixing the JSON example in 8.2 to a code-block. Change-Id: Ib004e158279b1ff6fc4c1bd97055b8126ab499a3 Issue-ID: VNFRQTS-284 Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>