Mark YamlTemplate as GA

Signed-off-by: Jeffrey Kinard <jeff@thekinards.com>
GoogleCloudPlatform · May 7, 2024 · 84517c9 · 84517c9
1 parent 92a6433
commit 84517c9
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 15 deletions.
diff --git a/...ore-plugin/src/main/java/com/google/cloud/teleport/plugin/docs/TemplateDocsGenerator.java b/...ore-plugin/src/main/java/com/google/cloud/teleport/plugin/docs/TemplateDocsGenerator.java
@@ -50,6 +50,13 @@ public static String readmeMarkdown(ImageSpec imageSpec) throws IOException, Tem
     parameters.put("flex", imageSpec.getMetadata().isFlexTemplate());
     parameters.put("statics", BeansWrapper.getDefaultInstance().getStaticModels());
     parameters.put("language", imageSpec.getSdkInfo().getLanguage());
+    parameters.put(
+        "appendTemplate",
+        !imageSpec
+            .getMetadata()
+            .getName()
+            .substring(Math.max(0, imageSpec.getMetadata().getName().length() - 8))
+            .equalsIgnoreCase("template"));
 
     Template template = freemarkerConfig.getTemplate("README-template.md");
 
@@ -78,6 +85,13 @@ public static String siteMarkdown(ImageSpec imageSpec) throws IOException, Templ
     parameters.put("flex", imageSpec.getMetadata().isFlexTemplate());
     parameters.put("statics", BeansWrapper.getDefaultInstance().getStaticModels());
     parameters.put("base_include", "dataflow");
+    parameters.put(
+        "appendTemplate",
+        !imageSpec
+            .getMetadata()
+            .getName()
+            .substring(Math.max(0, imageSpec.getMetadata().getName().length() - 8))
+            .equalsIgnoreCase("template"));
 
     Template template = freemarkerConfig.getTemplate("site-template.md");
 

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
@@ -1,6 +1,6 @@
 <#assign TemplateDocsUtils=statics['com.google.cloud.teleport.plugin.docs.TemplateDocsUtils']>
 
-${spec.metadata.name} template
+${spec.metadata.name}<#if appendTemplate> template</#if>
 ---
 <#list spec.metadata.description?split("\n\n") as paragraph>
 ${TemplateDocsUtils.wrapText(paragraph!?trim, 80, "", false)?ensure_ends_with(".")}
@@ -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!}

diff --git a/plugins/core-plugin/src/main/resources/site-template.md b/plugins/core-plugin/src/main/resources/site-template.md
@@ -2,13 +2,13 @@
 {% extends "${base_include}/_base.html" %}
 {% include "${base_include}/_local_variables.html" %}
 {% include "${base_include}/docs/guides/templates/_provided-templates-vars.html" %}
-{% block page_title %}${TemplateDocsUtils.replaceVariableInterpolationNames(spec.metadata.name)} template{% endblock %}
+{% block page_title %}${TemplateDocsUtils.replaceVariableInterpolationNames(spec.metadata.name)}<#if appendTemplate> template</#if>{% endblock %}
 
 {% block body %}
 
 <section id="${spec.metadata.internalName?lower_case?replace("_", "")}">
 
-{% dynamic setvar launch_name %}the <b>${TemplateDocsUtils.replaceVariableInterpolationNames(spec.metadata.name)}</b> template{% dynamic endsetvar %}
+{% dynamic setvar launch_name %}the <b>${TemplateDocsUtils.replaceVariableInterpolationNames(spec.metadata.name)}</b><#if appendTemplate> template</#if>{% dynamic endsetvar %}
 {% dynamic setvar gcs_template_name %}${spec.metadata.internalName}{% dynamic endsetvar %}
 <#if spec.metadata.preview!false>
 {% dynamic setvar launch_stage %}beta{% dynamic endsetvar %}

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/.
 
 
 
@@ -139,7 +147,7 @@ mvn clean package -PtemplatesRun \
 -DjobName="yaml-template-job" \
 -DtemplateName="Yaml_Template" \
 -Dparameters="yaml_pipeline=$YAML_PIPELINE,yaml_pipeline_file=$YAML_PIPELINE_FILE" \
--f python
+-f v2/python
 ```
 
 ## Terraform

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 Template",
     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,