Skip to content

Commit

Permalink
Update support level terminology in docs (#40723)
Browse files Browse the repository at this point in the history
  • Loading branch information
lmossman authored Jul 8, 2024
1 parent 8c8c636 commit 5bdbaa4
Show file tree
Hide file tree
Showing 8 changed files with 44 additions and 25 deletions.
4 changes: 2 additions & 2 deletions docs/enterprise-setup/upgrading-from-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ These instructions are for you if:

### Step 1: Update Airbyte Open Source

You must first update to the latest Open Source community release. We assume you are running the following steps from the root of the `airbytehq/airbyte-platform` cloned repo.
You must first update to the latest Open Source Community release. We assume you are running the following steps from the root of the `airbytehq/airbyte-platform` cloned repo.

1. Determine your current helm release name by running `helm list`. This will now be referred to as `[RELEASE_NAME]` for the rest of this guide.
2. Upgrade to the latest Open Source community release. The output will now be refered to as `[RELEASE_VERSION]` for the rest of this guide:
2. Upgrade to the latest Open Source Community release. The output will now be refered to as `[RELEASE_VERSION]` for the rest of this guide:

```sh
helm upgrade [RELEASE_NAME] airbyte/airbyte
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Learn more about contributing to Airbyte [here](/contributing-to-airbyte/).

## Connector Support Levels

Airbyte uses a tiered system for connectors to help you understand what to expect from a connector. In short, there are three tiers: Certified Connectors, Community Connectors, and Custom Connectors. Review the documentation on [connector support levels](./connector-support-levels.md) for details on each tier.
Airbyte uses a tiered system for connectors to help you understand what to expect from a connector. In short, there are three tiers: Airbyte Connectors, Marketplace Connectors, and Custom Connectors. Review the documentation on [connector support levels](./connector-support-levels.md) for details on each tier.

_[View the connector registries in full](https://connectors.airbyte.com/files/generated_reports/connector_registry_report.html)_

Expand Down
37 changes: 19 additions & 18 deletions docs/integrations/connector-support-levels.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,54 +6,55 @@ products: all

The following table describes the support levels of Airbyte connectors.

| | Certified | Community | Custom |
| | Airbyte Connector | Marketplace | Custom |
| ------------------------------------ | ----------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Availability** | Available to all users | Available to all users | Available to all users |
| **Who builds them?** | Either the community or the Airbyte team. | Typically they are built by the community. The Airbyte team may upgrade them to Certified at any time. | Anyone can build custom connectors. We recommend using our [Connector Builder](https://docs.airbyte.com/connector-development/connector-builder-ui/overview) or [Low-code CDK](https://docs.airbyte.com/connector-development/config-based/low-code-cdk-overview). |
| **Who builds them?** | Either the community or the Airbyte team. | Typically they are built by the community. The Airbyte team may upgrade them to become an Airbyte Connector at any time. | Anyone can build custom connectors. We recommend using our [Connector Builder](https://docs.airbyte.com/connector-development/connector-builder-ui/overview) or [Low-code CDK](https://docs.airbyte.com/connector-development/config-based/low-code-cdk-overview). |
| **Who maintains them?** | The Airbyte team | Users | Users |
| **Production Readiness** | Guaranteed by Airbyte | Not guaranteed | Not guaranteed |
| **Support: Cloud** | Supported\* | No Support | Supported\*\* |
| **Support: Powered by Airbyte** | Supported\* | No Support | Supported\*\* |
| **Support: Self-Managed Enterprise** | Supported\* | No Support | Supported\*\* |
| **Support: Community (OSS)** | Slack Support only | No Support | Slack Support only |

\*For Certified connectors, Official Support SLAs are only available to customers with Premium
\*For Airbyte Connectors, Official Support SLAs are only available to customers with Premium
Support included in their contract. Otherwise, please use our support portal and we will address
your issues as soon as possible.

\*\*For Custom connectors, Official Support SLAs are only available to customers with Premium
Support included in their contract. This support is provided with best efforts, and
maintenance/upgrades are owned by the customer.

## Certified
## Airbyte Connectors

A **Certified** connector is actively maintained and supported by the Airbyte team and maintains a
An **Airbyte Connector** is actively maintained and supported by the Airbyte team and maintains a
high quality bar. It is production ready.

### What you should know about Certified connectors:
### What you should know about Airbyte Connectors:

- Certified connectors are available to all users.
- These connectors have been tested and vetted in order to be certified and are production ready.
- Certified connectors should go through minimal breaking change but in the event an upgrade is
- Airbyte Connectors are officially supported by Airbyte and are available to all users.
- These connectors have been tested and vetted. They are production ready.
- Airbyte Connectors should go through minimal breaking change but in the event an upgrade is
needed users will be given an adequate upgrade window.

## Community
## Marketplace

A **Community** connector is maintained by the Airbyte community until it becomes Certified. Airbyte
A **Marketplace** connector is maintained by the community members until it becomes an official Integration. Airbyte
has over 800 code contributors and 15,000 people in the Slack community to help. The Airbyte team is
continually certifying Community connectors as usage grows. As these connectors are not maintained
by Airbyte, we do not offer support SLAs around them, and we encourage caution when using them in
continually reviewing Marketplace connectors as usage grows to determine when a Marketplace connector should become an Airbyte Integration. Marketplace connectors are not maintained
by Airbyte and we do not offer support SLAs around them. We encourage caution when using them in
production.

### What you should know about Community connectors:
### What you should know about Marketplace connectors:

- Community connectors are available to all users.
- Community connectors may be upgraded to Certified at any time, and we will notify users of these
- Marketplace connectors are available to all users.
- Marketplace connectors may be upgraded to an official Integration at any time, and we will notify users of these
upgrades via our Slack Community and in our Connector Catalog.
- Community connectors might not be feature-complete (features planned for release are under
- Marketplace connectors might not be feature-complete (features planned for release are under
development or not prioritized) and may include backward-incompatible/breaking API changes with no
or short notice.
- Community connectors have no Support SLAs.
- Marketplace connectors have no Support SLAs.
- You're very welcome to contribute new features and streams to an existing Marketplace integration. Airbyte Contributor Experience team is happy to review PRs when we have capacity.

## Archived

Expand Down
4 changes: 3 additions & 1 deletion docs/understanding-airbyte/database-data-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
- Each record represents a connector that Airbyte supports, e.g. Postgres. This table represents all the connectors that is supported by the current running platform.
- The `actor_type` column tells us whether the record represents a Source or a Destination.
- The `spec` column is a JSON blob. The schema of this JSON blob matches the [spec](airbyte-protocol.md#actor-specification) model in the Airbyte Protocol. Because the protocol object is JSON, this has to be a JSON blob.
- The `support_level` describes the support level of the connector (e.g. community, certified).
- The `support_level` describes the support level of the connector (e.g. `community`, `certified`, or `archived`).
- In the product UI, the Marketplace tab contains connectors with `community` support level, and Airbyte Connectors tab contains `certified` connectors.
- `support_level: archived` signals that this connector is no longer supported, and it's not available to install for any new connections.
- The `docker_repository` field is the name of the docker image associated with the connector definition. `docker_image_tag` is the tag of the docker image and the version of the connector definition.
- The `source_type` field is only used for Sources, and represents the category of the connector definition (e.g. API, Database).
- The `resource_requirements` field sets a default resource requirement for any connector of this type. This overrides the default we set for all connector definitions, and it can be overridden by a connection-specific resource requirement. The column is a JSON blob with the schema defined in [ActorDefinitionResourceRequirements.yaml](https://github.com/airbytehq/airbyte/blob/master/airbyte-config-oss/config-models-oss/src/main/resources/types/ActorDefinitionResourceRequirements.yaml)
Expand Down
2 changes: 1 addition & 1 deletion docs/using-airbyte/getting-started/add-a-destination.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Once you've signed up for Airbyte Cloud or logged in to your Airbyte Open Source
You can use the provided search bar at the top of the page, or scroll down the list to find the destination you want to replicate data from.

:::tip
You can filter the list of destinations by support level. Airbyte connectors are categorized in two support levels, Certified and Community. See our [Connector Support Levels](/integrations/connector-support-levels.md) page for more information on this topic.
You can filter the list of destinations by support level. Airbyte connectors are categorized in two support levels, Airbyte Connectors and Marketplace Connectors. See our [Connector Support Levels](/integrations/connector-support-levels.md) page for more information on this topic.
:::

<Tabs groupId="cloud-hosted">
Expand Down
3 changes: 2 additions & 1 deletion docusaurus/src/components/ConnectorRegistry.jsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import React from "react";
import { useEffect, useState } from "react";
import { getSupportLevelDisplay } from "../connector_registry";

import styles from "./ConnectorRegistry.module.css";
import { REGISTRY_URL } from "../connector_registry";
Expand Down Expand Up @@ -86,7 +87,7 @@ export default function ConnectorRegistry({ type }) {
) : null}
</td>
<td>
<small>{connector.supportLevel_oss}</small>
<small>{getSupportLevelDisplay(connector.supportLevel_oss)}</small>
</td>
<td>{connector.is_oss ? "✅" : "❌"}</td>
<td>{connector.is_cloud ? "✅" : "❌"}</td>
Expand Down
3 changes: 2 additions & 1 deletion docusaurus/src/components/HeaderDecoration.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import relativeTime from "dayjs/plugin/relativeTime";
import styles from "./HeaderDecoration.module.css";
import { Chip } from "./Chip";
import { Callout } from "./Callout";
import { getSupportLevelDisplay } from "../connector_registry";

// Extend Day.js with the relativeTime plugin
dayjs.extend(relativeTime);
Expand Down Expand Up @@ -254,7 +255,7 @@ const ConnectorMetadataCallout = ({
</MetadataStat>
<MetadataStat label="Support Level">
<a href="/integrations/connector-support-levels/">
<Chip>{supportLevel}</Chip>
<Chip>{getSupportLevelDisplay(supportLevel)}</Chip>
</a>
</MetadataStat>
{supportLevel !== "archived" && (
Expand Down
14 changes: 14 additions & 0 deletions docusaurus/src/connector_registry.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@ const parseCDKVersion = (connectorCdkVersion, latestPythonCdkVersion, latestJava
}
};

function getSupportLevelDisplay(rawSupportLevel) {
switch (rawSupportLevel) {
case "certified":
return "Airbyte Connector";
case "community":
return "Marketplace";
case "archived":
return "Archived";
default:
return null;
}
}

module.exports = {
REGISTRY_URL,
catalog: fetchCatalog(),
Expand All @@ -46,4 +59,5 @@ module.exports = {
},
getLatestPythonCDKVersion,
parseCDKVersion,
getSupportLevelDisplay,
};

0 comments on commit 5bdbaa4

Please sign in to comment.