Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds docstrings for pod task #1153

Merged
merged 4 commits into from
Sep 15, 2022
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions plugins/flytekit-k8s-pod/flytekitplugins/pod/task.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ def _sanitize_resource_name(resource: _task_models.Resources.ResourceEntry) -> s


class Pod(object):
"""
Pod is a platform-wide configuration that uses pod templates. By default, every task is launched as a container in a pod.
This plugin helps expose a fully modifiable Kubernetes pod spec to customize the task execution runtime.
pingsutw marked this conversation as resolved.
Show resolved Hide resolved
To use pod tasks:
1. Define a pod spec;
2. Specify the primary container name.
pingsutw marked this conversation as resolved.
Show resolved Hide resolved
"""

def __init__(
self,
pod_spec: V1PodSpec,
Expand Down