Understanding essential settings in values.yml for manual deployment of Airbyte community version using abctl

Summary

When manually deploying the Airbyte community version using abctl, it is important to understand the essential settings to include in the values.yml file. The user is seeking documentation or a simplified version to help with the setup.


Question

Hello everyone! I’m attempting to manually deploy the Airbyte community version using abctl, but I would like to understand more about the essential settings to include in the values.yml file. This is my starting point for setting up my Airbyte environment (https://github.com/airbytehq/airbyte-platform/tree/main/charts/airbyte/templates). However, if anyone has documentation or a simplified version, it would be greatly appreciated.



This topic has been created from a Slack thread to give it more visibility.
It will be on Read-Only mode here. Click here if you want
to access the original thread.

Join the conversation on Slack

["manual-deployment", "airbyte-community-version", "abctl", "values.yml", "airbyte-environment", "documentation"]

You probably want to start with the deployment docs:
https://docs.airbyte.com/deploying-airbyte/#3-create-a-valuesyaml-override-file

You only need to add the settings for the changes you want from the default (meaning you don’t need to add a bunch of config to override details). So for example, if you want to use an external postgres database for Airbyte instead of the one it will run by default, you would include the values listed on the <https://docs.airbyte.com/deploying-airbyte/integrations/database|External Database> integration docs. Basically, you can just find the settings based on your needs, then merge them together into one YAML (e.g. don’t repeat the top-level global—this is just telling you where the different configs belong within your config).

In addition to the ones listed, people will often set the default resources for jobs under global.jobs.resources. There are a bunch of individual settings listed in <https://github.com/airbytehq/airbyte-platform/blob/main/charts/airbyte/README.md|this readme>, but I will point out that some of theses are old options that haven’t yet been removed (e.g. externalDatabase.* which has been replaced with global.database.*). There’s also an example <https://github.com/airbytehq/airbyte-platform/blob/main/charts/airbyte/values.yaml|template here> (but again, DON’T use this directly—you don’t need to set all that stuff and having a fat values file makes it hard to know what you’re actually customizing)