davidcavazos commented on a change in pull request #12188: URL: https://github.com/apache/beam/pull/12188#discussion_r451817171
########## 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: Can we get rid of the initial `>` and the "output"? It makes it trickier to copy-paste the command. ```sh java --version ``` ########## 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: Can we get rid of the `>` as well? For this command example, we could assume it's running locally. Someone not familiar with IP addresses might not know what `KAFKA_ADDRESS` means. We could mention that if you're running it in a distributed environment you'll need to replace the address with its public IP address. ```sh export BOOTSTRAP_SERVER=127.0.0.1:9092 ``` > **[edit]**: after looking below, it looks like this guide's instructions are only written in Dataflow. If that's the case, running Kafka locally won't work since Dataflow needs to reach the Kafka address. Should we take out any mention of running it locally and just assume users will run it in a distributed environment? ########## 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: Can we link to https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=openj9 for installing Java? ########## 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: Do we need anything besides java like maven or gradle? ########## 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: Can we get rid of the `>` from here as well? I would highly suggest breaking this command into separate lines for readability. It would also be a good idea to set variables beforehand so that once they set those variables, they can copy-paste the rest of the command. I would link to the [Dataflow regional endpoints docs](https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) for more information about the `--region`. ```sh PROJECT="$(gcloud config get-value project)" TEMP_LOCATION="gs://MY-BUCKET/temp" REGION="us-central1" JOB_NAME="kafka_taxi-`date +%Y%m%d-%H%M%S`" BOOTSTRAP_SERVER="123.45.67.89:123" python -m apache_beam.examples.kafkataxi.kafka_taxi \ --runner "DataflowRunner" \ --project "$PROJECT" \ --temp_location "$TEMP_LOCATION" \ --region "$REGION" \ --num_workers 1 \ --job_name "$JOB_NAME" \ --bootstrap_servers "$BOOTSTRAP_SERVER" \ --experiments "use_runner_v2" ``` ########## 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: Can we get rid of the `>` from these as well? ########## 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: Typo on link? `(short name)[url]` -> `[url](short name)` ########## 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: I would put an `(Optional)` note at the beginning of the header to be explicit that it's safe to skip this section if they're not interested in running from a git clone. ```md ## *(Optional)* Running the Example from a Beam Git Clone ``` ########## 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: Can we get rid of the `>` from these as well? ########## 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: Can we remove the `>` from here as well? In general, we can assume users will run these commands in their working directory of choice, so I would say we can safely omit the `export WORK_DIRECTORY` and `cd $WORK_DIRECTORY` instructions. ########## 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: Can we get rid of the `>` from these as well? I think it's also safe to skip the `WORK_DIRECTORY` step. ########## 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: Can we link to http://kafka.apache.org/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 +> 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: Same as the previous section ########## 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: As of Python 3, the [recommended way to create virtual environments](https://docs.python.org/3/tutorial/venv.html) is through `venv` which already comes preinstalled with Python. I would also use the more "standard" name `env` for the virtualenv, it's more familiar and a good assumption for most tools. In [`zsh`](https://ohmyz.sh/) using `pip install -e .[gcp]` gets interpreted a little bit different, so it's actually a good idea to surround the `.[gcp]` in quotes. Also, is there any reason to install `-e '.[gcp]'` instead of `-U 'apache-beam[gcp]'`? ```sh python -m venv env source env/bin/activate pip install -e '.[gcp]' ``` ########## 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: Same as the previous section ########## 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: Can we link to the [Docker installation page](https://www.docker.com/get-started) here? Users might not have docker installed. ########## 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: Can we get rid of the `>` from these as well? I would also surround the `.[gcp,test]` in single quotes for `zsh` users. ---------------------------------------------------------------- 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]
