Skip to content

Commit

Permalink
Deprecation notice for pod plugin (#2698)
Browse files Browse the repository at this point in the history
Signed-off-by: Yee Hing Tong <wild-endeavor@users.noreply.github.com>
Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>
  • Loading branch information
wild-endeavor authored Aug 21, 2024
1 parent e28c8bf commit 184bce7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
6 changes: 6 additions & 0 deletions plugins/flytekit-k8s-pod/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Flytekit Kubernetes Pod Plugin

> [!IMPORTANT]
> This plugin is no longer needed and is here only for backwards compatibility. No new versions will be published after v1.13.x
> Please use the `pod_template` and `pod_template_name` args to `@task` as described in https://docs.flyte.org/en/latest/deployment/configuration/general.html#configuring-task-pods-with-k8s-podtemplates
> instead.

By default, Flyte tasks decorated with `@task` are essentially single functions that are loaded in one container. But often, there is a need to run a job with more than one container.

In this case, a regular task is not enough. Hence, Flyte provides a Kubernetes pod abstraction to execute multiple containers, which can be accomplished using Pod's `task_config`. The `task_config` can be leveraged to fully customize the pod spec used to run the task.
Expand Down
10 changes: 9 additions & 1 deletion plugins/flytekit-k8s-pod/flytekitplugins/pod/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
import warnings

from .task import Pod

"""
.. currentmodule:: flytekitplugins.pod
Expand All @@ -10,4 +14,8 @@
Pod
"""

from .task import Pod
warnings.warn(
"This pod plugin is no longer necessary, please use the pod_template and pod_template_name options to @task as described "
"in https://docs.flyte.org/en/latest/deployment/configuration/general.html#configuring-task-pods-with-k8s-podtemplates",
FutureWarning,
)

0 comments on commit 184bce7

Please sign in to comment.