Merge pull request #1531 from Polber:jkinard/yaml-docs

PiperOrigin-RevId: 636651447
GoogleCloudPlatform · May 23, 2024 · b20548c · b20548c
2 parents 5c8b086 + a96e8bc
commit b20548c
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 12 deletions.
diff --git a/...core-plugin/src/main/java/com/google/cloud/teleport/plugin/model/TemplateDefinitions.java b/...core-plugin/src/main/java/com/google/cloud/teleport/plugin/model/TemplateDefinitions.java
@@ -160,9 +160,7 @@ public ImageSpec buildSpecModel(boolean validateFlag) {
                         block.name(), Arrays.asList(block.content())))
             .collect(Collectors.toList()));
 
-    if (templateAnnotation.type().equals(TemplateType.YAML)) {
-      metadata.setMainClass("");
-    } else if (templateAnnotation.placeholderClass() != null
+    if (templateAnnotation.placeholderClass() != null
         && templateAnnotation.placeholderClass() != void.class) {
       metadata.setMainClass(templateAnnotation.placeholderClass().getName());
     } else {

diff --git a/plugins/core-plugin/src/main/resources/README-template.md b/plugins/core-plugin/src/main/resources/README-template.md
@@ -95,7 +95,7 @@ mvn clean package -PtemplatesStage  \
 -DbucketName="$BUCKET_NAME" \
 -DstagePrefix="templates" \
 -DtemplateName="${spec.metadata.internalName}" \
-<#if language == 'PYTHON'>
+<#if language == 'PYTHON' || language == 'YAML'>
 -f python
 <#elseif flex>
 -f v2/${spec.metadata.module!}
@@ -196,7 +196,7 @@ mvn clean package -PtemplatesRun \
 -DjobName="${spec.metadata.internalName?lower_case?replace("_", "-")}-job" \
 -DtemplateName="${spec.metadata.internalName}" \
 -Dparameters="<#list spec.metadata.parameters as parameter>${parameter.name}=$${parameter.name?replace('([a-z])([A-Z])', '$1_$2', 'r')?upper_case?replace("-", "_")}<#sep>,</#sep></#list>" \
-<#if language == 'PYTHON'>
+<#if language == 'PYTHON' || language == 'YAML'>
 -f python
 <#elseif flex>
 -f v2/${spec.metadata.module!}

diff --git a/python/README_Yaml_Template.md b/python/README_Yaml_Template.md
@@ -1,8 +1,16 @@
 
-YAML Template (Experimental) template
+YAML Template
 ---
-YAML pipeline. Reads YAML from Cloud Storage and dynamically expands YAML into
-Beam pipeline graph.
+The YAML Template is used to run Dataflow pipelines written in Beam YAML. The
+YAML pipeline can be passed to the template directly as a raw string or the
+location of a Beam YAML pipeline file stored in Google Cloud Storage can
+optionally be passed.
+
+For launching a Beam YAML pipeline directly from the gcloud command line, see
+https://cloud.google.com/sdk/gcloud/reference/dataflow/yaml.
+
+For more information on Beam YAML, see
+https://beam.apache.org/documentation/sdks/yaml/.
 
 
 

diff --git a/python/src/main/java/com/google/cloud/teleport/templates/python/YAMLTemplate.java b/python/src/main/java/com/google/cloud/teleport/templates/python/YAMLTemplate.java
@@ -24,12 +24,21 @@
     name = "Yaml_Template",
     category = TemplateCategory.GET_STARTED,
     type = Template.TemplateType.YAML,
-    displayName = "YAML Template (Experimental)",
+    displayName = "YAML",
     description =
-        "YAML pipeline. Reads YAML from Cloud Storage and dynamically expands YAML into "
-            + "Beam pipeline graph.",
+        "The YAML Template is used to run Dataflow pipelines written in Beam YAML. "
+            + "The YAML pipeline can be passed to the template directly as a raw string or the location "
+            + "of a Beam YAML pipeline file stored in Google Cloud Storage can optionally be passed."
+            + "\n\n"
+            + "For launching a Beam YAML pipeline directly from the gcloud command line, see "
+            + "https://cloud.google.com/sdk/gcloud/reference/dataflow/yaml"
+            + "\n\n"
+            + "For more information on Beam YAML, see https://beam.apache.org/documentation/sdks/yaml/",
     flexContainerName = "yaml-template",
-    contactInformation = "https://cloud.google.com/support")
+    contactInformation = "https://cloud.google.com/support",
+    requirements = {
+      "A valid Beam YAML pipeline.",
+    })
 public interface YAMLTemplate {
   @TemplateParameter.Text(
       order = 1,