Docs connector level resource requirements #54146
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
octavia-squidington-iii
added
the
area/documentation
| There are three different ways to configure connector resource requirements for a sync. The narrower in scope the requirement, the higher the precedence. | ||
|
|
||
| There are three different ways to configure connector resource requirements for a Sync: | ||
| 1. Instance-wide: applies to all containers in a sync. Lowest precedence. Overridden by all other configuration. Intended to be a default. | ||
| 2. Connector-specific: applies to all containers of that connector type in a sync. Second-highest precedence. Overrides instance-wide configuration. | ||
| 3. Connection-specific: applies to all containers of that connection in a sync. Highest precedence. Overrides all other configuration. |
There was a problem hiding this comment.
There are four in SME as of 1.5:
- instance-wide
- actor-definition-specific: IE: All Postgres sources
- actor-specific: IE: This specific Postgres source I set up (this is the new one)
- connection-specific
There was a problem hiding this comment.
I am not sure how we externally communicate actor definition vs. actor, but I think in this docs update it makes sense to be more specific
There was a problem hiding this comment.
Ah. We don't use the term actor outside of a dev context, and I'd prefer to keep it that way for simplicity. I'm going to try to talk around this.
|
Thanks Teal. I made a few changes, trying to avoid introducing the actor terminology since its outside the usual scope of our external nomenclature. I think this makes sense? |
There was a problem hiding this comment.
Hey @ian-at-airbyte thanks for writing this up! I have a couple of wording suggestions.
Co-authored-by: Catherine Noll <[email protected]>
Co-authored-by: Catherine Noll <[email protected]>
|
Thanks @clnoll. I've accepted your suggestions and quite like them. |
What
Basic docs about connector-level resource requirements in the UI. I realize this is not the full/optimal way to tell this story. But I did want to have something ready when this gets released this week. Please let me know if you have any thoughts!
How
Updated some previous information about memory and CPU management to modernize it within the context of the new UI feature. I also used Tadata (AI tool we're trialing) to put together some recommendations and best practices based on what it knows about Airbyte. I'm super curious how those land with you.
Please note due to the readme outage currently I can't link to our API docs but I see a PR was merged to update them. I will link it later, once readme is back online.
Review guide
The main changes are in docs/operator-guides/configuring-connector-resources.md.
Changes to other pages were mostly companion changes to reference this content.
User Impact
We have a place to link users who are having resource issues.
Can this PR be safely reverted and rolled back?