From 43dc70fa2d54fdd7f3d433a491ab781bbc360e1d Mon Sep 17 00:00:00 2001 From: ian-at-airbyte Date: Mon, 28 Apr 2025 17:29:27 -0700 Subject: [PATCH 1/5] First draft of release notes and docs updates. subject to change. --- .../platform/enterprise-setup/multi-region.md | 22 +++++++++---------- docs/release_notes/v-1.6.md | 22 +++++++++++++++++++ 2 files changed, 33 insertions(+), 11 deletions(-) diff --git a/docs/platform/enterprise-setup/multi-region.md b/docs/platform/enterprise-setup/multi-region.md index e2c4a1febf64..24395c05a9fa 100644 --- a/docs/platform/enterprise-setup/multi-region.md +++ b/docs/platform/enterprise-setup/multi-region.md @@ -47,7 +47,7 @@ Before you begin, make sure you've completed the following. - Deploy your Self-Managed Enterprise version of Airbyte as described in the [implementation guide](implementation-guide). -- You must be an Instance Administrator to manage regions and data planes. +- You must be an Organization Administrator to manage regions and data planes. - You need a Kubernetes cluster on which your data plane can run. For example, if your Airbyte control plane already runs on an EKS cluster on `us-west-2`, and you want your data plane to run on `eu-west-1`, create an EKS cluster on `eu-west-1`. @@ -111,16 +111,16 @@ Once you have a region, you create a data plane within it.
Request -Send a POST request to /v1/regions/``/dataplanes. +Send a POST request to /v1/dataplanes. ```bash -curl --request POST \ - --url https://example.com/api/public/v1/regions/116a49ab-b04a-49d6-8f9e-4d9d6a4189cc/dataplanes \ - --header 'authorization: Bearer $TOKEN' \ - --header 'content-type: application/json' \ - --data '{ - "name": "aws-us-west-3-dp-8" -}' +curl -X POST https://api.airbyte.com/v1/dataplanes \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer YOUR_API_TOKEN" \ + -d '{ + "name": "My Data Plane" + "regionId": "780d5bd9-a8a0-43cf-8b35-cc2061ad8319" + }' ``` Include the following parameters in your request. @@ -128,9 +128,9 @@ Include the following parameters in your request. | Body parameter | Required? | Description | | -------------- | --------- | ------------------------------------------------------------------------------------------------------------------- | | `name` | Required | The name of your data plane. For simplicity, you might want to name it based on the region in which you created it. | -| `enabled` | Optional | Defaults to true. Set this to `false` if you don't want this data plane enabled. | +| `regionId` | Optional | The region this data plane belongs to. | -For additional request examples, see [the API reference](https://reference.airbyte.com/reference/regions#/). +For additional request examples, see [the API reference](https://reference.airbyte.com/reference/dataplanes#/).
diff --git a/docs/release_notes/v-1.6.md b/docs/release_notes/v-1.6.md index 0fb640461d9c..9195025e284f 100644 --- a/docs/release_notes/v-1.6.md +++ b/docs/release_notes/v-1.6.md @@ -118,3 +118,25 @@ Airbyte now requires that stream identifiers be unique across Airbyte connection A common scenario looks like this: you have multiple accounts for the same source API and want to sync all this data to a single table in your destination. Although convenient, doing this carried a risk of data loss as multiple connections clashed with each other while writing to the same table. After careful consideration, Airbyte has stopped supporting this. You must use a unique prefix for each stream or a unique namespace in each connection. Then, you can combine your tables downstream of Airbyte. [Learn more >](/platform/using-airbyte/configuring-schema#stream-uniqueness) + +## Patches + +### 1.6.1 + +Version 1.6.1 was released April 30, 2025. + +- Fixed [issue #58587](https://github.com/airbytehq/airbyte/issues/58587), which caused some 1.6.0 deployments and upgrades using abctl to fail. + +- Self-Managed Enterprise customers can create, update, delete, and list data planes using the new, top-level dataplane endpoint, `/dataplane`. Previously, data plane endpoints were nested under `/region`. For more information about creating data planes, see [Multiple region deployments](/platform/enterprise-setup/multi-region). (pending) + +- In Self-Managed Enterprise, organization administrators can now create and manage regions and data planes. Previously, only the instance administrator could do this. + +- Removed the name from the data plane model, as it wasn't necessary data. (pending) + +- Data planes are now automatically set to `enabled: true`. Previously, you had to set this manually. To turn off a data plane after creating it, send a PATCH request to `/dataplane`. (pending) + +- Deleting a data plane now *actually* deletes it. Previously, the data plane still existed, and deleting it set `enabled` to `false`. To turn off a data plane without deleting it, use PATCH instead of DELETE. (pending) + +- Removed an unnecessary line from the log in workload-launcher, because it caused a variety of problems. + +- When a data plane comes online and connects to the server, we now log this. From fe1367bd14ef7d32d63fe9ea2b1d84e2354e2768 Mon Sep 17 00:00:00 2001 From: ian-at-airbyte Date: Tue, 29 Apr 2025 17:22:53 -0700 Subject: [PATCH 2/5] Updates based on inclusions/cuts --- docs/platform/enterprise-setup/multi-region.md | 2 +- docs/release_notes/v-1.6.md | 12 +++--------- 2 files changed, 4 insertions(+), 10 deletions(-) diff --git a/docs/platform/enterprise-setup/multi-region.md b/docs/platform/enterprise-setup/multi-region.md index 24395c05a9fa..99e37b1526a5 100644 --- a/docs/platform/enterprise-setup/multi-region.md +++ b/docs/platform/enterprise-setup/multi-region.md @@ -47,7 +47,7 @@ Before you begin, make sure you've completed the following. - Deploy your Self-Managed Enterprise version of Airbyte as described in the [implementation guide](implementation-guide). -- You must be an Organization Administrator to manage regions and data planes. +- You must be an Instance Administrator to manage regions and data planes. - You need a Kubernetes cluster on which your data plane can run. For example, if your Airbyte control plane already runs on an EKS cluster on `us-west-2`, and you want your data plane to run on `eu-west-1`, create an EKS cluster on `eu-west-1`. diff --git a/docs/release_notes/v-1.6.md b/docs/release_notes/v-1.6.md index 9195025e284f..38790d122622 100644 --- a/docs/release_notes/v-1.6.md +++ b/docs/release_notes/v-1.6.md @@ -127,16 +127,10 @@ Version 1.6.1 was released April 30, 2025. - Fixed [issue #58587](https://github.com/airbytehq/airbyte/issues/58587), which caused some 1.6.0 deployments and upgrades using abctl to fail. -- Self-Managed Enterprise customers can create, update, delete, and list data planes using the new, top-level dataplane endpoint, `/dataplane`. Previously, data plane endpoints were nested under `/region`. For more information about creating data planes, see [Multiple region deployments](/platform/enterprise-setup/multi-region). (pending) +- Self-Managed Enterprise customers can create, update, delete, and list data planes using the new `/dataplane` endpoint. Previously, data plane endpoints were under `/region`. For more information about creating data planes, see [Multiple region deployments](/platform/enterprise-setup/multi-region). -- In Self-Managed Enterprise, organization administrators can now create and manage regions and data planes. Previously, only the instance administrator could do this. - -- Removed the name from the data plane model, as it wasn't necessary data. (pending) - -- Data planes are now automatically set to `enabled: true`. Previously, you had to set this manually. To turn off a data plane after creating it, send a PATCH request to `/dataplane`. (pending) - -- Deleting a data plane now *actually* deletes it. Previously, the data plane still existed, and deleting it set `enabled` to `false`. To turn off a data plane without deleting it, use PATCH instead of DELETE. (pending) +- Data planes and regions are automatically enabled when you create them. Previously, you had to set this manually. - Removed an unnecessary line from the log in workload-launcher, because it caused a variety of problems. -- When a data plane comes online and connects to the server, we now log this. +- When a data plane comes online and connects to the server, Airbyte now logs it. From 3f19ee36cb6829567c318115129da02dc534f3b6 Mon Sep 17 00:00:00 2001 From: ian-at-airbyte Date: Wed, 30 Apr 2025 14:18:15 -0700 Subject: [PATCH 3/5] We already do this log. No change needed. --- docs/release_notes/v-1.6.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/release_notes/v-1.6.md b/docs/release_notes/v-1.6.md index 38790d122622..e586b4022554 100644 --- a/docs/release_notes/v-1.6.md +++ b/docs/release_notes/v-1.6.md @@ -125,12 +125,10 @@ After careful consideration, Airbyte has stopped supporting this. You must use a Version 1.6.1 was released April 30, 2025. -- Fixed [issue #58587](https://github.com/airbytehq/airbyte/issues/58587), which caused some 1.6.0 deployments and upgrades using abctl to fail. +- Fixed [issue #58587](https://github.com/airbytehq/airbyte/issues/58587), which caused some 1.6.0 installs and upgrades using abctl to fail. - Self-Managed Enterprise customers can create, update, delete, and list data planes using the new `/dataplane` endpoint. Previously, data plane endpoints were under `/region`. For more information about creating data planes, see [Multiple region deployments](/platform/enterprise-setup/multi-region). - Data planes and regions are automatically enabled when you create them. Previously, you had to set this manually. - Removed an unnecessary line from the log in workload-launcher, because it caused a variety of problems. - -- When a data plane comes online and connects to the server, Airbyte now logs it. From b2bad660bf26ba0782915296ccb083d0c28f65f8 Mon Sep 17 00:00:00 2001 From: ian-at-airbyte Date: Wed, 30 Apr 2025 16:47:07 -0700 Subject: [PATCH 4/5] Slight clarification --- docs/release_notes/v-1.6.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release_notes/v-1.6.md b/docs/release_notes/v-1.6.md index e586b4022554..efb868ba2725 100644 --- a/docs/release_notes/v-1.6.md +++ b/docs/release_notes/v-1.6.md @@ -125,7 +125,7 @@ After careful consideration, Airbyte has stopped supporting this. You must use a Version 1.6.1 was released April 30, 2025. -- Fixed [issue #58587](https://github.com/airbytehq/airbyte/issues/58587), which caused some 1.6.0 installs and upgrades using abctl to fail. +- Fixed [issue #58587](https://github.com/airbytehq/airbyte/issues/58587), which caused some 1.6.0 installs and upgrades using abctl and helm to fail. - Self-Managed Enterprise customers can create, update, delete, and list data planes using the new `/dataplane` endpoint. Previously, data plane endpoints were under `/region`. For more information about creating data planes, see [Multiple region deployments](/platform/enterprise-setup/multi-region). From 75df1113fc984e72c27fbcdd11cedd7400639846 Mon Sep 17 00:00:00 2001 From: ian-at-airbyte Date: Wed, 30 Apr 2025 16:56:50 -0700 Subject: [PATCH 5/5] Fix a bad example link --- docs/platform/enterprise-setup/multi-region.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform/enterprise-setup/multi-region.md b/docs/platform/enterprise-setup/multi-region.md index 99e37b1526a5..51d4b24b93d0 100644 --- a/docs/platform/enterprise-setup/multi-region.md +++ b/docs/platform/enterprise-setup/multi-region.md @@ -114,7 +114,7 @@ Once you have a region, you create a data plane within it. Send a POST request to /v1/dataplanes. ```bash -curl -X POST https://api.airbyte.com/v1/dataplanes \ +curl -X POST https://example.com/api/public/v1/dataplanes \ -H "Content-Type: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -d '{