Adjust repository for code and project conventions

Following Airship Code and Project conventions [0], adding
standard Makefile targets and moving charts and Dockerfiles
into correct directories.

[0] https://airship-docs.readthedocs.io/en/latest/code-conventions.html#code-and-project-conventions

Change-Id: Ia38fd662be663b83a1b8adef1eca1492ed1fde34

Dockerfiles/Makefile

@@ -1,103 +0,0 @@
-# Copyright 2019 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
-#
-#    https://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.
-
-# It's necessary to set this because some environments don't link sh -> bash.
-SHELL := /bin/bash
-
-# APP INFO
-DOCKER_REGISTRY   ?= quay.io
-IMAGE_PREFIX      ?= airshipit
-IMAGE_NAME        ?=
-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)
-DISTRO_SUFFIX     ?= $(DISTRO)
-IMAGE             := ${DOCKER_REGISTRY}/${IMAGE_PREFIX}/${IMAGE_NAME}:${IMAGE_TAG}-${DISTRO_SUFFIX}
-BASE_IMAGE        ?=
-
-# VERSION INFO
-GIT_COMMIT = ${COMMIT}
-GIT_SHA    = $(shell git rev-parse --short HEAD)
-GIT_TAG    = $(shell git describe --tags --abbrev=0 --exact-match 2>/dev/null)
-GIT_DIRTY  = $(shell test -n "`git status --porcelain`" && echo "dirty" || echo "clean")
-
-ifdef VERSION
-	DOCKER_VERSION = $(VERSION)
-endif
-
-ifeq "$(DISTRO_SUFFIX)" ""
-	# We expect that container is named 'porthole-xxxxx', and
-	# subdirectory is named 'xxxxx'; so we cut 'porthole-' from
-	# directory names here below and in next statement
-	DOCKERFILE = "$(subst porthole-,,$(IMAGE_NAME))/Dockerfile"
-else
-	DOCKERFILE = "$(subst porthole-,,$(IMAGE_NAME))/Dockerfile.$(DISTRO_SUFFIX)"
-endif
-
-info:
-	@echo "Version:           ${VERSION}"
-	@echo "Git Tag:           ${GIT_TAG}"
-	@echo "Git Commit:        ${GIT_COMMIT}"
-	@echo "Git Tree State:    ${GIT_DIRTY}"
-	@echo "Docker Version:    ${DOCKER_VERSION}"
-	@echo "Registry:          ${DOCKER_REGISTRY}"
-
-all:
-	@echo "And what is there's nothing in there? You die, and there's" \
-	      "nothing beyond that. Nothing. Nothing remains. Someone might" \
-	      "remember you for a little while after but not for long.">&2; exit 2
-
-check-docker:
-	@if [ -z $$(which docker) ]; then \
-		echo "Missing \`docker\` client which is required for development"; \
-		exit 2; \
-	fi
-
-_BASE_IMAGE_ARG := $(if $(BASE_IMAGE),--build-arg FROM="${BASE_IMAGE}" ,)
-
-build-image-$(IMAGE_NAME): check-docker
-ifeq "$(IMAGE_NAME)" ""
-	@echo "Missing \`IMAGE_NAME\` variable." >&2; exit 2
-endif
-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) \
-		$(_BASE_IMAGE_ARG) \
-		--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) \
-		$(_BASE_IMAGE_ARG) .
-endif
-ifeq ($(PUSH_IMAGE), true)
-	docker push $(IMAGE)
-endif
-
-.PHONY: all build-image-$(IMAGE_NAME) build-image-% check-docker info

Makefile

@@ -15,48 +15,157 @@
 # It's necessary to set this because some environments don't link sh -> bash.
 SHELL := /bin/bash
 
-HELM := helm
+# APP INFO
-TASK := build
+DOCKER_REGISTRY   ?= quay.io
+IMAGE_PREFIX      ?= airshipit
+IMAGE_NAME        ?=
+IMAGE_TAG         ?= latest
+BUILD_DIR         := $(shell mktemp -d)
+HELM              ?= $(BUILD_DIR)/helm
+CHARTS            := $(patsubst charts/%/.,%,$(wildcard charts/*/.))
+IMAGES            := $(patsubst images/%/.,%,$(wildcard images/*/.))
+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)
+DISTRO_SUFFIX     ?= $(DISTRO)
+IMAGE             := ${DOCKER_REGISTRY}/${IMAGE_PREFIX}/${IMAGE_NAME}:${IMAGE_TAG}-${DISTRO_SUFFIX}
+BASE_IMAGE        ?=
 
