diff --git a/docs/release_notes/assets/1.5-declarative-oauth.png b/docs/release_notes/assets/1.5-declarative-oauth.png new file mode 100644 index 00000000000..d460d6f75ff Binary files /dev/null and b/docs/release_notes/assets/1.5-declarative-oauth.png differ diff --git a/docs/release_notes/assets/1.5-resource-allocation.png b/docs/release_notes/assets/1.5-resource-allocation.png new file mode 100644 index 00000000000..8b1652ef6d1 Binary files /dev/null and b/docs/release_notes/assets/1.5-resource-allocation.png differ diff --git a/docs/release_notes/assets/1.5-tags.png b/docs/release_notes/assets/1.5-tags.png new file mode 100644 index 00000000000..4043ffca684 Binary files /dev/null and b/docs/release_notes/assets/1.5-tags.png differ diff --git a/docs/release_notes/v-1.0.md b/docs/release_notes/v-1.0.md index 7dc4660047c..d79bf317ac9 100644 --- a/docs/release_notes/v-1.0.md +++ b/docs/release_notes/v-1.0.md @@ -1,7 +1,5 @@ # Airbyte 1.0 -## airbyte v1.0.0 - This page includes new features and improvements to the Airbyte products we're excited to share as a part of the 1.0 release. Airbyte v1.0 contains many improvements and additions to enhance the reliability, scalability, and uses of Airbyte. Moving forward, Airbyte will release official new platform versions on a monthly cadence, with the associated [changelog](https://github.com/airbytehq/airbyte/releases). @@ -59,4 +57,4 @@ Self-Managed Enterprise extends on Airbyte 1.0 by introducing new classes of fun - To ensure adherence to security best practices, Airbyte is migrating all connectors to [non-root versions](https://github.com/airbytehq/airbyte/discussions/44924). It is highly recommended that you upgrade your platform version to [v0.63.9](https://github.com/airbytehq/airbyte-platform/releases/tag/v0.63.9) or later before October 2024 to ensure your syncs continue to succeed. -- As we prepare to deprecate Docker Compose, we published a [migration guide](../../using-airbyte/getting-started/oss-quickstart#migrating-from-docker-compose-optional) for those migrating from Docker Compose to abctl. \ No newline at end of file +- As we prepare to deprecate Docker Compose, we published a [migration guide](../../using-airbyte/getting-started/oss-quickstart#migrating-from-docker-compose-optional) for those migrating from Docker Compose to abctl. diff --git a/docs/release_notes/v-1.5.md b/docs/release_notes/v-1.5.md new file mode 100644 index 00000000000..29f1e3e9c48 --- /dev/null +++ b/docs/release_notes/v-1.5.md @@ -0,0 +1,87 @@ +# Airbyte 1.5.0 + +Valentine's Day let you down? That's OK. You'll love this. Airbyte 1.5.0 was released on February 20, 2025. We’re excited to share new improvements and changes to the Airbyte platform. + +## πŸš€ Platform Changes + +These changes improve Airbyte for all Self-Managed users. + +### Declarative OAuth 2.0 in the connector builder + +If you're building a connector to an API and want to authenticate with OAuth, you can now authenticate directly in the Connector Builder. This simplified flow ensures you can start building connectors to APIs that support OAuth without writing code to authenticate yourself and provide Airbyte with tokens. OAuth 2.0 is also supported in the low-code connector development kit (CDK), where you can define your authentication using YAML. + +To learn more, see the authentication documentation: [No-code Connector Builder](../connector-development/connector-builder-ui/authentication#oauth) | [Low-code CDK](../connector-development/config-based/advanced-topics/oauth). + +![Connector builder with OAuth 2.0 authentication](assets/1.5-declarative-oauth.png) + +### Connection tags + +You can now classify your connections with tags. As time goes on, your number of connections tends to increase. This popular classification tool gives you the power to organize connections based on any set of criteria you like, then filter for the ones you want to see. [**Learn more >**](../using-airbyte/tagging) + +![Connections page with tags applied to connections](assets/1.5-tags.png) + +### Configure workspace notifications in the API + +Use the Airbyte API to view and change email and webhook notification settings in your workspace. Previously, this was only available in Airbyte's user interface. + +- [List workspaces](https://reference.airbyte.com/reference/listworkspaces) returns a notifications object with details about each workspace's notification settings. +- [Get workspace details](https://reference.airbyte.com/reference/getworkspace) returns a notifications object with details about that workspace's notification settings. +- [Create a workspace](https://reference.airbyte.com/reference/createworkspace) has a notifications object parameter so you can configure notifications when you create the workspace. +- [Update a workspace](https://reference.airbyte.com/reference/updateworkspace) has a notifications object parameter so you can configure notifications later. + +Use notifications if you want to be alerted to important events in Airbyte, like failed syncs, schema changes, and mandatory connector upgrades. [**Learn more about notifications >**](../cloud/managing-airbyte-cloud/manage-airbyte-cloud-notifications) + +### Full Refresh - Overwrite + Deduped in the API + +Use the API to set "Full Refresh - Overwrite + Deduped" as your [sync mode](../using-airbyte/core-concepts/sync-modes/) when [creating](https://reference.airbyte.com/reference/createconnection) and [updating](https://reference.airbyte.com/reference/patchconnection) a connection. Previously, this sync mode was only available in Airbyte's user interface. + +## πŸš€ Self-Managed Enterprise Changes + +These changes bring new capabilities to Airbyte's Self-Managed Enterprise customers. + +### Mappings in the UI + +We introduced mappings in the API in version 1.3, and it's now available in Airbyte's user interface, too. Use mappings to hash, encrypt, and rename fields, and filter rows. You set up mappings on each stream, ensuring your source data arrives in your destination in a more meaningful way. [**Learn more >**](../using-airbyte/mappings) + +![](../using-airbyte/images/mappings.png) + +### OpenTelemetry (OTel) metrics monitoring + +Self-Managed Enterprise now generates a number of crucial metrics about syncs and volumes of data moved. You can configure Airbyte to send telemetry data to an OTel collector endpoint so you can consume these metrics in your downstream monitoring tool of choice. The following metrics are available: + +- Sync details +- Sync duration +- Volume of data moved +- API requests + +To start sending metrics, update your `values.yaml` file with the following configurations. [**Learn more >**](../operator-guides/collecting-metrics) + +```yaml title="values.yaml" +global: + edition: enterprise # This is an enterprise-only feature + metrics: + enabled: true + otlp: + enabled: true + collectorEndpoint: "YOUR_ENDPOINT" # The OTel collector endpoint Airbyte sends metrics to. You configure this endpoint outside of Airbyte as part of your OTel deployment. +``` + +### Resource allocation on connectors + +In Self-Managed Enterprise, you can now define resource allocations for individual connectors as part of that connector's configuration, both in the user interface and the API. + +Airbyte's default CPU and memory allocations aren't always appropriate for every situation, and different connectors have different resource requirements. This can make it challenging to run a large number of concurrent syncs. Historically, you had to tweak a number of variables to configure this. Now, you can set CPU and memory allocation when you set up a source or destination, and it applies to all connections using that connector. [**Learn more >**](../operator-guides/configuring-connector-resources) + +![Connector resource allocation screenshot](assets/1.5-resource-allocation.png) + +:::note +Resource allocation can still be set on specific connections, on all connectors of a type using `resourceRequirements`, and using environment variables. In cases where resource allocation is defined multiple times, there is an order of precedence. Narrower definitions have higher precedence. From highest to lowest: **Connection** > **Connector** > **Connector yaml definition** > **environment variables**. See [the documentation](../operator-guides/configuring-connector-resources) to learn more about precedence. +::: + +## πŸ› Bug fixes + +- [Fixed issue #46097](https://github.com/airbytehq/airbyte/issues/46097). When using AWS Secrets Manager, updating a connector that used secrets caused its secrets to be deleted. For connectors with secrets that were deleted because of the bug, upgrade to 1.5 and then update your connector's secrets. They will persist correctly. For sources/destinations that were not affected, upgrading to 1.5 prevents the issue. + +## Other Changes + +Docusaurus is upgraded to version 3.7. Local docs site builds are a bit faster. diff --git a/docusaurus/sidebars.js b/docusaurus/sidebars.js index 746636620c8..ba4166a26a3 100644 --- a/docusaurus/sidebars.js +++ b/docusaurus/sidebars.js @@ -777,37 +777,48 @@ module.exports = { description: "We release new self-managed versions of Airbyte regularly. Airbyte Cloud customers always have the latest enhancements.", }, items: [ + "release_notes/v-1.5", "release_notes/v-1.4", "release_notes/v-1.3", "release_notes/v-1.2", "release_notes/v-1.1", "release_notes/v-1.0", - "release_notes/aug_2024", - "release_notes/july_2024", - "release_notes/june_2024", - "release_notes/may_2024", - "release_notes/april_2024", - "release_notes/march_2024", - "release_notes/february_2024", - "release_notes/january_2024", - "release_notes/december_2023", - "release_notes/november_2023", - "release_notes/october_2023", - "release_notes/upgrading_to_destinations_v2", - "release_notes/september_2023", - "release_notes/july_2023", - "release_notes/june_2023", - "release_notes/may_2023", - "release_notes/april_2023", - "release_notes/march_2023", - "release_notes/february_2023", - "release_notes/january_2023", - "release_notes/december_2022", - "release_notes/november_2022", - "release_notes/october_2022", - "release_notes/september_2022", - "release_notes/august_2022", - "release_notes/july_2022", + { + type: "category", + label: "Historical release notes", + link: { + type: "generated-index", + description: "Historical release notes from before Airbyte 1.0 are preserved here for posterity." + }, + items: [ + "release_notes/aug_2024", + "release_notes/july_2024", + "release_notes/june_2024", + "release_notes/may_2024", + "release_notes/april_2024", + "release_notes/march_2024", + "release_notes/february_2024", + "release_notes/january_2024", + "release_notes/december_2023", + "release_notes/november_2023", + "release_notes/october_2023", + "release_notes/upgrading_to_destinations_v2", + "release_notes/september_2023", + "release_notes/july_2023", + "release_notes/june_2023", + "release_notes/may_2023", + "release_notes/april_2023", + "release_notes/march_2023", + "release_notes/february_2023", + "release_notes/january_2023", + "release_notes/december_2022", + "release_notes/november_2022", + "release_notes/october_2022", + "release_notes/september_2022", + "release_notes/august_2022", + "release_notes/july_2022", + ] + }, ], }, ],