diff --git a/images/bazelbuild/README.md b/images/bazelbuild/README.md index 4264bee54213..625d0c6c5d6d 100644 --- a/images/bazelbuild/README.md +++ b/images/bazelbuild/README.md @@ -1,4 +1,4 @@ -# bazelbuild +# bazelbuild image This image is used for a variety of deploy/push jobs that run in the test-infra-trusted cluster. It contains: - two versions of bazel, to support migration from one to the other diff --git a/images/gcb-docker-gcloud/README.md b/images/gcb-docker-gcloud/README.md new file mode 100644 index 000000000000..478d4fc7d927 --- /dev/null +++ b/images/gcb-docker-gcloud/README.md @@ -0,0 +1,15 @@ +# gcb-docker-gcloud image + +This image is available for Google Cloud Build jobs that want to use a +combination of `docker`, `gcloud`, and `go` all in the same build step + +## contents + +- base: + - golang:1.16.2-alpine +- languages: + - `go` +- tools: + - `docker` + - `docker-buildx`, `qemu` binaries, `/buildx-entrypoint` for multi-arch support + - `gcloud` via rapid channel, with default components diff --git a/pkg/benchmarkjunit/README.md b/pkg/benchmarkjunit/README.md index 4022f9d2a451..063e1e8516e7 100644 --- a/pkg/benchmarkjunit/README.md +++ b/pkg/benchmarkjunit/README.md @@ -1,39 +1,56 @@ # benchmarkjunit -`benchmarkjunit` is a go utility that runs go [`testing` package](https://golang.org/pkg/testing/#hdr-Benchmarks) benchmarks with a command like `go test -v -bench=. ` and translates the output into JUnit XML. + +`benchmarkjunit` is a go utility that runs go [`testing` package benchmarks] +with a command like `go test -v -bench=. ` and translates the output +into JUnit XML. ## Usage Examples + Run `go run ./pkg/benchmarkjunit --help` to see all the available flags. ```shell go run ./pkg/benchmarkjunit k8s.io/test-infra/experiment/dummybenchmarks ``` + ```shell go run ./pkg/benchmarkjunit ./experiment/dummybenchmarks/... ``` + ```shell go run ./pkg/benchmarkjunit \ -o junit_benchmark.xml -l testlog.txt \ --test-arg=-benchmem --bench=Core --pass-on-error \ ./experiment/dummybenchmarks/... ``` + With bazel: ```shell bazel run //pkg/benchmarkjunit -- k8s.io/test-infra/experiment/dummybenchmarks ``` ### Running as a ProwJob -`benchmarkjunit` can be used from a ProwJob to generate JUnit results for consumption in Testgrid, Spyglass, Gubernator, etc. See the [`prowjob_example.yaml`](/pkg/benchmarkjunit/prowjob_example.yaml) file. + +`benchmarkjunit` can be used from a ProwJob to generate JUnit results for +consumption in Testgrid, Spyglass, Gubernator, etc. See the +[`prowjob_example.yaml`](/pkg/benchmarkjunit/prowjob_example.yaml) file. ### Demo Job -The [`ci-test-infra-benchmark-demo`](https://github.com/kubernetes/test-infra/blob/1423204f375ee7cf99f2a8a61a213562039b2ac7/config/jobs/kubernetes/test-infra/test-infra-canaries.yaml#L33-L51) periodic ProwJob provides a live example of how to use `benchmarkjunit` and what the results look like. Examples: -[Testgrid](https://testgrid.k8s.io/sig-testing-canaries#benchmark-demo&width=20&graph-metrics=avg%20op%20duration%20(ns%2Fop)&graph-metrics=test-duration-minutes&graph-metrics=op%20count&graph-metrics=MB%2Fs&graph-metrics=alloced%20B%2Fop&graph-metrics=allocs%2Fop), -[Spyglass](https://prow.k8s.io/view/gcs/kubernetes-jenkins/logs/ci-test-infra-benchmark-demo/1124364619008184320), -[Raw results](https://gcsweb.k8s.io/gcs/kubernetes-jenkins/logs/ci-test-infra-benchmark-demo/1124364619008184320/artifacts/). + +The [`ci-test-infra-benchmark-demo`] periodic ProwJob provides a live example +of how to use `benchmarkjunit` and what the results look like. Examples: +- [Testgrid](https://testgrid.k8s.io/sig-testing-canaries#benchmark-demo&width=20&graph-metrics=avg%20op%20duration%20(ns%2Fop)&graph-metrics=test-duration-minutes&graph-metrics=op%20count&graph-metrics=MB%2Fs&graph-metrics=alloced%20B%2Fop&graph-metrics=allocs%2Fop), +- [Spyglass](https://prow.k8s.io/view/gcs/kubernetes-jenkins/logs/ci-test-infra-benchmark-demo/1124364619008184320), +- [Raw results](https://gcsweb.k8s.io/gcs/kubernetes-jenkins/logs/ci-test-infra-benchmark-demo/1124364619008184320/artifacts/). ## Translation Example: -The following is the `go test` benchmark output and the corresponding JUnit XML for the [`experiment/dummybenchmarks`](/experiment/dummybenchmarks) package. This was generated by running `go run ./pkg/benchmarkjunit ./experiment/dummybenchmarks -l testlog.txt`. + +The following is the `go test` benchmark output and the corresponding JUnit XML +for the [`experiment/dummybenchmarks`](/experiment/dummybenchmarks) package. +This was generated by running +`go run ./pkg/benchmarkjunit ./experiment/dummybenchmarks -l testlog.txt`. #### Benchmark output: + ``` goos: linux goarch: amd64 @@ -76,6 +93,7 @@ FAIL k8s.io/test-infra/experiment/dummybenchmarks 25.419s ``` #### JUnit XML: + ```xml @@ -213,3 +231,6 @@ FAIL k8s.io/test-infra/experiment/dummybenchmarks 25.419s ``` + +[`testing` package benchmarks]: https://golang.org/pkg/testing/#hdr-Benchmarks +[`ci-test-infra-benchmark-demo`]: https://github.com/kubernetes/test-infra/blob/1423204f375ee7cf99f2a8a61a213562039b2ac7/config/jobs/kubernetes/test-infra/test-infra-canaries.yaml#L33-L51