X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=01b848730dfc9082c111907a6ab1fe6b62eac84c;hb=98f7bda6a4057f4a902de0b2c3396f0868e66227;hp=54023287677a3ff57989824858f8fb4a27188431;hpb=eaaee91b1defd671d06bcdfb69047e356956b77f;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 54023287..01b84873 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2020 Nordix Developer Guide =============== @@ -12,34 +13,34 @@ SDNC A1 Controller Prerequisites ------------- -1. Java development kit (JDK), version 8 -2. Maven dependency-management tool, version 3.4 or later -3. Python, version 2 -4. Docker, version 19.03.1 or later -5. Docker Compose, version 1.24.1 or later +1. Java development kit (JDK), version 11 +2. Maven dependency-management tool, version 3.6 or later +3. Python, version 2 or later +4. Docker, version 19.03.1 or latest +5. Docker Compose, version 1.24.1 or latest Build and run ------------- Go to the northbound directory and run this command :: - mvn clean install + mvn clean install -Dmaven.test.skip=true This will build the project and create artifcats in maven repo Go to oam/installation directory and run this command :: mvn clean install -P docker -This will create the docker images required for sdnc +This will create the docker images required for a1-controller. After this step check for the docker images created by the maven build with this command :: - docker images | grep sdnc + docker images | grep a1-controller Go to oam/installation/src/main/yaml and run this command :: - docker-compose up -d sdnc + docker-compose up -d a1-controller -This will create the docker containers with the sdnc image, you can check the status of the docker container using :: - docker-compose logs -f sdnc +This will create the docker containers with the a1-controller image, you can check the status of the docker container using :: + docker-compose logs -f a1-controller -The SDNC url to access the Northbound API, +The Open Daylight GUI url to access the Northbound API, http://localhost:8282/apidoc/explorer/index.html Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U