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

Failover to OCI when push fails with default push mechanism #476

Merged
merged 1 commit into from
Nov 21, 2024

Conversation

rhatdan
Copy link
Member

@rhatdan rhatdan commented Nov 20, 2024

Summary by Sourcery

Enhancements:

  • Implement failover mechanism to OCI when the default push mechanism fails.

Copy link
Contributor

sourcery-ai bot commented Nov 20, 2024

Reviewer's Guide by Sourcery

This PR implements a failover mechanism in the push operation. When the default push mechanism fails with a KeyError, the system attempts to push the model as a container image using OCI (Open Container Initiative) format. This provides a fallback option for handling push operations when the primary method fails.

Sequence diagram for failover mechanism in push operation

sequenceDiagram
    participant User
    participant CLI
    participant NewModel
    participant OCIModel

    User->>CLI: push_cli(args)
    CLI->>NewModel: New(tgt, args)
    NewModel->>NewModel: push(source, args)
    alt Push succeeds
        NewModel-->>CLI: Success
    else Push fails with KeyError
        CLI->>OCIModel: OCI(model, config)
        OCIModel->>OCIModel: push(args)
        alt OCI Push succeeds
            OCIModel-->>CLI: Success
        else OCI Push fails
            OCIModel-->>CLI: Raise KeyError
        end
    end
Loading

File-Level Changes

Change Details Files
Added error handling and failover logic for push operations
  • Wrapped the original push operation in a try-except block
  • Added fallback logic to attempt pushing as OCI container image when default push fails
  • Implemented model type checking before attempting OCI fallback
  • Added container manager configuration support for OCI push
ramalama/cli.py
Code cleanup in model class
  • Removed unnecessary blank line in remove method
ramalama/model.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @rhatdan - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding logging when falling back to OCI push to make it clear to users when this occurs
  • The error handling could be improved - catching a broad Exception and re-raising the original KeyError could mask important errors. Consider handling specific exceptions and providing more informative error messages
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

if model.startswith(mtype + "://"):
raise e
try:
# attempt to push as a container image
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Consider adding logging or user feedback when falling back to container image handling for better debugging experience.

Suggested change
# attempt to push as a container image
logger.info("Falling back to container image handling for model push")
# attempt to push as a container image

@rhatdan rhatdan merged commit 68ab492 into containers:main Nov 21, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants