Skip to content

Commit 604e335

Browse files
authored
Merge pull request #34491: Adds instructions regarding building the Go SDK harness container for Dataflow
2 parents 2facaef + e9e6766 commit 604e335

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

contributor-docs/code-change-guide.md

+2
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ The guide contains the following sections:
3737
for Python development, running unit and integration tests, and running a pipeline
3838
with modified Beam code.
3939

40+
For instructions regarding testing code changes for Go SDK, please see the Go SDK's [README file](https://github.com/apache/beam/tree/master/sdks/go).
41+
4042
## Repository structure
4143

4244
The Apache Beam GitHub repository (Beam repo) is, for the most part, a "mono repo".

sdks/go/README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,19 @@ sport: 3
106106
Crown'd: 1
107107
```
108108
109+
Note that, when running at Beam HEAD, the Dataflow runner will try to use a non-existent container `gcr.io/cloud-dataflow/v1beta3/beam_go_sdk:<Beam version>.dev`.
110+
To address this, you need to push your own SDK harness container image to a repository (for example, Docker Hub or Google Artifact Registry) and specify that as the
111+
`<YOUR_SDK_HARNESS_IMAGE_LOCATION>` parameter above.
112+
For example, running the following from Beam HEAD, will make the container availble at the location `<repository>/beam_go_sdk`.
113+
114+
```bash
115+
$ ./gradlew :sdks:go:container:docker -Pdocker-repository-root=<repository>
116+
117+
$ docker push <repository>/beam_go_sdk
118+
```
119+
109120
See [BUILD.md](./BUILD.md) for how to build Go code in general. See
110-
[container documentation](https://beam.apache.org/documentation/runtime/environments/#building-container-images) for how to build and push the Go SDK harness container image.
121+
[container documentation](https://beam.apache.org/documentation/runtime/environments/#building-container-images) for more details on how to build and push the Go SDK harness container image.
111122
112123
## Issues
113124

0 commit comments

Comments
 (0)