VOL-1318 PONSIM Demo build fresh environment creation
Added BUILD_ENV.md to include steps to create fresh env for
the choice of OS to use.
Currently steps to use ubuntu 16.04 (64bits) are added
Change-Id: I3800addb7bdce762135a43d1f7ed2824be119a6e
diff --git a/python/adapters/BUILD_ENV.md b/python/adapters/BUILD_ENV.md
new file mode 100644
index 0000000..e445141
--- /dev/null
+++ b/python/adapters/BUILD_ENV.md
@@ -0,0 +1,53 @@
+
+Build Environment for Ubuntu
+============================
+
+1. The following commands were executed on a Ubuntu 16.04 (b4 bits) VM with following configuation (OpenStack Flavor: m1.medium):
+ - vCPUs - 2
+ - RAM - 4 GB
+ - HDD - 40 GB
+ - Network - Floating IP attached to Internal IP NIC. Internet access available
+
+
+2. login as root as docker command needs root access. When logged-in as root 'sudo' becomes optional in each command below
+
+git clone https://gerrit.opencord.org/voltha-go
+sudo apt-get install make
+sudo apt-get install python
+sudo apt-get install virtualenv
+sudo apt-get install gcc
+sudo apt-get install python-dev
+sudo apt-get install g++
+sudo apt-get install libpcap-dev
+sudo apt-get install apt-utils
+sudo apt-get install docker-compose
+
+
+3. Install docker CE for Ubuntu as mentioned in this link: https://docs.docker.com/install/linux/docker-ce/ubuntu/#set-up-the-repository. These are commands executed to install docker
+
+sudo apt-get update
+
+sudo apt-get install \
+ apt-transport-https \
+ ca-certificates \
+ curl \
+ software-properties-common
+
+curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
+
+sudo apt-key fingerprint 0EBFCD88
+
+sudo add-apt-repository \
+ "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
+ $(lsb_release -cs) \
+ stable"
+
+sudo apt-get update
+
+sudo apt-get install docker-ce
+
+
+4. Verify that Docker CE is installed correctly by running the hello-world image. The following command downloads a test image and runs it in a container. When the container runs, it prints an informational message and exits.
+
+sudo docker run hello-world
+
diff --git a/python/adapters/README.md b/python/adapters/README.md
index 1ab1c4f..72d7395 100644
--- a/python/adapters/README.md
+++ b/python/adapters/README.md
@@ -3,6 +3,11 @@
The build and development environment of a Voltha Adapter is left to the developer's choice. The
environment used below is the macOS.
+# Create fresh build setup
+When creating a fresh build setup various packages, applications and libraries are required to Build successfully.
+Please refer BUILD_ENV.md for details to create fresh setup on your choice of OS.
+This file will increment as new setups are created on difference OSes.
+
### Build
To build the adapters (so far Ponsim OLT and Ponsim ONU adapters) and dependent containers follow
@@ -26,11 +31,16 @@
voltha-protoc latest a67dda73f695 2 months ago 1.41GB
```
-Now build the Voltha Core from the voltha-go directory as well as the CLI image (used below for provisioning)
+Now build the Voltha Core from the voltha-go directory
```
make rw_core
```
+Now build the Voltha CLI image from the voltha-go/python directory (used below for provisioning)
+```
+make cli
+```
+
This will create the following images:
```
REPOSITORY TAG IMAGE ID CREATED SIZE
@@ -76,7 +86,7 @@
First get the IP address of the Ponsim OLT container by using the docker inspect command.
-Now, start the CLI.
+Now, start the CLI. Password for 'voltha' user is 'admin'. Please see Dockerfile.cli for passwords
```$xslt
ssh -p 5022 voltha@localhost