aboutsummaryrefslogtreecommitdiffstats
path: root/docs/platform
diff options
context:
space:
mode:
authorManisha Aggarwal <amanisha@att.com>2022-11-09 15:24:32 +0000
committerGerrit Code Review <gerrit@onap.org>2022-11-09 15:24:32 +0000
commit8b504f6db32630ae4b6774efabc87ed76a950053 (patch)
tree9268c155f08e79fde05c33f63ed2b02d9ff5a07d /docs/platform
parentfbb02159b84435cf37221ae8ae5e0045167be15a (diff)
parent5b83ba0814d6a046d45146e97762626700440520 (diff)
Merge "[AAI] Fix doc config files"
Diffstat (limited to 'docs/platform')
-rw-r--r--docs/platform/Getting Started/AAI_Developer_Environment_Setup.rst36
-rw-r--r--docs/platform/Getting Started/Queries/vnf_to_esr_system_info_Named_Query.rst2
2 files changed, 16 insertions, 22 deletions
diff --git a/docs/platform/Getting Started/AAI_Developer_Environment_Setup.rst b/docs/platform/Getting Started/AAI_Developer_Environment_Setup.rst
index c8afd9c1..4122a9e0 100644
--- a/docs/platform/Getting Started/AAI_Developer_Environment_Setup.rst
+++ b/docs/platform/Getting Started/AAI_Developer_Environment_Setup.rst
@@ -33,7 +33,7 @@ For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 1
Running `nodetool statusthrift`... OK (returned exit status 0 and printed string "running").
Forking Elasticsearch...
Connecting to Elasticsearch (127.0.0.1:9200)...... OK (connected to 127.0.0.1:9200).
- Forking Gremlin-Server...
+ Forking Gremlin-Server...
Connecting to Gremlin-Server (127.0.0.1:8182).... OK (connected to 127.0.0.1:8182).
Run gremlin.sh to connect.
@@ -59,7 +59,7 @@ For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 1
1. $ sudo apt-get -y install haproxy
2. $ <path-to-haproxy>/haproxy -v
- Response should be:
+ Response should be:
.. code-block:: bash
@@ -79,9 +79,9 @@ For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 1
$ sudo cp aai.pem /etc/ssl/private/aai.pem
$ sudo chmod 640 /etc/ssl/private/aai.pem
- $ sudo chown root:ssl-cert /etc/ssl/private/aai.pem
+ $ sudo chown root:ssl-cert /etc/ssl/private/aai.pem
- Add these hostnames to the loopback interface in /etc/hosts:
+ Add these hostnames to the loopback interface in /etc/hosts:
127.0.0.1 localhost aai-traversal.api.simpledemo.openecomp.org aai-resources.api.simpledemo.openecomp.org aai-traversal.api.simpledemo.onap.org aai-resources.api.simpledemo.onap.org
@@ -101,12 +101,6 @@ For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 1
$ mkdir ~/.m2
$ cp settings.xml ~/.m2
- If you get an error on some of the repos saying that oparent is
- unresolvable, using the example settings.xml file should solve this
- problem: `Setting Up Your Development
- Environment#MavenExamplesettings.xml
- <https://wiki.onap.org/display/DW/Setting+Up+Your+Development+Environment#SettingUpYourDevelopmentEnvironment-MavenExamplesettings.xml>`__
-
5. Set Up Repos
---------------
@@ -127,8 +121,8 @@ For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 1
Modify both janus-cached.properties and janus-realtime.properties to the following (for all MS’s that will connect to the local Cassandra backend)
- .. code::
-
+ .. code::
+
storage.backend=cassandra
storage.hostname=localhost
storage.cassandra.keyspace=onap # or different keyspace name of your choosing
@@ -183,7 +177,7 @@ For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 1
9. Janus setup (part 2)
-----------------------
-
+
Run this on the local instance on your first time running AAI and whenever using new keyspace or after wiping the data.
Install the schema
@@ -194,7 +188,7 @@ For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 1
You should see:
- .. code::
+ .. code::
---- NOTE --- about to open graph (takes a little while)--------;
-- Loading new schema elements into JanusGraph --
@@ -271,10 +265,10 @@ For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 1
> PUT /aai/v16/cloud-infrastructure/complexes/complex/clli2 HTTP/1.1
> GET /aai/v16/cloud-infrastructure/complexes/complex/clli2 HTTP/1.1
- With payload:
+ With payload:
.. code-block:: json
-
+
{
"physical-location-id": "clli2",
"data-center-code": "example-data-center-code-val-6667",
@@ -294,7 +288,7 @@ For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 1
"elevation": "example-elevation-val-28399",
"lata": "example-lata-val-28399"
}
-
+
And finishes with:
.. code-block:: bash
@@ -303,7 +297,7 @@ For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 1
> GET /aai/v16/cloud-infrastructure/complexes HTTP/1.1
With the following:
-
+
.. code-block:: json
{
@@ -319,10 +313,10 @@ For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 1
]
}
}
- }
+ }
12. Start the "traversal" microservice
---------------------------------------
+--------------------------------------
Traversal runs on port 8446. Go to the traversal directory
@@ -331,7 +325,7 @@ For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 1
$ cd ~/src/aai/traversal
Set the debug port to 9446
-
+
$ export MAVEN_OPTS="-Xms1024m -Xmx5120m -XX:PermSize=2024m -Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,address=9446,server=y,suspend=n"
Start the microservice - adjust your build version accordingly
diff --git a/docs/platform/Getting Started/Queries/vnf_to_esr_system_info_Named_Query.rst b/docs/platform/Getting Started/Queries/vnf_to_esr_system_info_Named_Query.rst
index 7ad412a9..078801a4 100644
--- a/docs/platform/Getting Started/Queries/vnf_to_esr_system_info_Named_Query.rst
+++ b/docs/platform/Getting Started/Queries/vnf_to_esr_system_info_Named_Query.rst
@@ -7,7 +7,7 @@ vnf to esr-system-info Named Query
**Example Request**
-POST https://127.0.0.1:8443/aai/search/named-query
+POST /aai/search/named-query
{