Feat: Add docker image override for connectors in Cloud

[aaronsteers]

This PR aims to add capability of overriding the docker image used by a connector.

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Introduced a new dataclass for managing Docker image overrides for connectors.
  • Added functionality to retrieve and set Docker image overrides for connectors.

• Bug Fixes

  • Enhanced error handling for missing keys and multiple overrides in connector image retrieval.

• Tests

  • Expanded integration tests to cover new functionalities, including testing for valid bearer tokens and connector overrides.

[coderabbitai[bot]]

📝 Walkthrough

📝 Walkthrough

Walkthrough

This pull request introduces enhancements to Airbyte's API utility module, focusing on Docker image override management for connectors. The changes include a new DockerImageOverride dataclass and two key functions: get_connector_image_override and set_actor_override. These additions provide more granular control over connector image configurations, allowing workspace and actor-level overrides. Corresponding integration tests have been added to validate the new functionality, ensuring robust error handling and correct API interactions.

Changes

File	Change Summary
airbyte/_util/api_util.py	- Added DockerImageOverride dataclass - Implemented get_connector_image_override() method - Implemented set_actor_override() method - Enhanced with detailed docstrings
tests/integration_tests/cloud/test_cloud_api_util.py	- Added test_get_bearer_token() test - Added test_check_connector() test - Added test_get_connector_overrides() test - Updated import statements

Sequence Diagram

sequenceDiagram
    participant User
    participant APIUtil
    participant ConfigAPI
    
    User->>APIUtil: get_connector_image_override()
    APIUtil->>ConfigAPI: Request image override
    ConfigAPI-->>APIUtil: Return override details
    APIUtil-->>User: Return DockerImageOverride or None

    User->>APIUtil: set_actor_override()
    APIUtil->>ConfigAPI: Send override configuration
    ConfigAPI-->>APIUtil: Confirm override set

Possibly related PRs

• #562: Modifications to airbyte/_util/api_util.py including the check_connector function, which shares similar API interaction patterns with the new connector override functions.

[!TIP] CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[aaronsteers]

/format-fix