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.

Sign up for GitHub

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

Jump to bottom

new source: kafka #5906

Merged
merged 3 commits into from
Sep 22, 2021
Merged

new source: kafka #5906

merged 3 commits into from
Sep 22, 2021

Conversation

heade
Copy link
Contributor

@heade heade commented Sep 8, 2021 •
edited
Loading

What

Source Kafka: #2655

How

Implemented the connector logic for Kafka as a source for Airbyte.

MVP scope:
-Full refresh.
-Possibility to configure topic offset per partition.
-SASL auth
-Within batch processing with one consumer

Phase 2 scope:
-tls auth
-Incremental sync

2 types of subscriptions are implemented: topic-pattern and topic-partitions. To build streams in the first case, all available topics for this consumer are taken, and then filtered using a pattern: link

Recommended reading order

  1. spec.json
  2. KafkaSourceConfig.java
  3. KafkaSource.java

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions
  • Connector added to connector index like described here

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions
  • Connector version bumped like described here

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Connector Generator

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed.

@github-actions github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Sep 8, 2021
@heade heade linked an issue Sep 8, 2021 that may be closed by this pull request
New Source: Kafka #2655
Closed
@heade heade marked this pull request as ready for review September 14, 2021 17:55
@sherifnada sherifnada requested review from subodh1810 and tuliren and removed request for subodh1810 September 14, 2021 22:27
@sherifnada
Copy link
Contributor

@heade could you please include some more context for liren to be able to review the code? For example, links to any design docs, the reading order, any interesting implementation details? Also could you maximize the appropriate checklist section i.e: "New connector"?

@sherifnada sherifnada removed their request for review September 14, 2021 22:39
tuliren
tuliren approved these changes Sep 22, 2021
View reviewed changes
Copy link
Contributor

@tuliren tuliren left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Nice! Thanks for the contribution.

A few docs and links are missing. But I can do that in a follow up PR.

airbyte-integrations/connectors/source-kafka/README.md

#### Integration Tests
TODO: _how can a user run integration tests?_
_this section is currently under construction -- please reach out to us on Slack for help with setting up Airbyte's standard test suite_
Copy link
Contributor

Choose a reason for hiding this comment

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

This TODOs should either be resolved or removed.

@tuliren tuliren merged commit c86403f into master Sep 22, 2021
@tuliren tuliren deleted the ddubinin/2655-source-kafka branch September 22, 2021 16:18
@tuliren tuliren mentioned this pull request Sep 22, 2021
Merged
tuliren
tuliren reviewed Sep 22, 2021
View reviewed changes
Copy link
Contributor

@tuliren tuliren left a comment

Choose a reason for hiding this comment

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

@heade, sorry that I did not know you are from the GL team. Can you create a follow-up PR to complete the remaining tasks and publish this connector?

@jrhizor jrhizor mentioned this pull request Sep 25, 2021
Merged
@heade heade mentioned this pull request Sep 30, 2021
Merged
@tuliren tuliren mentioned this pull request Oct 5, 2021
Merged
tuliren added a commit that referenced this pull request Oct 5, 2021
@tuliren
Register kafka source in index (#6751)
ff6ed2f 
- A follow up PR for #5906.
- Register the Kafka source in the source index.
- We temporarily categorize this connector as `database` for convenience. However, this may change in the future.
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
@tuliren @schlattk
Register kafka source in index (airbytehq#6751)
93235b8 
- A follow up PR for airbytehq#5906.
- Register the Kafka source in the source index.
- We temporarily categorize this connector as `database` for convenience. However, this may change in the future.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tuliren tuliren tuliren approved these changes

Assignees
No one assigned
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

New Source: Kafka
3 participants
@heade @sherifnada @tuliren