diff options
Diffstat (limited to 'docs/platform')
| -rw-r--r-- | docs/platform/architecture.rst | 22 | ||||
| -rw-r--r-- | docs/platform/images/aai-architecture.PNG | bin | 0 -> 124837 bytes | |||
| -rw-r--r-- | docs/platform/images/aai_in_onap.png | bin | 0 -> 108561 bytes | |||
| -rw-r--r-- | docs/platform/index.rst | 14 | ||||
| -rw-r--r-- | docs/platform/installation.rst | 14 | ||||
| -rw-r--r-- | docs/platform/offeredapis.rst | 202686 |
6 files changed, 202736 insertions, 0 deletions
diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst new file mode 100644 index 00000000..26e8b6cb --- /dev/null +++ b/docs/platform/architecture.rst @@ -0,0 +1,22 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +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. + +In addition to inventory and topology management, AAI provides the ability to do inventory administration. Data in AAI is continually updated in real-time as changes are made within the cloud. Because AAI is metadata-driven, new resources and services can be added quickly with Service Design and Creation (SDC) catalog definitions, using the AAI model loader, thus eliminating the need for lengthy development cycles. In addition, new inventory item types can be added quickly through schema configuration files. + +.. 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. + +With the high volume and variety of data, AAI must be prepared to answer many types of queries; real-time search to quickly retrieve specific items from an ocean of data, relationships to determine impacts and consequences, aggregations and counts to explore availability and consumption, validation and integrity to establish whether systems are acting on good information, history and provenance to reconstruct the current view and its context, and enrichment out to legacy systems to examine the low-level details of the network and virtual assets. + +.. image:: images/aai_in_onap.png diff --git a/docs/platform/images/aai-architecture.PNG b/docs/platform/images/aai-architecture.PNG Binary files differnew file mode 100644 index 00000000..9834d24f --- /dev/null +++ b/docs/platform/images/aai-architecture.PNG diff --git a/docs/platform/images/aai_in_onap.png b/docs/platform/images/aai_in_onap.png Binary files differnew file mode 100644 index 00000000..151e95b5 --- /dev/null +++ b/docs/platform/images/aai_in_onap.png diff --git a/docs/platform/index.rst b/docs/platform/index.rst new file mode 100644 index 00000000..4d0c8310 --- /dev/null +++ b/docs/platform/index.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Platform +-------- + +AAI is the central inventory system for ONAP. AAI collects network, vnf, service, and model information and stores the information in a graph which provides for easy lookup and traversal of inventory objects. + +.. toctree:: + :maxdepth: 1 + + architecture.rst + offeredapis.rst + installation.rst + diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst new file mode 100644 index 00000000..8e8aaad5 --- /dev/null +++ b/docs/platform/installation.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Installation and Developer Setup +---------------------------- +.. toctree:: + :maxdepth: 3 + + Getting Started/How_to_Docker_setup_on_Single_VM + Getting Started/AAI_Developer_Environment_Setup + Getting Started/How_to_AAI_data_snapshot_and_restore_in_ONAP_1_1 + Getting Started/Edge_Rules + Getting Started/Queries/Policy_Named_Query + Getting Started/Queries/vnf_to_esr_system_info_Named_Query + diff --git a/docs/platform/offeredapis.rst b/docs/platform/offeredapis.rst new file mode 100644 index 00000000..b493c958 --- /dev/null +++ b/docs/platform/offeredapis.rst @@ -0,0 +1,202686 @@ +======================================== +Active and Available Inventory REST API. +======================================== + +.. raw:: html + + <div class="container"> + +.. rubric:: Active and Available Inventory REST API. + :name: active-and-available-inventory-rest-api. + +Version: v11 + +| Copyright © 2017 AT&T Intellectual Property. All rights reserved. +| Licensed under the Creative Commons License, Attribution 4.0 Intl. + (the "License"); you may not use this documentation except in + compliance with the License. +| You may obtain a copy of the License at +| `(https://creativecommons.org/licenses/by/4.0/) <https://creativecommons.org/licenses/by/4.0>`__ +| Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied. See the License for the specific language governing + permissions and limitations under the License. +| ECOMP and OpenECOMP are trademarks and service marks of AT&T + Intellectual Property. +| This document is best viewed with Firefox or Chrome. Nodes can be + found by appending /#/definitions/node-type-to-find to the path to + this document. Edge definitions can be found with the node + definitions. + +.. raw:: html + + <div id="sw-schemes" class="sw-default-value"> + +Schemes: https + +.. raw:: html + + </div> + +.. rubric:: Summary + :name: swagger--summary-tags + +.. rubric:: Tag: CloudInfrastructure + :name: tag-CloudInfrastructure + :class: swagger-summary-tag + ++--------------------------------------+--------------------------------------+ +| Operation | Description | ++======================================+======================================+ +| `GET | returns cloud-regions | +| /cloud-infrastructure/cloud-regions | | +| <#operation--cloud-infrastructure-cl | | +| oud-regions-get>`__ | | ++--------------------------------------+--------------------------------------+ +| `GET | returns cloud-region | +| /cloud-infrastructure/cloud-regions/ | | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id} <#operation--cloud-infrastr | | +| ucture-cloud-regions-cloud-region--c | | +| loud-owner---cloud-region-id--get>`_ | | +| _ | | ++--------------------------------------+--------------------------------------+ +| `PUT | create or update an existing | +| /cloud-infrastructure/cloud-regions/ | cloud-region | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id} <#operation--cloud-infrastr | | +| ucture-cloud-regions-cloud-region--c | | +| loud-owner---cloud-region-id--put>`_ | | +| _ | | ++--------------------------------------+--------------------------------------+ +| `DELETE | delete an existing cloud-region | +| /cloud-infrastructure/cloud-regions/ | | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id} <#operation--cloud-infrastr | | +| ucture-cloud-regions-cloud-region--c | | +| loud-owner---cloud-region-id--delete | | +| >`__ | | ++--------------------------------------+--------------------------------------+ +| `GET | returns availability-zones | +| /cloud-infrastructure/cloud-regions/ | | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id}/availability-zones <#operat | | +| ion--cloud-infrastructure-cloud-regi | | +| ons-cloud-region--cloud-owner---clou | | +| d-region-id--availability-zones-get> | | +| `__ | | ++--------------------------------------+--------------------------------------+ +| `GET | returns availability-zone | +| /cloud-infrastructure/cloud-regions/ | | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id}/availability-zones/availabi | | +| lity-zone/{availability-zone-name} < | | +| #operation--cloud-infrastructure-clo | | +| ud-regions-cloud-region--cloud-owner | | +| ---cloud-region-id--availability-zon | | +| es-availability-zone--availability-z | | +| one-name--get>`__ | | ++--------------------------------------+--------------------------------------+ +| `PUT | create or update an existing | +| /cloud-infrastructure/cloud-regions/ | availability-zone | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id}/availability-zones/availabi | | +| lity-zone/{availability-zone-name} < | | +| #operation--cloud-infrastructure-clo | | +| ud-regions-cloud-region--cloud-owner | | +| ---cloud-region-id--availability-zon | | +| es-availability-zone--availability-z | | +| one-name--put>`__ | | ++--------------------------------------+--------------------------------------+ +| `DELETE | delete an existing availability-zone | +| /cloud-infrastructure/cloud-regions/ | | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id}/availability-zones/availabi | | +| lity-zone/{availability-zone-name} < | | +| #operation--cloud-infrastructure-clo | | +| ud-regions-cloud-region--cloud-owner | | +| ---cloud-region-id--availability-zon | | +| es-availability-zone--availability-z | | +| one-name--delete>`__ | | ++--------------------------------------+--------------------------------------+ +| `PUT | see node definition for valid | +| /cloud-infrastructure/cloud-regions/ | relationships | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id}/availability-zones/availabi | | +| lity-zone/{availability-zone-name}/r | | +| elationship-list/relationship <#oper | | +| ation--cloud-infrastructure-cloud-re | | +| gions-cloud-region--cloud-owner---cl | | +| oud-region-id--availability-zones-av | | +| ailability-zone--availability-zone-n | | +| ame--relationship-list-relationship- | | +| put>`__ | | ++--------------------------------------+--------------------------------------+ +| `DELETE | delete an existing relationship | +| /cloud-infrastructure/cloud-regions/ | | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id}/availability-zones/availabi | | +| lity-zone/{availability-zone-name}/r | | +| elationship-list/relationship <#oper | | +| ation--cloud-infrastructure-cloud-re | | +| gions-cloud-region--cloud-owner---cl | | +| oud-region-id--availability-zones-av | | +| ailability-zone--availability-zone-n | | +| ame--relationship-list-relationship- | | +| delete>`__ | | ++--------------------------------------+--------------------------------------+ +| `GET | returns dvs-switches | +| /cloud-infrastructure/cloud-regions/ | | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id}/dvs-switches <#operation--c | | +| loud-infrastructure-cloud-regions-cl | | +| oud-region--cloud-owner---cloud-regi | | +| on-id--dvs-switches-get>`__ | | ++--------------------------------------+--------------------------------------+ +| `GET | returns dvs-switch | +| /cloud-infrastructure/cloud-regions/ | | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id}/dvs-switches/dvs-switch/{sw | | +| itch-name} <#operation--cloud-infras | | +| tructure-cloud-regions-cloud-region- | | +| -cloud-owner---cloud-region-id--dvs- | | +| switches-dvs-switch--switch-name--ge | | +| t>`__ | | ++--------------------------------------+--------------------------------------+ +| `PUT | create or update an existing | +| /cloud-infrastructure/cloud-regions/ | dvs-switch | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id}/dvs-switches/dvs-switch/{sw | | +| itch-name} <#operation--cloud-infras | | +| tructure-cloud-regions-cloud-region- | | +| -cloud-owner---cloud-region-id--dvs- | | +| switches-dvs-switch--switch-name--pu | | +| t>`__ | | ++--------------------------------------+--------------------------------------+ +| `DELETE | delete an existing dvs-switch | +| /cloud-infrastructure/cloud-regions/ | | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id}/dvs-switches/dvs-switch/{sw | | +| itch-name} <#operation--cloud-infras | | +| tructure-cloud-regions-cloud-region- | | +| -cloud-owner---cloud-region-id--dvs- | | +| switches-dvs-switch--switch-name--de | | +| lete>`__ | | ++--------------------------------------+--------------------------------------+ +| `PUT | see node definition for valid | +| /cloud-infrastructure/cloud-regions/ | relationships | +| cloud-region/{cloud-owner}/{cloud-re | | +| gion-id}/dvs-switches/dvs-switch/{sw | | +| itch-name}/relationship-list/relatio | | +| nship <#operation--cloud-infrastruct | | +| ure-cloud-regions-cloud-region--clou | | +| d-owner---cloud-region-id--dvs-switc | | +| hes-dvs-switch--switch-name--relatio | |
