From 5932327350f7ec12bc9151621fb640931cc93240 Mon Sep 17 00:00:00 2001 From: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com> Date: Thu, 4 Jul 2024 17:40:57 +0200 Subject: [PATCH] consolidate union templates into single one Signed-off-by: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com> --- basic-union-byoc-template/cookiecutter.json | 3 - .../{{cookiecutter.project_name}}/README.md | 3 - .../requirements.txt | 2 - .../cookiecutter.json | 3 - .../{{cookiecutter.project_name}}/LICENSE | 201 ------------------ .../{{cookiecutter.project_name}}/README.md | 3 - .../requirements.txt | 1 - .../workflows/__init__.py | 0 .../workflows/example.py | 95 --------- basic-union-template/cookiecutter.json | 3 + .../{{cookiecutter.project_name}}/LICENSE | 0 .../{{cookiecutter.project_name}}/README.md | 3 + .../requirements.txt | 1 + .../workflows/__init__.py | 0 .../workflows/example.py | 21 +- 15 files changed, 21 insertions(+), 318 deletions(-) delete mode 100644 basic-union-byoc-template/cookiecutter.json delete mode 100644 basic-union-byoc-template/{{cookiecutter.project_name}}/README.md delete mode 100644 basic-union-byoc-template/{{cookiecutter.project_name}}/requirements.txt delete mode 100644 basic-union-serverless-template/cookiecutter.json delete mode 100644 basic-union-serverless-template/{{cookiecutter.project_name}}/LICENSE delete mode 100644 basic-union-serverless-template/{{cookiecutter.project_name}}/README.md delete mode 100644 basic-union-serverless-template/{{cookiecutter.project_name}}/requirements.txt delete mode 100644 basic-union-serverless-template/{{cookiecutter.project_name}}/workflows/__init__.py delete mode 100644 basic-union-serverless-template/{{cookiecutter.project_name}}/workflows/example.py create mode 100644 basic-union-template/cookiecutter.json rename {basic-union-byoc-template => basic-union-template}/{{cookiecutter.project_name}}/LICENSE (100%) create mode 100644 basic-union-template/{{cookiecutter.project_name}}/README.md create mode 100644 basic-union-template/{{cookiecutter.project_name}}/requirements.txt rename {basic-union-byoc-template => basic-union-template}/{{cookiecutter.project_name}}/workflows/__init__.py (100%) rename {basic-union-byoc-template => basic-union-template}/{{cookiecutter.project_name}}/workflows/example.py (86%) diff --git a/basic-union-byoc-template/cookiecutter.json b/basic-union-byoc-template/cookiecutter.json deleted file mode 100644 index 56835c5..0000000 --- a/basic-union-byoc-template/cookiecutter.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "project_name": "Basic Union BYOC template" -} diff --git a/basic-union-byoc-template/{{cookiecutter.project_name}}/README.md b/basic-union-byoc-template/{{cookiecutter.project_name}}/README.md deleted file mode 100644 index ef5ce7d..0000000 --- a/basic-union-byoc-template/{{cookiecutter.project_name}}/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# {{ cookiecutter.project_name }} - -A basic code template for Union BYOC. diff --git a/basic-union-byoc-template/{{cookiecutter.project_name}}/requirements.txt b/basic-union-byoc-template/{{cookiecutter.project_name}}/requirements.txt deleted file mode 100644 index ccbf6b8..0000000 --- a/basic-union-byoc-template/{{cookiecutter.project_name}}/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -unionai -flytekitplugins-envd diff --git a/basic-union-serverless-template/cookiecutter.json b/basic-union-serverless-template/cookiecutter.json deleted file mode 100644 index 0b3d07d..0000000 --- a/basic-union-serverless-template/cookiecutter.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "project_name": "Basic Union Serverless template" -} diff --git a/basic-union-serverless-template/{{cookiecutter.project_name}}/LICENSE b/basic-union-serverless-template/{{cookiecutter.project_name}}/LICENSE deleted file mode 100644 index f49a4e1..0000000 --- a/basic-union-serverless-template/{{cookiecutter.project_name}}/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - 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. \ No newline at end of file diff --git a/basic-union-serverless-template/{{cookiecutter.project_name}}/README.md b/basic-union-serverless-template/{{cookiecutter.project_name}}/README.md deleted file mode 100644 index 2c36a44..0000000 --- a/basic-union-serverless-template/{{cookiecutter.project_name}}/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# {{ cookiecutter.project_name }} - -A basic code template for Union Serverless. \ No newline at end of file diff --git a/basic-union-serverless-template/{{cookiecutter.project_name}}/requirements.txt b/basic-union-serverless-template/{{cookiecutter.project_name}}/requirements.txt deleted file mode 100644 index 85ab7d2..0000000 --- a/basic-union-serverless-template/{{cookiecutter.project_name}}/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -unionai \ No newline at end of file diff --git a/basic-union-serverless-template/{{cookiecutter.project_name}}/workflows/__init__.py b/basic-union-serverless-template/{{cookiecutter.project_name}}/workflows/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/basic-union-serverless-template/{{cookiecutter.project_name}}/workflows/example.py b/basic-union-serverless-template/{{cookiecutter.project_name}}/workflows/example.py deleted file mode 100644 index 9c720ea..0000000 --- a/basic-union-serverless-template/{{cookiecutter.project_name}}/workflows/example.py +++ /dev/null @@ -1,95 +0,0 @@ -"""Basic Union Serverless workflow template.""" - -from unionai import task, workflow, ImageSpec - -image_spec = ImageSpec( - - # The name of the image - name="basic-union-serverless-image", - - # The base image on which this image is based - base_image="ghcr.io/flyteorg/flytekit:py3.11-latest", - - # Use the requirements.txt to define the packages to be installed in the the image - requirements="requirements.txt", - - # Container registry to which the image will be pushed. - # Make sure that: - # * You subsitutue the actual name of the registry here. - # If you are using GHCR, substitute with your github org name. - # * You have Docker installed locally and are logged into this 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/" - - # Python version of the image. Use default python in the base image if None. - # python_version="3.11" - - # Plugin used to build the image locally. - # Uses flytekitplugin_envd by default. - # - # Only applies to BYOC. - # On Serverless, Images are built by Union's ImageBuilder service. - # builder="flytekitplugins_envd" - - # Source root of the image. - # source_root="/path/to/source/root" - - # Environment variables to be set in the image. - # env=[FOO="foo", BAR="bar"] - - # List of python packages to install. - # packages=["package-1", "package-2"] - - # List of conda packages to install. - # conda_packages=["package-1", "package-2"] - - # List of conda channels. - # conda_channels=["channel-1", "channel-2"] - - # List of apt packages to install. - # apt_packages=["package-1", "package-2"] - - # Version of cuda to install. - # cuda="12.5" - - # Version of cudnn to install. - # cudnn="9.2.0" - - # Target platforms for the build output - # (for example: windows/amd64, linux/amd64, darwin/arm64) - # platform=["linux/amd64"] - - # Custom pip index url - # pip_index="https://my-pypi.mywebsite.com/simple" - - # One or more pip index urls as a list - # pip_extra_index_url=["https://my-pypi.mywebsite.com/simple", "https://my-other-pypi.mywebsite.com/simple"] - - # Path to a JSON registry config file - # registry_config ="/path/to/registry/config.json" - - # Commands to run during the build process - # commands= ["pip install -r requirements.txt"] - - # Custom string format for image tag. The ImageSpec hash is passed in as `spec_hash`. - # So, for example, to add a "dev" suffix to the image tag use: - # tag_format = "{spec_hash}-dev" - - - - -) - -@task(container_image=image_spec) -def say_hello(name: str) -> str: - return f"Hello, {name}!" - - -@workflow -def wf(name: str = "world") -> str: - greeting = say_hello(name=name) - return greeting diff --git a/basic-union-template/cookiecutter.json b/basic-union-template/cookiecutter.json new file mode 100644 index 0000000..afefec8 --- /dev/null +++ b/basic-union-template/cookiecutter.json @@ -0,0 +1,3 @@ +{ + "project_name": "Basic Union template" +} diff --git a/basic-union-byoc-template/{{cookiecutter.project_name}}/LICENSE b/basic-union-template/{{cookiecutter.project_name}}/LICENSE similarity index 100% rename from basic-union-byoc-template/{{cookiecutter.project_name}}/LICENSE rename to basic-union-template/{{cookiecutter.project_name}}/LICENSE diff --git a/basic-union-template/{{cookiecutter.project_name}}/README.md b/basic-union-template/{{cookiecutter.project_name}}/README.md new file mode 100644 index 0000000..0ddf06f --- /dev/null +++ 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 new file mode 100644 index 0000000..cc7b8d5 --- /dev/null +++ b/basic-union-template/{{cookiecutter.project_name}}/requirements.txt @@ -0,0 +1 @@ +unionai diff --git a/basic-union-byoc-template/{{cookiecutter.project_name}}/workflows/__init__.py b/basic-union-template/{{cookiecutter.project_name}}/workflows/__init__.py similarity index 100% rename from basic-union-byoc-template/{{cookiecutter.project_name}}/workflows/__init__.py rename to basic-union-template/{{cookiecutter.project_name}}/workflows/__init__.py diff --git a/basic-union-byoc-template/{{cookiecutter.project_name}}/workflows/example.py b/basic-union-template/{{cookiecutter.project_name}}/workflows/example.py similarity index 86% rename from basic-union-byoc-template/{{cookiecutter.project_name}}/workflows/example.py rename to basic-union-template/{{cookiecutter.project_name}}/workflows/example.py index 9006e54..a81daa6 100644 --- a/basic-union-byoc-template/{{cookiecutter.project_name}}/workflows/example.py +++ b/basic-union-template/{{cookiecutter.project_name}}/workflows/example.py @@ -1,4 +1,4 @@ -"""Basic Union BYOC workflow template.""" +"""Basic Union workflow template.""" from unionai import task, workflow, ImageSpec @@ -6,7 +6,7 @@ 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 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/"). + # + # * 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/" + # This parameter is only needed for BYOC. On Serverless, images are stored + # transparently in Union's own container registry. + # registry="" # Python version of the image. Use default python in the base image if None. # python_version="3.11"