Feat: Added `use_host_network` param to `get_source()`, for Docker containers to use host's network by niyasrad · Pull Request #277 · airbytehq/PyAirbyte

Niyas Hameed (niyasrad) · 2024-06-20T13:56:11Z

What

Adding the use_host_network param so that the DockerExecutor can run the containers with access to host's network.

Why

I've been excited ever since the announcement of the DockerExecutor experimental feature, since i wanted to run all the Java connectors and test them out when i have time.

I started out with PostgreSQL. I gave it my local postgres configuration and also tried the PUBLIC RNA postgres. But it failed to connect, and gave me the following error:

airbyte.exceptions.AirbyteConnectorCheckFailedError: AirbyteConnectorCheckFailedError: Connector check failed.
    Failure Reason: 'Message: HikariPool-1 - Connection is not available, request timed out after 10002ms (total=0, active=0, idle=0, waiting=0)'
More info: https://docs.airbyte.com/integrations/sources/postgres

I made a change over the get_source() function and it worked flawlessly afterwards.

How

Added a use_host_network in get_source() as a parameter to control whether the Docker container should use the host network.
Updated the DockerExecutor configuration to conditionally include the --network host option in the Docker run command.

Summary by CodeRabbit

New Features
- Introduced an option to run connectors using the host network for accessing local resources, enhancing connectivity for specific use cases.

coderabbitai · 2024-06-20T13:56:17Z

Walkthrough

The _get_source() function in airbyte/sources/util.py has been enhanced with a new use_host_network parameter. By setting use_host_network to True, the connector runs using the host network, which is beneficial for accessing local resources such as databases.

Changes

File Path	Change Summary
`airbyte/sources/util.py`	Added `use_host_network` parameter to `_get_source` function to allow connectors to use host network when needed.

Sequence Diagram(s)

New Flow with `use_host_network`

sequenceDiagram
    participant User
    participant _get_source
    participant Docker
    User->>_get_source: Call _get_source(docker_image, use_host_network=True, ...)
    _get_source->>Docker: Execute container using host network
    Docker->>_get_source: Container running with host network
    _get_source->>User: Return source instance

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

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Aaron ("AJ") Steers (aaronsteers)

This looks great, Niyas Hameed (@niyasrad)!

Thank you for this contribution. Any reason we should not merge as-is (assuming tests and lint checks pass)?

Since you already adding the description to the docstring, related docs will be updated automatically. 🙏

Aaron ("AJ") Steers (aaronsteers) · 2024-06-20T16:48:04Z

CodeRabbit (@coderabbitai) review

coderabbitai · 2024-06-20T16:48:08Z

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4de5793 and b2754eb.

Files selected for processing (1)

airbyte/sources/util.py (3 hunks)

Files not reviewed due to errors (1)

airbyte/sources/util.py (no review received)

Niyas Hameed (niyasrad) · 2024-06-20T16:58:01Z

Thank you for this contribution. Any reason we should not merge as-is (assuming tests and lint checks pass)?

Aaron ("AJ") Steers (@aaronsteers)
I have tested the use-cases, and all conditions with the code that I have submitted.

You can merge as-is if the tests pass, and update the experimental version! I'm excited to use it further 😆

Aaron ("AJ") Steers (aaronsteers) · 2024-06-21T01:32:21Z

/test-pr

PR test job started... Check job output.

✅ Tests passed.

Aaron ("AJ") Steers (aaronsteers) · 2024-06-21T01:50:32Z

Tests passing! Ready to merge! Thanks Niyas Hameed (@niyasrad), for this contribution!

Aaron ("AJ") Steers (aaronsteers)

Looks great! ✅

feat(docker): added use_host_network param to get_source

b2754eb

Niyas Hameed (niyasrad) force-pushed the network-host branch from 6be5e06 to b2754eb Compare June 20, 2024 14:01

Aaron ("AJ") Steers (aaronsteers) approved these changes Jun 20, 2024

View reviewed changes

Aaron ("AJ") Steers (aaronsteers) added the enable-ai-review label Jun 20, 2024

This comment was marked as outdated.

Sign in to view

coderabbitai Bot reviewed Jun 20, 2024

View reviewed changes

coderabbitai Bot approved these changes Jun 20, 2024

View reviewed changes

Merge branch 'main' into network-host

3a9e3bc

Aaron ("AJ") Steers (aaronsteers) approved these changes Jun 21, 2024

View reviewed changes

Aaron ("AJ") Steers (aaronsteers) merged commit 37b50db into airbytehq:main Jun 21, 2024

This was referenced Sep 16, 2024

Feat: Add use_host_network param to get_destination() #363

Closed

Feat: Added use_host_network param to get_destination() #364

Merged

coderabbitai Bot mentioned this pull request Mar 29, 2025

feat: Docker in Docker compatibility: add param "host_temp_dir" to get_source() and get_destination() #644

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feat: Added `use_host_network` param to `get_source()`, for Docker containers to use host's network#277

Feat: Added `use_host_network` param to `get_source()`, for Docker containers to use host's network#277
Aaron ("AJ") Steers (aaronsteers) merged 2 commits into
airbytehq:mainfrom
niyasrad:network-host

Niyas Hameed (niyasrad) commented Jun 20, 2024 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jun 20, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Aaron ("AJ") Steers (aaronsteers) left a comment •

edited

Loading

Uh oh!

This comment was marked as outdated.

Aaron ("AJ") Steers (aaronsteers) commented Jun 20, 2024

Uh oh!

coderabbitai Bot commented Jun 20, 2024

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Niyas Hameed (niyasrad) commented Jun 20, 2024 •

edited

Loading

Uh oh!

Aaron ("AJ") Steers (aaronsteers) commented Jun 21, 2024 •

edited by github-actions Bot

Loading

Uh oh!

Aaron ("AJ") Steers (aaronsteers) commented Jun 21, 2024

Uh oh!

Aaron ("AJ") Steers (aaronsteers) left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

Niyas Hameed (niyasrad) commented Jun 20, 2024 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Why

How

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jun 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

New Flow with use_host_network

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Aaron ("AJ") Steers (aaronsteers) left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Aaron ("AJ") Steers (aaronsteers) commented Jun 20, 2024

Uh oh!

coderabbitai Bot commented Jun 20, 2024

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Niyas Hameed (niyasrad) commented Jun 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Aaron ("AJ") Steers (aaronsteers) commented Jun 21, 2024 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Aaron ("AJ") Steers (aaronsteers) commented Jun 21, 2024

Uh oh!

Aaron ("AJ") Steers (aaronsteers) left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Niyas Hameed (niyasrad) commented Jun 20, 2024 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 20, 2024 •

edited

Loading

New Flow with `use_host_network`

CodeRabbit Configration File (`.coderabbit.yaml`)

Aaron ("AJ") Steers (aaronsteers) left a comment •

edited

Loading

Niyas Hameed (niyasrad) commented Jun 20, 2024 •

edited

Loading

Aaron ("AJ") Steers (aaronsteers) commented Jun 21, 2024 •

edited by github-actions Bot

Loading