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

octavia-cli: Manage custom definitions with octavia #15058

Closed

Conversation

marcelopio
Copy link
Contributor

What

Implements #14787

How

Basically just copy the implementations for the source/destination and make them available pro source/destination definitions

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

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/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

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
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as 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

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
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped 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

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

@github-actions github-actions bot added area/api Related to the api area/documentation Improvements or additions to documentation area/platform issues related to the platform labels Jul 27, 2022
@marcelopio
Copy link
Contributor Author

Apply and import are working for source definitions (which is what I needed for now). I am going to implement destination, generation logic, import logic for source with references, etc next

@marcosmarxm
Copy link
Member

@marcelopio do you need any assistance here?

@marcelopio
Copy link
Contributor Author

Yeah, I have some doubts how generate and import should work after this. A source can now point to a source definition id or a file that will contain the definition.

My doubt is, should we import all source definitions, even non custom? Because that could be useful so we can upgrade a version of a conector with octavia (or downgrade).

If we go that way, when generating, maybe we should also generate the source definition, even for non custom connectors

@marcosmarxm
Copy link
Member

Sorry the missing reply here @marcelopio
I added the issue to correct team backlog.
also can you check the conflicts?

@marcelopio marcelopio marked this pull request as ready for review October 18, 2022 14:26
@marcosmarxm
Copy link
Member

Hello 👋, first thank you for this amazing contribution.

We really appreciate the effort you've made to improve the project.
We ask you patience for the code review. Last month our team was focused on Hacktoberfest event and that probably left some PR without the proper feedback. And this week, due to the Thanksgiving US Holiday, most our team is out of office with their families. Another important piece of information why code won't be merge this week is: as a safety measure the core team has decided to freeze merging code to main branch to keep the release stable. Next week we'll return to you with the proper code review and update the status of your contribution.

If you have any questions feel free to send me a message in Slack!
Thanks!

@@ -453,6 +456,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomSourceDefinitionUpdate"
required: true
Copy link
Contributor

@xiaohansong xiaohansong Dec 2, 2022

Choose a reason for hiding this comment

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

Thanks for your contribution. In #19670 we are moving away from this function, and will use updateSourceDefinition to replace this.

A tl;dr version of the linked ticket is:

  1. We are moving away updateCustomSourceDefinition and going to use updateSourceDefinition (same for destination)
  2. We are moving away deleteCustomSourceDefinition and going to use deleteSourceDefinition (same for destination)
  3. We are moving away from SourceDefinitionCreate and going to use CustomSourceDefinitionCreate (same for destination). (Note in this bullet point we are actually going to use custom in API because created definitions are always going to be custom connectors, while in the first 2 we are moving away from custom so both custom connector or public connector share the same path)

@marcosmarxm
Copy link
Member

Hello 👋:skin-tone-2: and thank you for your contribution!

Airbyte has instituted a code freeze between 19 and 30 December, to make sure there are no disruptions during the holidays.
Because of this, reviewing and merging your contribution may take longer than usual.
We apologize for the delay, but we want everyone to have a quiet and happy holiday.

If you have any questions or need further clarification, please don't hesitate to ping via Slack.

@xiaohansong
Copy link
Contributor

Per previous comment the APIs were outdated and not used anymore. Please open a new PR if you are still interested to make the change, thanks again for your contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api Related to the api area/documentation Improvements or additions to documentation area/platform issues related to the platform area/platform-oss community team/platform-move
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants