d12927a156
Readthedocs failed to render Promenade exceptions with error: > WARNING: autodoc: failed to import exception 'xxx' from module > 'promenade'; the following exception was raised: No module > named 'falcon' Trying to add Promenade requirements to the installed requirements list, so that Readthedocs has all modules, including those needed for the Promenade itself. Unify docs building by utilizing Zuul docs-on-readthedocs template job. Cosmetic readability changes: 1. combined all Makefile .PHONY targets into one 2. merged multiple LABEL instructions in Dockerfile into one Change-Id: I731ee3426a631fa765f13ba7091dcb4b9ebd0353
144 lines
4.1 KiB
Makefile
144 lines
4.1 KiB
Makefile
# Copyright 2018 AT&T Intellectual Property. All other rights reserved.
|
|
#
|
|
# 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.
|
|
|
|
BUILD_DIR := $(shell mktemp -d)
|
|
DOCKER_REGISTRY ?= quay.io
|
|
HELM := $(BUILD_DIR)/helm
|
|
IMAGE_PREFIX ?= airshipit
|
|
IMAGE_NAME ?= promenade
|
|
IMAGE_TAG ?= latest
|
|
PROXY ?= http://proxy.foo.com:8000
|
|
NO_PROXY ?= localhost,127.0.0.1,.svc.cluster.local
|
|
USE_PROXY ?= false
|
|
PUSH_IMAGE ?= false
|
|
# use this variable for image labels added in internal build process
|
|
LABEL ?= org.airshipit.build=community
|
|
COMMIT ?= $(shell git rev-parse HEAD)
|
|
PYTHON = python3
|
|
CHARTS := $(patsubst charts/%/.,%,$(wildcard charts/*/.))
|
|
IMAGE := ${DOCKER_REGISTRY}/${IMAGE_PREFIX}/${IMAGE_NAME}:${IMAGE_TAG}
|
|
PYTHON_BASE_IMAGE ?= python:3.6
|
|
|
|
HELM_PIDFILE ?= $(abspath ./.helm-pid)
|
|
|
|
CHARTS := $(patsubst charts/%/.,%,$(wildcard charts/*/.))
|
|
|
|
all: charts lint
|
|
|
|
tests: external-deps gate-lint
|
|
tox
|
|
|
|
tests-security:
|
|
tox -e bandit
|
|
|
|
docs: clean
|
|
tox -e docs
|
|
|
|
tests-unit: external-deps
|
|
tox -e py35
|
|
|
|
external-deps:
|
|
./tools/install-external-deps.sh
|
|
|
|
tests-pep8:
|
|
tox -e pep8
|
|
|
|
chartbanner:
|
|
@echo Building charts: $(CHARTS)
|
|
|
|
charts: $(CHARTS)
|
|
@echo Done building charts.
|
|
|
|
helm-init: $(addprefix helm-init-,$(CHARTS))
|
|
|
|
helm-init-%: helm-serve
|
|
@echo Initializing chart $*
|
|
cd charts;if [ -s $*/requirements.yaml ]; then echo "Initializing $*";$(HELM) dep up $*; fi
|
|
|
|
lint: helm-lint gate-lint
|
|
|
|
gate-lint: gate-lint-deps
|
|
tox -e gate-lint
|
|
|
|
gate-lint-deps:
|
|
sudo apt-get install -y --no-install-recommends shellcheck
|
|
|
|
helm-lint: $(addprefix helm-lint-,$(CHARTS))
|
|
|
|
helm-lint-%: helm-install helm-init-%
|
|
@echo Linting chart $*
|
|
cd charts;$(HELM) lint $*
|
|
|
|
images: check-docker build_promenade
|
|
|
|
check-docker:
|
|
@if [ -z $$(which docker) ]; then \
|
|
echo "Missing \`docker\` client which is required for development"; \
|
|
exit 2; \
|
|
fi
|
|
|
|
dry-run: $(addprefix dry-run-,$(CHARTS))
|
|
|
|
dry-run-%: helm-lint-%
|
|
echo Running Dry-Run on chart $*
|
|
cd charts;$(HELM) template --set pod.resources.enabled=true $*
|
|
|
|
$(CHARTS): $(addprefix dry-run-,$(CHARTS)) chartbanner
|
|
$(HELM) package -d charts charts/$@
|
|
|
|
build_promenade:
|
|
ifeq ($(USE_PROXY), true)
|
|
docker build --network host -t $(IMAGE) --label $(LABEL) \
|
|
--label "org.opencontainers.image.revision=$(COMMIT)" \
|
|
--label "org.opencontainers.image.created=$(shell date --rfc-3339=seconds --utc)" \
|
|
--label "org.opencontainers.image.title=$(IMAGE_NAME)" \
|
|
-f ./Dockerfile \
|
|
--build-arg FROM=$(PYTHON_BASE_IMAGE) \
|
|
--build-arg http_proxy=$(PROXY) \
|
|
--build-arg https_proxy=$(PROXY) \
|
|
--build-arg HTTP_PROXY=$(PROXY) \
|
|
--build-arg HTTPS_PROXY=$(PROXY) \
|
|
--build-arg no_proxy=$(NO_PROXY) \
|
|
--build-arg NO_PROXY=$(NO_PROXY) .
|
|
else
|
|
docker build --network host -t $(IMAGE) --label $(LABEL) \
|
|
--label "org.opencontainers.image.revision=$(COMMIT)" \
|
|
--label "org.opencontainers.image.created=$(shell date --rfc-3339=seconds --utc)" \
|
|
--label "org.opencontainers.image.title=$(IMAGE_NAME)" \
|
|
-f ./Dockerfile \
|
|
--build-arg FROM=$(PYTHON_BASE_IMAGE) .
|
|
endif
|
|
ifeq ($(PUSH_IMAGE), true)
|
|
docker push $(IMAGE)
|
|
endif
|
|
|
|
|
|
helm-serve: helm-install
|
|
./tools/helm_tk.sh $(HELM) $(HELM_PIDFILE)
|
|
|
|
clean:
|
|
rm -rf doc/build
|
|
rm -f charts/*.tgz
|
|
rm -f charts/*/requirements.lock
|
|
rm -rf charts/*/charts
|
|
|
|
# Install helm binary
|
|
helm-install:
|
|
tools/helm_install.sh $(HELM)
|
|
|
|
.PHONY: $(CHARTS) all build_promenade charts check-docker clean docs \
|
|
dry-run dry-run-% external-deps gate-lint gate-lint-deps helm-init \
|
|
helm-init-% helm-install helm-lint helm-lint-% helm-serve images \
|
|
lint tests tests-pep8 tests-security tests-unit
|