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

[WIP] Rename container_image to image for improved UX #3094

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JiangJiaWei1103
Copy link
Contributor

@JiangJiaWei1103 JiangJiaWei1103 commented Jan 25, 2025

Tracking issue

flyteorg/flyte#6140

Why are the changes needed?

To enhance the user experience, the concept of container should be abstracted from flytekit users.

What changes were proposed in this pull request?

At this early stage, we propose to focus on the user-facing codebase and support both image and container_image for backward compatibility. There exist three cases:

  1. Both image and container_image are specified: Raise an error
  2. container_image is used: Warn users about the future deprecation
  3. image is used: Use image directly

In the future, we can revisit whether modifying the developer-facing code is beneficial when it becomes more relevant.

How was this patch tested?

Setup process

Screenshots

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Docs link

1. Support both `image` and `container_image` for backward compatibility
2. Modify the core decorator used for any task type
    * We focus on the user-facing inteface

Signed-off-by: JiangJiaWei1103 <[email protected]>
@flyte-bot
Copy link
Contributor

Code Review Agent Run Status

  • Limitations and other issues: ❌ Failure - The AI Code Review Agent skipped reviewing this change because it is configured to exclude certain pull requests based on the source/target branch or the pull request status. You can change the settings here, or contact the agent instance creator at [email protected].

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In progress
Development

Successfully merging this pull request may close these issues.

2 participants