From 8303a591949e603ad4ad58cef8f6adef6d1140fb Mon Sep 17 00:00:00 2001 From: jimmy Date: Wed, 8 Nov 2017 17:11:13 -0500 Subject: Fix dev setup guide to include images Issue-ID: AAI-255 Signed-off-by: Jimmy Forsyth Change-Id: I4c0fa8de83bab29e0f89a0af7fb639eb38e6944a --- .../AAI_Developer_Environment_Setup.rst | 279 +++++++++++---------- docs/platform/Getting Started/media/image1.png | Bin 0 -> 125765 bytes docs/platform/Getting Started/media/image2.png | Bin 0 -> 72973 bytes docs/platform/Getting Started/media/image3.png | Bin 0 -> 118940 bytes docs/platform/Getting Started/media/image4.png | Bin 0 -> 213389 bytes 5 files changed, 144 insertions(+), 135 deletions(-) create mode 100644 docs/platform/Getting Started/media/image1.png create mode 100644 docs/platform/Getting Started/media/image2.png create mode 100644 docs/platform/Getting Started/media/image3.png create mode 100644 docs/platform/Getting Started/media/image4.png (limited to 'docs/platform') diff --git a/docs/platform/Getting Started/AAI_Developer_Environment_Setup.rst b/docs/platform/Getting Started/AAI_Developer_Environment_Setup.rst index 10f45dfa..a5809ec2 100644 --- a/docs/platform/Getting Started/AAI_Developer_Environment_Setup.rst +++ b/docs/platform/Getting Started/AAI_Developer_Environment_Setup.rst @@ -1,9 +1,10 @@ + .. contents:: :depth: 3 .. _dev-setup: -A&AI Developer Environment Setup +AAI Developer Environment Setup ================================ This guide will illustrate setting up an A&AI development environment in @@ -12,123 +13,122 @@ Ubuntu 16.04.   For this exercise, I set up a new instance of Ubuntu in Virtualbox and gave it 16G RAM, 200GB dynamically allocated storage, and 3 processors. -1. install openjdk 8 +- install openjdk 8 - 1. sudo apt install openjdk-8-jdk + ..code:: bash -2. Install single node hadoop/titan + sudo apt install openjdk-8-jdk - 1. $ wget - http://s3.thinkaurelius.com/downloads/titan/titan-1.0.0-hadoop1.zip +- Install single node hadoop/titan - 2. $ unzip titan-1.0.0-hadoop1.zip + ..code:: bash - 3. $ cd titan-1.0.0-hadoop1 + wget http://s3.thinkaurelius.com/downloads/titan/titan-1.0.0-hadoop1.zip - 4. $ sudo ./bin/titan.sh start + unzip titan-1.0.0-hadoop1.zip -3. Install haproxy + cd titan-1.0.0-hadoop1 + + sudo ./bin/titan.sh start - 1. $ sudo apt-get -y install haproxy +- Install haproxy - 2. | $ haproxy -v - | HA-Proxy version 1.6.3 2015/12/25 - | Copyright 2000-2015 Willy Tarreau - `__> + ..code:: bash - 3. Install this haproxy.cfg file in /etc/haproxy + sudo apt-get -y install haproxy - `haproxy.cfg `__ + haproxy -v + HA-Proxy version 1.6.3 2015/12/25 + Copyright 2000-2015 Willy Tarreau + willy@haproxy.org http://haproxy.org/ -1. $ sudo cp aai.pem /etc/ssl/private/aai.pem +- Install this haproxy.cfg file in /etc/haproxy -2. $ sudo chmod 640 /etc/ssl/private/aai.pem + `haproxy.cfg `__ -3. | $ sudo chown root:ssl-cert /etc/ssl/private/aai.pem - | `aai.pem `__ + ..code:: bash -4. sudo mkdir /usr/local/etc/haproxy + sudo cp aai.pem /etc/ssl/private/aai.pem -5. Add these hostnames to the loopback interface in /etc/hosts:  + sudo chmod 640 /etc/ssl/private/aai.pem - 1. 127.0.0.1 localhost - `aai-traversal.api.simpledemo.openecomp.org `__ - aai-resour\ `ces.api.simpledemo.openecomp.or `__\ g + sudo chown root:ssl-cert /etc/ssl/private/aai.pem -6. $ sudo service haproxy restart + `aai.pem `__ -1. Set up repos. First, follow the initial setup instructions - in \ `Setting Up Your Development - Environment `__ + ..code::bash - 1. $ mkdir -p ~/LF/AAI + sudo mkdir /usr/local/etc/haproxy - 2. $ cd ~/LF/AAI +- Add these hostnames to the loopback interface in /etc/hosts:  - 3. $ git clone - ssh://%3Cusername%3E@gerrit.onap.org:29418/aai/aai-common + ..code:: bash - 4. $ git - clone \ `ssh://@gerrit.onap.org:29418/aai/traversal `__ + 127.0.0.1 localhost aai-traversal.api.simpledemo.openecomp.org aai-resouces.api.simpledemo.openecomp.org - 5. $ git - clone \ `ssh://@gerrit.onap.org:29418/aai/resources `__ +- Restart haproxy - 6. $ git clone - ssh://%3Cusername%3E@gerrit.onap.org:29418/aai/logging-service + ..code:: bash - 7. If you did not originally create a settings.xml file when setting - up the dev environment, you may 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 `__ + sudo service haproxy restart -2. Build aai-common, traversal, and resources +- Set up repos. First, follow the initial setup instructions in  + `Setting Up Your Development Environment `__ - 1. $ cd ~/LF/AAI/aai-common + ..code:: bash - 2. | $ mvn clean install - | Should result in BUILD SUCCESS + mkdir -p ~/LF/AAI - 3. $ cd ~/LF/AAI/resources + cd ~/LF/AAI - 4. | $ mvn clean install - | Should result in BUILD SUCCESS + git clone ssh://@gerrit.onap.org:29418/aai/aai-common - 5. $ cd ~/LF/AAI/logging-service + git clone ssh://@gerrit.onap.org:29418/aai/traversal - 6. | $ mvn clean install - | Should result in BUILD SUCCESS + git clone ssh://@gerrit.onap.org:29418/aai/resources - 7. | $ cd ~/LF/AAI/traversal - | I had to add the following to traversal/pom.xml to get - traversal to build:  + git clone ssh://@gerrit.onap.org:29418/aai/logging-service + +- If you did not originally create a settings.xml file when setting + up the dev environment, you may 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 `__ + +- Build aai-common, traversal, and resources + + ..code:: bash + + cd ~/LF/AAI/aai-common - 8. + mvn clean install # Should result in BUILD SUCCESS - 9. + cd ~/LF/AAI/resources - 10. maven-restlet + mvn clean install # Should result in BUILD SUCCESS - 11. Restlet repository + cd ~/LF/AAI/logging-service - 12. https://maven.restlet.com + mvn clean install # Should result in BUILD SUCCESS - 13. + cd ~/LF/AAI/traversal # I had to add the following to traversal/pom.xml to get + traversal to build:  - + ..code:: xml + maven-restletRestlet repositoryhttps://maven.restlet.com -1. | mvn clean install - | Should result in BUILD SUCCESS + mvn clean install # Should result in BUILD SUCCESS -1. Titan setup +- Titan setup - 1. | Modify both titan-cached.properties and + 1. Modify both titan-cached.properties and titan-realtime.properties to the following (for all MS’s that will connect to the local Cassandra backend) - | storage.backend=\ *cassandra* - | storage.hostname=\ *localhost* + + ..code:: bash + + storage.backend=\ *cassandra* + storage.hostname=\ *localhost* 2. update ~/LF/AAI/resources/aai-resources/bundleconfig-local/etc/appprops/titan-cached.properties @@ -142,11 +142,14 @@ gave it 16G RAM, 200GB dynamically allocated storage, and 3 processors. 5. update ~/LF/AAI/traversal/aai-traversal/bundleconfig-local/etc/appprops/titan-realtime.properties - 6. | The following property can be added to specify the keyspace + 6. The following property can be added to specify the keyspace name, each time you do this step (g) should be done. If not specified Titan will try to create/use a defaulted keyspace named titan. - | storage.cassandra.keyspace= + + ..code:: bash + + storage.cassandra.keyspace= 7. From the resources MS run the create db schema standalone program. @@ -154,112 +157,118 @@ gave it 16G RAM, 200GB dynamically allocated storage, and 3 processors. the schema to the local instance. (this will need to be done whenever using a new keyspace or after wiping the data). - Runnable class com.att.aai.dbgen.GenTester with the following vm + Runnable class org.onap.aai.dbgen.GenTester with the following vm args. -                 -DAJSC\_HOME=~/LF/AAI/resources - -DBUNDLECONFIG\_DIR="bundleconfig-local" + ..code:: bash -1. | Here's the command I used, and it worked: - | $ cd ~/LF/AAI; java - -DAJSC\_HOME=/home/jimmy/LF/AAI/resources/aai-resources - -DBUNDLECONFIG\_DIR="bundleconfig-local" -cp - aai-common/aai-core/target/aai-core-1.1.0-SNAPSHOT.jar:resources/aai-resources/target/aai-resources.jar:resources/aai-resources/target/userjars/\* - org.openecomp.aai.dbgen.GenTester + -DAJSC_HOME=~/LF/AAI/resources -DBUNDLECONFIG\_DIR="bundleconfig-local" -1. Start the "resources" microservice + 9. Here's the command I used, and it worked: - 1. | Resources runs on port 8446.  Go to the resources directory - | $ cd ~/LF/AAI/resources + ..code:: bash - 2. | 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" + cd ~/LF/AAI; java -DAJSC_HOME=/home/jimmy/LF/AAI/resources/aai-resources + -DBUNDLECONFIG_DIR="bundleconfig-local" -cp + aai-common/aai-core/target/aai-core-1.1.0-SNAPSHOT.jar:resources/aai-resources/target/aai-resources.jar:resources/aai-resources/target/userjars/\* + org.onap.aai.dbgen.GenTester - 3. | Start the microservice - | $ mvn -P runAjsc +- Start the "resources" microservice + + 1. Resources runs on port 8446.  Go to the resources directory + + ..code:: bash + cd ~/LF/AAI/resources + + 2. Set the debug port to 9446 + + ..code:: bash + + export MAVEN_OPTS="-Xms1024m -Xmx5120m -XX:PermSize=2024m + -Xdebug -Xnoagent -Djava.compiler=NONE + -Xrunjdwp:transport=dt_socket,address=9446,server=y,suspend=n" -2. Verify the resources microservice (this example uses Postman utility + 3. Start the microservice + + ..code::bash + + mvn -P runAjsc + +16. Verify the resources microservice (this example uses Postman utility for Google Chrome) - 1. Use basic auth, user = AAI, pw = AAI + 1. | Use basic auth, user = AAI, pw = AAI - 2. Set the X-TransactionId header (in the example below, the value is - 9999) + 2. | Set the X-TransactionId header (in the example below, the value is + | 9999) - 3. Set the X-FromAppId header (in the example below, the value is - jimmy-postman) + 3. | Set the X-FromAppId header (in the example below, the value is + | jimmy-postman) - 4. Perform a GET of https://127.0.0.1:8443/aai/v11/network/vces + 4. | Perform a GET of https://127.0.0.1:8443/aai/v11/network/vces - 5. You should see an error as below, 404 Not Found, ERR.5.4.6114.  - This indicates that the service is functioning normally: + 5. | You should see an error as below, 404 Not Found, ERR.5.4.6114.  + | This indicates that the service is functioning normally: +------------------------------------------+ -| |C:\\9cb03b5a507d917b3f460df1c1d95eea| | +| |image1| | +------------------------------------------+ -1. -2. Start the "traversal" microservice + +18. Start the "traversal" microservice 1. | Traversal runs on port 8447.  Go to the traversal directory - | $ cd ~/LF/AAI/traversal + ..code:: bash + $ cd ~/LF/AAI/traversal 2. | Set the debug port to 9447 - | $ export MAVEN\_OPTS="-Xms1024m -Xmx5120m -XX:PermSize=2024m + | $ export MAVEN_OPTS="-Xms1024m -Xmx5120m -XX:PermSize=2024m -Xdebug -Xnoagent -Djava.compiler=NONE - -Xrunjdwp:transport=dt\_socket,address=9447,server=y,suspend=n" + -Xrunjdwp:transport=dt_socket,address=9447,server=y,suspend=n" 3. | Start the microservice - | $ mvn -P runAjsc  - | Should see something like this: 2017-07-26 + | $ mvn -P runAjsc + | Should see something like this: 2017-07-26 12:46:35.524:INFO:oejs.Server:com.att.ajsc.runner.Runner.main(): Started @25827ms -3. Verify the traversal microservice +- Verify the traversal microservice 1. | Set up the widget models - | This will set up the postman to add widget models: \ `Add Widget - Models.postman\_collection.json `__\ `NamedQuery.postman\_collection.json `__ + | This will set up the postman to add widget models: `Add Widget Models.postman_collection.json `__ `NamedQuery.postman_collection.json `__ - 2. Create a runner using this - file: \ `models.csv `__ + 2. | Create a runner using this file: + `models.csv `__ 3. | Run the test runner - | |C:\\de01805e8408f48478705feb59a27e02| + | |image2| - 4. | Add a named query called "getComponentList" (this named query is - used by - VID): \ `NamedQuery.postman\_collection.json `__ - | |C:\\5cdb29c4d0655cf5ede2011736938e58| + 4. | Add a named query called "getComponentList" (this named query is used by VID):  + `NamedQuery.postman_collection.json `__ + | |image3| - 5. Add objects: \ `Add Instances for Named - Query.postman\_collection.json `__ (replacing - the xmlns "http://org.openecomp.aai.inventory/v11" with - "http://org.onap.aai.inventory/v11" in the Body of the PUT - request) + 5. | Add objects: + `Add Instances for Named Query.postman_collection.json `__ - 6. | Execute named-query: \ `Execute Named - Query.postman\_collection.json `__ + 6. | Execute named-query: + `Execute Named Query.postman_collection.json `__ | You should see something like the following: - | |C:\\a67954cfbcfebb8d7a7f48bba2a26195| + | |image4| -4. Your A&AI instance is now running, both the resources and traversal - microservices are working properly with a local titan graph.  +- Your A&AI instance is now running, both the resources and traversal + microservices are working properly with a local titan graph. -5. Next: \ `Tutorial: Making and Testing a Schema Change in - A&AI `__ +- Next: `Tutorial: Making and Testing a Schema Change in A&AI `__ -.. |C:\\9cb03b5a507d917b3f460df1c1d95eea| image:: media/image1.png +.. |image1| image:: media/image1.png :width: 4.87500in :height: 2.87500in -.. |C:\\de01805e8408f48478705feb59a27e02| image:: media/image2.tmp +.. |image2| image:: media/image2.png :width: 4.87500in :height: 3.75000in -.. |C:\\5cdb29c4d0655cf5ede2011736938e58| image:: media/image3.png +.. |image3| image:: media/image3.png :width: 4.87500in :height: 4.15000in -.. |C:\\a67954cfbcfebb8d7a7f48bba2a26195| image:: media/image4.png +.. |image4| image:: media/image4.png :width: 4.87500in :height: 4.15000in diff --git a/docs/platform/Getting Started/media/image1.png b/docs/platform/Getting Started/media/image1.png new file mode 100644 index 00000000..7bea6b1d Binary files /dev/null and b/docs/platform/Getting Started/media/image1.png differ diff --git a/docs/platform/Getting Started/media/image2.png b/docs/platform/Getting Started/media/image2.png new file mode 100644 index 00000000..6ddf0bf3 Binary files /dev/null and b/docs/platform/Getting Started/media/image2.png differ diff --git a/docs/platform/Getting Started/media/image3.png b/docs/platform/Getting Started/media/image3.png new file mode 100644 index 00000000..34aabf7e Binary files /dev/null and b/docs/platform/Getting Started/media/image3.png differ diff --git a/docs/platform/Getting Started/media/image4.png b/docs/platform/Getting Started/media/image4.png new file mode 100644 index 00000000..40f3977f Binary files /dev/null and b/docs/platform/Getting Started/media/image4.png differ -- cgit 1.2.3-korg