Genjobs: update docs, create Dockerfile, and make go submodule

istio · Nov 28, 2019 · 2b547da · 2b547da
1 parent 5971f38
commit 2b547da
Show file tree

Hide file tree

Showing 9 changed files with 767 additions and 19 deletions.
diff --git a/Makefile.core.mk b/Makefile.core.mk
@@ -34,7 +34,7 @@ testgrid:
 generate-config:
 	@rm -fr prow/cluster/jobs/istio/*/*.gen.yaml
 	@(cd prow/config/cmd; GOARCH=amd64 GOOS=linux go run generate.go write)
-	@$(MAKE) -C prow gen-private-jobs
+	@$(MAKE) -C prow/genjobs gen-private-jobs
 
 diff-config:
 	@(cd prow/config/cmd; GOARCH=amd64 GOOS=linux go run generate.go diff)

diff --git a/go.mod b/go.mod
@@ -18,7 +18,6 @@ require (
 	github.com/kr/pretty v0.1.0
 	github.com/prometheus/client_golang v1.2.1
 	github.com/sirupsen/logrus v1.4.2
-	github.com/spf13/pflag v1.0.5
 	golang.org/x/net v0.0.0-20191021144547-ec77196f6094
 	golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45
 	golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e
@@ -28,5 +27,4 @@ require (
 	k8s.io/apimachinery v0.0.0-20190817020851-f2f3a405f61d
 	k8s.io/client-go v11.0.1-0.20190805182717-6502b5e7b1b5+incompatible
 	k8s.io/test-infra v0.0.0-20191126210720-282e49f14e7a
-	sigs.k8s.io/yaml v1.1.0
 )
diff --git a/prow/Makefile b/prow/Makefile
@@ -14,9 +14,6 @@ CLUSTER_BUILD ?= prow
 CLUSTER_PRIVATE ?= prow-private
 ZONE    ?= us-west1-a
 
-gen-private-jobs:
-	@./genjobs/gen-private-jobs.sh
-
 update-config-dry-run: get-cluster-credentials
 	./recreate_prow_configmaps.py \
 		--job-config-dir=cluster/jobs \

diff --git a/prow/genjobs/Dockerfile b/prow/genjobs/Dockerfile
@@ -0,0 +1,13 @@
+FROM golang:1.13 as build-env
+
+WORKDIR /go/src/genjobs
+
+COPY . /go/src/genjobs
+
+RUN go build -o /go/bin/genjobs
+
+FROM gcr.io/distroless/base:22bd467b41e5e656e31db347265fae118db166d9
+
+COPY --from=build-env /go/bin/genjobs /
+
+ENTRYPOINT ["/genjobs"]
diff --git a/prow/genjobs/Makefile b/prow/genjobs/Makefile
@@ -0,0 +1,33 @@
+# Copyright 2019 Istio Authors
+#
+# 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.
+
+PROJECT = istio-testing
+HUB = gcr.io
+VERSION ?= 0.0.1
+
+.PHONY: deploy
+deploy: image push
+
+.PHONY: gen-private-jobs
+gen-private-jobs:
+	@./gen-private-jobs.sh
+
+.PHONY: image
+image:
+	docker build -t "$(HUB)/$(PROJECT)/genjobs:$(VERSION)" -t "$(HUB)/$(PROJECT)/genjobs:latest" .
+
+.PHONY: push
+push:
+	docker push "$(HUB)/$(PROJECT)/genjobs:$(VERSION)"
+	docker push "$(HUB)/$(PROJECT)/genjobs:latest"
diff --git a/prow/genjobs/README.md b/prow/genjobs/README.md
@@ -6,16 +6,39 @@
 
 ## Installation
 
+Install using Golang:
+
+```console
+$ GO111MODULE="on" go get -u istio.io/test-infra/prow/genjobs
+```
+
+Install using Docker:
+
 ```console
-$ go get -u istio.io/test-infra/prow/genjobs
+$ docker pull gcr.io/istio-testing/genjobs:latest
+```
+
+Install from source:
+
+```console
+$ git clone https://github.com/istio/test-infra.git
+$ cd ./test-infra/prow/genjobs/
+$ go install
 ```
 
 ## Usage
 
 Run using Golang:
+> Ensure `$GOPATH/bin` is on your `$PATH`; or execute `$GOPATH/bin/genjobs` directly.
 
 ```console
-$ go run istio.io/test-infra/prow/genjobs <options>
+$ genjobs <options>
+```
+
+Run using Docker:
+
+```console
+$ docker run gcr.io/istio-testing/genjobs:latest <options>
 ```
 
 The following is a list of supported options for `genjobs`. The only **required** option is `-m, --mapping`, which is the translation mapping between public/private Github organizations.
@@ -102,3 +125,7 @@ Delete jobs in destination path prior to generation:
 ```console
 $ genjobs --mapping istio=istio-private --clean
 ```
+
+## Changelog
+
+- 0.0.1: initial release
diff --git a/prow/genjobs/gen-private-jobs.sh b/prow/genjobs/gen-private-jobs.sh
@@ -31,10 +31,10 @@ COMMON_OPTS=(
 )
 
 # Clean ./prow/cluster/jobs/istio-private directory
-go run ./genjobs --clean --mapping=istio=istio-private --output=./cluster/jobs/ --dry-run >/dev/null
+go run . --clean --mapping=istio=istio-private --output=./cluster/jobs/ --dry-run >/dev/null
 
 # istio/istio build job(s) - postsubmit(s)
-go run ./genjobs \
+go run . \
   "${COMMON_OPTS[@]}" \
   --branches=release-1.4,master \
   --env DOCKER_HUB=gcr.io/istio-prow-build,GCS_BUCKET=istio-private-build/dev \
@@ -44,15 +44,15 @@ go run ./genjobs \
   --job-whitelist release_istio_postsubmit,release_istio_release-1.4_postsubmit
 
 # istio/istio test jobs(s) - presubmit(s) and postsubmit(s)
-go run ./genjobs \
+go run . \
   "${COMMON_OPTS[@]}" \
   --branches=release-1.4,master \
   --job-type presubmit,postsubmit \
   --repo-whitelist istio \
   --job-blacklist release_istio_postsubmit,release_istio_release-1.4_postsubmit
 
 # istio/proxy master test jobs(s) - presubmit(s)
-go run ./genjobs \
+go run . \
   "${COMMON_OPTS[@]}" \
   --branches master \
   --modifier=master_priv \
@@ -62,7 +62,7 @@ go run ./genjobs \
   --repo-whitelist proxy
 
 # istio/proxy master build jobs(s) - postsubmit(s)
-go run ./genjobs \
+go run . \
   "${COMMON_OPTS[@]}" \
   --branches master \
   --modifier master_priv \
@@ -72,7 +72,7 @@ go run ./genjobs \
   --repo-whitelist proxy
 
 # istio/proxy release-1.4 test jobs(s) - presubmit(s)
-go run ./genjobs \
+go run . \
   "${COMMON_OPTS[@]}" \
   --branches release-1.4 \
   --modifier release-1.4_priv \
@@ -82,7 +82,7 @@ go run ./genjobs \
   --repo-whitelist proxy
 
 # istio/proxy release-1.4 build jobs(s) - postsubmit(s)
-go run ./genjobs \
+go run . \
   "${COMMON_OPTS[@]}" \
   --branches release-1.4 \
   --modifier=release-1.4_priv \
@@ -92,23 +92,23 @@ go run ./genjobs \
   --repo-whitelist proxy
 
 # istio/release-builder master test jobs(s) - pre/postsubmit(s)
-go run ./genjobs \
+go run . \
   "${COMMON_OPTS[@]}" \
   --branches=master \
   --job-type presubmit,postsubmit \
   --repo-whitelist release-builder \
   --job-whitelist lint_release-builder,lint_release-builder_postsubmit,test_release-builder,test_release-builder_postsubmit,gencheck_release-builder,gencheck_release-builder_postsubmit
 
 # istio/release-builder release-1.4 test jobs(s) - pre/postsubmit(s)
-go run ./genjobs \
+go run . \
   "${COMMON_OPTS[@]}" \
   --branches=release-1.4 \
   --job-type presubmit,postsubmit \
   --repo-whitelist release-builder \
   --job-whitelist lint_release-builder_release-1.4,lint_release-builder_release-1.4_postsubmit,test_release-builder_release-1.4,test_release-builder_release-1.4_postsubmit,gencheck_release-builder_release-1.4,gencheck_release-builder_release-1.4_postsubmit
 
 # istio/release-builder build warning jobs(s) - presubmit(s)
-go run ./genjobs \
+go run . \
   "${COMMON_OPTS[@]}" \
   --branches=release-1.4,master \
   --env PRERELEASE_DOCKER_HUB=gcr.io/istio-prow-build,GCS_BUCKET=istio-private-prerelease/prerelease \
@@ -117,7 +117,7 @@ go run ./genjobs \
   --job-whitelist build-warning_release-builder,build-warning_release-builder_release-1.4
 
 # istio/release-builder build jobs(s) - postsubmit(s)
-go run ./genjobs \
+go run . \
   "${COMMON_OPTS[@]}" \
   --branches=release-1.4,master \
   --labels preset-override-envoy=true,preset-override-deps=release-1.4 \

diff --git a/prow/genjobs/go.mod b/prow/genjobs/go.mod
@@ -0,0 +1,14 @@
+module istio.io/test-infra/prow/genjobs
+
+go 1.13
+
+replace k8s.io/client-go => k8s.io/client-go v0.0.0-20190918200256-06eb1244587a
+
+require (
+	github.com/spf13/pflag v1.0.5
+	golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4 // indirect
+	k8s.io/api v0.0.0-20190918195907-bd6ac527cfd2
+	k8s.io/apimachinery v0.0.0-20190817020851-f2f3a405f61d
+	k8s.io/test-infra v0.0.0-20191128022303-0a9f4b1a27b0
+	sigs.k8s.io/yaml v1.1.0
+)