docs(samples): Add flex template "getting started" sample (GoogleCloudPlatform#10918)

VeronicaWasson · web-flow · commit 169352670726 · 2023-11-17T11:29:06.000-06:00
diff --git a/dataflow/flex-templates/getting_started/README.md b/dataflow/flex-templates/getting_started/README.md
@@ -0,0 +1,54 @@
+# Dataflow flex template: Getting started sample
+
+## Before you begin
+
+Make sure you have followed the
+[Dataflow setup instructions](../../README.md).
+
+## Create a Cloud Storage bucket
+
+```sh
+export BUCKET="your--bucket"
+gsutil mb gs://$BUCKET
+```
+
+## create an Artifact Registry repository
+
+```sh
+export REGION="us-central1"
+export REPOSITORY="your-repository"
+
+gcloud artifacts repositories create $REPOSITORY \
+    --repository-format=docker \
+    --location=$REGION
+```
+
+## Build the template
+
+```sh
+export PROJECT="project-id"
+
+gcloud dataflow flex-template build gs://$BUCKET/getting_started_py.json \
+    --image-gcr-path "$REGION-docker.pkg.dev/$PROJECT/$REPOSITORY/getting-started-py:latest" \
+    --sdk-language "PYTHON" \
+    --flex-template-base-image "PYTHON3" \
+    --py-path "." \
+    --metadata-file "metadata.json" \
+    --env "FLEX_TEMPLATE_PYTHON_PY_FILE=getting_started.py" \
+    --env "FLEX_TEMPLATE_PYTHON_REQUIREMENTS_FILE=requirements.txt"
+```
+
+## Run the template
+
+```sh
+gcloud dataflow flex-template run "flex-`date +%Y%m%d-%H%M%S`" \
+    --template-file-gcs-location "gs://$BUCKET/getting_started_py.json" \
+    --region $REGION \
+    --parameters output="gs://$BUCKET/output-"
+```
+
+## What's next?
+
+For more information about building and running flex templates, see
+📝 [Use Flex Templates](https://cloud.google.com/dataflow/docs/guides/templates/using-flex-templates).
+
diff --git a/dataflow/flex-templates/getting_started/getting_started.py b/dataflow/flex-templates/getting_started/getting_started.py
@@ -0,0 +1,41 @@
+#!/usr/bin/env python
+#  Copyright 2023 Google LLC
+#
+#  Licensed 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.
+
+import apache_beam as beam
+from apache_beam.io.textio import WriteToText
+from apache_beam.options.pipeline_options import PipelineOptions
+
+
+def write_to_cloud_storage(argv=None):
+    # Parse the pipeline options passed into the application.
+    class MyOptions(PipelineOptions):
+        @classmethod
+        # Define a custom pipeline option that specfies the Cloud Storage bucket.
+        def _add_argparse_args(cls, parser):
+            parser.add_argument("--output", required=True)
+
+    wordsList = ["1", "2", "3", "4"]
+    options = MyOptions()
+
+    with beam.Pipeline(options=options) as pipeline:
+        (
+            pipeline
+            | "Create elements" >> beam.Create(wordsList)
+            | "Write Files" >> WriteToText(options.output, file_name_suffix=".txt")
+        )
+
+
+if __name__ == "__main__":
+    write_to_cloud_storage()
diff --git a/dataflow/flex-templates/getting_started/metadata.json b/dataflow/flex-templates/getting_started/metadata.json
@@ -0,0 +1,14 @@
+{
+  "name": "Getting started Python flex template",
+  "description": "An example flex template for Python.",
+  "parameters": [
+    {
+      "name": "output",
+      "label": "Output destination",
+      "helpText": "The path and filename prefix for writing output files. Example: gs://your-bucket/your-path",
+      "regexes": [
+        "^gs:\\/\\/[^\\n\\r]+$"
+      ]
+    }
+  ]
+}
diff --git a/dataflow/flex-templates/getting_started/requirements.txt b/dataflow/flex-templates/getting_started/requirements.txt
@@ -0,0 +1 @@
+apache-beam[gcp]==2.48.0
