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

Document various available configuration. #9249

Merged
merged 8 commits into from
Jan 4, 2022
Merged

Document various available configuration. #9249

merged 8 commits into from
Jan 4, 2022

Conversation

davinchia
Copy link
Contributor

@davinchia davinchia commented Jan 3, 2022 •
edited
Loading

What

Explicitly document Airbyte configuration.

How

  • Add comments to the interface methods in Configs.java.
  • Add new document on configuring airbyte. Transfer the non internal-only variables to this document.
  • Some minor refactoring.

Recommended reading order

  1. Configs.java
  2. configuring-airbyte.md

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

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
  • 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
  • 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
  • After the new connector version is published, connector version bumped in the seed directory 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

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.

@davinchia davinchia mentioned this pull request Jan 3, 2022
Merged
40 tasks
@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Jan 3, 2022
@davinchia davinchia temporarily deployed to more-secrets January 3, 2022 14:46 Inactive
@davinchia davinchia temporarily deployed to more-secrets January 3, 2022 17:27 Inactive
@davinchia davinchia marked this pull request as ready for review January 3, 2022 17:28
davinchia
davinchia commented Jan 3, 2022
View reviewed changes
airbyte-config/models/src/main/java/io/airbyte/config/Configs.java
String getWorkspaceDockerMount();

String getLocalDockerMount();

/**
* Defines the docker network jobs are launched on with the new scheduler.
*/
String getDockerNetwork();

Path getLocalRoot();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This too.

Copy link
Contributor

Choose a reason for hiding this comment

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

This is only used by tests or as a fallback default for some reason for the local docker mount. Not really a valid configuration item. We should remove it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Remove it from Configs.java altogether?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

will do so in a follow up PR based on your reply

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah

@davinchia davinchia temporarily deployed to more-secrets January 3, 2022 17:30 Inactive
jrhizor
jrhizor approved these changes Jan 3, 2022
View reviewed changes
docs/understanding-airbyte/configuring-airbyte.md Show resolved Hide resolved
docs/understanding-airbyte/configuring-airbyte.md Outdated Show resolved Hide resolved
docs/understanding-airbyte/configuring-airbyte.md Outdated Show resolved Hide resolved
docs/understanding-airbyte/configuring-airbyte.md Outdated Show resolved Hide resolved
airbyte-config/models/src/main/java/io/airbyte/config/Configs.java Show resolved Hide resolved
airbyte-config/models/src/main/java/io/airbyte/config/Configs.java
String getWorkspaceDockerMount();

String getLocalDockerMount();

/**
* Defines the docker network jobs are launched on with the new scheduler.
*/
String getDockerNetwork();

Path getLocalRoot();
Copy link
Contributor

Choose a reason for hiding this comment

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

This is only used by tests or as a fallback default for some reason for the local docker mount. Not really a valid configuration item. We should remove it.

@davinchia @jrhizor
Update docs/understanding-airbyte/configuring-airbyte.md
11c93b7 
Co-authored-by: Jared Rhizor <jared@dataline.io>
@davinchia davinchia temporarily deployed to more-secrets January 4, 2022 07:36 Inactive
@davinchia davinchia temporarily deployed to more-secrets January 4, 2022 08:56 Inactive
@davinchia davinchia temporarily deployed to more-secrets January 4, 2022 09:26 Inactive
@davinchia davinchia merged commit 8c3c68c into master Jan 4, 2022
@davinchia davinchia deleted the davinchia/document-configuration branch January 4, 2022 09:27
@marcosmarxm marcosmarxm mentioned this pull request Jan 4, 2022
Closed
@jrhizor jrhizor mentioned this pull request Jan 7, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jrhizor jrhizor jrhizor approved these changes

@cgardens cgardens Awaiting requested review from cgardens

@avaidyanatha avaidyanatha Awaiting requested review from avaidyanatha

@harshithmullapudi harshithmullapudi Awaiting requested review from harshithmullapudi

@ChristopheDuong ChristopheDuong Awaiting requested review from ChristopheDuong

@marcosmarxm marcosmarxm Awaiting requested review from marcosmarxm

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

Successfully merging this pull request may close these issues.
2 participants
@davinchia @jrhizor