Making it easy to build, deploy and use. (Also vendor checkin)

.gitignore

@@ -6,3 +6,8 @@
 /pkg
 /vendor/pkg
 .idea
+/.go
+/.push-*
+/.container-*
+/.dockerfile-*
+.envs.sh

Dockerfile.in

@@ -0,0 +1,5 @@
+FROM {ARG_FROM}
+
+ADD bin/{ARG_OS}_{ARG_ARCH}/{ARG_BIN} /{ARG_BIN}
+
+ENTRYPOINT ["/{ARG_BIN}"]

Makefile

@@ -0,0 +1,205 @@
+# The binary to build (just the basename).
+# This can be overwritten from command line using
+BIN := beanstalkd_exporter
+KUBE_CONTEXT := ""
+
+UNIQUE:=$(shell date +%s)
+
+# Where to push the docker image.
+REGISTRY := practodev
+
+# This version-strategy uses git tags to set the version string
+VERSION := $(shell git describe --tags --always --dirty)
+#
+# This version-strategy uses a manual value to set the version string
+#VERSION := 1.2.3
+
+###
+### These variables should not need tweaking.
+###
+
+SRC_DIRS := cmd pkg # directories which hold app source (not vendored)
+
+ALL_PLATFORMS := darwin/amd64 linux/amd64
+# linux/arm linux/arm64 linux/ppc64le linux/s390x
+
+# Used internally.  Users should pass GOOS and/or GOARCH.
+OS := $(if $(GOOS),$(GOOS),$(shell go env GOOS))
+ARCH := $(if $(GOARCH),$(GOARCH),$(shell go env GOARCH))
+
+BASEIMAGE ?= gcr.io/distroless/static
+
+IMAGE := $(REGISTRY)/$(BIN)
+TAG := $(VERSION)
+
+BUILD_IMAGE ?= golang:1.13.7-alpine
+
+# If you want to build all binaries, see the 'all-build' rule.
+# If you want to build all containers, see the 'all-container' rule.
+# If you want to build AND push all containers, see the 'all-push' rule.
+all: build
+
+# For the following OS/ARCH expansions, we transform OS/ARCH into OS_ARCH
+# because make pattern rules don't match with embedded '/' characters.
+
+build-%:
+	@$(MAKE) build                        \
+	    --no-print-directory              \
+	    GOOS=$(firstword $(subst _, ,$*)) \
+	    GOARCH=$(lastword $(subst _, ,$*))
+
+container-%:
+	@$(MAKE) container                    \
+	    --no-print-directory              \
+	    GOOS=$(firstword $(subst _, ,$*)) \
+	    GOARCH=$(lastword $(subst _, ,$*))
+
+push-%:
+	@$(MAKE) push                         \
+	    --no-print-directory              \
+	    GOOS=$(firstword $(subst _, ,$*)) \
+	    GOARCH=$(lastword $(subst _, ,$*))
+
+all-build: $(addprefix build-, $(subst /,_, $(ALL_PLATFORMS)))
+
+all-container: $(addprefix container-, $(subst /,_, $(ALL_PLATFORMS)))
+
+all-push: $(addprefix push-, $(subst /,_, $(ALL_PLATFORMS)))
+
+fmt:
+	@echo "formatting code"
+	/bin/sh -c "./hack/format.sh"
+
+build: bin/$(OS)_$(ARCH)/$(BIN)
+
+# Directories that we need created to build/test.
+BUILD_DIRS := bin/$(OS)_$(ARCH)     \
+              .go/bin/$(OS)_$(ARCH) \
+              .go/cache
+
+# The following structure defeats Go's (intentional) behavior to always touch
+# result files, even if they have not changed.  This will still run `go` but
+# will not trigger further work if nothing has actually changed.
+OUTBIN = bin/$(OS)_$(ARCH)/$(BIN)
+$(OUTBIN): .go/$(OUTBIN).stamp
+	@true
+
+# This will build the binary under ./.go and update the real binary iff needed.
+.PHONY: .go/$(OUTBIN).stamp
+.go/$(OUTBIN).stamp: $(BUILD_DIRS)
+	@echo "making $(OUTBIN)"
+	@docker run                                                 \
+	    -i                                                      \
+	    --rm                                                    \
+	    -u $$(id -u):$$(id -g)                                  \
+	    -v $$(pwd):/src                                         \
+	    -w /src                                                 \
+	    -v $$(pwd)/.go/bin/$(OS)_$(ARCH):/go/bin                \
+	    -v $$(pwd)/.go/bin/$(OS)_$(ARCH):/go/bin/$(OS)_$(ARCH)  \
+	    -v $$(pwd)/.go/cache:/.cache                            \
+	    --env HTTP_PROXY=$(HTTP_PROXY)                          \
+	    --env HTTPS_PROXY=$(HTTPS_PROXY)                        \
+	    $(BUILD_IMAGE)                                          \
+	    /bin/sh -c "                                            \
+	        ARCH=$(ARCH)                                        \
+	        OS=$(OS)                                            \
+	        VERSION=$(VERSION)                                  \
+	        ./hack/build.sh                                    \
+	    "
+	@if ! cmp -s .go/$(OUTBIN) $(OUTBIN); then \
+	    mv .go/$(OUTBIN) $(OUTBIN);            \
+	    date >$@;                              \
+	fi
+
+# Example: make shell CMD="-c 'date > datefile'"
+shell: $(BUILD_DIRS)
+	@echo "launching a shell in the containerized build environment"
+	@docker run                                                 \
+	    -ti                                                     \
+	    --rm                                                    \
+	    -u $$(id -u):$$(id -g)                                  \
+	    -v $$(pwd):/src                                         \
+	    -w /src                                                 \
+	    -v $$(pwd)/.go/bin/$(OS)_$(ARCH):/go/bin                \
+	    -v $$(pwd)/.go/bin/$(OS)_$(ARCH):/go/bin/$(OS)_$(ARCH)  \
+	    -v $$(pwd)/.go/cache:/.cache                            \
+	    --env HTTP_PROXY=$(HTTP_PROXY)                          \
+	    --env HTTPS_PROXY=$(HTTPS_PROXY)                        \
+	    $(BUILD_IMAGE)                                          \
+	    /bin/sh $(CMD)
+
+# Used to track state in hidden files.
+DOTFILE_IMAGE = $(subst /,_,$(IMAGE))-$(TAG)
+
+container: .container-$(DOTFILE_IMAGE) say_container_name
+.container-$(DOTFILE_IMAGE): bin/$(OS)_$(ARCH)/$(BIN) Dockerfile.in
+	@sed                                 \
+	    -e 's|{ARG_BIN}|$(BIN)|g'        \
+	    -e 's|{ARG_ARCH}|$(ARCH)|g'      \
+	    -e 's|{ARG_OS}|$(OS)|g'          \
+	    -e 's|{ARG_FROM}|$(BASEIMAGE)|g' \
+	    Dockerfile.in > .dockerfile-$(OS)_$(ARCH)
+	@docker build -t $(IMAGE):$(TAG) -f .dockerfile-$(OS)_$(ARCH) .
+	@docker images -q $(IMAGE):$(TAG) > $@
+
+say_container_name:
+	@echo "container: $(IMAGE):$(TAG)"
+
+push: .push-$(DOTFILE_IMAGE) say_push_name
+.push-$(DOTFILE_IMAGE): .container-$(DOTFILE_IMAGE)
+	@docker push $(IMAGE):$(TAG)
+
+say_push_name:
+	@echo "pushed: $(IMAGE):$(TAG)"
+
+manifest-list: push
+	platforms=$$(echo $(ALL_PLATFORMS) | sed 's/ /,/g');  \
+	manifest-tool                                         \
+	    --username=oauth2accesstoken                      \
+	    --password=$$(gcloud auth print-access-token)     \
+	    push from-args                                    \
+	    --platforms "$$platforms"                         \
+	    --template $(REGISTRY)/$(BIN):$(VERSION)__OS_ARCH \
+	    --target $(REGISTRY)/$(BIN):$(VERSION)
+
+version:
+	@echo $(VERSION)
+
+test: $(BUILD_DIRS)
+	@docker run                                                 \
+	    -i                                                      \
+	    --rm                                                    \
+	    -u $$(id -u):$$(id -g)                                  \
+	    -v $$(pwd):/src                                         \
+	    -w /src                                                 \
+	    -v $$(pwd)/.go/bin/$(OS)_$(ARCH):/go/bin                \
+	    -v $$(pwd)/.go/bin/$(OS)_$(ARCH):/go/bin/$(OS)_$(ARCH)  \
+	    -v $$(pwd)/.go/cache:/.cache                            \
+	    --env HTTP_PROXY=$(HTTP_PROXY)                          \
+	    --env HTTPS_PROXY=$(HTTPS_PROXY)                        \
+	    $(BUILD_IMAGE)                                          \
+	    /bin/sh -c "                                            \
+	        ARCH=$(ARCH)                                        \
+	        OS=$(OS)                                            \
+	        VERSION=$(VERSION)                                  \
+	        ./hack/test.sh $(SRC_DIRS)                         \
+	    "
+
+$(BUILD_DIRS):
+	@mkdir -p $@
+
+clean: container-clean bin-clean
+
+container-clean:
+	rm -rf .container-* .dockerfile-* .push-*
+
+bin-clean:
+	rm -rf .go bin
+
+deploy:
+	@echo "Creating kubernetes deployment at: ./artifacts/deployment.yaml"
+	@cp artifacts/deployment-template.yaml artifacts/deployment.yaml
+	VERSION=$(VERSION) ./hack/generate.sh artifacts/deployment.yaml
+	@echo "Create the deployment: kubectl create -f artifacts/deployment.yaml"
+	@echo "Create the service to scrap the exporter data: kubectl create -f artifacts/service.yaml"
+	@echo "Create the servicemonitor to scrap the service to get the data to prometheus: kubectl create -f artifacts/service-monitor.yaml"

