Makefile

# Copyright 2018 Google LLC
#
# 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.

# Make will use bash instead of sh
SHELL := /usr/bin/env bash

# google cloud project
PROJECT:=$(shell gcloud config get-value core/project)
ROOT:=.

# we're building images based on [distroless](https://github.com/GoogleContainerTools/distroless) are so minimal
# that they don't have a shell to exec into which makes it difficult to do traditional k8s debugging
# this option includes busybox but should be omitted for production
DEBUG?=-c dbg

# add any bazel build options here
BAZEL_OPTIONS?=

# set the cluster for override build
CLUSTER?=
# set the container repo for override build
CONTAINER_REPO?=

################################################################################################
#                      Verification/testing helpers                                            #
################################################################################################

# All is the first target in the file so it will get picked up when you just run 'make' on its own
.PHONY: lint
lint: check_shell check_python check_gofmt check_terraform check_docker check_base_files check_trailing_whitespace check_headers

# The .PHONY directive tells make that this isn't a real target and so
# the presence of a file named 'check_shell' won't cause this target to stop
# working
.PHONY: check_shell
check_shell:
	@source test/make.sh && check_shell

.PHONY: check_python
check_python:
	@source test/make.sh && check_python

.PHONY: check_gofmt
check_gofmt:
	@test/verify-gofmt.sh

.PHONY: gofmt
gofmt:
	gofmt -s -w pyrios-ui/
	gofmt -s -w pyrios/

.PHONY: check_terraform
check_terraform:
	@source test/make.sh && check_terraform

.PHONY: check_docker
check_docker:
	@source test/make.sh && docker

.PHONY: check_base_files
check_base_files:
	@source test/make.sh && basefiles

.PHONY: check_shebangs
check_shebangs:
	@source test/make.sh && check_bash

.PHONY: check_trailing_whitespace
check_trailing_whitespace:
	@source test/make.sh && check_trailing_whitespace

.PHONY: check_headers
check_headers:
	@python test/verify_boilerplate.py


################################################################################################
#             Infrastructure bootstrapping and mgmt helpers                                    #
################################################################################################

# 1: Sets up some of the prerequisite APIs that will be needed to interact with GCP in this demo
.PHONY: bootstrap
bootstrap:
	gcloud services enable \
	  cloudresourcemanager.googleapis.com \
	  compute.googleapis.com \
	  container.googleapis.com \
	  cloudbuild.googleapis.com \
	  containerregistry.googleapis.com \
	  logging.googleapis.com \
	  bigquery-json.googleapis.com

# 2: Terraform is used to manage the larger infrastructure components

.PHONY: terraform_preapply
terraform_preapply:
	terraform init terraform/
	terraform validate terraform/
	terraform plan -var "project=$(PROJECT)" -out=tfplan terraform/

.PHONY: terraform
terraform: terraform_preapply
	terraform apply tfplan

# 3. We will not be checking secrets into version control. This helps manage that process
.PHONY: configure
configure:
	$(ROOT)/scripts/configure.sh

# 4: Deploys kubernetes resources. ie: elasticsearch, pyrios and pyrios-ui
.PHONY: create
create:
	CONTAINER_REPO=${CONTAINER_REPO} $(ROOT)/scripts/create.sh

# 5: Exposes the elasticsearch endpoint to your workstation so that you can seed the demo data
.PHONY: expose
expose:
	$(ROOT)/scripts/expose.sh

# 6: Seeds the demo data via the proxy exposed in 5
.PHONY: load
load:
	$(ROOT)/scripts/load-shakespeare.sh

# 7: Validate that the data was properly seeded into ES
.PHONY: validate
validate:
	$(ROOT)/scripts/validate.sh

# 7: Disconnect proxy. You'll have to run this in a separate window/terminal
.PHONY: close-expose
close-expose:
	killall kubectl

# 8: Expose the pyrios UI so that you can navigate to the site on localhost:8080
.PHONY: expose-ui
expose-ui:
	$(ROOT)/scripts/expose-ui.sh

# The elasticsearch portion of the demo is complete. You're welcome to tear
# down your infrastructure right now, or if you skip the teardown, you can
# start experimenting with bazel!

