This is an automated email from the ASF dual-hosted git repository.
damccorm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git
The following commit(s) were added to refs/heads/master by this push:
new b573c8ffc8b Add a little more info on snapshot containers (#31861)
b573c8ffc8b is described below
commit b573c8ffc8b7ac765ff3ef281a5c6a5dd3d084ef
Author: Danny McCormick <dannymccorm...@google.com>
AuthorDate: Fri Jul 12 18:35:06 2024 +0200
Add a little more info on snapshot containers (#31861)
* Add a little more info on snapshot containers
* Missing space
---
contributor-docs/code-change-guide.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/contributor-docs/code-change-guide.md
b/contributor-docs/code-change-guide.md
index 935a2c6276c..583c01f6bab 100644
--- a/contributor-docs/code-change-guide.md
+++ b/contributor-docs/code-change-guide.md
@@ -423,6 +423,17 @@ If you're using Dataflow Runner v2 and `sdks/java/harness`
or its dependencies (
--sdkContainerImage="us.gcr.io/apache-beam-testing/beam_java11_sdk:2.49.0-custom"
```
+#### Snapshot Version Containers
+
+By default, a Snapshot version for an SDK under development will use the
containers published to the [apache-beam-testing project's container
registry](https://us.gcr.io/apache-beam-testing/github-actions). For example,
the most recent snapshot container for Java 17 can be found
[here](https://us.gcr.io/apache-beam-testing/github-actions/beam_java17_sdk).
+
+When a version is entering the [release candidate
stage](https://github.com/apache/beam/blob/master/contributor-docs/release-guide.md),
one final SNAPSHOT version will be published.
+This SNAPSHOT version will use the final containers published on
[DockerHub](https://hub.docker.com/search?q=apache%2Fbeam).
+
+**NOTE:** During the release process, there may be some downtime where a
container is not available for use for a SNAPSHOT version. To avoid this, it is
recommended to either switch to the latest SNAPSHOT version available or to use
[custom
containers](https://beam.apache.org/documentation/runtime/environments/#custom-containers).
You should also only rely on snapshot versions for important workloads if
absolutely necessary.
+
+Certain runners may override this snapshot behavior; for example, the Dataflow
runner overrides all SNAPSHOT containers into a [single
registry](https://console.cloud.google.com/gcr/images/cloud-dataflow/GLOBAL/v1beta3).
The same downtime will still be incurred, however, when switching to the final
container
+
## Python guide
The Beam Python SDK is distributed as a single wheel, which is more
straightforward than the Java SDK.
