diff options
| -rw-r--r-- | docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst | 71 | ||||
| -rw-r--r-- | docs/release-notes.rst | 90 |
2 files changed, 80 insertions, 81 deletions
diff --git a/docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst b/docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst index 7776ebdb..d869c9ac 100644 --- a/docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst +++ b/docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst @@ -1,56 +1,71 @@ + .. contents:: :depth: 3 -.. +.. _dev-setup: How to Docker setup on Single VM ================================ +Prerequisites +------------- +1. Linux distribution Ubuntu is assumed (version 16.04 preferred) + +2. Make sure that git, docker and docker-compose are installed + Step-by-step guide ------------------ -1. You would need to have root access to the vm +1. You would need to have a root access to the vm + .. code-block:: bash + + sudo su - root + +2. Navigate to /opt directory + .. code-block:: bash -2. sudo su - root + cd /opt -3. cd /opt +3. Clone the test-config git project + .. code-block:: bash -4. git clone http://gerrit.onap.org/r/aai/test-config + git clone http://gerrit.onap.org/r/aai/test-config -5. cd test-config +4. Navigate to /opt/test-config directory + .. code-block:: bash -6. In deploy\_vm1.sh comment out the lines 89-94 which should be an if - statement checking for the /opt/message-router folder + cd test-config -7. Create a directory called /opt/config +5. Create a directory called /opt/config + .. code-block:: bash - 1. mkdir /opt/config/ + mkdir /opt/config/ -8. Create a file called /opt/config/nexus\_username.txt containing the - text: docker +6. Create a file called /opt/config/nexus\_username.txt containing the text: docker + .. code-block:: bash - 1. echo "docker" > /opt/config/nexus\_username.txt + echo "docker" > /opt/config/nexus_username.txt -9. Create a file called /opt/config/nexus\_password.txt containing the - text: docker +7. Create a file called /opt/config/nexus\_password.txt containing the text: docker + .. code-block:: bash - 1. echo "docker" > /opt/config/nexus\_password.txt + echo "docker" > /opt/config/nexus_password.txt -10. Create a file called /opt/config/dmaap\_topic.txt containing the - text: AAI-EVENT +8. Create a file called /opt/config/dmaap\_topic.txt containing the text: AAI-EVENT + .. code-block:: bash - 1. echo " AAI-EVENT" > /opt/config/dmaap\_topic.txt + echo "AAI-EVENT" > /opt/config/dmaap_topic.txt -11. Create a file called /opt/config/nexus\_docker\_repo.txt containing - text: nexus3.onap.org:10001 +9. Create a file called /opt/config/nexus\_docker\_repo.txt containing text: nexus3.onap.org:10001 + .. code-block:: bash - echo "nexus3.onap.org:10001" > /opt/config/nexus\_docker\_repo.txt + echo "nexus3.onap.org:10001" > /opt/config/nexus_docker_repo.txt -1. Create a file called /opt/config/docker\_version.txt containing text: - 1.1-STAGING-latest +10. Create a file called /opt/config/docker\_version.txt containing text: 1.1-STAGING-latest + .. code-block:: bash - echo "1.1-STAGING-latest" > /opt/config/docker\_version.txt + echo "1.1-STAGING-latest" > /opt/config/docker_version.txt -1. Please note that in the previous step, docker version is currently - 1.1-STAGING-latest and this will be changed later +11. Please note that in the previous step, docker version is currently 1.1-STAGING-latest and this will be changed later. Finally, run the installation scripts + .. code-block:: bash - ./deploy\_vm2.sh && ./deploy\_vm1.sh + ./deploy_vm2.sh && ./deploy_vm1.sh diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 775535b7..a6df0582 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -4,39 +4,29 @@ AAI 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-AMSTERDAM +Version: 1.1.0 -------------- - -:Release Date: 2017-11-17 - +:Release Date: 2017-11-16 **New Features** - Initial release of Active and Available Inventory (AAI) for Open Network Automation Platform (ONAP). AAI provides ONAP with its logically centralized view of inventory data, taking in updates from orchestrators, controllers, and assurance systems. AAI provides core REST services for - ONAP AAI R1 includes the following components: +Initial release of Active and Available Inventory (AAI) for Open Network Automation Platform (ONAP). AAI provides ONAP with its logically centralized view of inventory data, taking in updates from orchestrators, controllers, and assurance systems. AAI provides core REST services. + +ONAP AAI R1 includes the following components: - AAI Data Management - - Resources (CRUD operations) - - Traversal (Advanced search operations) - - Data Router (Route/persist AAI event data for consumption by the UI) - - Model Loader (Obtains SDC artifacts and loads them into the A&AI Resources service for storage) - - Search Data SErvice (Abstraction layer for searchengine, supporting queries and updates) - +- Resources (CRUD operations) +- Traversal (Advanced search operations) +- Data Router (Route/persist AAI event data for consumption by the UI) +- Model Loader (Obtains SDC artifacts and loads them into the A&AI Resources service for storage) +- Search Data SErvice (Abstraction layer for searchengine, supporting queries and updates) - Applications - - Sparky (AAI User Interface) +- Sparky (AAI User Interface) -Source code of AAI is released under the following repositories on gerrit.onap.org +Source code of AAI is released under the following repositories at https://gerrit.onap.org . - aai/aai-common - aai/aai-config @@ -59,24 +49,16 @@ Source code of AAI is released under the following repositories on gerrit.onap.o - aai/test-config - aai/traversal -Epic -^^^^ - - `AAI-17 <https://jira.onap.org/browse/AAI-17>`_ - Seed code stabilization - - `AAI-20 <https://jira.onap.org/browse/AAI-20>`_ - Champ Library - - `AAI-22 <https://jira.onap.org/browse/AAI-22>`_ - Amsterdam User Case Schema Updates - - `AAI-23 <https://jira.onap.org/browse/AAI-23>`_ - Model Loader Support for R1 - - `AAI-58 <https://jira.onap.org/browse/AAI-58>`_ - Define and build functional test cases for CSIT - - `AAI-72 <https://jira.onap.org/browse/AAI-72>`_ - External System Register - - `AAI-254 <https://jira.onap.org/browse/AAI-254>`_ - Documentation of REST APIs, dev guides, onboarding, etc. - - `AAI-280 <https://jira.onap.org/browse/AAI-280>`_ - Confguration enhancements +**Epic** + +- `AAI-17 <https://jira.onap.org/browse/AAI-17>`_ Seed code stabilization +- `AAI-20 <https://jira.onap.org/browse/AAI-20>`_ Champ Library +- `AAI-22 <https://jira.onap.org/browse/AAI-22>`_ Amsterdam User Case Schema Updates +- `AAI-23 <https://jira.onap.org/browse/AAI-23>`_ Model Loader Support for R1 +- `AAI-58 <https://jira.onap.org/browse/AAI-58>`_ Define and build functional test cases for CSIT +- `AAI-72 <https://jira.onap.org/browse/AAI-72>`_ External System Register +- `AAI-254 <https://jira.onap.org/browse/AAI-254>`_ Documentation of REST APIs, dev guides, onboarding, etc. +- `AAI-280 <https://jira.onap.org/browse/AAI-280>`_ Confguration enhancements **Bug Fixes** @@ -93,13 +75,13 @@ Compilation failure in aai-traversal AAI Common REST Client returns an error on a 204 (No Content) server response `AAI-49 <https://jira.onap.org/browse/AAI-49>`_ -Health check is failing in DFW 1.1 RS. Connection refused. +Health check is failing in DFW 1.1 RS. Connection refused `AAI-62 <https://jira.onap.org/browse/AAI-62>`_ -Search Data Service should not implicitly create indexes on document write... +Search Data Service should not implicitly create indexes on document write `AAI-63 <https://jira.onap.org/browse/AAI-63>`_ -Data Router must handle Search Service document create failures if index does not exit. +Data Router must handle Search Service document create failures if index does not exit `AAI-73 <https://jira.onap.org/browse/AAI-73>`_ Sparky sync issues @@ -168,7 +150,7 @@ Remove DMaaP router duplication There is an error to startup esr-gui docker `AAI-412 <https://jira.onap.org/browse/AAI-412>`_ -Replace the type specification in this constructor call with the diamond operator ("<>"). +Replace the type specification in this constructor call with the diamond operator ("<>") `AAI-417 <https://jira.onap.org/browse/AAI-417>`_ Rackspace 20170928 fails to authenticate nexus3 on 10003 during *_init.sh (sdnc for example) @@ -231,24 +213,26 @@ Fix stage-site jenkins job for aai-common LoggingContext.requestId required NULL handling in aai/aai-common (20170607) - during demo.sh init_customer **Known Issues** - - `AAI-61 <https://jira.onap.org/browse/AAI-61>`_ - AAI cleaned up references to OpenECOMP but in order to keep the release stable for R1, the XML namespace still contains openecomp. + +- `AAI-61 <https://jira.onap.org/browse/AAI-61>`_ AAI cleaned up references to OpenECOMP but in order to keep the release stable for R1, the XML namespace still contains openecomp. - Client systems should use http://org.openecomp.aai.inventory/v11 as the XML namespace for ONAP AAI R1 +Client systems should use http://org.openecomp.aai.inventory/v11 as the XML namespace for ONAP AAI R1. **Security Issues** - See Common Vulnerabilities and Exposures `CVE <https://cve.mitre.org>` - ONAP docker images and repos include demo TLS server certificates that are signed by a demo Certificate Authority. DO NOT use the demo certificates in a production environment. +See Common Vulnerabilities and Exposures `CVE <https://cve.mitre.org>` - AAI uses HTTPS Basic Authentication +ONAP docker images and repos include demo TLS server certificates that are signed by a demo Certificate Authority. DO NOT use the demo certificates in a production environment. + +AAI uses HTTPS Basic Authentication. **Upgrade Notes** - This is an initial release +This is an initial release **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. + +AAI Amsterdam provides support for legacy versions of the API, v8 and v11 in this release. v11 is the latest and preferred version. **Other** |