-
Notifications
You must be signed in to change notification settings - Fork 36
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
docs: Add a guide for running airbyte workloads on custom nodes #874
Merged
michaeljguarino
merged 1 commit into
pluralsh:main
from
chrishronek:airbyte-custom-nodes
Oct 13, 2023
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
## Running Airbyte Workloads on Custom Node Group | ||
|
||
There may be a desire to run your Airbyte workloads on a specific node size for large workloads, or maybe even | ||
[spot instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html) to achieve higher cost | ||
savings. | ||
|
||
### create custom node group | ||
|
||
In order to run your Airbyte Workloads on custom configured nodes, you will need to first follow [these docs](https://docs.plural.sh/operations/cluster-configuration#modifying-node-types) | ||
to create your desired nodes. For example, if you were on AWS and wanted to use spot instances you would add something | ||
like this to your `bootstrap/terraform/main.tf` file: | ||
|
||
```yaml | ||
multi_az_node_groups = { | ||
medium_burst_spot = { | ||
name = "medium-burst-spot" | ||
min_capacity = 3 | ||
desired_capacity = 3 | ||
instance_types = ["t3.xlarge", "t3a.xlarge"] | ||
capacity_type = "SPOT" | ||
k8s_labels = { | ||
"plural.sh/capacityType" = "SPOT" | ||
"plural.sh/performanceType" = "BURST" | ||
"plural.sh/scalingGroup" = "medium-burst-spot" | ||
} | ||
k8s_taints = [{ | ||
key = "plural.sh/capacityType" | ||
value = "SPOT" | ||
effect = "NO_SCHEDULE" | ||
}] | ||
} | ||
} | ||
``` | ||
|
||
Then run `plural deploy --commit "add more spot nodes"` to update your cluster. | ||
|
||
> ! If you get an error like `InvalidParameterException: Minimum capacity 3 can't be greater than desired size 0` you | ||
> may have to use your cloud CLI or console to enact the change manually and then try running again. | ||
|
||
### update airbyte to use node group | ||
|
||
After creating your custom node group, you can point configure Airbyte to use it by adding the following to your | ||
`./airbyte/helm/values.yaml` (this can also be done in the plural application console) | ||
|
||
```yaml | ||
global: | ||
jobs: | ||
kube: | ||
nodeSelector: | ||
plural.sh/capacityType: SPOT | ||
tolerations: | ||
- effect: NoSchedule | ||
key: plural.sh/capacityType | ||
operator: Equal | ||
value: SPOT | ||
``` | ||
|
||
### redeploy | ||
|
||
From there, you should be able to run `plural build --only airbyte && plural deploy --commit "run on spot instances"` to | ||
use the custom node group to execute your workloads. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can probably leave this part out of the airbyte docs (or explain its optional as well only if you want to ensure a 3 node spot pool)