README.md

@@ -19,6 +19,15 @@ the number of concurrent tube stats workers via the
 
 ## Usage
 
+How to build it?
+```
+make build
+```
+
+How to generate the deployment yamls?
+```
+make deploy
+```
 
 Running beanstalkd_exporter is as easy as executing `beanstalkd_exporter` on the command line. One argument is required: `-mapping-config` (see below for what it needs).
 
@@ -110,4 +119,3 @@ tube_current_jobs_ready{tube="incoming-emails",user_id="8882"}
 ## License
 
 beanstalkd_exporter is licensed under [The BSD 2-Clause License](http://opensource.org/licenses/BSD-2-Clause). Copyright (c) 2016, MessageBird
-

artifacts/.gitignore

@@ -0,0 +1 @@
+deployment.yaml

artifacts/deployment-template.yaml

@@ -0,0 +1,34 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: beanstalkd-exporter
+ labels:
+   app: beanstalkd-exporter
+spec:
+ replicas: 1
+ selector:
+   matchLabels:
+     app: beanstalkd-exporter
+ template:
+   metadata:
+     labels:
+       app: beanstalkd-exporter
+   spec:
+     tolerations:
+     - effect: NoExecute
+       operator: Exists
+     - effect: NoSchedule
+       operator: Exists
+     containers:
+     - name: beanstalkd-exporter
+       image: practodev/beanstalkd_exporter:{{ BEANSTALK_EXPORTER_VERSION }}
+       imagePullPolicy: Always
+       command:
+       - /beanstalkd_exporter
+       resources:
+         limits:
+           cpu: 100m
+           memory: 100Mi
+         requests:
+           cpu: 10m
+           memory: 20Mi

artifacts/service.yaml

@@ -0,0 +1,19 @@
+# Please edit the object below. Lines beginning with a '#' will be ignored,
+# and an empty file will abort the edit. If an error occurs while saving this file will be
+# reopened with the relevant failures.
+#
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    k8s-app: beanstalkd-exporter
+  name: beanstalkd-exporter
+spec:
+  ports:
+  - name: beanstalkd-exporter-metrics
+    port: 8080
+    protocol: TCP
+    targetPort: 8080
+  selector:
+    app: beanstalkd-exporter
+  type: ClusterIP

go.sum

@@ -4,6 +4,7 @@ github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf h1:qet1QNfXsQxTZq
 github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0=
 github.com/beorn7/perks v0.0.0-20160804104726-4c0e84591b9a h1:BtpsbiV638WQZwhA98cEZw2BsbnQJrbd0BI7tsy0W1c=
 github.com/beorn7/perks v0.0.0-20160804104726-4c0e84591b9a/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/golang/protobuf v0.0.0-20170920220647-130e6b02ab05 h1:Kesru7U6Mhpf/x7rthxAKnr586VFmoE2NdEvkOKvfjg=
 github.com/golang/protobuf v0.0.0-20170920220647-130e6b02ab05/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
@@ -15,6 +16,7 @@ github.com/kr/beanstalk v0.0.0-20150923205605-e99e1a384e4a h1:obXkCagFdhty4KYKpe
 github.com/kr/beanstalk v0.0.0-20150923205605-e99e1a384e4a/go.mod h1:S640fId9Ag4k2hh6Hwwj62pMSZqfMtg/kfKPeAOhET8=
 github.com/matttproud/golang_protobuf_extensions v1.0.0 h1:YNOwxxSJzSUARoD9KRZLzM9Y858MNGCOACTvCW9TSAc=
 github.com/matttproud/golang_protobuf_extensions v1.0.0/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/prometheus/client_golang v0.8.0 h1:1921Yw9Gc3iSc4VQh3PIoOqgPCZS7G/4xQNVUp8Mda8=
 github.com/prometheus/client_golang v0.8.0/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw=
@@ -27,7 +29,9 @@ github.com/prometheus/procfs v0.0.0-20171017214025-a6e9df898b13/go.mod h1:c3At6R
 github.com/sirupsen/logrus v1.4.2 h1:SPIRibHv4MatM3XXNO2BJeFLZwZ2LvZgfQ5+UNI2im4=
 github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
 github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58 h1:8gQV6CLnAEikrhgkHFbMAEhagSSnXWGV915qUMm9mrU=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20190523142557-0e01d883c5c5 h1:sM3evRHxE/1RuMe1FYAL3j7C7fUfIjkbE+NiDAYUF8U=

hack/build.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+set -o errexit
+set -o nounset
+set -o pipefail
+
+if [ -z "${OS:-}" ]; then
+    echo "OS must be set"
+    exit 1
+fi
+if [ -z "${ARCH:-}" ]; then
+    echo "ARCH must be set"
+    exit 1
+fi
+if [ -z "${VERSION:-}" ]; then
+    echo "VERSION must be set"
+    exit 1
+fi
+
+export CGO_ENABLED=0
+export GOARCH="${ARCH}"
+export GOOS="${OS}"
+export GO111MODULE=on
+export GOFLAGS="-mod=vendor"
+
+go install                                                      \
+    -installsuffix "static"                                     \
+    -ldflags "-X $(go list -m)/pkg/version.Version=${VERSION}"  \
+    ./...

hack/format.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+set -o errexit
+set -o nounset
+set -o pipefail
+
+find . -type f | grep .go$ | grep -v vendor | xargs -I {} gofmt -w {}