-EXCLUDES := helm-toolkit docs tools logs tmp Dockerfiles zuul.d jmphost
+# VERSION INFO
-CHARTS := helm-toolkit $(filter-out $(EXCLUDES), $(patsubst %/.,%,$(wildcard */.)))
+GIT_COMMIT = ${COMMIT}
+GIT_SHA    = $(shell git rev-parse --short HEAD)
+GIT_TAG    = $(shell git describe --tags --abbrev=0 --exact-match 2>/dev/null)
+GIT_DIRTY  = $(shell test -n "`git status --porcelain`" && echo "dirty" || echo "clean")
 
-.PHONY: $(EXCLUDES) $(CHARTS)
+HELM_PIDFILE ?= $(abspath ./.helm-pid)
 
-all: $(CHARTS)
+ifdef VERSION
+	DOCKER_VERSION = $(VERSION)
+endif
 
-$(CHARTS):
+ifeq "$(DISTRO_SUFFIX)" ""
-	@echo
+	# We expect that container is named 'porthole-xxxxx', and
-	@echo "===== Processing [$@] chart ====="
+	# subdirectory is named 'xxxxx'; so we cut 'porthole-' from
-	@make $(TASK)-$@
+	# directory names here below and in next statement
+	DOCKERFILE = "images/$(subst porthole-,,$(IMAGE_NAME))/Dockerfile"
+else
+	DOCKERFILE = "images/$(subst porthole-,,$(IMAGE_NAME))/Dockerfile.$(DISTRO_SUFFIX)"
+endif
 
-init-%:
+info:
-	if [ -f $*/Makefile ]; then make -C $*; fi
+	@echo "Version:           ${VERSION}"
-	if [ -f $*/requirements.yaml ]; then helm dep up $*; fi
+	@echo "Git Tag:           ${GIT_TAG}"
+	@echo "Git Commit:        ${GIT_COMMIT}"
+	@echo "Git Tree State:    ${GIT_DIRTY}"
+	@echo "Docker Version:    ${DOCKER_VERSION}"
+	@echo "Registry:          ${DOCKER_REGISTRY}"
 
-lint-%: init-%
+all: lint charts images
-	if [ -d $* ]; then $(HELM) lint $*; fi
+	@echo "And what is there's nothing in there? You die, and there's" \
+	      "nothing beyond that. Nothing. Nothing remains. Someone might" \
+	      "remember you for a little while after but not for long."
 
-build-%: lint-%
+check-docker:
-	if [ -d $* ]; then $(HELM) package $*; fi
+	@if [ -z $$(which docker) ]; then \
+		echo "Missing \`docker\` client which is required for development"; \
+		exit 2; \
+	fi
+
+dry-run: clean $(addprefix dry-run-,$(CHARTS))
+
+dry-run-%: helm-lint-%
+	echo Running Dry-Run on chart $*
+	cd charts; $(HELM) template --set pod.resources.enabled=true $*
+
+charts: $(CHARTS)
+	@echo "Done building charts."
+
+$(CHARTS): $(addprefix dry-run-,$(CHARTS)) chartbanner
+	$(HELM) package -d charts charts/$@
+
+chartbanner:
+	@echo "Building charts: $(CHARTS)"
+
+lint: helm_lint
+
+helm-lint: $(addprefix helm-lint-,$(CHARTS))
+
+helm-lint-%: helm-init-%
+	@echo "Linting chart $*"
+	cd charts;$(HELM) lint $*
+
+helm-init-%: helm-serve
+	@echo "Initializing chart $*"
+	cd charts;if [ -s $*/requirements.yaml ]; then echo "Initializing $*";$(HELM) dep up $*; fi
+
+helm-serve: helm-install
+	./tools/helm_tk.sh $(HELM) $(HELM_PIDFILE)
+
+# Install helm binary
+helm-install:
+	./tools/helm_install.sh $(HELM)
+
+dry-run:
+
+docs:
+	@echo "Not implemented." >&2; exit 2
 
 clean:
-	@echo "Removed .b64, _partials.tpl, and _globals.tpl files"
+	rm -rf build
-	rm -f helm-toolkit/secrets/*.b64
+	rm -f charts/*.tgz
-	rm -f */templates/_partials.tpl
+	rm -f charts/*/requirements.lock
-	rm -f */templates/_globals.tpl
+	rm -rf charts/*/charts
-	rm -f *tgz */charts/*tgz
-	rm -f */requirements.lock
-	-rm -rf */charts */tmpcharts
 
-pull-all-images:
+run_images:
-	@./tools/pull-images.sh
+	@echo "Not implemented." >&2; exit 2
 
-pull-images:
+run_$(IMAGE_NAME):
-	@./tools/pull-images.sh $(filter-out $@,$(MAKECMDGOALS))
+	@echo "Not implemented." >&2; exit 2
 
