.. 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
===============
Prerequisites
-------------
-1. Java development kit (JDK), version 8
-2. Maven dependency-management tool, version 3.4 or later
+1. Java development kit (JDK), version 11
+2. Maven dependency-management tool, version 3.6 or later
3. Python, version 2
-4. Docker, version 19.03.1 or later
-5. Docker Compose, version 1.24.1 or later
+4. Docker, version 19.03.1 or latest
+5. Docker Compose, version 1.24.1 or latest
Build and run
-------------
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,
http://localhost:8282/apidoc/explorer/index.html