VOL-1422: Update docs and docker compose files
- remove deprecated cli
- use updated etcd matching k8s deployment
- remove references to python openolt adapter
Change-Id: I273490233652b03163b77f990a96f4b8847579cb
diff --git a/compose/adapters-openolt.yml b/compose/adapters-openolt.yml
deleted file mode 100644
index da3b0c3..0000000
--- a/compose/adapters-openolt.yml
+++ /dev/null
@@ -1,38 +0,0 @@
----
-# Copyright 2018 the original author or authors.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-version: '2'
-services:
- adapter_openolt:
- image: "${REGISTRY}${REPOSITORY}voltha-adapter-openolt${TAG}"
- logging:
- driver: "json-file"
- options:
- max-size: "10m"
- max-file: "3"
- command: [
- "/voltha/python/adapters/openolt/main.py",
- "-v",
- "--name=openolt",
- "--kafka_adapter=${DOCKER_HOST_IP}:9092",
- "--kafka_cluster=${DOCKER_HOST_IP}:9092",
- "--core_topic=rwcore"
- ]
- networks:
- - default
-#Add brcm_openomci_onu here if needed
-networks:
- default:
- driver: bridge
diff --git a/compose/cli.yml b/compose/cli.yml
deleted file mode 100644
index 2869329..0000000
--- a/compose/cli.yml
+++ /dev/null
@@ -1,37 +0,0 @@
----
-# Copyright 2018 the original author or authors.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-version: "2"
-services:
- cli:
- image: "${REGISTRY}${REPOSITORY}voltha-cli:latest"
- logging:
- driver: "json-file"
- options:
- max-size: "10m"
- max-file: "3"
- environment:
- DOCKER_HOST_IP: "${DOCKER_HOST_IP}"
- entrypoint:
- - /voltha/python/cli/setup.sh
- - -g ${DOCKER_HOST_IP}:50057
- networks:
- - default
- ports:
- - "5022:22"
-
-networks:
- default:
- driver: bridge
diff --git a/compose/docker-compose-etcd.yml b/compose/docker-compose-etcd.yml
index cbcb7d5..9c11c3c 100644
--- a/compose/docker-compose-etcd.yml
+++ b/compose/docker-compose-etcd.yml
@@ -19,7 +19,7 @@
# Single-node etcd server
#
etcd:
- image: "quay.io/coreos/etcd:v3.2.9"
+ image: "quay.io/coreos/etcd:v3.4.1"
command: [
"etcd",
"--name=etcd0",
diff --git a/compose/system-test-bbsim.yml b/compose/system-test-bbsim.yml
index 37abd5e..d3dc347 100644
--- a/compose/system-test-bbsim.yml
+++ b/compose/system-test-bbsim.yml
@@ -50,7 +50,7 @@
etcd:
- image: "quay.io/coreos/etcd:v3.2.9"
+ image: "quay.io/coreos/etcd:v3.4.1"
command: [
"etcd",
"--name=etcd0",
@@ -97,20 +97,6 @@
restart: unless-stopped
- cli:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-cli:${DOCKER_TAG}"
- environment:
- DOCKER_HOST_IP: "${DOCKER_HOST_IP}"
- entrypoint:
- - /voltha/python/cli/setup.sh
- - -g ${DOCKER_HOST_IP}:50057
- networks:
- - default
- ports:
- - "5022:22"
- restart: unless-stopped
-
-
ofagent:
image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-ofagent:${DOCKER_TAG}"
command: [
diff --git a/compose/system-test-openolt-go.yml b/compose/system-test-openolt-go.yml
deleted file mode 100644
index 8bbe8b6..0000000
--- a/compose/system-test-openolt-go.yml
+++ /dev/null
@@ -1,188 +0,0 @@
----
-# Copyright 2018 the original author or authors.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-version: '2'
-
-networks:
- default:
- driver: bridge
-
-services:
-
- zookeeper:
- image: "wurstmeister/zookeeper:latest"
- environment:
- SERVICE_2181_NAME: "zookeeper"
- ports:
- - 2181:2181
- networks:
- - default
- restart: unless-stopped
-
-
- kafka:
- image: "wurstmeister/kafka:2.11-2.0.1"
- environment:
- KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://${DOCKER_HOST_IP}:9092
- KAFKA_LISTENERS: PLAINTEXT://:9092
- KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
- KAFKA_AUTO_CREATE_TOPICS_ENABLE: 'true'
- SERVICE_9092_NAME: "kafka"
- volumes:
- - /var/run/docker.sock:/var/run/docker.sock
- ports:
- - 9092:9092
- networks:
- - default
- restart: unless-stopped
-
-
- etcd:
- image: "quay.io/coreos/etcd:v3.2.9"
- command: [
- "etcd",
- "--name=etcd0",
- "--advertise-client-urls=http://${DOCKER_HOST_IP}:2379,http://${DOCKER_HOST_IP}:4001",
- "--listen-client-urls=http://0.0.0.0:2379,http://0.0.0.0:4001",
- "--initial-advertise-peer-urls=http://${DOCKER_HOST_IP}:2380",
- "--listen-peer-urls=http://0.0.0.0:2380",
- "--initial-cluster-token=etcd-cluster-1",
- "--initial-cluster=etcd0=http://${DOCKER_HOST_IP}:2380",
- "--initial-cluster-state=new"
- ]
- ports:
- - "2379:2379"
- - 2380
- - 4001
- networks:
- - default
- restart: unless-stopped
-
-
- rw_core:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-rw-core:${DOCKER_TAG}"
- entrypoint:
- - /app/rw_core
- - -kv_store_type=etcd
- - -kv_store_host=${DOCKER_HOST_IP}
- - -kv_store_port=2379
- - -grpc_port=50057
- - -banner=true
- - -kafka_adapter_host=${DOCKER_HOST_IP}
- - -kafka_adapter_port=9092
- - -kafka_cluster_host=${DOCKER_HOST_IP}
- - -kafka_cluster_port=9092
- - -rw_core_topic=rwcore
- - -kv_store_data_prefix=service/voltha
- - -in_competing_mode=false
- - -log_level=0
- volumes:
- - "/var/run/docker.sock:/tmp/docker.sock"
- ports:
- - 50057:50057
- networks:
- - default
- restart: unless-stopped
-
-
- cli:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-cli:${DOCKER_TAG}"
- logging:
- driver: "json-file"
- options:
- max-size: "10m"
- max-file: "3"
- environment:
- DOCKER_HOST_IP: "${DOCKER_HOST_IP}"
- entrypoint:
- - /voltha/python/cli/setup.sh
- - -g ${DOCKER_HOST_IP}:50057
- networks:
- - default
- ports:
- - "5022:22"
- restart: unless-stopped
-
-
- ofagent:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-ofagent:${DOCKER_TAG}"
- logging:
- driver: "json-file"
- options:
- max-size: "10m"
- max-file: "3"
- command: [
- "/ofagent/ofagent/main.py",
- "--consul=${DOCKER_HOST_IP}:8500",
- "--controller=${DOCKER_HOST_IP}:6653",
- "--grpc-endpoint=${DOCKER_HOST_IP}:50057",
- "--instance-id-is-container-name",
- "-v"
- ]
- volumes:
- - "/var/run/docker.sock:/tmp/docker.sock"
- networks:
- - default
- restart: unless-stopped
-
-
- onos:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-onos:${DOCKER_TAG}"
- ports:
- - "8101:8101" # ssh
- - "6653:6653" # OF
- - "8181:8181" # UI
- environment:
- ONOS_APPS: 'drivers,openflow-base'
- volumes:
- - "/var/run/docker.sock:/tmp/docker.sock"
- - "./network-cfg.json:/root/onos/config/network-cfg.json"
- networks:
- - default
- restart: unless-stopped
-
-
- adapter_openolt:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-openolt-adapter:${DOCKER_TAG}-go"
- command: [
- "/app/openolt",
- "--kafka_adapter_host=${DOCKER_HOST_IP}",
- "--kafka_adapter_port=9092",
- "--kafka_cluster_host=${DOCKER_HOST_IP}",
- "--kafka_cluster_port=9092",
- "--core_topic=rwcore",
- "--kv_store_host=${DOCKER_HOST_IP}",
- "--kv_store_port=2379"
- ]
- ports:
- - "50062:50062"
- networks:
- - default
-
-
- adapter_openonu:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-openonu-adapter:${DOCKER_TAG}"
- command: [
- "/voltha/adapters/brcm_openomci_onu/main.py",
- "-v",
- "--name=brcm_openomci_onu",
- "--kafka_adapter=${DOCKER_HOST_IP}:9092",
- "--kafka_cluster=${DOCKER_HOST_IP}:9092",
- "--backend=etcd",
- "--etcd=${DOCKER_HOST_IP}:2379",
- "--core_topic=rwcore"
- ]
- networks:
- - default
diff --git a/compose/system-test-openolt-py.yml b/compose/system-test-openolt-py.yml
deleted file mode 100644
index edd6eb7..0000000
--- a/compose/system-test-openolt-py.yml
+++ /dev/null
@@ -1,186 +0,0 @@
----
-# Copyright 2018 the original author or authors.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-version: '2'
-
-networks:
- default:
- driver: bridge
-
-services:
-
- zookeeper:
- image: "wurstmeister/zookeeper:latest"
- environment:
- SERVICE_2181_NAME: "zookeeper"
- ports:
- - 2181:2181
- networks:
- - default
- restart: unless-stopped
-
-
- kafka:
- image: "wurstmeister/kafka:2.11-2.0.1"
- environment:
- KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://${DOCKER_HOST_IP}:9092
- KAFKA_LISTENERS: PLAINTEXT://:9092
- KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
- KAFKA_AUTO_CREATE_TOPICS_ENABLE: 'true'
- SERVICE_9092_NAME: "kafka"
- volumes:
- - /var/run/docker.sock:/var/run/docker.sock
- ports:
- - 9092:9092
- networks:
- - default
- restart: unless-stopped
-
-
- etcd:
- image: "quay.io/coreos/etcd:v3.2.9"
- command: [
- "etcd",
- "--name=etcd0",
- "--advertise-client-urls=http://${DOCKER_HOST_IP}:2379,http://${DOCKER_HOST_IP}:4001",
- "--listen-client-urls=http://0.0.0.0:2379,http://0.0.0.0:4001",
- "--initial-advertise-peer-urls=http://${DOCKER_HOST_IP}:2380",
- "--listen-peer-urls=http://0.0.0.0:2380",
- "--initial-cluster-token=etcd-cluster-1",
- "--initial-cluster=etcd0=http://${DOCKER_HOST_IP}:2380",
- "--initial-cluster-state=new"
- ]
- ports:
- - "2379:2379"
- - 2380
- - 4001
- networks:
- - default
- restart: unless-stopped
-
-
- rw_core:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-rw-core:${DOCKER_TAG}"
- entrypoint:
- - /app/rw_core
- - -kv_store_type=etcd
- - -kv_store_host=${DOCKER_HOST_IP}
- - -kv_store_port=2379
- - -grpc_port=50057
- - -banner=true
- - -kafka_adapter_host=${DOCKER_HOST_IP}
- - -kafka_adapter_port=9092
- - -kafka_cluster_host=${DOCKER_HOST_IP}
- - -kafka_cluster_port=9092
- - -rw_core_topic=rwcore
- - -kv_store_data_prefix=service/voltha
- - -in_competing_mode=false
- - -log_level=0
- volumes:
- - "/var/run/docker.sock:/tmp/docker.sock"
- ports:
- - 50057:50057
- networks:
- - default
- restart: unless-stopped
-
-
- cli:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-cli:${DOCKER_TAG}"
- logging:
- driver: "json-file"
- options:
- max-size: "10m"
- max-file: "3"
- environment:
- DOCKER_HOST_IP: "${DOCKER_HOST_IP}"
- entrypoint:
- - /voltha/python/cli/setup.sh
- - -g ${DOCKER_HOST_IP}:50057
- networks:
- - default
- ports:
- - "5022:22"
- restart: unless-stopped
-
-
- ofagent:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-ofagent:${DOCKER_TAG}"
- logging:
- driver: "json-file"
- options:
- max-size: "10m"
- max-file: "3"
- command: [
- "/ofagent/ofagent/main.py",
- "--consul=${DOCKER_HOST_IP}:8500",
- "--controller=${DOCKER_HOST_IP}:6653",
- "--grpc-endpoint=${DOCKER_HOST_IP}:50057",
- "--instance-id-is-container-name",
- "-v"
- ]
- volumes:
- - "/var/run/docker.sock:/tmp/docker.sock"
- networks:
- - default
- restart: unless-stopped
-
-
- onos:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-onos:${DOCKER_TAG}"
- ports:
- - "8101:8101" # ssh
- - "6653:6653" # OF
- - "8181:8181" # UI
- environment:
- ONOS_APPS: 'drivers,openflow-base'
- volumes:
- - "/var/run/docker.sock:/tmp/docker.sock"
- - "./network-cfg.json:/root/onos/config/network-cfg.json"
- networks:
- - default
- restart: unless-stopped
-
-
- adapter_openolt:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-openolt-adapter:${DOCKER_TAG}-py"
- command: [
- "/voltha/adapters/openolt/main.py",
- "-v",
- "--name=openolt",
- "--kafka_adapter=${DOCKER_HOST_IP}:9092",
- "--kafka_cluster=${DOCKER_HOST_IP}:9092",
- "--backend=etcd",
- "--etcd=${DOCKER_HOST_IP}:2379",
- "--core_topic=rwcore"
- ]
- networks:
- - default
-
-
- adapter_openonu:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-openonu-adapter:${DOCKER_TAG}"
- command: [
- "/voltha/adapters/brcm_openomci_onu/main.py",
- "-v",
- "--name=brcm_openomci_onu",
- "--kafka_adapter=${DOCKER_HOST_IP}:9092",
- "--kafka_cluster=${DOCKER_HOST_IP}:9092",
- "--backend=etcd",
- "--etcd=${DOCKER_HOST_IP}:2379",
- "--core_topic=rwcore"
- ]
- networks:
- - default
diff --git a/compose/system-test-ponsim.yml b/compose/system-test-ponsim.yml
old mode 100755
new mode 100644
index f26d27f..af23668
--- a/compose/system-test-ponsim.yml
+++ b/compose/system-test-ponsim.yml
@@ -48,7 +48,7 @@
etcd:
- image: "quay.io/coreos/etcd:v3.2.9"
+ image: "quay.io/coreos/etcd:v3.4.1"
command: [
"etcd",
"--name=etcd0",
@@ -95,24 +95,6 @@
restart: unless-stopped
- cli:
- image: "${REGISTRY}${REPOSITORY}voltha-cli:latest"
- logging:
- driver: "json-file"
- options:
- max-size: "10m"
- max-file: "3"
- environment:
- DOCKER_HOST_IP: "${DOCKER_HOST_IP}"
- entrypoint:
- - /voltha/python/cli/setup.sh
- - -g ${DOCKER_HOST_IP}:50057
- networks:
- - default
- ports:
- - "5022:22"
-
-
ofagent:
image: "${REGISTRY}${REPOSITORY}voltha-ofagent:latest"
logging:
diff --git a/compose/system-test.yml b/compose/system-test.yml
index c5f016a..358b619 100644
--- a/compose/system-test.yml
+++ b/compose/system-test.yml
@@ -50,7 +50,7 @@
etcd:
- image: "quay.io/coreos/etcd:v3.2.9"
+ image: "quay.io/coreos/etcd:v3.4.1"
command: [
"etcd",
"--name=etcd0",
@@ -97,24 +97,6 @@
restart: unless-stopped
- cli:
- image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-cli:${DOCKER_TAG}"
- logging:
- driver: "json-file"
- options:
- max-size: "10m"
- max-file: "3"
- environment:
- DOCKER_HOST_IP: "${DOCKER_HOST_IP}"
- entrypoint:
- - /voltha/python/cli/setup.sh
- - -g ${DOCKER_HOST_IP}:50057
- networks:
- - default
- ports:
- - "5022:22"
- restart: unless-stopped
-
ofagent:
image: "${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-ofagent:${DOCKER_TAG}"
diff --git a/quickstart.md b/quickstart.md
index 72be64a..76998e1 100644
--- a/quickstart.md
+++ b/quickstart.md
@@ -38,8 +38,8 @@
### Setup environment
-Setup a local Golang and docker-compose environment, verifying the golang-1.12 binaries are in your path. Also add your local GOPATH's bin folder to PATH.
-Add to your `~/.profile` to persist.
+Setup a local Golang and docker-compose environment, verifying the golang-1.12 binaries are in your path. Also add your local `GOPATH` bin folder to `PATH`
+Add export statements to your `~/.profile` to persist.
```sh
mkdir $HOME/source
@@ -67,7 +67,7 @@
### VOLTHA 2.x Core Containers
-Checkout needed source from gerrit. Build the `voltha-rw-core` and `voltha-ofagent` docker images.
+Checkout needed source from gerrit. Build the `voltha-rw-core` docker image.
```sh
cd ~/source/
git clone https://gerrit.opencord.org/voltha-go.git
@@ -107,6 +107,18 @@
+### VOLTHA 2.x OFAgent
+
+Checkout needed source from gerrit. Build the `voltha-ofagent` docker image.
+```sh
+cd ~/source/
+git clone https://gerrit.opencord.org/ofagent-py.git
+cd ~/source/ofagent-py/
+make docker-build
+```
+
+
+
### ONOS Container with VOLTHA Compatible Apps
By default the standard ONOS docker image does not contain nor start any apps needed by VOLTHA. If you use the standard image then you need to use the ONOS restful API to load needed apps separately.