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.

The helper scripts here should be specifically used with GCR. The predominate drive of developing these scripts are to assist continuous build. The scripts could also help with manual usage of prebuilt images if working with GCR. If another image registry is chosen, the prebuilt workers Dockerfiles are available. The root directory of the Dockerfiles could be find test-infra/containers/pre_built_images.

Build and push images

The script prepare_prebuilt_workers.go builds images and pushes them to a user specified 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 wish to build workers from can be specified as language:gitref. May be repeated.
• -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 without being pushed to an image registry.
• -p
  Image registry to store images. In the example, the location of the images are:

  gcr.io/grpc-testing/project-name/pre_built_workers/cxx:user-specified-tag
  gcr.io/grpc-testing/project-name/pre_built_workers/go:user-specified-tag
  

Delete the images

The script delete_prebuilt_workers.go deletes images within user specified registry. The script lists all images within the specified registry, then check if the image has the user specified tag.

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 have 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 take image registry without the image name. The image registry should also be the most direct registry of images, the directories within image registry will not be checked.