diff options
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/platform/architecture.rst | 4 | ||||
| -rw-r--r-- | docs/platform/index.rst | 1 | ||||
| -rw-r--r-- | docs/platform/installation.rst | 2 | ||||
| -rw-r--r-- | docs/release-notes.rst | 52 | ||||
| -rw-r--r-- | docs/release-notes/index.rst | 42 | ||||
| -rw-r--r-- | docs/release-notes/release-notes-amsterdam.rst | 42 |
7 files changed, 56 insertions, 89 deletions
diff --git a/docs/index.rst b/docs/index.rst index 409d6517..b3f21cb7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,6 +14,6 @@ The key AAI repos for running the AAI REST APIs: :maxdepth: 2 platform/index.rst - release-notes/index.rst + release-notes.rst AAI REST API Documentation/AAIRESTAPI_AMSTERDAM diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst index 26e8b6cb..8e6dd421 100644 --- a/docs/platform/architecture.rst +++ b/docs/platform/architecture.rst @@ -4,7 +4,7 @@ Architecture ------------ AAI Architecture in ONAP -^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^ AAI provides ONAP with its logically centralized view of inventory data, taking in updates from orchestrators, controllers, and assurance systems. With that responsibility, it takes on a key data management role, providing the ONAP components not only the current “as-built” view of the services, but also the view into the data of the system itself; it’s integrity, it’s chronology, and where the source of the information can be found. @@ -13,7 +13,7 @@ In addition to inventory and topology management, AAI provides the ability to do .. image:: images/aai-architecture.PNG AAI's Role in ONAP -^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^ AAI is where the data converges, where the pictures come together, and where the ONAP actor systems ask questions so they can make their decisions. As new network or data center resources become available, AAI is updated with their specifics via REST APIs. When new service types are designed, or new services instantiated, systems keep AAI up to date of their deployment at each step of the way. As telemetry is gathered for the services as well as their underlying infrastructure, the health and analytics conclusions reached are stored in AAI as state information. When assurance systems detect a failure, AAI is queried to determine the extent of the impact. diff --git a/docs/platform/index.rst b/docs/platform/index.rst index 4d0c8310..88db1bc7 100644 --- a/docs/platform/index.rst +++ b/docs/platform/index.rst @@ -11,4 +11,3 @@ AAI is the central inventory system for ONAP. AAI collects network, vnf, service architecture.rst offeredapis.rst installation.rst - diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst index 8e8aaad5..4792744d 100644 --- a/docs/platform/installation.rst +++ b/docs/platform/installation.rst @@ -1,7 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. Installation and Developer Setup ----------------------------- +-------------------------------- .. toctree:: :maxdepth: 3 diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 00000000..efd36781 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,52 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +A&AI Release Notes +================== + +.. note:: + * This Release Notes must be updated each time the team decides to Release new artifacts. + * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. + * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. + * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. + * This note must be removed after content has been added. + + +Version: x.y.z +-------------- + + +:Release Date: yyyy-mm-dd + + + +**New Features** + Initial release of Active and Available Inventory (AAI) for Open Network Automation Platform (ONAP) + + +**Bug Fixes** + - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing. +**Known Issues** + - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences. + One sentences explaining what is the issue. + + Another sentence explaining the impact of the issue. + + And an optional sentence providing a workaround. + +**Security Issues** + You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_ + + +**Upgrade Notes** + +**Deprecation Notes** + AAI Amsterdam provides support for legacy versions of the API, v8 and v11 in this release. v11 is the latest and preferred version. + +**Other** + +=========== + +End of Release Notes diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst deleted file mode 100644 index 5f5d2dc1..00000000 --- a/docs/release-notes/index.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - - Release Notes - ============= - - .. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. - - - Version: 1.1.0 - -------------- - - - :Release Date: yyyy-mm-dd - - - - **New Features** - - Initial release of Active and Available Inventory (AAI) for Open Network Automation Platform (ONAP) - - **Bug Fixes** - - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing. - **Known Issues** - - **Security Issues** - - **Upgrade Notes** - - **Deprecation Notes** - - AAI Amsterdam provides support for legacy versions of the API, v8 and v11 in this release. v11 is the latest and preferred version. - - **Other** - - =========== - - End of Release Notes diff --git a/docs/release-notes/release-notes-amsterdam.rst b/docs/release-notes/release-notes-amsterdam.rst deleted file mode 100644 index 7abcda3d..00000000 --- a/docs/release-notes/release-notes-amsterdam.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - - Release Notes - ============= - - .. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. - - - Version: 1.1.0 - -------------- - - - :Release Date: yyyy-mm-dd - - - - **New Features** - - Initial release of Active and Available Inventory (AAI) for Open Network Automation Platform (ONAP) - - **Bug Fixes** - - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing. - **Known Issues** - - **Security Issues** - - **Upgrade Notes** - - **Deprecation Notes** - - AAI Amsterdam provides support for legacy versions of the API, v8 and v11 in this release. v11 is the latest and preferred version. - - **Other** - - =========== - - End of Release Notes |