-dev-deploy:
+tests:
-	@./tools/gate/devel/start.sh $(filter-out $@,$(MAKECMDGOALS))
+	@echo "Not implemented." >&2; exit 2
 
-%:
+format:
-	@:
+	@echo "Not implemented." >&2; exit 2
+
+images: $(addprefix build-image-,$(IMAGES))
+	@echo "Done building images."
+
+_BASE_IMAGE_ARG := $(if $(BASE_IMAGE),--build-arg FROM="${BASE_IMAGE}" ,)
+
+build-image-%: IMAGE_NAME = $*
+build-image-%:
+	@echo "Building $(IMAGE_NAME)..."
+ifeq ($(USE_PROXY), true)
+	@echo 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) \
+		$(_BASE_IMAGE_ARG) \
+		--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
+	@echo 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) \
+		$(_BASE_IMAGE_ARG) .
+endif
+ifeq ($(PUSH_IMAGE), true)
+	@echo docker push $(IMAGE)
+endif
+
+.PHONY: $(CHARTS) all build-image-% chartbanner charts check-docker clean \
+        docs dry-run-% dry-run format helm-init-% helm-install helm-lint-% \
+		helm-lint helm-serve images info lint run_$(IMAGE_NAME) run_images \
+        tests

tools/helm_install.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+# 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.
+#
+
+set -x
+
+HELM=$1
+HELM_ARTIFACT_URL=${HELM_ARTIFACT_URL:-"https://storage.googleapis.com/kubernetes-helm/helm-v2.13.1-linux-amd64.tar.gz"}
+
+
+function install_helm_binary {
+  if [[ -z "${HELM}" ]]
+  then
+    echo "No Helm binary target location."
+    exit -1
+  fi
+
+  if [[ -w "$(dirname ${HELM})" ]]
+  then
+    TMP_DIR=${BUILD_DIR:-$(mktemp -d)}
+    curl -o "${TMP_DIR}/helm.tar.gz" "${HELM_ARTIFACT_URL}"
+    cd ${TMP_DIR}
+    tar -xvzf helm.tar.gz
+    cp "${TMP_DIR}/linux-amd64/helm" "${HELM}"
+  else
+    echo "Cannot write to ${HELM}"
+    exit -1
+  fi
+}
+
+install_helm_binary

tools/helm_tk.sh

@@ -0,0 +1,79 @@
+#!/bin/bash
+# Copyright 2017 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.
+#
+# Script to setup helm-toolkit and helm dep up the armada chart
+#
+
+set -eux
+
+HELM=${1}
+HELM_PIDFILE=${2}
+SERVE_DIR=$(mktemp -d)
+
+HTK_STABLE_COMMIT=${HTK_COMMIT:-"200b5e902b3a176fbfbe669b6a10a254c9b50f5d"}
+
+${HELM} init --client-only
+
+if [[ -s ${HELM_PIDFILE} ]]; then
+    HELM_PID=$(cat "${HELM_PIDFILE}")
+    if ps "${HELM_PID}"; then
+        kill "${HELM_PID}"
+        sleep 0.5
+        if ps "${HELM_PID}"; then
+            echo Failed to terminate Helm, PID = "${HELM_PID}"
+            exit 1
+        fi
+    fi
+fi
+
+${HELM} serve & > /dev/null
+HELM_PID=${!}
+echo Started Helm, PID = "${HELM_PID}"
+echo "${HELM_PID}" > "${HELM_PIDFILE}"
+
+set +x
+if [[ -z $(curl -s 127.0.0.1:8879 | grep 'Helm Repository') ]]; then
+    while [[ -z $(curl -s 127.0.0.1:8879 | grep 'Helm Repository') ]]; do
+       sleep 1
+       echo "Waiting for Helm Repository"
+    done
+else
+    echo "Helm serve already running"
+fi
+set -x
+
+if ${HELM} repo list | grep -q "^stable" ; then
+    ${HELM} repo remove stable
+fi
+
+${HELM} repo add local http://localhost:8879/charts
+
+
+#OSH Makefile is bugged, so ensure helm is in the path
+if [[ ${HELM} != "helm" ]]
+then
+  export PATH=${PATH}:$(dirname ${HELM})
+fi
+
+{
+    cd "${SERVE_DIR}"
+    git clone https://git.openstack.org/openstack/openstack-helm-infra.git || true
+    cd openstack-helm-infra
+    git reset --hard "${HTK_STABLE_COMMIT}"
+
+    make helm-toolkit
+}
+
+rm -rf "${SERVE_DIR}"