chamikaramj commented on a change in pull request #12188: URL: https://github.com/apache/beam/pull/12188#discussion_r452546221
########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` Review comment: No (also Beam comes with a Gradle script when cloning). ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in Review comment: Added the same link as Beam quick-start and updated text. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/kafka_taxi.py ########## @@ -0,0 +1,87 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +"""An example that writes to and reads from Kafka. + + This example reads from the PubSub NYC Taxi stream described in + https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon, writes to a + given Kafka topic and reads back from the same Kafka topic. + """ + +# pytype: skip-file + +from __future__ import absolute_import + +import argparse +import logging +import typing + +import apache_beam as beam +from apache_beam.io.kafka import ReadFromKafka +from apache_beam.io.kafka import WriteToKafka +from apache_beam.options.pipeline_options import PipelineOptions +from apache_beam.options.pipeline_options import SetupOptions +from apache_beam.options.pipeline_options import StandardOptions + + +def run(argv=None): + """Main entry point; defines and runs the wordcount pipeline.""" + parser = argparse.ArgumentParser() + parser.add_argument( + '--bootstrap_servers', + dest='bootstrap_servers', + required=True, + help='Bootstrap servers for the Kafka cluster. Should be accessible by ' + 'the runner') + parser.add_argument( + '--topic', + dest='topic', + default='kafka_taxirides_realtime', + help='Kafka topic to write to and read from') + known_args, pipeline_args = parser.parse_known_args(argv) + + pipeline_options = PipelineOptions(pipeline_args) + pipeline_options.view_as(SetupOptions).save_main_session = True + pipeline_options.view_as(StandardOptions).streaming = True + + pipeline = beam.Pipeline(options=pipeline_options) + bootstrap_servers = known_args.bootstrap_servers + _ = ( + pipeline + | beam.io.ReadFromPubSub( + topic='projects/pubsub-public-data/topics/taxirides-realtime'). + with_output_types(bytes) + | beam.Map(lambda x: (b'', x)).with_output_types( Review comment: It's required by the Kafka write transform added a comment. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 +``` + +## Running the example on latest released Beam version + +Perform Beam runner specific setup. Note that cross-language transforms require +portable implementations of Spark/Flink/Direct runners. Dataflow requires +(runner V2)[https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2] +and Beam 2.22.0 or later. See +[here](https://beam.apache.org/documentation/runners/dataflow/) for +instructions for setting up Dataflow. + +Setup a virtual environment for running Beam Python programs. See +[here](https://beam.apache.org/get-started/quickstart-py/) for prerequisites. +Dataflow requires the `gcp` tag. Assuming your work directory to be +`/path/to/work`. + +```sh +> export WORK_DIRECTORY=/path/to/work +> cd $WORK_DIRECTORY +> mkdir kafka_env +> virtualenv kafka_env Review comment: Done. Though I noticed that we mention virtualenv both in Beam contribution guide and Python quickstart. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 +``` + +## Running the example on latest released Beam version + +Perform Beam runner specific setup. Note that cross-language transforms require +portable implementations of Spark/Flink/Direct runners. Dataflow requires +(runner V2)[https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2] +and Beam 2.22.0 or later. See +[here](https://beam.apache.org/documentation/runners/dataflow/) for +instructions for setting up Dataflow. + +Setup a virtual environment for running Beam Python programs. See +[here](https://beam.apache.org/get-started/quickstart-py/) for prerequisites. +Dataflow requires the `gcp` tag. Assuming your work directory to be +`/path/to/work`. + +```sh +> export WORK_DIRECTORY=/path/to/work Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/kafka_taxi.py ########## @@ -0,0 +1,87 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +"""An example that writes to and reads from Kafka. + + This example reads from the PubSub NYC Taxi stream described in + https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon, writes to a + given Kafka topic and reads back from the same Kafka topic. + """ + +# pytype: skip-file + +from __future__ import absolute_import + +import argparse +import logging +import typing + +import apache_beam as beam +from apache_beam.io.kafka import ReadFromKafka +from apache_beam.io.kafka import WriteToKafka +from apache_beam.options.pipeline_options import PipelineOptions +from apache_beam.options.pipeline_options import SetupOptions +from apache_beam.options.pipeline_options import StandardOptions + + +def run(argv=None): + """Main entry point; defines and runs the wordcount pipeline.""" + parser = argparse.ArgumentParser() + parser.add_argument( + '--bootstrap_servers', + dest='bootstrap_servers', + required=True, + help='Bootstrap servers for the Kafka cluster. Should be accessible by ' + 'the runner') + parser.add_argument( + '--topic', + dest='topic', + default='kafka_taxirides_realtime', + help='Kafka topic to write to and read from') + known_args, pipeline_args = parser.parse_known_args(argv) + + pipeline_options = PipelineOptions(pipeline_args) Review comment: Are you sure this works ? I don't see such keyword arguments. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 +``` + +## Running the example on latest released Beam version + +Perform Beam runner specific setup. Note that cross-language transforms require +portable implementations of Spark/Flink/Direct runners. Dataflow requires +(runner V2)[https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2] +and Beam 2.22.0 or later. See +[here](https://beam.apache.org/documentation/runners/dataflow/) for +instructions for setting up Dataflow. + +Setup a virtual environment for running Beam Python programs. See +[here](https://beam.apache.org/get-started/quickstart-py/) for prerequisites. +Dataflow requires the `gcp` tag. Assuming your work directory to be +`/path/to/work`. + +```sh +> export WORK_DIRECTORY=/path/to/work +> cd $WORK_DIRECTORY +> mkdir kafka_env +> virtualenv kafka_env +> . kafka_env/bin/activate +> pip install -e .[gcp] +``` + +Run the Beam pipeline. You can either use the default Kafka topic name or +specify a Kafka topic name. Following command assumes Dataflow. See +[here](https://beam.apache.org/get-started/quickstart-py/) for instructions on +running Beam Python programs on other runners. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). + +Note that this exemple is not available in Beam versions before 2.24.0 hence +you'll have to either get the example program from Beam or follow steps +provided in the section *Running the Example from a Beam Git Clone*. + +```sh +> python -m apache_beam.examples.kafkataxi.kafka_taxi --runner DataflowRunner --temp_location <GCS temp location> --project <GCP project> --region <region> \ + --num_workers 1 --job_name <job name> --bootstrap_servers $BOOTSTRAP_SERVER --experiments=use_runner_v2 +``` + +## Running the Example from a Beam Git Clone + +Running this example from a Beam Git clone requires some additional steps. + +Checkout a clone of the Beam Git repo. See +[here](https://beam.apache.org/contribute/) for prerequisites. + +Assume your Github username to be `GITHUB_USERNAME`. + +```sh +> cd $WORK_DIRECTORY +> git clone [email protected]:${GITHUB_USERNAME}/beam +> cd beam +``` + +Build IO expansion service jar. + +```sh +> ./gradlew :sdks:java:io:expansion-service:build +``` + +Push a java SDK Harness container to Docker Hub. See Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/kafka_taxi.py ########## @@ -0,0 +1,87 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +"""An example that writes to and reads from Kafka. + + This example reads from the PubSub NYC Taxi stream described in + https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon, writes to a + given Kafka topic and reads back from the same Kafka topic. + """ + +# pytype: skip-file + +from __future__ import absolute_import + +import argparse +import logging +import typing + +import apache_beam as beam +from apache_beam.io.kafka import ReadFromKafka +from apache_beam.io.kafka import WriteToKafka +from apache_beam.options.pipeline_options import PipelineOptions +from apache_beam.options.pipeline_options import SetupOptions +from apache_beam.options.pipeline_options import StandardOptions + + +def run(argv=None): + """Main entry point; defines and runs the wordcount pipeline.""" + parser = argparse.ArgumentParser() + parser.add_argument( + '--bootstrap_servers', + dest='bootstrap_servers', + required=True, + help='Bootstrap servers for the Kafka cluster. Should be accessible by ' + 'the runner') + parser.add_argument( + '--topic', + dest='topic', + default='kafka_taxirides_realtime', + help='Kafka topic to write to and read from') + known_args, pipeline_args = parser.parse_known_args(argv) + + pipeline_options = PipelineOptions(pipeline_args) + pipeline_options.view_as(SetupOptions).save_main_session = True + pipeline_options.view_as(StandardOptions).streaming = True + + pipeline = beam.Pipeline(options=pipeline_options) + bootstrap_servers = known_args.bootstrap_servers + _ = ( + pipeline + | beam.io.ReadFromPubSub( + topic='projects/pubsub-public-data/topics/taxirides-realtime'). + with_output_types(bytes) + | beam.Map(lambda x: (b'', x)).with_output_types( + typing.Tuple[bytes, bytes]) + | beam.WindowInto(beam.window.FixedWindows(15)) Review comment: Moved to a parameter. Don't think this will be useful as a command line argument. Added a comment with the unit. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 +``` + +## Running the example on latest released Beam version + +Perform Beam runner specific setup. Note that cross-language transforms require +portable implementations of Spark/Flink/Direct runners. Dataflow requires +(runner V2)[https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2] +and Beam 2.22.0 or later. See +[here](https://beam.apache.org/documentation/runners/dataflow/) for +instructions for setting up Dataflow. + +Setup a virtual environment for running Beam Python programs. See +[here](https://beam.apache.org/get-started/quickstart-py/) for prerequisites. +Dataflow requires the `gcp` tag. Assuming your work directory to be +`/path/to/work`. + +```sh +> export WORK_DIRECTORY=/path/to/work +> cd $WORK_DIRECTORY +> mkdir kafka_env +> virtualenv kafka_env +> . kafka_env/bin/activate +> pip install -e .[gcp] +``` + +Run the Beam pipeline. You can either use the default Kafka topic name or +specify a Kafka topic name. Following command assumes Dataflow. See +[here](https://beam.apache.org/get-started/quickstart-py/) for instructions on +running Beam Python programs on other runners. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). + +Note that this exemple is not available in Beam versions before 2.24.0 hence +you'll have to either get the example program from Beam or follow steps +provided in the section *Running the Example from a Beam Git Clone*. + +```sh +> python -m apache_beam.examples.kafkataxi.kafka_taxi --runner DataflowRunner --temp_location <GCS temp location> --project <GCP project> --region <region> \ + --num_workers 1 --job_name <job name> --bootstrap_servers $BOOTSTRAP_SERVER --experiments=use_runner_v2 +``` + +## Running the Example from a Beam Git Clone + +Running this example from a Beam Git clone requires some additional steps. + +Checkout a clone of the Beam Git repo. See +[here](https://beam.apache.org/contribute/) for prerequisites. + +Assume your Github username to be `GITHUB_USERNAME`. + +```sh +> cd $WORK_DIRECTORY Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 +``` + +## Running the example on latest released Beam version + +Perform Beam runner specific setup. Note that cross-language transforms require +portable implementations of Spark/Flink/Direct runners. Dataflow requires +(runner V2)[https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2] +and Beam 2.22.0 or later. See +[here](https://beam.apache.org/documentation/runners/dataflow/) for +instructions for setting up Dataflow. + +Setup a virtual environment for running Beam Python programs. See +[here](https://beam.apache.org/get-started/quickstart-py/) for prerequisites. +Dataflow requires the `gcp` tag. Assuming your work directory to be +`/path/to/work`. + +```sh +> export WORK_DIRECTORY=/path/to/work +> cd $WORK_DIRECTORY +> mkdir kafka_env +> virtualenv kafka_env +> . kafka_env/bin/activate +> pip install -e .[gcp] +``` + +Run the Beam pipeline. You can either use the default Kafka topic name or +specify a Kafka topic name. Following command assumes Dataflow. See +[here](https://beam.apache.org/get-started/quickstart-py/) for instructions on +running Beam Python programs on other runners. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). + +Note that this exemple is not available in Beam versions before 2.24.0 hence +you'll have to either get the example program from Beam or follow steps +provided in the section *Running the Example from a Beam Git Clone*. + +```sh +> python -m apache_beam.examples.kafkataxi.kafka_taxi --runner DataflowRunner --temp_location <GCS temp location> --project <GCP project> --region <region> \ Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 Review comment: Yes, this is geared towards distributed runners though users would be able to run the example with Flink/Spark in local mode as well. I think it's good to not mention local Kafka cluster so that it's not confusing and gives the impression that distributed runners will work with this. Updated. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 +``` + +## Running the example on latest released Beam version + +Perform Beam runner specific setup. Note that cross-language transforms require +portable implementations of Spark/Flink/Direct runners. Dataflow requires +(runner V2)[https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2] Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 +``` + +## Running the example on latest released Beam version + +Perform Beam runner specific setup. Note that cross-language transforms require +portable implementations of Spark/Flink/Direct runners. Dataflow requires +(runner V2)[https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2] +and Beam 2.22.0 or later. See +[here](https://beam.apache.org/documentation/runners/dataflow/) for +instructions for setting up Dataflow. + +Setup a virtual environment for running Beam Python programs. See +[here](https://beam.apache.org/get-started/quickstart-py/) for prerequisites. +Dataflow requires the `gcp` tag. Assuming your work directory to be +`/path/to/work`. + +```sh +> export WORK_DIRECTORY=/path/to/work +> cd $WORK_DIRECTORY +> mkdir kafka_env +> virtualenv kafka_env +> . kafka_env/bin/activate +> pip install -e .[gcp] +``` + +Run the Beam pipeline. You can either use the default Kafka topic name or +specify a Kafka topic name. Following command assumes Dataflow. See +[here](https://beam.apache.org/get-started/quickstart-py/) for instructions on +running Beam Python programs on other runners. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). + +Note that this exemple is not available in Beam versions before 2.24.0 hence +you'll have to either get the example program from Beam or follow steps +provided in the section *Running the Example from a Beam Git Clone*. + +```sh +> python -m apache_beam.examples.kafkataxi.kafka_taxi --runner DataflowRunner --temp_location <GCS temp location> --project <GCP project> --region <region> \ + --num_workers 1 --job_name <job name> --bootstrap_servers $BOOTSTRAP_SERVER --experiments=use_runner_v2 +``` + +## Running the Example from a Beam Git Clone + +Running this example from a Beam Git clone requires some additional steps. + +Checkout a clone of the Beam Git repo. See +[here](https://beam.apache.org/contribute/) for prerequisites. + +Assume your Github username to be `GITHUB_USERNAME`. + +```sh +> cd $WORK_DIRECTORY +> git clone [email protected]:${GITHUB_USERNAME}/beam +> cd beam +``` + +Build IO expansion service jar. + +```sh +> ./gradlew :sdks:java:io:expansion-service:build +``` + +Push a java SDK Harness container to Docker Hub. See +[here](https://beam.apache.org/documentation/runtime/environments/) for +prerequisites and additional information. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). Assume your Docker +repository root to be `<Docker repository root>`. + +```sh +> export DOCKER_ROOT=<Docker repository root> Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/kafka_taxi.py ########## @@ -0,0 +1,87 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +"""An example that writes to and reads from Kafka. + + This example reads from the PubSub NYC Taxi stream described in + https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon, writes to a + given Kafka topic and reads back from the same Kafka topic. + """ + +# pytype: skip-file + +from __future__ import absolute_import + +import argparse +import logging +import typing + +import apache_beam as beam +from apache_beam.io.kafka import ReadFromKafka +from apache_beam.io.kafka import WriteToKafka +from apache_beam.options.pipeline_options import PipelineOptions +from apache_beam.options.pipeline_options import SetupOptions +from apache_beam.options.pipeline_options import StandardOptions + + +def run(argv=None): + """Main entry point; defines and runs the wordcount pipeline.""" + parser = argparse.ArgumentParser() + parser.add_argument( + '--bootstrap_servers', + dest='bootstrap_servers', + required=True, + help='Bootstrap servers for the Kafka cluster. Should be accessible by ' + 'the runner') + parser.add_argument( + '--topic', + dest='topic', + default='kafka_taxirides_realtime', + help='Kafka topic to write to and read from') + known_args, pipeline_args = parser.parse_known_args(argv) + + pipeline_options = PipelineOptions(pipeline_args) + pipeline_options.view_as(SetupOptions).save_main_session = True + pipeline_options.view_as(StandardOptions).streaming = True + + pipeline = beam.Pipeline(options=pipeline_options) Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 +``` + +## Running the example on latest released Beam version + +Perform Beam runner specific setup. Note that cross-language transforms require +portable implementations of Spark/Flink/Direct runners. Dataflow requires +(runner V2)[https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2] +and Beam 2.22.0 or later. See +[here](https://beam.apache.org/documentation/runners/dataflow/) for +instructions for setting up Dataflow. + +Setup a virtual environment for running Beam Python programs. See +[here](https://beam.apache.org/get-started/quickstart-py/) for prerequisites. +Dataflow requires the `gcp` tag. Assuming your work directory to be +`/path/to/work`. + +```sh +> export WORK_DIRECTORY=/path/to/work +> cd $WORK_DIRECTORY +> mkdir kafka_env +> virtualenv kafka_env +> . kafka_env/bin/activate +> pip install -e .[gcp] +``` + +Run the Beam pipeline. You can either use the default Kafka topic name or +specify a Kafka topic name. Following command assumes Dataflow. See +[here](https://beam.apache.org/get-started/quickstart-py/) for instructions on +running Beam Python programs on other runners. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). + +Note that this exemple is not available in Beam versions before 2.24.0 hence +you'll have to either get the example program from Beam or follow steps +provided in the section *Running the Example from a Beam Git Clone*. + +```sh +> python -m apache_beam.examples.kafkataxi.kafka_taxi --runner DataflowRunner --temp_location <GCS temp location> --project <GCP project> --region <region> \ + --num_workers 1 --job_name <job name> --bootstrap_servers $BOOTSTRAP_SERVER --experiments=use_runner_v2 +``` + +## Running the Example from a Beam Git Clone Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/kafka_taxi.py ########## @@ -0,0 +1,87 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +"""An example that writes to and reads from Kafka. + + This example reads from the PubSub NYC Taxi stream described in + https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon, writes to a + given Kafka topic and reads back from the same Kafka topic. + """ + +# pytype: skip-file + +from __future__ import absolute_import + +import argparse +import logging +import typing + +import apache_beam as beam +from apache_beam.io.kafka import ReadFromKafka +from apache_beam.io.kafka import WriteToKafka +from apache_beam.options.pipeline_options import PipelineOptions +from apache_beam.options.pipeline_options import SetupOptions +from apache_beam.options.pipeline_options import StandardOptions + + +def run(argv=None): Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 +``` + +## Running the example on latest released Beam version + +Perform Beam runner specific setup. Note that cross-language transforms require +portable implementations of Spark/Flink/Direct runners. Dataflow requires +(runner V2)[https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2] +and Beam 2.22.0 or later. See +[here](https://beam.apache.org/documentation/runners/dataflow/) for +instructions for setting up Dataflow. + +Setup a virtual environment for running Beam Python programs. See +[here](https://beam.apache.org/get-started/quickstart-py/) for prerequisites. +Dataflow requires the `gcp` tag. Assuming your work directory to be +`/path/to/work`. + +```sh +> export WORK_DIRECTORY=/path/to/work +> cd $WORK_DIRECTORY +> mkdir kafka_env +> virtualenv kafka_env +> . kafka_env/bin/activate +> pip install -e .[gcp] +``` + +Run the Beam pipeline. You can either use the default Kafka topic name or +specify a Kafka topic name. Following command assumes Dataflow. See +[here](https://beam.apache.org/get-started/quickstart-py/) for instructions on +running Beam Python programs on other runners. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). + +Note that this exemple is not available in Beam versions before 2.24.0 hence +you'll have to either get the example program from Beam or follow steps +provided in the section *Running the Example from a Beam Git Clone*. + +```sh +> python -m apache_beam.examples.kafkataxi.kafka_taxi --runner DataflowRunner --temp_location <GCS temp location> --project <GCP project> --region <region> \ + --num_workers 1 --job_name <job name> --bootstrap_servers $BOOTSTRAP_SERVER --experiments=use_runner_v2 +``` + +## Running the Example from a Beam Git Clone + +Running this example from a Beam Git clone requires some additional steps. + +Checkout a clone of the Beam Git repo. See +[here](https://beam.apache.org/contribute/) for prerequisites. + +Assume your Github username to be `GITHUB_USERNAME`. + +```sh +> cd $WORK_DIRECTORY +> git clone [email protected]:${GITHUB_USERNAME}/beam +> cd beam +``` + +Build IO expansion service jar. + +```sh +> ./gradlew :sdks:java:io:expansion-service:build +``` + +Push a java SDK Harness container to Docker Hub. See +[here](https://beam.apache.org/documentation/runtime/environments/) for +prerequisites and additional information. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). Assume your Docker +repository root to be `<Docker repository root>`. + +```sh +> export DOCKER_ROOT=<Docker repository root> +> ./gradlew :sdks:java:container:docker -Pdocker-repository-root=$DOCKER_ROOT -Pdocker-tag=latest +> docker push $DOCKER_ROOT/beam_java_sdk:latest +``` + +For portable Flink/Spark in local mode, instead of above command just build the +Java SDK harness container locally using the default values for repository root +and the docker tag. + +Activate your Python virtual environment. This example uses `virtualenv`. See +[here](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips) for +instructions regarding setting up other types of Python virtual environments. + +```sh +> cd $WORK_DIRECTORY Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 +``` + +## Running the example on latest released Beam version + +Perform Beam runner specific setup. Note that cross-language transforms require +portable implementations of Spark/Flink/Direct runners. Dataflow requires +(runner V2)[https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2] +and Beam 2.22.0 or later. See +[here](https://beam.apache.org/documentation/runners/dataflow/) for +instructions for setting up Dataflow. + +Setup a virtual environment for running Beam Python programs. See +[here](https://beam.apache.org/get-started/quickstart-py/) for prerequisites. +Dataflow requires the `gcp` tag. Assuming your work directory to be +`/path/to/work`. + +```sh +> export WORK_DIRECTORY=/path/to/work +> cd $WORK_DIRECTORY +> mkdir kafka_env +> virtualenv kafka_env +> . kafka_env/bin/activate +> pip install -e .[gcp] +``` + +Run the Beam pipeline. You can either use the default Kafka topic name or +specify a Kafka topic name. Following command assumes Dataflow. See +[here](https://beam.apache.org/get-started/quickstart-py/) for instructions on +running Beam Python programs on other runners. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). + +Note that this exemple is not available in Beam versions before 2.24.0 hence +you'll have to either get the example program from Beam or follow steps +provided in the section *Running the Example from a Beam Git Clone*. + +```sh +> python -m apache_beam.examples.kafkataxi.kafka_taxi --runner DataflowRunner --temp_location <GCS temp location> --project <GCP project> --region <region> \ + --num_workers 1 --job_name <job name> --bootstrap_servers $BOOTSTRAP_SERVER --experiments=use_runner_v2 +``` + +## Running the Example from a Beam Git Clone + +Running this example from a Beam Git clone requires some additional steps. + +Checkout a clone of the Beam Git repo. See +[here](https://beam.apache.org/contribute/) for prerequisites. + +Assume your Github username to be `GITHUB_USERNAME`. + +```sh +> cd $WORK_DIRECTORY +> git clone [email protected]:${GITHUB_USERNAME}/beam +> cd beam +``` + +Build IO expansion service jar. + +```sh +> ./gradlew :sdks:java:io:expansion-service:build +``` + +Push a java SDK Harness container to Docker Hub. See +[here](https://beam.apache.org/documentation/runtime/environments/) for +prerequisites and additional information. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). Assume your Docker +repository root to be `<Docker repository root>`. + +```sh +> export DOCKER_ROOT=<Docker repository root> +> ./gradlew :sdks:java:container:docker -Pdocker-repository-root=$DOCKER_ROOT -Pdocker-tag=latest +> docker push $DOCKER_ROOT/beam_java_sdk:latest +``` + +For portable Flink/Spark in local mode, instead of above command just build the +Java SDK harness container locally using the default values for repository root +and the docker tag. + +Activate your Python virtual environment. This example uses `virtualenv`. See +[here](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips) for +instructions regarding setting up other types of Python virtual environments. + +```sh +> cd $WORK_DIRECTORY +> mkdir kafka_env +> virtualenv kafka_env +> . kafka_env/bin/activate +``` + +Install Beam and dependencies and build a Beam distribution. + +```sh +> cd beam/sdks/python Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/kafka_taxi.py ########## @@ -0,0 +1,87 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +"""An example that writes to and reads from Kafka. + + This example reads from the PubSub NYC Taxi stream described in + https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon, writes to a + given Kafka topic and reads back from the same Kafka topic. + """ + +# pytype: skip-file + +from __future__ import absolute_import + +import argparse +import logging +import typing + +import apache_beam as beam +from apache_beam.io.kafka import ReadFromKafka +from apache_beam.io.kafka import WriteToKafka +from apache_beam.options.pipeline_options import PipelineOptions +from apache_beam.options.pipeline_options import SetupOptions +from apache_beam.options.pipeline_options import StandardOptions + + +def run(argv=None): + """Main entry point; defines and runs the wordcount pipeline.""" + parser = argparse.ArgumentParser() + parser.add_argument( + '--bootstrap_servers', Review comment: I think it's better to keep this as 'bootstrap_servers' since that's well known for any Kafka users. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 +``` + +## Running the example on latest released Beam version + +Perform Beam runner specific setup. Note that cross-language transforms require +portable implementations of Spark/Flink/Direct runners. Dataflow requires +(runner V2)[https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2] +and Beam 2.22.0 or later. See +[here](https://beam.apache.org/documentation/runners/dataflow/) for +instructions for setting up Dataflow. + +Setup a virtual environment for running Beam Python programs. See +[here](https://beam.apache.org/get-started/quickstart-py/) for prerequisites. +Dataflow requires the `gcp` tag. Assuming your work directory to be +`/path/to/work`. + +```sh +> export WORK_DIRECTORY=/path/to/work +> cd $WORK_DIRECTORY +> mkdir kafka_env +> virtualenv kafka_env +> . kafka_env/bin/activate +> pip install -e .[gcp] +``` + +Run the Beam pipeline. You can either use the default Kafka topic name or +specify a Kafka topic name. Following command assumes Dataflow. See +[here](https://beam.apache.org/get-started/quickstart-py/) for instructions on +running Beam Python programs on other runners. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). + +Note that this exemple is not available in Beam versions before 2.24.0 hence +you'll have to either get the example program from Beam or follow steps +provided in the section *Running the Example from a Beam Git Clone*. + +```sh +> python -m apache_beam.examples.kafkataxi.kafka_taxi --runner DataflowRunner --temp_location <GCS temp location> --project <GCP project> --region <region> \ + --num_workers 1 --job_name <job name> --bootstrap_servers $BOOTSTRAP_SERVER --experiments=use_runner_v2 +``` + +## Running the Example from a Beam Git Clone + +Running this example from a Beam Git clone requires some additional steps. + +Checkout a clone of the Beam Git repo. See +[here](https://beam.apache.org/contribute/) for prerequisites. + +Assume your Github username to be `GITHUB_USERNAME`. + +```sh +> cd $WORK_DIRECTORY +> git clone [email protected]:${GITHUB_USERNAME}/beam +> cd beam +``` + +Build IO expansion service jar. + +```sh +> ./gradlew :sdks:java:io:expansion-service:build Review comment: Done. ########## File path: sdks/python/apache_beam/examples/kafkataxi/kafka_taxi.py ########## @@ -0,0 +1,87 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +"""An example that writes to and reads from Kafka. + + This example reads from the PubSub NYC Taxi stream described in + https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon, writes to a + given Kafka topic and reads back from the same Kafka topic. + """ + +# pytype: skip-file + +from __future__ import absolute_import + +import argparse +import logging +import typing + +import apache_beam as beam +from apache_beam.io.kafka import ReadFromKafka +from apache_beam.io.kafka import WriteToKafka +from apache_beam.options.pipeline_options import PipelineOptions +from apache_beam.options.pipeline_options import SetupOptions +from apache_beam.options.pipeline_options import StandardOptions + + +def run(argv=None): + """Main entry point; defines and runs the wordcount pipeline.""" + parser = argparse.ArgumentParser() + parser.add_argument( + '--bootstrap_servers', + dest='bootstrap_servers', + required=True, + help='Bootstrap servers for the Kafka cluster. Should be accessible by ' + 'the runner') + parser.add_argument( + '--topic', + dest='topic', + default='kafka_taxirides_realtime', + help='Kafka topic to write to and read from') + known_args, pipeline_args = parser.parse_known_args(argv) + + pipeline_options = PipelineOptions(pipeline_args) + pipeline_options.view_as(SetupOptions).save_main_session = True + pipeline_options.view_as(StandardOptions).streaming = True + + pipeline = beam.Pipeline(options=pipeline_options) + bootstrap_servers = known_args.bootstrap_servers + _ = ( + pipeline + | beam.io.ReadFromPubSub( + topic='projects/pubsub-public-data/topics/taxirides-realtime'). + with_output_types(bytes) + | beam.Map(lambda x: (b'', x)).with_output_types( + typing.Tuple[bytes, bytes]) + | beam.WindowInto(beam.window.FixedWindows(15)) + | WriteToKafka( + producer_config={'bootstrap.servers': bootstrap_servers}, + topic=known_args.topic)) + + _ = ( + pipeline + | ReadFromKafka( + consumer_config={'bootstrap.servers': bootstrap_servers}, + topics=[known_args.topic]) + | beam.FlatMap(lambda x: [])) Review comment: Updated to parse and print elements. ########## File path: sdks/python/apache_beam/examples/kafkataxi/README.md ########## @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Python KafkaIO Example + +This example reads from the PubSub NYC Taxi stream described +[here](https://github.com/googlecodelabs/cloud-dataflow-nyc-taxi-tycoon), writes +to a given Kafka topic and reads back from the same Kafka topic. This example +uses cross-language transforms available in +[kafka.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/kafka.py). +Transforms are implemented in Java and are available +[here](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java). + +## Prerequisites + +Install Java in your system and make sure that `java` command is available in +the environment. + +```sh +>java --version +> <Should print information regarding the installed Java version> +``` + +## Setup the Kafka cluster + +This example requires users to setup a Kafka cluster that the Beam runner +executing the pipeline has access to. There are few options. + +* For local runners that execute the pipelines in a single computer (for +example, portable DirectRunner or Spark/Flink runners in local mode), you can +setup a local Kafka cluster running in the same computer. +* For Dataflow or portable Spark/Flink in distributed mode, you can setup a Kafka +cluster in GCE. See +[here](https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/dataflow/flex-templates/kafka_to_bigquery) +for step by step instructions for this. + +Let's assume that that IP address of the node running the Kafka cluster to be +`KAFKA_ADDRESS` and the port to be `9092`. + +```sh +> export BOOTSTRAP_SERVER=KAFKA_ADDRESS:9092 +``` + +## Running the example on latest released Beam version + +Perform Beam runner specific setup. Note that cross-language transforms require +portable implementations of Spark/Flink/Direct runners. Dataflow requires +(runner V2)[https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2] +and Beam 2.22.0 or later. See +[here](https://beam.apache.org/documentation/runners/dataflow/) for +instructions for setting up Dataflow. + +Setup a virtual environment for running Beam Python programs. See +[here](https://beam.apache.org/get-started/quickstart-py/) for prerequisites. +Dataflow requires the `gcp` tag. Assuming your work directory to be +`/path/to/work`. + +```sh +> export WORK_DIRECTORY=/path/to/work +> cd $WORK_DIRECTORY +> mkdir kafka_env +> virtualenv kafka_env +> . kafka_env/bin/activate +> pip install -e .[gcp] +``` + +Run the Beam pipeline. You can either use the default Kafka topic name or +specify a Kafka topic name. Following command assumes Dataflow. See +[here](https://beam.apache.org/get-started/quickstart-py/) for instructions on +running Beam Python programs on other runners. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). + +Note that this exemple is not available in Beam versions before 2.24.0 hence +you'll have to either get the example program from Beam or follow steps +provided in the section *Running the Example from a Beam Git Clone*. + +```sh +> python -m apache_beam.examples.kafkataxi.kafka_taxi --runner DataflowRunner --temp_location <GCS temp location> --project <GCP project> --region <region> \ + --num_workers 1 --job_name <job name> --bootstrap_servers $BOOTSTRAP_SERVER --experiments=use_runner_v2 +``` + +## Running the Example from a Beam Git Clone + +Running this example from a Beam Git clone requires some additional steps. + +Checkout a clone of the Beam Git repo. See +[here](https://beam.apache.org/contribute/) for prerequisites. + +Assume your Github username to be `GITHUB_USERNAME`. + +```sh +> cd $WORK_DIRECTORY +> git clone [email protected]:${GITHUB_USERNAME}/beam +> cd beam +``` + +Build IO expansion service jar. + +```sh +> ./gradlew :sdks:java:io:expansion-service:build +``` + +Push a java SDK Harness container to Docker Hub. See +[here](https://beam.apache.org/documentation/runtime/environments/) for +prerequisites and additional information. Note that you have to fill in +information mentioned within angle brackets (`<` and `>`). Assume your Docker +repository root to be `<Docker repository root>`. + +```sh +> export DOCKER_ROOT=<Docker repository root> +> ./gradlew :sdks:java:container:docker -Pdocker-repository-root=$DOCKER_ROOT -Pdocker-tag=latest +> docker push $DOCKER_ROOT/beam_java_sdk:latest +``` + +For portable Flink/Spark in local mode, instead of above command just build the +Java SDK harness container locally using the default values for repository root +and the docker tag. + +Activate your Python virtual environment. This example uses `virtualenv`. See +[here](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips) for +instructions regarding setting up other types of Python virtual environments. + +```sh +> cd $WORK_DIRECTORY +> mkdir kafka_env +> virtualenv kafka_env +> . kafka_env/bin/activate +``` + +Install Beam and dependencies and build a Beam distribution. + +```sh +> cd beam/sdks/python +> pip install -r build-requirements.txt +> pip install -e .[gcp,test] +> python setup.py sdist +``` + +Run the Beam pipeline. You can either use the default Kafka topic name or specify +a Kafka topic name. Following command assumes Dataflow. See +[here](https://beam.apache.org/get-started/quickstart-py/) for instructions on +running Beam Python programs on other runners. + +```sh +> python -m apache_beam.examples.kafkataxi.kafka_taxi --runner DataflowRunner --temp_location <GCS temp location> --project <GCP project> --region <region> \ Review comment: Done. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
