jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-19 18:14:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: Regenerate platform documentation version 2.0 (#68674)

Browse Source 
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
This commit is contained in:
devin-ai-integration[bot]
2025-10-28 01:48:31 +00:00
committed by GitHub
parent b691f08936
commit a66b142e95
11 changed files with 738 additions and 157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
docusaurus/platform_versioned_docs/version-2.0/access-management/sso-providers/azure-entra-id.md
View File

@@ -8,7 +8,7 @@ import TabItem from "@theme/TabItem";
# Set up single sign on using Entra ID
This guide shows you how to set up Microsoft Entra ID (formerly Azure ActiveDirectory) and Airbyte so your users can log into Airbyte using your organization's identity provider (IdP) using OpenID Connect (OIDC).
This guide shows you how to set up Microsoft Entra ID (formerly Azure ActiveDirectory) and Airbyte so your users can log into Airbyte using your organization's identity provider (IdP) and OpenID Connect (OIDC).
## Overview
@@ -20,17 +20,13 @@ This guide is for administrators. It assumes you have:
The exact process differs between the Cloud or Self-Managed versions of Airbyte. Steps for both are below.
## Cloud Pro with Entra ID OIDC
## Cloud with Entra ID OIDC
:::warning
For security purposes, Airbyte disables existing [applications](/platform/enterprise-setup/api-access-config) used to access the Airbyte API once the user who owns the application signs in with SSO for the first time. Replace any Application secrets that were previously in use to ensure your integrations don't break.
:::
Before you can proceed, you require your **Company Identifier** so you can properly fill in these values. Your contact at Airbyte gives this to you.
### Set up SSO in Airbyte for the first time
#### Create an application in Entra ID
### Part 1: Create an application in Entra ID
Create a new [Entra ID application](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/what-is-application-management).
@@ -42,9 +38,15 @@ Create a new [Entra ID application](https://learn.microsoft.com/en-us/entra/iden
4. Configure a **Redirect URI** with the type **Web** and the following value: `https://cloud.airbyte.com/auth/realms/<your-company-identifier>/broker/default/endpoint`
Replace `<your-company-identifier>` with a unique identifier for your organization. This is often your organization name or domain. For example, `airbyte`. You'll use this same identifier when configuring SSO in Airbyte.
:::tip
To avoid coming back later to change this, check if this company identifier is available now by trying to log into Airbyte with it. If the company identifier is already claimed, Airbyte tries and fails to log you into another organization's IdP.
:::
5. Click **Register** to create the application.
#### Create client credentials in Entra ID
### Part 2: Create client credentials in Entra ID
Create client credentials so Airbyte can talk to your application.
@@ -60,55 +62,58 @@ Create client credentials so Airbyte can talk to your application.
4. Copy the **Value** (the client secret itself) immediately after you create it. You won't be able to view this later.
#### Configure SSO in Airbyte
### Part 3: Configure and test SSO in Airbyte
1. In Airbyte, click **Organization settings** > **General**.
:::info
Currently, this portion of the setup requires an Airbyte employee. Contact Support to proceed.
:::
2. Click **Set up SSO**, then input the following information.
- **Email domain**: The full email domain of users who sign in to Entra ID. For example, `airbyte.io`.
- **Company identifier**: The unique identifier you used in the redirect URI in Entra ID. For example, `airbyte`.
:::note
If you use multiple email domains, only enter one domain here. Contact Airbyte's [support team](https://support.airbyte.com) to have them add additional domains after you're done.
:::
- **Client ID**: Find this in the Essentials section of your Entra ID application's homepage.
- **Client ID**: The client ID you created in the preceding section. Find this in the Essentials section of your Entra ID application's homepage.
- **Client secret**: The client secret you created in the preceding section.
- **Discovery URL**: Your OpenID Connect metadata endpoint. The format is similar to `https://login.microsoftonline.com/{tenant_id}/v2.0/.well-known/openid-configuration`.
- **SSO subdomain**: Your company identifier, which users enter to access Airbyte.
3. Click **Test your connection** to verify your settings. Airbyte forwards you to your identity provider. Log in to test that your credentials work.
- It must be a unique.
- If the test is successful, you return to Airbyte and see a "Test Successful" message.
- It must be consistent with the company identifier you used in the redirect URI you defined in Entra ID.
- If the test wasn't successful, either Airbyte or Entra ID show you an error message, depending on what the problem is. Verify the values you entered and try again.
- It's often your organization name or domain. For example, `airbyte`.
4. Enter your **Email domain** (for example, `airbyte.io`) and click **Activate SSO**.
3. Click **Save changes**.
4. Test SSO to make sure people can access Airbyte. **Stay logged in so you don't lock yourself out** and ask a colleague to complete the following steps.
1. Sign out of Airbyte.
2. On the Airbyte login page, click **Continue with SSO**, enter your company identifier, and click **Continue with SSO**. The Entra ID sign in page appears.
3. Sign into Entra ID. Entra ID then forwards you back to Airbyte, which logs you in.
:::note
If you were already logged into your company’s IdP somewhere else, you might not see a login screen. In this case, Airbyte forwards you directly to Airbyte's logged-in area.
:::note Limitations and restrictions on domains
- If you use multiple email domains, only enter one domain here. After activation, [contact support](https://support.airbyte.com) to have them add additional domains for you.
- You can't claim an email domain if someone using that domain exists in another organization. For example, if your email domain is `example.com`, but someone with an `example.com` email uses Airbyte for another organization, you can't enable SSO for that domain. This also means SSO is unavailable for common public email domains like `gmail.com`.
:::
If you successfully set up SSO, but your users can't log into Airbyte, verify that they have access to the Airbyte application you created in Entra ID.
Once you activate SSO, users with your email domain must sign in using SSO.
### Update or delete SSO configurations
#### If users can't log in
To prevent a situation where you could lock yourself out of Airbyte, we require that you contact Airbyte's [support team](https://support.airbyte.com) if you need to change or remove SSO in your Cloud organization.
If you successfully set up SSO but your users can't log into Airbyte, verify that they have access to the Airbyte application you created in Entra ID.
### Update SSO credentials
To update SSO for your organization, [contact support](https://support.airbyte.com).
<!-- Organization admins can log in using your email and password (instead of SSO) to update SSO settings. If your client secret expires or you need to update your SSO configuration, follow these steps.
1. In Airbyte, click **Organization settings** > **General**.
2. Click **Set up SSO** > **Re-test your connection**.
3. Update the form fields as needed.
4. Click **Test your connection** to verify the updated credentials work correctly.
5. Click **Activate SSO**. -->
### Delete SSO configuration
To remove SSO from your organization, [contact support](https://support.airbyte.com).
## Self-Managed Enterprise with Entra ID OIDC
@@ -280,6 +285,5 @@ In your command-line tool, deploy Airbyte using your updated values file.
helm upgrade airbyte-enterprise airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.3 \ # Helm chart version to use
--set global.image.tag=1.7.0 # Airbyte version to use
--version 2.x.x # Helm chart version to use
```

80
docusaurus/platform_versioned_docs/version-2.0/access-management/sso-providers/okta.md
View File

@@ -20,19 +20,13 @@ This guide is for administrators. It assumes you have:
The exact process differs between the Cloud or Self-Managed versions of Airbyte. Steps for both are below.
## Cloud Pro with Okta OIDC
Follow the steps below to set up single sign on with Okta.
## Cloud with Okta OIDC
:::warning
For security purposes, when a user who owns [applications](/platform/enterprise-setup/api-access-config) logs in with SSO for the first time, Airbyte disables their existing applications. Those users must replace any application secrets that were previously in use to ensure API and Terraform integrations don't break.
:::
### Set up SSO for the first time
Follow these steps to set up SSO in Airbyte Cloud.
#### Create a new Okta application
### Part 1: Create a new Okta application
1. In Okta, create a new Okta OIDC App Integration for Airbyte. For help, see [Okta's documentation](https://help.okta.com/en-us/content/topics/apps/apps_app_integration_wizard_oidc.htm). Create an app integration with the following options.
@@ -52,6 +46,12 @@ Follow these steps to set up SSO in Airbyte Cloud.
- **Sign-in redirect URIs**: `https://cloud.airbyte.com/auth/realms/<your-company-identifier>/broker/default/endpoint`
Replace `<your-company-identifier>` with a unique identifier for your organization. This is often your organization name or domain (for example, `airbyte`). You'll use this same identifier when configuring SSO in Airbyte.
:::tip
To avoid coming back later to change this, check if this company identifier is available now by trying to log into Airbyte with it. If the company identifier is already claimed, Airbyte tries and fails to log you into another organization's IdP.
:::
- **Sign-out redirect URIs**: `https://cloud.airbyte.com/auth/realms/<your-company-identifier>/broker/default/endpoint/logout_response`
- **Trusted origins**: Leave empty.
@@ -62,21 +62,13 @@ Follow these steps to set up SSO in Airbyte Cloud.
4. Click **Save**.
#### Configure SSO in Airbyte
### Part 2: Configure and test SSO in Airbyte
1. In Airbyte, click **Organization settings** > **General**.
:::info
Currently, this portion of the setup can only be done by an Airbyte employee. Contact Support to proceed.
:::
2. Click **Set up SSO**, then input the following information.
- **Email domain**: The full email domain of users who sign in to Okta. For example, `airbyte.io`.
:::note
If you use multiple email domains, only enter one domain here. Contact Airbyte's [support team](https://support.airbyte.com) to have them add additional domains after you're done.
:::
- **Company identifier**: The unique identifier you used in the redirect URI in Okta. For example, `airbyte`.
- **Client ID**: In Okta's administrator panel, **Applications** > **Applications** > **Airbyte** > **General** tab > **Client ID**.
@@ -84,33 +76,44 @@ Follow these steps to set up SSO in Airbyte Cloud.
- **Discovery URL**: Your OpenID Connect (OIDC) metadata endpoint. It's similar to `https://<yourOktaDomain>/.well-known/openid-configuration`.
- **SSO subdomain**: Your company identifier, which Airbyte users use to access Airbyte.
3. Click **Test your connection** to verify your settings. Airbyte forwards you to your identity provider. Log in to test that your credentials work.
- It must be a unique.
- If the test is successful, you return to Airbyte and see a "Test Successful" message.
- It must be consistent with the company identifier you used in the redirect URI you defined in Okta.
- If the test wasn't successful, either Airbyte or Okta show you an error message, depending on what the problem is. Verify the values you entered and try again.
- It's often your organization name or domain. For example, `airbyte`.
4. Enter your **Email domain** (for example, `airbyte.io`) and click **Activate SSO**.
3. Click **Save changes**.
4. Test SSO to make sure people can access Airbyte. **Stay logged in so you don't lock yourself out** and ask a colleague to complete the following steps.
1. Sign out of Airbyte.
2. On the Airbyte login page, click **Continue with SSO**, enter your company identifier, and click **Continue with SSO**. The Okta sign in page appears.
3. Sign into Okta. Okta then forwards you back to Airbyte, which logs you in.
:::note
If you were already logged into your company’s IdP somewhere else, you might not see a login screen. In this case, Airbyte forwards you directly to Airbyte's logged-in area.
:::note Limitations and restrictions on domains
- If you use multiple email domains, only enter one domain here. After activation, [contact support](https://support.airbyte.com) to have them add additional domains for you.
- You can't claim an email domain if someone using that domain exists in another organization. For example, if your email domain is `example.com`, but someone with an `example.com` email uses Airbyte for another organization, you can't enable SSO for that domain. This also means SSO is unavailable for common public email domains like `gmail.com`.
:::
If you successfully set up SSO, but your users can't log into Airbyte, verify that they have access to the Airbyte application you created in Okta.
Once you activate SSO, users with your email domain must sign in using SSO.
### Update or delete SSO configurations
#### If users can't log in
To prevent a situation where you could lock yourself out of Airbyte, we require that you contact Airbyte's [support team](https://support.airbyte.com) if you need to change or remove SSO in your Cloud organization.
If you successfully set up SSO but your users can't log into Airbyte, verify that they have access to the Airbyte application you created in Okta.
### Update SSO credentials
To update SSO for your organization, [contact support](https://support.airbyte.com).
<!-- Organization admins can log in using your email and password (instead of SSO) to update SSO settings. If your client secret expires or you need to update your SSO configuration, follow these steps.
1. In Airbyte, click **Organization settings** > **General**.
2. Click **Set up SSO** > **Re-test your connection**.
3. Update the form fields as needed.
4. Click **Test your connection** to verify the updated credentials work correctly.
5. Click **Activate SSO**. -->
#### Delete SSO configuration
To remove SSO from your organization, contact Airbyte's [support team](https://support.airbyte.com).
## Self-Managed Enterprise with Okta OIDC
@@ -300,6 +303,5 @@ helm upgrade -i \
--values ./values.yaml \
airbyte \
airbyte-v2/airbyte \
--version 2.0.3 \
--set global.image.tag=1.7.0
--version 2.x.x
```

3
docusaurus/platform_versioned_docs/version-2.0/connector-development/connector-builder-ui/custom-components.md
View File

@@ -150,8 +150,7 @@ If you're deploying Airbyte using public Helm charts without abctl, follow the s
helm upgrade airbyte airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.3 \ # Helm chart version to use
--set global.image.tag=1.7.0 # Airbyte version to use
--version 2.x.x # Helm chart version to use
```
</TabItem>

92
docusaurus/platform_versioned_docs/version-2.0/deploying-airbyte/chart-v2-community.mdx
View File

@@ -131,13 +131,9 @@ If you're not using an external database, skip this step. At deployment time, yo
### Add V2 chart repo
Helm chart V2 uses a different repo URL than V1 did. In your command line tool, add this repo and index it.
Helm chart V2 uses a different repo URL (`/charts`) than V1 did (`/helm-charts`). In your command line tool, add this repo and index it.
```bash
# Helm chart V1
# helm repo add airbyte https://airbytehq.github.io/helm-charts
# Helm chart V2
helm repo add airbyte-v2 https://airbytehq.github.io/charts
helm repo update
```
@@ -387,15 +383,46 @@ workloadLauncher:
<Tabs groupId="external-db">
<TabItem value='db-yes' label='External database' default>
Deploy Airbyte. Here is an example of how to deploy version 1.7.0 of Airbyte using the latest Helm chart V2 values. Normally the Helm chart version is identical to the Airbyte version. Since using this chart version is optional, the Helm chart and Airbyte have different, but compatible, versions.
1. Identify the Helm chart version that corresponds to the platform version you want to run. Most Helm chart versions are designed to work with one Airbyte version, and they don't necessarily have the same version number.
```bash
helm install airbyte airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.3 \ # Helm chart version to use
--set global.image.tag=1.7.0 # Airbyte version to use
```
```bash
helm search repo airbyte-v2 --versions
```
You should see something like this:
```text
NAME CHART VERSION APP VERSION DESCRIPTION
airbyte-v2/airbyte 2.0.18 2.0.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.17 1.8.5 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.16 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.15 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.14 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.13 1.8.3 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.12 1.8.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.11 1.8.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.10 1.8.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.9 1.8.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.8 1.8.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.7 1.7.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.6 1.7.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.5 1.7.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.4 1.6.3 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.3 1.6.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.2 1.6.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.1 1.6.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.0 1.6.0 Helm chart to deploy airbyte
airbyte-v2/airbyte-data-plane 2.0.0 2.0.0 A Helm chart for installing an Airbyte Data Plane.
```
2. Install Airbyte into your Helm chart V2 namespace. In this example, you install Airbyte version 2.0.
```bash
helm install airbyte airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.18 # Helm chart version to use
```
</TabItem>
<TabItem value='db-no' label='No external database' default>
@@ -410,21 +437,52 @@ Do not proceed if you have not backed up Airbyte's internal Postgres database.
helm uninstall airbyte -n airbyte
```
2. Reinstall Airbyte into the same namespace as before. Here is an example of how to deploy version 1.7.0 of Airbyte using the latest Helm chart V2 values. Normally the Helm chart version is identical to the Airbyte version. Since using this chart version is optional, the Helm chart and Airbyte have different, but compatible, versions.
2. Identify the Helm chart version that corresponds to the platform version you want to run. Most Helm chart versions are designed to work with one Airbyte version, but they don't necessarily have the same version number as the Airbyte platform.
```bash
helm search repo airbyte-v2 --versions
```
You see something like this:
```text
NAME CHART VERSION APP VERSION DESCRIPTION
airbyte-v2/airbyte 2.0.18 2.0.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.17 1.8.5 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.16 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.15 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.14 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.13 1.8.3 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.12 1.8.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.11 1.8.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.10 1.8.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.9 1.8.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.8 1.8.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.7 1.7.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.6 1.7.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.5 1.7.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.4 1.6.3 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.3 1.6.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.2 1.6.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.1 1.6.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.0 1.6.0 Helm chart to deploy airbyte
airbyte-v2/airbyte-data-plane 2.0.0 2.0.0 A Helm chart for installing an Airbyte Data Plane.
```
3. Reinstall Airbyte into the same namespace as before. In this example, you install Airbyte version 2.0 using the Helm chart version 2.0.18.
```bash
helm install airbyte airbyte-v2/airbyte \
--namespace airbyte \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.3 \ # Helm chart version to use
--set global.image.tag=1.7.0 # Airbyte version to use
--version 2.0.18 \ # Helm chart version to use
```
Airbyte continues in this namespace as before, now running on Helm Chart V2.
#### Restore your database
You do not need to restore your database except in exceptional circumstances. Only restore your database if there is an issue with your deployment that isn't related to your configurations. The restoration process is essentially the reverse of the backup process you went through above.
You only need to restore your database in exceptional circumstances. Only restore your database if there is an issue with your deployment that isn't related to your configurations. The restoration process is essentially the reverse of the backup process you went through above.
These examples assume your namespace is still `airbyte` and your database pod name is still `airbyte-db-0`.

47
docusaurus/platform_versioned_docs/version-2.0/deploying-airbyte/deploying-airbyte.md
View File

@@ -171,13 +171,46 @@ helm install airbyte airbyte/airbyte \
</TabItem>
<TabItem value='helm-2' label='Helm chart V2' default>
```bash
helm install airbyte airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.3 \ # Helm chart version to use
--set global.image.tag=1.7.0 # Airbyte version to use
```
1. Identify the Helm chart version that corresponds to the platform version you want to run. Most Helm chart versions are designed to work with one Airbyte version, and they don't necessarily have the same version number.
```bash
helm search repo airbyte-v2 --versions
```
You should see something like this:
```text
NAME CHART VERSION APP VERSION DESCRIPTION
airbyte-v2/airbyte 2.0.18 2.0.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.17 1.8.5 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.16 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.15 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.14 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.13 1.8.3 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.12 1.8.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.11 1.8.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.10 1.8.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.9 1.8.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.8 1.8.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.7 1.7.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.6 1.7.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.5 1.7.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.4 1.6.3 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.3 1.6.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.2 1.6.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.1 1.6.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.0 1.6.0 Helm chart to deploy airbyte
airbyte-v2/airbyte-data-plane 2.0.0 2.0.0 A Helm chart for installing an Airbyte Data Plane.
```
2. Install Airbyte into your Helm chart V2 namespace. In this example, you install Airbyte version 2.0.
```bash
helm install airbyte airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.18 # Helm chart version to use
```
</TabItem>
</Tabs>

3
docusaurus/platform_versioned_docs/version-2.0/enterprise-setup/audit-logging.md
View File

@@ -104,8 +104,7 @@ Choose a new blob storage bucket with your chosen cloud provider (for example, A
helm upgrade airbyte airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.3 \ # Helm chart version to use
--set global.image.tag=1.7.0 # Airbyte version to use
--version 2.x.x # Helm chart version to use
```
</TabItem>

49
docusaurus/platform_versioned_docs/version-2.0/enterprise-setup/chart-v2-enterprise.mdx
View File

@@ -71,7 +71,7 @@ kubectl create namespace airbyte-v2
### Add and index the repo
Helm chart V2 uses a separate repo than V1 did. In your command line tool, add this repo and index it.
Helm chart V2 uses a different repo URL (`/charts`) than V1 did (`/helm-charts`). In your command line tool, add this repo and index it.
```bash
helm repo add airbyte-v2 https://airbytehq.github.io/charts
@@ -412,14 +412,43 @@ workloadLauncher:
### Deploy Airbyte {#deploy-airbyte}
Here is an example of how to deploy version 1.7.0 of Airbyte using the latest Helm chart V2 values. Normally, in V1, the Helm chart version is identical to the Airbyte version. Since using this chart version is optional, the Helm chart and Airbyte have different, but compatible, versions.
1. Identify the Helm chart version that corresponds to the platform version you want to run. Most Helm chart versions are designed to work with one Airbyte version, and they don't necessarily have the same version number.
```bash
helm install airbyte-enterprise airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.3 \ # Helm chart version to use
--set global.image.tag=1.7.0 # Airbyte version to use
```
```bash
helm search repo airbyte-v2 --versions
```
<!-- I am realizing the decoupling the chart from the platform may create weird scenarios where it's unclear which version/chart combination to use. -->
You should see something like this:
```text
NAME CHART VERSION APP VERSION DESCRIPTION
airbyte-v2/airbyte 2.0.18 2.0.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.17 1.8.5 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.16 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.15 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.14 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.13 1.8.3 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.12 1.8.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.11 1.8.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.10 1.8.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.9 1.8.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.8 1.8.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.7 1.7.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.6 1.7.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.5 1.7.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.4 1.6.3 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.3 1.6.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.2 1.6.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.1 1.6.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.0 1.6.0 Helm chart to deploy airbyte
airbyte-v2/airbyte-data-plane 2.0.0 2.0.0 A Helm chart for installing an Airbyte Data Plane.
```
2. Install Airbyte into your Helm chart V2 namespace. In this example, you install Airbyte version 2.0.
```bash
helm install airbyte airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.18 # Helm chart version to use
```

55
docusaurus/platform_versioned_docs/version-2.0/enterprise-setup/implementation-guide.md
View File

@@ -957,13 +957,46 @@ helm install airbyte-enterprise airbyte/airbyte \
</TabItem>
<TabItem value='helm-2' label='Helm chart V2' default>
```bash
helm install airbyte-enterprise airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.3 \ # Helm chart version to use
--set global.image.tag=1.7.0 # Airbyte version to use
```
1. Identify the Helm chart version that corresponds to the platform version you want to run. Most Helm chart versions are designed to work with one Airbyte version, and they don't necessarily have the same version number.
```bash
helm search repo airbyte-v2 --versions
```
You should see something like this:
```text
NAME CHART VERSION APP VERSION DESCRIPTION
airbyte-v2/airbyte 2.0.18 2.0.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.17 1.8.5 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.16 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.15 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.14 1.8.4 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.13 1.8.3 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.12 1.8.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.11 1.8.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.10 1.8.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.9 1.8.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.8 1.8.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.7 1.7.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.6 1.7.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.5 1.7.0 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.4 1.6.3 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.3 1.6.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.2 1.6.2 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.1 1.6.1 Helm chart to deploy airbyte
airbyte-v2/airbyte 2.0.0 1.6.0 Helm chart to deploy airbyte
airbyte-v2/airbyte-data-plane 2.0.0 2.0.0 A Helm chart for installing an Airbyte Data Plane.
```
2. Install Airbyte into your Helm chart V2 namespace. In this example, you install Airbyte version 2.0.
```bash
helm install airbyte airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.18 # Helm chart version to use
```
</TabItem>
</Tabs>
@@ -990,11 +1023,10 @@ Upgrade Airbyte Self-Managed Enterprise by:
<TabItem value='helm-2' label='Helm chart V2' default>
```bash
helm upgrade airbyte-enterprise airbyte-v2/airbyte \
helm upgrade airbyte airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.3 \ # Helm chart version to use
--set global.image.tag=1.7.0 # Airbyte version to use
--version 2.x.x # Helm chart version to use
```
</TabItem>
@@ -1022,8 +1054,7 @@ After specifying your own configuration, run the following command:
helm upgrade airbyte-enterprise airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.3 \ # Helm chart version to use
--set global.image.tag=1.7.0 # Airbyte version to use
--version 2.x.x # Helm chart version to use
```
</TabItem>

3
docusaurus/platform_versioned_docs/version-2.0/enterprise-setup/upgrading-from-community.md
View File

@@ -55,8 +55,7 @@ Update your `values.yaml` file as explained in the [Self-Managed Enterprise impl
helm upgrade airbyte airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.3 \ # Helm chart version to use
--set global.image.tag=1.7.0 # Airbyte version to use
--version 2.x.x # Helm chart version to use
```
</TabItem>

3
docusaurus/platform_versioned_docs/version-2.0/operator-guides/upgrading-airbyte.md
View File

@@ -41,8 +41,7 @@ Upgrade by updating your `values.yaml` file and redeploying Airbyte. If you're n
helm upgrade airbyte airbyte-v2/airbyte \
--namespace airbyte-v2 \ # Target Kubernetes namespace
--values ./values.yaml \ # Custom configuration values
--version 2.0.3 \ # Helm chart version to use
--set global.image.tag=1.7.0 # Airbyte version to use
--version 2.x.x # Helm chart version to use
```
</TabItem>

476
docusaurus/src/data/embedded_api_spec.json
View File

@@ -263,6 +263,190 @@
}
}
},
"/api/v1/agents/chat/schema/definitions/sources/{source_definition_id}": {
"post": {
"tags": ["Agents - Schema Definitions"],
"summary": "Create Definition Chat",
"operationId": "create_agents_chat_schema_definitions_sources_source_definition_id",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "source_definition_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Source Definition Id"
}
},
{
"name": "x-organization-id",
"in": "header",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"description": "Select the working organization. Necessary since users can belong to multiple organizations.",
"title": "X-Organization-Id"
},
"description": "Select the working organization. Necessary since users can belong to multiple organizations."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPostRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/api/v1/agents/chat/schema/definitions/sources/{source_definition_id}/state": {
"get": {
"tags": ["Agents - Schema Definitions"],
"summary": "Get Schema Chat State",
"operationId": "get_agents_chat_schema_definitions_sources_source_definition_id_state",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "source_definition_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Source Definition Id"
}
},
{
"name": "x-organization-id",
"in": "header",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"description": "Select the working organization. Necessary since users can belong to multiple organizations.",
"title": "X-Organization-Id"
},
"description": "Select the working organization. Necessary since users can belong to multiple organizations."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SchemaChatAgentState"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/api/v1/agents/chat/schema/{source_id}": {
"post": {
"tags": ["Chat - Schema"],
@@ -2566,17 +2750,6 @@
"title": "Source Definition Id"
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"type": "string",
"description": "JMESPath query to filter the catalog. Example: `streams[].name` (names only) or `streams[?name=='users']` (users stream only).",
"title": "Query"
},
"description": "JMESPath query to filter the catalog. Example: `streams[].name` (names only) or `streams[?name=='users']` (users stream only)."
},
{
"name": "selected",
"in": "query",
@@ -2654,6 +2827,202 @@
}
}
}
},
"patch": {
"tags": ["Sources Definitions"],
"summary": "Patch Source Definition Catalog",
"description": "Patch the source definition's catalog. This allows updating global configurations such as selected streams.",
"operationId": "update_integrations_definitions_sources_source_definition_id_catalog",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "source_definition_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Source Definition Id"
}
},
{
"name": "x-organization-id",
"in": "header",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"description": "Select the working organization. Necessary since users can belong to multiple organizations.",
"title": "X-Organization-Id"
},
"description": "Select the working organization. Necessary since users can belong to multiple organizations."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourceDefinitionCatalogPatchRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourceDefinitionCatalogPatchResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/api/v1/integrations/definitions/sources/{source_definition_id}/catalog/query": {
"post": {
"tags": ["Sources Definitions"],
"summary": "Query Source Definition Catalog",
"description": "Query the source definition's catalog using a JMESPath expression.",
"operationId": "create_integrations_definitions_sources_source_definition_id_catalog_query",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "source_definition_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Source Definition Id"
}
},
{
"name": "x-organization-id",
"in": "header",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
"description": "Select the working organization. Necessary since users can belong to multiple organizations.",
"title": "X-Organization-Id"
},
"description": "Select the working organization. Necessary since users can belong to multiple organizations."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourceDefinitionCatalogQueryRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourceDefinitionCatalogQueryResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/api/v1/integrations/definitions/sources/{source_definition_id}/streams": {
@@ -9780,7 +10149,10 @@
"create_source_template",
"query_source_catalog",
"patch_source_catalog",
"patch_source_catalog_stream"
"patch_source_catalog_stream",
"query_source_definition_catalog",
"patch_source_definition_catalog",
"patch_source_definition_catalog_stream"
],
"title": "AgentToolName",
"description": "Enum of tool names available to agents.\nThis enum is automatically synced to the frontend via OpenAPI generation,\nensuring type safety when handling tool calls and responses.\nWhen adding a new tool to an agent (e.g., in app/agents/chat_agent.py),\nadd the corresponding tool name here to expose it to the frontend."
@@ -12746,9 +13118,21 @@
"$ref": "#/components/schemas/SchemaChatAgentStateType"
},
"source_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Source Id"
},
"source_definition_id": {
"type": "string",
"format": "uuid",
"title": "Source Id"
"title": "Source Definition Id"
},
"source_definition_name": {
"type": "string",
@@ -12787,12 +13171,17 @@
}
},
"type": "object",
"required": ["state", "source_id", "source_definition_name"],
"required": ["state", "source_definition_id", "source_definition_name"],
"title": "SchemaChatAgentState"
},
"SchemaChatAgentStateType": {
"type": "string",
"enum": ["unsupported_source", "first_session", "returning"],
"enum": [
"unsupported_source",
"first_session",
"returning",
"admin_session"
],
"title": "SchemaChatAgentStateType"
},
"ScopedTokenCreateRequest": {
@@ -13370,21 +13759,60 @@
"type": "null"
}
]
},
"query_result": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Query Result"
}
},
"type": "object",
"required": ["id", "name", "source_definition_id"],
"title": "SourceDefinitionCatalogGetResponse"
},
"SourceDefinitionCatalogPatchRequest": {
"properties": {
"patch_ops": {
"items": {
"$ref": "#/components/schemas/PatchOp"
},
"type": "array",
"title": "Patch Ops",
"description": "List of JSON Patch (RFC 6902) operations to apply to the catalog."
}
},
"type": "object",
"required": ["patch_ops"],
"title": "SourceDefinitionCatalogPatchRequest"
},
"SourceDefinitionCatalogPatchResponse": {
"properties": {
"catalog": {
"$ref": "#/components/schemas/SonarCatalogOutput"
}
},
"type": "object",
"required": ["catalog"],
"title": "SourceDefinitionCatalogPatchResponse"
},
"SourceDefinitionCatalogQueryRequest": {
"properties": {
"query": {
"type": "string",
"title": "Query",
"description": "JMESPath query to filter the catalog. Example: `streams[].name` (names only) or `streams[?name=='users']` (users stream only)."
}
},
"type": "object",
"required": ["query"],
"title": "SourceDefinitionCatalogQueryRequest"
},
"SourceDefinitionCatalogQueryResponse": {
"properties": {
"result": {
"title": "Result",
"description": "The result of the JMESPath query on the source definition's catalog"
}
},
"type": "object",
"required": ["result"],
"title": "SourceDefinitionCatalogQueryResponse"
},
"SourceDefinitionListResponse": {
"properties": {
"definitions": {