tools/

Using prebuilt images with gRPC OSS benchmarks

The scripts in this folder:

• Build the images with the worker executables compiled and embedded.
• Push the images to specified registry.
• Delete the images from specified registry.

Build and push images

The script prepare_prebuilt_workers.go builds images and pushes them to a user specified Google cloud registry. For example, the following shows this process (building and pushing prebuilt images) for cxx and go workers:

go run test-infra/tools/prepare_prebuilt_workers/prepare_prebuilt_workers.go \
 -l cxx:master \
 -l go:master \
 -p gcr.io/grpc-testing/project-name/pre_built_workers \
 -t user-specified-tag \
 -r test-infra/containers/pre_built_workers

These built cxx and go images contain the workers built from commit/branch we wish to test.

The script prepare_for_prebuilt_workers.go takes the following options:

• -l
  Language and GITREF to benchmark. The language and its specific GITREF to build the workers from can be specified as language:COMMIT_SHA. May be repeated. Valid input for language names are all in lower case: java, go, csharp, c++, cxx, node, node_purejs, ruby, php7 , php7_protobuf_c, python and python_asyncio.

• -t
  Tag for prebuilt images. Tag is a required fields. Tag complies with docker tag's restrictions .

• -r
  Root directory of Dockerfiles.

• -build-only
  Option to build only, when specified -build-only=true, images will only be built locally.

• -p
  Image registry to store images. The image prefix should be in form of gcr.io/project-name/your-directory-name for the Google Container Registry. For example, the built images would be stored as gcr.io/grpc-testing/project-name/pre_built_workers/cxx:user-specified-tag and gcr.io/grpc-testing/project-name/pre_built_workers/go:user-specified-tag .

  If using a registry other than GCR, the images should be built through the script with the flag -build-only=true. The user could then push the images manually.

  The Dockerfiles that the script uses to build are available in test-infra/containers/pre_built_images.

Delete the images

The script delete_prebuilt_workers.go deletes images within a user specified registry. The script lists all images within the specified registry, then checks if the image has the user specified tag. This script only supports Google Container Registry, because it relies on the google-cloud-sdk.

The following example delete all images within gcr.io/grpc-testing/project-name/pre_built_workers that have tag:user-specified-tag.

go run test-infra/tools/delete_prebuilt_workers/delete_prebuilt_workers.go \
 -p gcr.io/grpc-testing/project-name/pre_built_workers \
 -t user-specified-tag

• -t
  Tag for prebuilt images. Tag is the unique identifier for images to delete. If the image has multiple tags including the user specified tag, the tag specified here is removed from image's tag list, otherwise the image is deleted.
• -p
  Image registry to search images from. Only accepts the image registry prefix, not the actual image name. If the image registry supports nested repositories, the image registry prefix should be the absolute path to the image's parent repository.