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

🎉 Make job docker container name meaningful #12503

Merged
merged 2 commits into from
May 3, 2022

Conversation

davinchia
Copy link
Contributor

@davinchia davinchia commented May 1, 2022

What

Closes #9584.

This now follows the Kubernetes name convention of <image-name>-<job-id>-<attempt-number>.

This should make things easier for oss users doing oncall for docker deployments.

How

Mirror the Kubernetes name convention: https://github.com/airbytehq/airbyte/blob/master/airbyte-workers/src/main/java/io/airbyte/workers/process/KubeProcessFactory.java#L180

We can probably reuse the naming functions across both processes. We are going to do more changes in this area around making things more ergonomic (e.g. instead of always using sync, we want to replace this with the actual operation - discover, check connection etc.) so we'll do refactoring in that PR. I want to unblock this in the time being since open source users are having difficulty debugging now.

Recommended reading order

The one file.

🚨 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
  • 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/platform issues related to the platform area/worker Related to worker labels May 1, 2022
@davinchia davinchia requested a review from marcosmarxm May 1, 2022 16:03
@davinchia
Copy link
Contributor Author

Evidence this works:

Screenshot 2022-05-01 at 11 58 38 PM

Copy link
Contributor

@jdpgrailsdev jdpgrailsdev left a comment

Choose a reason for hiding this comment

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

:shipit: with one nit.

Copy link
Contributor

@pmossman pmossman left a comment

Choose a reason for hiding this comment

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

LGTM, +1 to Jonathan's nit

@davinchia davinchia temporarily deployed to more-secrets May 3, 2022 08:52 Inactive
@davinchia davinchia temporarily deployed to more-secrets May 3, 2022 08:52 Inactive
@davinchia davinchia merged commit c570225 into master May 3, 2022
@davinchia davinchia deleted the davinchia/better-container-name-debugging branch May 3, 2022 09:21
@davinchia davinchia mentioned this pull request May 3, 2022
38 tasks
@marcosmarxm marcosmarxm changed the title Make job docker container name meaningful. 🎉 Make job docker container name meaningful May 3, 2022
@marcosmarxm
Copy link
Member

@Amruta-Ranade this is a good feature for OSS in the annoucement.

davinchia added a commit that referenced this pull request May 3, 2022
Follow up to #12503.

Combine the naming logic to avoid duplication as they are mostly similar. Since Kubernetes has stricter conventions, we use the stricter convention throughout.

Move the naming function to DockerProcessFactory.
suhomud pushed a commit that referenced this pull request May 23, 2022
Closes #9584.

This now follows the Kubernetes name convention of <image-name>-<job-id>-<attempt-number>.

This should make things easier for oss users doing oncall for docker deployments.

Mirror the Kubernetes name convention: https://github.com/airbytehq/airbyte/blob/master/airbyte-workers/src/main/java/io/airbyte/workers/process/KubeProcessFactory.java#L180

We can probably reuse the naming functions across both processes. We are going to do more changes in this area around making things more ergonomic (e.g. instead of always using sync, we want to replace this with the actual operation - discover, check connection etc.) so we'll do refactoring in that PR. I want to unblock this in the time being since open source users are having difficulty debugging now.
suhomud pushed a commit that referenced this pull request May 23, 2022
Follow up to #12503.

Combine the naming logic to avoid duplication as they are mostly similar. Since Kubernetes has stricter conventions, we use the stricter convention throughout.

Move the naming function to DockerProcessFactory.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/platform issues related to the platform area/worker Related to worker
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add container name for source/destination container launched by Airbyte worker
4 participants