Please visit Google Doc for review, wiki page will be updated after release plan is finalized.

This page describes the release, validation, and other aspects related to SDKHarness images.

...

Things to know about gcr.io:

• Quotas:
  • ?It seems like gcr only has hit limit from each IP, I didn't find any documentation about image limit. But it would have size limit.
• Permissions:
  • download access - public
  • publish - limited to authorized accounts that have correct permissions under apache-beam-testing:
    • publishing the snapshots nightly might be feasible similar to how we currently publish nightly maven snapshots, by creating a Jenkins job;
    • publishing at release time can be another job triggered manually by the release owner;
      • Depends on how many tests we want to run. If need to run many tests, it should be a Jenkins job, otherwise, we can write a shell script to automate the process.
• GCP Project:
  • apache-beam-testing

...

*Java and Go will not have language version until we support multi versions.

Publication Schedule

...

Snapshot images

• how do we publish the snapshots, what's the frequency?
  • automatic, when HEAD is built, nightly similar to maven snapshots, or manually?.
• when and how do we cleanup the snapshot images:
  • when you publish an image you have a new version/hash and still can use any previous versions. They take space and will count towards a quota. We need to clean them up periodically:
    • make it part of the publish job to look and delete the versions that are more than X days (or versions) old?

...

• How should we build and publish the images for release versions of Beam?
  • Start with manually, as part of Beam release , and automate it later.
• Should it be a blocker for the release?
  • Should we make it part of the release and not mark release as complete until the images are published?
    • For first three release(v2.16 ~ v2.18), we can make it optional, and if all these release go well, we can make it mandatory part of the release(from v2.19).
  • Should it be done by the same release owner?
    • Yes, this document provides step by step guide about building, testing and pushing. In future, we can automate this process.
  • Should the validation be part of the release validation?
    • Yes, when we validate code base.

Docker images

Commands

This section describes the commands that are used to build, publish, run tests and examples for the images.

...

Please note this will create new images (not used for above testings). Since they are created from the same code, we assume exactly same and if all tests passed with the new created images then assume images created above also pass the testsassume the images are exactly the same.

Set repository and tag as variables:

...

$ pwd
[...]/beam/
$ ./gradlew :sdks:python:container:py2:dockerdockerPush  -Pdocker-repository-root=$REPOSITORY -Pdocker-tag=$TAG --info
$ ./gradlew :sdks:python:container:py35:dockerdockerPush -Pdocker-repository-root=$REPOSITORY -Pdocker-tag=$TAG --info
$ ./gradlew :sdks:python:container:py36:dockerdockerPush -Pdocker-repository-root=$REPOSITORY -Pdocker-tag=$TAG --info
$ ./gradlew :sdks:python:container:py37:dockerdockerPush -Pdocker-repository-root=$REPOSITORY -Pdocker-tag=$TAG --info

...

• precommit tests
• postcommit tests

*These tests will use default images, not the one pushed to gcr.

Manual testing

Test on Dataflow with uploaded images.

...