consolidate union templates into single one

Signed-off-by: Peeter Piegaze <[email protected]>
flyteorg · Jul 4, 2024 · 5932327 · 5932327
1 parent ee51f82
commit 5932327
Show file tree

Hide file tree

Showing 15 changed files with 21 additions and 318 deletions.
diff --git a/basic-union-byoc-template/cookiecutter.json b/basic-union-byoc-template/cookiecutter.json
diff --git a/basic-union-byoc-template/{{cookiecutter.project_name}}/README.md b/basic-union-byoc-template/{{cookiecutter.project_name}}/README.md
diff --git a/basic-union-byoc-template/{{cookiecutter.project_name}}/requirements.txt b/basic-union-byoc-template/{{cookiecutter.project_name}}/requirements.txt
diff --git a/basic-union-serverless-template/cookiecutter.json b/basic-union-serverless-template/cookiecutter.json
diff --git a/basic-union-serverless-template/{{cookiecutter.project_name}}/LICENSE b/basic-union-serverless-template/{{cookiecutter.project_name}}/LICENSE
diff --git a/basic-union-serverless-template/{{cookiecutter.project_name}}/README.md b/basic-union-serverless-template/{{cookiecutter.project_name}}/README.md
diff --git a/basic-union-serverless-template/{{cookiecutter.project_name}}/requirements.txt b/basic-union-serverless-template/{{cookiecutter.project_name}}/requirements.txt
diff --git a/basic-union-serverless-template/{{cookiecutter.project_name}}/workflows/__init__.py b/basic-union-serverless-template/{{cookiecutter.project_name}}/workflows/__init__.py
diff --git a/basic-union-serverless-template/{{cookiecutter.project_name}}/workflows/example.py b/basic-union-serverless-template/{{cookiecutter.project_name}}/workflows/example.py
diff --git a/basic-union-template/cookiecutter.json b/basic-union-template/cookiecutter.json
@@ -0,0 +1,3 @@
+{
+    "project_name": "Basic Union template"
+}
diff --git a/...ate/{{cookiecutter.project_name}}/LICENSE → ...ate/{{cookiecutter.project_name}}/LICENSE b/...ate/{{cookiecutter.project_name}}/LICENSE → ...ate/{{cookiecutter.project_name}}/LICENSE
diff --git a/basic-union-template/{{cookiecutter.project_name}}/README.md b/basic-union-template/{{cookiecutter.project_name}}/README.md
@@ -0,0 +1,3 @@
+# {{ cookiecutter.project_name }}
+
+A basic code template for Union.
diff --git a/basic-union-template/{{cookiecutter.project_name}}/requirements.txt b/basic-union-template/{{cookiecutter.project_name}}/requirements.txt
@@ -0,0 +1 @@
+unionai
diff --git a/...tter.project_name}}/workflows/__init__.py → ...tter.project_name}}/workflows/__init__.py b/...tter.project_name}}/workflows/__init__.py → ...tter.project_name}}/workflows/__init__.py
diff --git a/...utter.project_name}}/workflows/example.py → ...utter.project_name}}/workflows/example.py b/...utter.project_name}}/workflows/example.py → ...utter.project_name}}/workflows/example.py
@@ -1,12 +1,12 @@
-"""Basic Union BYOC workflow template."""
+"""Basic Union workflow template."""
 
 from unionai import task, workflow, ImageSpec
 
 # ImageSpec defines the container image used for the Kubernetes pods that run the tasks in Union.
 image_spec = ImageSpec(
 
     # The name of the image
-    name="basic-union-byoc-image",
+    name="basic-union-image",
 
     # The base image on which this image is based
     base_image="ghcr.io/flyteorg/flytekit:py3.11-latest",
@@ -15,16 +15,23 @@
     requirements="requirements.txt",
 
     # Container registry to which the image will be pushed.
+    #
+    # ON UNION BYOC UNCOMMENT THIS PARAMETER!
+    #
     # Make sure that:
+    #
     # * You subsitutue the actual name of the registry here.
-    #   If you are using GHCR, substitute <my-github-org> with your github org name.
-    # * You have Docker installed locally and are logged into this registry.
+    #   (for example if you are using GitHub's GHCR, you would
+    #   use "https://ghcr.io/<your-github-org>").
+    #
+    # * You have Docker installed locally and are logged into the registry.
+    #
     # * The image, once pushed to the registry, is accessible to Union
     #   (for example, for GHCR, make sure the image is public)
     #
-    # Only needed for BYOC.
-    # On Serverless, images are stored in Union's own container registry.
-    registry="ghcr.io/<my-github-org>"
+    # This parameter is only needed for BYOC. On Serverless, images are stored
+    # transparently in Union's own container registry.
+    # registry="<my-registry>"
 
     # Python version of the image. Use default python in the base image if None.
     # python_version="3.11"