# 9: (OPTIONAL) Delete k8s clusters and associated infrastructure and go back to a blank slate.
.PHONY: teardown
teardown:
	$(ROOT)/scripts/teardown.sh

################################################################################################
#                      pyrios/pyrios-ui                                                        #
################################################################################################

.PHONY: bazel-clean
bazel-clean:
	bazel clean --expunge

.PHONY: bazel-test
bazel-test:
	bazel ${BAZEL_OPTIONS} test \
	--platforms=@io_bazel_rules_go//go/toolchain:linux_amd64 //pyrios/... //pyrios-ui/... //test:verify-all --test_output=errors

.PHONY: bazel-build-pyrios-image
bazel-build-pyrios-image:
	bazel run ${BAZEL_OPTIONS} ${DEBUG} \
		--platforms=@io_bazel_rules_go//go/toolchain:linux_amd64 //pyrios:app_image

.PHONY: bazel-build-pyrios-ui-image
bazel-build-pyrios-ui-image:
	bazel run ${BAZEL_OPTIONS} ${DEBUG} \
		--platforms=@io_bazel_rules_go//go/toolchain:linux_amd64 //pyrios-ui:app_image

.PHONY: bazel-build-images
bazel-build-images: bazel-build-pyrios-image bazel-build-pyrios-ui-image


# this is sort of like a standard kubernetes dry run - except that it pushes
# the image to the repo. it will print out the manifests to the terminal
.PHONY: bazel-publish-pyrios-image
bazel-publish-pyrios-image:
	bazel run --platforms=@io_bazel_rules_go//go/toolchain:linux_amd64 //pyrios:staging

.PHONY: bazel-publish-pyrios-ui-image
bazel-publish-pyrios-ui-image:
	bazel run --platforms=@io_bazel_rules_go//go/toolchain:linux_amd64 //pyrios-ui:staging

.PHONY: bazel-publish-images
bazel-publish-images: bazel-publish-pyrios-image bazel-publish-pyrios-ui-image

# this is publishing a k8s_object- which allows you to bundle arbitrary
# kube resources together. for example, the sevice with deploymnent
.PHONY: bazel-deploy-pyrios-staging
bazel-deploy-pyrios-staging:
	# bazel run ${BAZEL_OPTIONS} ${DEBUG} --platforms=@io_bazel_rules_go//go/toolchain:linux_amd64 //pyrios:staging.apply
	bazel run ${BAZEL_OPTIONS} ${DEBUG} //pyrios:staging.apply

.PHONY: bazel-deploy-pyrios-ui-staging
bazel-deploy-pyrios-ui-staging:
	# bazel run ${BAZEL_OPTIONS} ${DEBUG} --platforms=@io_bazel_rules_go//go/toolchain:linux_amd64 //pyrios-ui:staging.apply
	bazel run ${BAZEL_OPTIONS} ${DEBUG} //pyrios-ui:staging.apply

.PHONY: bazel-deploy-staging
bazel-deploy-staging: bazel-deploy-pyrios-staging bazel-deploy-pyrios-ui-staging


.PHONY: bazel-override
bazel-override:
	bazel run ${BAZEL_OPTIONS} ${DEBUG} \
		--platforms=@io_bazel_rules_go//go/toolchain:linux_amd64 \
		--define cluster=${CLUSTER} \
		--define repo=${CONTAINER_REPO} \
		//pyrios-ui:k8s.apply
	bazel run ${BAZEL_OPTIONS} ${DEBUG} \
		--platforms=@io_bazel_rules_go//go/toolchain:linux_amd64 \
		--define cluster=${CLUSTER} \
		--define repo=${CONTAINER_REPO} \
		//pyrios:k8s.apply

# delete your staging resources from kubernetes
.PHONY: bazel-delete-staging
bazel-delete-staging:
	bazel run ${BAZEL_OPTIONS} //pyrios:staging.delete 	//pyrios-ui:staging.delete

################################################################################################
#                                 kubernetes helpers                                           #
################################################################################################

# this works off of the old static manifests
.PHONY: deploy
deploy:
	kubectl apply -f pyrios/manifests/
	kubectl apply -f pyrios-ui/manifests/

# wait on the pytios deployment to launch
.PHONY: wait-on-pyrios
wait-on-pyrios:
	$(ROOT)/scripts/wait-on-pyrios.sh