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

Configurable worker pull image policy in k8s #6827

Conversation

mmolimar
Copy link
Contributor

@mmolimar mmolimar commented Oct 6, 2021

What

Adds a new property to allow configuring the worker image pull policy when deploying Airbyte on Kubernetes.

How

Added a new environment variable in the EnvConfigs class to be used in the KubePodProcess class to set the image pull policy.
Also, in the WorkerUtils I've added the CONFIGS object as a static one.

Recommended reading order

  1. KubePodProcess.java
  2. WorkerUtils.java
  3. EnvConfigs.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/worker Related to worker kubernetes labels Oct 6, 2021
@marcosmarxm marcosmarxm requested review from davinchia and jrhizor and removed request for davinchia October 6, 2021 00:29
@marcosmarxm
Copy link
Member

thanks @mmolimar! @davinchia / @jrhizor can you review this contribution?

@marcosmarxm marcosmarxm self-assigned this Oct 6, 2021
Copy link
Contributor

@davinchia davinchia left a comment

Choose a reason for hiding this comment

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

Looks good.

One minor thing, we are going to change our terminology here in the future to avoid confusion.

We actually have worker pods and job pods, both are separate from each other and do separate things. This separation is recent which explains the mixed terms we currently have.

The image pull policy you've added is actually for job pods. Can you change the name from worker to jobs? I can take care of cleaning up the rest in a follow up PR. Thanks.

@mmolimar
Copy link
Contributor Author

mmolimar commented Oct 6, 2021

Done! @davinchia

@davinchia
Copy link
Contributor

@mmolimar oops I should be clearer, the change is from getPodImagePullPolicy to getJobImagePullPolicy.

Sorry for the back and forth! Thanks :)

@mmolimar
Copy link
Contributor Author

mmolimar commented Oct 6, 2021

Just that change? or maybe also the env var @davinchia ?

@davinchia
Copy link
Contributor

@mmolimar the env var should be renamed to match it too, thanks!

@mmolimar
Copy link
Contributor Author

mmolimar commented Oct 6, 2021

Done! @davinchia

@davinchia davinchia merged commit febeb52 into airbytehq:master Oct 6, 2021
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants