blob: 170bbd9a95c4928505106565251980d09ffc056d [file] [log] [blame]
Zsolt Haraszti8fa9da02016-09-10 17:34:03 -07001#
2# Copyright 2016 the original author or authors.
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16
Nathan Knuthedc88da2016-09-17 00:28:05 -070017ifeq ($(VOLTHA_BASE)_set,_set)
18$(error To get started, please source the env.sh file)
19endif
20
David K. Bainbridge12463052018-01-19 09:26:09 -080021ifeq ($(TAG),)
22TAG := latest
23endif
24
Nathan Knuth84dfd2e2016-09-16 15:06:34 -070025include setup.mk
26
Gertjan Van Droogenbroeckcb3507d2017-11-16 16:54:22 +010027ifneq ($(http_proxy)$(https_proxy),)
28# Include proxies from the environment
29DOCKER_PROXY_ARGS = \
30 --build-arg http_proxy=$(http_proxy) \
31 --build-arg https_proxy=$(https_proxy) \
32 --build-arg ftp_proxy=$(ftp_proxy) \
33 --build-arg no_proxy=$(no_proxy) \
34 --build-arg HTTP_PROXY=$(HTTP_PROXY) \
35 --build-arg HTTPS_PROXY=$(HTTPS_PROXY) \
36 --build-arg FTP_PROXY=$(FTP_PROXY) \
37 --build-arg NO_PROXY=$(NO_PROXY)
38endif
David K. Bainbridge12463052018-01-19 09:26:09 -080039DOCKER_BUILD_ARGS = --build-arg TAG=$(TAG) $(DOCKER_PROXY_ARGS) $(DOCKER_CACHE_ARG) --rm --force-rm $(DOCKER_BUILD_EXTRA_ARGS)
Gertjan Van Droogenbroeckcb3507d2017-11-16 16:54:22 +010040
Zsolt Haraszti41612482016-09-21 12:26:20 -070041VENVDIR := venv-$(shell uname -s | tr '[:upper:]' '[:lower:]')
Zsolt Haraszti8fa9da02016-09-10 17:34:03 -070042
David K. Bainbridge12463052018-01-19 09:26:09 -080043.PHONY: $(DIRS) $(DIRS_CLEAN) $(DIRS_FLAKE8) flake8 docker-base voltha ofagent netconf shovel onos dashd cli portainer grafana nginx consul envoy golang envoyd tools opennms logstash unum start stop
Nathan Knuth84dfd2e2016-09-16 15:06:34 -070044
ggowdru9974f212017-06-06 23:31:25 -070045# This should to be the first and default target in this Makefile
46help:
47 @echo "Usage: make [<target>]"
48 @echo "where available targets are:"
49 @echo
50 @echo "build : Build the Voltha protos and docker images.\n\
51 If this is the first time you are building, choose \"make build\" option."
Sergio Slobodrian7a7091c2017-06-21 23:45:45 -040052 @echo "production : Build voltha for production deployment"
ggowdru9974f212017-06-06 23:31:25 -070053 @echo "clean : Remove files created by the build and tests"
54 @echo "distclean : Remove venv directory"
55 @echo "fetch : Pre-fetch artifacts for subsequent local builds"
56 @echo "flake8 : Run specifically flake8 tests"
57 @echo "help : Print this help"
58 @echo "protos : Compile all grpc/protobuf files"
59 @echo "rebuild-venv : Rebuild local Python virtualenv from scratch"
60 @echo "venv : Build local Python virtualenv if did not exist yet"
61 @echo "utest : Run all unit tests"
62 @echo "itest : Run all integration tests"
63 @echo "containers : Build all the docker containers"
64 @echo "docker-base : Build the base docker container used by all other dockers"
65 @echo "voltha : Build the voltha docker container"
ggowdru9974f212017-06-06 23:31:25 -070066 @echo "ofagent : Build the ofagent docker container"
ggowdru9974f212017-06-06 23:31:25 -070067 @echo "netconf : Build the netconf docker container"
68 @echo "shovel : Build the shovel docker container"
69 @echo "onos : Build the onos docker container"
70 @echo "dashd : Build the dashd docker container"
David K. Bainbridge12463052018-01-19 09:26:09 -080071 @echo "cli : Build the cli docker container"
ggowdru9974f212017-06-06 23:31:25 -070072 @echo "portainer : Build the portainer docker container"
73 @echo "grafana : Build the grafana docker container"
74 @echo "nginx : Build the nginx docker container"
schowdhury40739212017-06-12 07:40:31 -070075 @echo "consul : Build the consul docker container"
David K. Bainbridge215e0242017-09-05 23:18:24 -070076 @echo "unum : Build the unum docker container"
David K. Bainbridge12463052018-01-19 09:26:09 -080077 @echo "j2 : Build the Jinja2 template container"
78 @echo "start : Start VOLTHA on the current system"
79 @echo "stop : Stop VOLTHA on the current system"
ggowdru9974f212017-06-06 23:31:25 -070080 @echo
Nathan Knuth5157de02016-09-16 15:20:37 -070081
Nathan Knuth84dfd2e2016-09-16 15:06:34 -070082## New directories can be added here
83DIRS:=\
Nathan Knuthedc88da2016-09-17 00:28:05 -070084voltha/northbound/openflow \
85voltha/northbound/openflow/agent \
86voltha/northbound/openflow/oftest
Nathan Knuth84dfd2e2016-09-16 15:06:34 -070087
88## If one directory depends on another directory that
89## dependency can be expressed here
90##
91## For example, if the Tibit directory depended on the eoam
92## directory being built first, then that can be expressed here.
93## driver/tibit: eoam
94
95# Parallel Build
96$(DIRS):
97 @echo " MK $@"
98 $(Q)$(MAKE) -C $@
99
100# Parallel Clean
101DIRS_CLEAN = $(addsuffix .clean,$(DIRS))
102$(DIRS_CLEAN):
103 @echo " CLEAN $(basename $@)"
104 $(Q)$(MAKE) -C $(basename $@) clean
105
106# Parallel Flake8
107DIRS_FLAKE8 = $(addsuffix .flake8,$(DIRS))
108$(DIRS_FLAKE8):
109 @echo " FLAKE8 $(basename $@)"
Nathan Knuth950dff22016-09-17 16:12:34 -0700110 -$(Q)$(MAKE) -C $(basename $@) flake8
Zsolt Haraszti8fa9da02016-09-10 17:34:03 -0700111
Zsolt Harasztidb892332017-01-09 11:08:38 -0800112build: protos containers
Zsolt Haraszti32dda552016-09-27 09:17:29 -0700113
Sergio Slobodrian7a7091c2017-06-21 23:45:45 -0400114production: protos prod-containers
115
khenaidoofe874ae2017-07-14 18:07:27 -0400116jenkins : protos jenkins-containers
117
David K. Bainbridge12463052018-01-19 09:26:09 -0800118jenkins-containers: docker-base voltha ofagent netconf consul unum j2
Sergio Slobodrian7a7091c2017-06-21 23:45:45 -0400119
David K. Bainbridge12463052018-01-19 09:26:09 -0800120prod-containers: docker-base voltha ofagent netconf shovel dashd cli grafana consul tools golang envoyd envoy fluentd unum j2
Sergio Slobodrian7a7091c2017-06-21 23:45:45 -0400121
David K. Bainbridge12463052018-01-19 09:26:09 -0800122containers: docker-base voltha ofagent netconf shovel onos tester config-push dashd cli portainer grafana nginx consul tools golang envoyd envoy fluentd unum j2
Khen Nursimuluaaac7ee2016-12-11 22:03:52 -0500123
Rouzbahan Rashidi-Tabrizi95b68c52016-11-09 10:17:57 -0800124docker-base:
David K. Bainbridge12463052018-01-19 09:26:09 -0800125 docker build $(DOCKER_BUILD_ARGS) -t voltha/voltha-base:$(TAG) -f docker/Dockerfile.base .
Zsolt Haraszti51af3392016-09-10 22:18:45 -0700126
Shad Ansari83777cb2017-06-02 14:56:08 -0700127voltha: voltha-adapters
David K. Bainbridge12463052018-01-19 09:26:09 -0800128 docker build $(DOCKER_BUILD_ARGS) -t voltha/voltha:$(TAG) -f docker/Dockerfile.voltha .
Zsolt Harasztidb892332017-01-09 11:08:38 -0800129
Shad Ansari83777cb2017-06-02 14:56:08 -0700130voltha-adapters:
131 make -C voltha/adapters/asfvolt16_olt
132
Zsolt Harasztidb892332017-01-09 11:08:38 -0800133ofagent:
David K. Bainbridge12463052018-01-19 09:26:09 -0800134 docker build $(DOCKER_BUILD_ARGS) -t voltha/ofagent:$(TAG) -f docker/Dockerfile.ofagent .
Zsolt Harasztidb892332017-01-09 11:08:38 -0800135
Sergio Slobodriancab0a392017-07-13 08:42:10 -0400136tools:
David K. Bainbridge12463052018-01-19 09:26:09 -0800137 docker build $(DOCKER_BUILD_ARGS) -t voltha/tools:$(TAG) -f docker/Dockerfile.tools .
Sergio Slobodriancab0a392017-07-13 08:42:10 -0400138
sathishgb5d1c182017-07-13 14:20:19 +0530139fluentd:
David K. Bainbridge12463052018-01-19 09:26:09 -0800140 docker build $(DOCKER_BUILD_ARGS) -t voltha/fluentd:$(TAG) -f docker/Dockerfile.fluentd .
sathishgb5d1c182017-07-13 14:20:19 +0530141
Sergio Slobodriancab0a392017-07-13 08:42:10 -0400142envoy:
David K. Bainbridge12463052018-01-19 09:26:09 -0800143 docker build $(DOCKER_BUILD_ARGS) -t voltha/envoy:$(TAG) -f docker/Dockerfile.envoy .
Sergio Slobodriancab0a392017-07-13 08:42:10 -0400144
Sergio Slobodrianbe829272017-07-17 14:45:45 -0400145envoyd:
Sergio Slobodrian6570c742017-08-07 23:11:33 -0400146 make -C envoy
Sergio Slobodrianbe829272017-07-17 14:45:45 -0400147 make -C envoy/go/envoyd
148
149golang:
David K. Bainbridge12463052018-01-19 09:26:09 -0800150 docker build $(DOCKER_BUILD_ARGS) -t voltha/go-builder:$(TAG) -f envoy/go/golang-builder/Dockerfile ./envoy/go/golang-builder
Sergio Slobodrianbe829272017-07-17 14:45:45 -0400151
Zsolt Harasztidb892332017-01-09 11:08:38 -0800152netconf:
David K. Bainbridge12463052018-01-19 09:26:09 -0800153 docker build $(DOCKER_BUILD_ARGS) -t voltha/netconf:$(TAG) -f docker/Dockerfile.netconf .
Zsolt Harasztidb892332017-01-09 11:08:38 -0800154
Stephane Barbarie14088962017-06-01 16:56:55 -0400155netopeer:
David K. Bainbridge12463052018-01-19 09:26:09 -0800156 docker build $(DOCKER_BUILD_ARGS) -t voltha/netopeer:$(TAG) -f docker/Dockerfile.netopeer .
Stephane Barbarie14088962017-06-01 16:56:55 -0400157
Zsolt Harasztidb892332017-01-09 11:08:38 -0800158shovel:
David K. Bainbridge12463052018-01-19 09:26:09 -0800159 docker build $(DOCKER_BUILD_ARGS) -t voltha/shovel:$(TAG) -f docker/Dockerfile.shovel .
Zsolt Harasztidb892332017-01-09 11:08:38 -0800160
Sergio Slobodrian9358bd42017-03-10 22:52:24 -0500161dashd:
David K. Bainbridge12463052018-01-19 09:26:09 -0800162 docker build $(DOCKER_BUILD_ARGS) -t voltha/dashd:$(TAG) -f docker/Dockerfile.dashd .
Sergio Slobodrian9358bd42017-03-10 22:52:24 -0500163
David K. Bainbridge12463052018-01-19 09:26:09 -0800164cli:
165 docker build $(DOCKER_BUILD_ARGS) -t voltha/cli:$(TAG) -f docker/Dockerfile.cli .
Sergio Slobodrianab11c642017-04-24 07:16:58 -0400166
Sergio Slobodrian4d307102017-04-24 10:19:00 -0400167portainer:
168 portainer/buildPortainer.sh
169
Sergio Slobodrianff52e1b2017-04-24 12:39:08 -0400170nginx:
David K. Bainbridge12463052018-01-19 09:26:09 -0800171 docker build $(DOCKER_BUILD_ARGS) -t voltha/nginx:$(TAG) -f docker/Dockerfile.nginx .
Sergio Slobodrianff52e1b2017-04-24 12:39:08 -0400172
schowdhury40739212017-06-12 07:40:31 -0700173consul:
David K. Bainbridge12463052018-01-19 09:26:09 -0800174 docker build $(DOCKER_BUILD_ARGS) -t voltha/consul:$(TAG) -f docker/Dockerfile.consul .
schowdhury40739212017-06-12 07:40:31 -0700175
Sergio Slobodrianff52e1b2017-04-24 12:39:08 -0400176grafana:
David K. Bainbridge12463052018-01-19 09:26:09 -0800177 docker build $(DOCKER_BUILD_ARGS) -t voltha/grafana:$(TAG) -f docker/Dockerfile.grafana .
Sergio Slobodrianff52e1b2017-04-24 12:39:08 -0400178
Zsolt Harasztidb892332017-01-09 11:08:38 -0800179onos:
David K. Bainbridge12463052018-01-19 09:26:09 -0800180 docker build $(DOCKER_BUILD_ARGS) -t voltha/onos:$(TAG) -f docker/Dockerfile.onos docker
Zsolt Harasztidb892332017-01-09 11:08:38 -0800181
David K. Bainbridge215e0242017-09-05 23:18:24 -0700182unum:
David K. Bainbridge12463052018-01-19 09:26:09 -0800183 docker build $(DOCKER_BUILD_ARGS) -t voltha/unum:$(TAG) -f unum/Dockerfile ./unum
David K. Bainbridge215e0242017-09-05 23:18:24 -0700184
alshabib5e180572017-01-10 23:59:47 -0600185tester:
David K. Bainbridge12463052018-01-19 09:26:09 -0800186 docker build $(DOCKER_BUILD_ARGS) -t voltha/tester:$(TAG) -f docker/Dockerfile.tester docker
alshabib5e180572017-01-10 23:59:47 -0600187
alshabiba5514082017-03-31 11:08:27 -0500188config-push:
David K. Bainbridge12463052018-01-19 09:26:09 -0800189 docker build $(DOCKER_BUILD_ARGS) -t voltha/config-push:$(TAG) -f docker/Dockerfile.configpush docker
alshabiba5514082017-03-31 11:08:27 -0500190
Stephane Barbarie95507c42017-09-19 10:41:04 -0400191opennms:
David K. Bainbridge12463052018-01-19 09:26:09 -0800192 docker build $(DOCKER_BUILD_ARGS) -t voltha/opennms:$(TAG) -f docker/Dockerfile.opennms .
Stephane Barbarie95507c42017-09-19 10:41:04 -0400193
194logstash:
David K. Bainbridge12463052018-01-19 09:26:09 -0800195 docker build $(DOCKER_BUILD_ARGS) -t voltha/logstash:$(TAG) -f docker/Dockerfile.logstash .
196
197j2:
198 docker build $(DOCKER_BUILD_ARGS) -t voltha/j2:$(TAG) -f docker/Dockerfile.j2 docker
199
200start:
201 bash -c 'echo $$VOLTHA_LOGS && TMP_STACK_FILE=$$(mktemp -u) && \
202 echo $$TMP_STACK_FILE && \
203 SWARM_MANAGER_COUNT=$$(docker node ls | grep Ready | egrep "(Leader)|(Reachable)" | wc -l | sed -e "s/ //g") && \
204 cat ./compose/voltha-stack.yml.j2 2>&1 | docker run -e RADIUS_ROOT=$$RADIUS_ROOT -e CONSUL_ROOT=$$CONSUL_ROOT -e VOLTHA_LOGS=$$VOLTHA_LOGS -e SWARM_MANAGER_COUNT=$$SWARM_MANAGER_COUNT --rm -i voltha/j2 - 2>&1 > $$TMP_STACK_FILE && \
205 docker stack deploy -c $$TMP_STACK_FILE voltha && \
206 rm -f $$TMP_STACK_FILE'
207
208stop:
209 docker stack rm voltha
Sergio Slobodrianff52e1b2017-04-24 12:39:08 -0400210
Zsolt Haraszti5cd64702016-09-27 13:48:35 -0700211protos:
212 make -C voltha/protos
Zsolt Haraszti023ea7c2016-10-16 19:30:34 -0700213 make -C ofagent/protos
Khen Nursimuluaaac7ee2016-12-11 22:03:52 -0500214 make -C netconf/protos
Zsolt Harasztia54f2ac2016-09-21 15:54:15 -0700215
216install-protoc:
Zsolt Haraszti5cd64702016-09-27 13:48:35 -0700217 make -C voltha/protos install-protoc
Zsolt Harasztia54f2ac2016-09-21 15:54:15 -0700218
Zsolt Harasztib71c2a02016-09-12 13:12:07 -0700219clean:
220 find voltha -name '*.pyc' | xargs rm -f
221
Nathan Knutha6b09e32016-09-21 16:26:09 -0700222distclean: clean
223 rm -rf ${VENVDIR}
224
khenaidoofe874ae2017-07-14 18:07:27 -0400225
226fetch-jenkins:
Richard Jankowskicb33c472017-08-24 14:21:59 -0400227 docker pull consul:0.9.2
Sergio Slobodrian6f5fc4c2017-11-17 15:31:12 -0500228 docker pull fluent/fluentd:v0.14.23.rc1
khenaidoofe874ae2017-07-14 18:07:27 -0400229 docker pull ubuntu:xenial
Sergio Slobodrian6f5fc4c2017-11-17 15:31:12 -0500230 docker pull wurstmeister/kafka:1.0.0
231 docker pull zookeeper:3.4.11
Zsolt Haraszti51af3392016-09-10 22:18:45 -0700232fetch:
Richard Jankowskicb33c472017-08-24 14:21:59 -0400233 docker pull consul:0.9.2
Sergio Slobodrian6f5fc4c2017-11-17 15:31:12 -0500234 docker pull fluent/fluentd:v0.14.23.rc1
Zsolt Haraszti0650d1a2016-09-26 17:29:25 -0700235 docker pull ubuntu:xenial
Sergio Slobodrian6f5fc4c2017-11-17 15:31:12 -0500236 docker pull wurstmeister/kafka:1.0.0
237 docker pull zookeeper:3.4.11
238 docker pull portainer/portainer:1.15.2
Sergio Slobodrianee417fa2017-08-11 09:34:50 -0400239 docker pull lyft/envoy:29361deae91575a1d46c7a21e913f19e75622ebe
Sergio Slobodriancab0a392017-07-13 08:42:10 -0400240 docker pull registry:2
Sergio Slobodrian6f5fc4c2017-11-17 15:31:12 -0500241 docker pull kamon/grafana_graphite:3.0
Zsolt Haraszti51af3392016-09-10 22:18:45 -0700242
243purge-venv:
Zsolt Haraszti8fa9da02016-09-10 17:34:03 -0700244 rm -fr ${VENVDIR}
Zsolt Haraszti51af3392016-09-10 22:18:45 -0700245
246rebuild-venv: purge-venv venv
247
248venv: ${VENVDIR}/.built
249
250${VENVDIR}/.built:
251 @ virtualenv ${VENVDIR}
252 @ . ${VENVDIR}/bin/activate && \
Zsolt Haraszti41612482016-09-21 12:26:20 -0700253 pip install --upgrade pip; \
Zsolt Haraszti8fa9da02016-09-10 17:34:03 -0700254 if ! pip install -r requirements.txt; \
255 then \
256 echo "On MAC OS X, if the installation failed with an error \n'<openssl/opensslv.h>': file not found,"; \
257 echo "see the BUILD.md file for a workaround"; \
Zsolt Haraszti51af3392016-09-10 22:18:45 -0700258 else \
Zsolt Haraszti41612482016-09-21 12:26:20 -0700259 uname -s > ${VENVDIR}/.built; \
Zsolt Haraszti8fa9da02016-09-10 17:34:03 -0700260 fi
261
Khen Nursimulu34e7ebb2016-11-10 13:38:44 -0800262test: venv protos run-as-root-tests
263 @ echo "Executing all tests"
264 . ${VENVDIR}/bin/activate && \
265 nosetests -s tests \
266 --exclude-dir=./tests/itests/run_as_root/
267
Zsolt Haraszti66186622016-11-08 14:24:00 -0800268utest: venv protos
Zsolt Haraszti51af3392016-09-10 22:18:45 -0700269 @ echo "Executing all unit tests"
270 . ${VENVDIR}/bin/activate && \
Kim Kempf8c2812c2017-10-23 15:07:50 -0700271 for d in $$(find ./tests/utests -type d|sort -nr); do echo $$d:; nosetests $$d; done
alshabib29a3ed52017-01-23 14:29:21 -0800272
273utest-with-coverage: venv protos
274 @ echo "Executing all unit tests and producing coverage results"
275 . ${VENVDIR}/bin/activate && \
Kim Kempf8c2812c2017-10-23 15:07:50 -0700276 for d in $$(find ./tests/utests -type d|sort -nr); do echo $$d:; \
khenaidoo079a7762017-10-26 21:42:05 -0400277 nosetests --with-xcoverage --with-xunit --cover-package=voltha,common,ofagent $$d; done
Khen Nursimulu37a9bf82016-10-16 20:11:31 -0400278
Zsolt Haraszti348d1932016-12-10 01:10:07 -0800279itest: venv run-as-root-tests
Khen Nursimulu34e7ebb2016-11-10 13:38:44 -0800280 @ echo "Executing all integration tests"
281 . ${VENVDIR}/bin/activate && \
282 nosetests -s \
283 tests/itests/docutests/build_md_test.py \
284 --exclude-dir=./tests/utests/ \
285 --exclude-dir=./tests/itests/run_as_root/
286
Zsolt Haraszti348d1932016-12-10 01:10:07 -0800287smoke-test: venv run-as-root-tests
Khen Nursimulu34e7ebb2016-11-10 13:38:44 -0800288 @ echo "Executing smoke tests"
Khen Nursimulu96bb5322016-11-09 20:16:03 -0800289 . ${VENVDIR}/bin/activate && \
290 nosetests -s \
291 tests/itests/docutests/build_md_test.py:BuildMdTests.test_07_start_all_containers \
Khen Nursimulu34e7ebb2016-11-10 13:38:44 -0800292 --exclude-dir=./tests/itests/run_as_root/
Khen Nursimulu96bb5322016-11-09 20:16:03 -0800293
khenaidoo1243ee92017-07-17 15:54:06 -0400294jenkins-test: venv
295 @ echo "Executing jenkins smoke tests"
296 . ${VENVDIR}/bin/activate && \
297 nosetests -s \
298 tests/itests/docutests/build_md_test.py:BuildMdTests.test_07_start_all_containers \
299 --exclude-dir=./tests/itests/run_as_root/
300
Khen Nursimulu96bb5322016-11-09 20:16:03 -0800301
Khen Nursimulu34e7ebb2016-11-10 13:38:44 -0800302run-as-root-tests:
David K. Bainbridge12463052018-01-19 09:26:09 -0800303 docker run -i --rm -v /cord/incubator/voltha:/voltha --privileged voltha/voltha-base env PYTHONPATH=/voltha python /voltha/tests/itests/run_as_root/test_frameio.py
Nathan Knuth84dfd2e2016-09-16 15:06:34 -0700304
305flake8: $(DIRS_FLAKE8)
Nathan Knuth220a6772016-10-11 08:10:46 -0700306
307# end file