Skip to content

ACCEPTING_PROVIDERS.rst

Latest commit

 

History

History
150 lines (111 loc) · 6.94 KB

ACCEPTING_PROVIDERS.rst

File metadata and controls

150 lines (111 loc) · 6.94 KB
Raw

Accepting New Community Providers

Table of Contents

The Airflow community welcomes new provider contributions. All new providers enter through the Incubation stage (unless specifically accelerated by the PMC) to ensure alignment with ASF guidelines and community principles.

For details on the incubation stage and graduation criteria, see Provider Governance.

Note

There are two options for providers:

  1. A provider registered under Apache Airflow, subject to the process described below.
  2. A 3rd-party managed provider published on the Ecosystem page.

Prerequisites for proposing a new provider

  1. Working codebase: A functional implementation demonstrating the integration
  2. Stewardship commitment: At least two individuals willing to serve as stewards
  3. Committer sponsorship: At least one existing Airflow Committer willing to sponsor the stewards
  4. Quality standards: Code, tests, and documentation meeting the Contributing Guide standards
  5. System tests: If the provider integrates with a live external service, the proposal should describe how the integration will be continuously validated. The community encourages stewards to run system tests and publish results on a publicly accessible dashboard. See the System Test Dashboards for examples of how existing providers handle this.

Approval process

Accepting new community providers requires a [DISCUSS] thread on the Airflow devlist. No formal vote is required.

The discussion thread should include:

  • Description of the integration and its value to the Airflow ecosystem
  • Identification of the proposed stewards and their sponsoring committer(s)
  • Commitment to meet incubation health metrics within 6 months
  • Plan for participating in quarterly governance updates
  • Sponsoring committer(s) if you already have alignment with one or asking for a volunteer

If no objections are raised within 7 days, the proposal is considered accepted and the contributor may proceed with opening a PR.

Discussion thread template

Use the following template when opening your [DISCUSS] thread on the devlist:

Subject: [DISCUSS] New Community Provider: <name/service>

Hi Airflow community,

I'd like to propose adding a new community provider for <Service/Tool Name>.

Integration overview
--------------------
<Brief description of what the service/tool does and why it is valuable to Airflow users.>

System tests
------------
<If the provider integrates with a live external service, describe how system tests will be
run and validated, and whether results will be published to a public dashboard. If no live
service is involved, state that system tests are not required. See the existing dashboards
for examples: https://airflow.apache.org/ecosystem/#airflow-provider-system-test-dashboards>

Proposed stewards
-----------------
- <Name, GitHub handle, email>
- <Name, GitHub handle, email>

Sponsoring committer(s)
-----------------------
- <Name, GitHub handle>

Working implementation
----------------------
<Link to the draft PR or repository demonstrating a working implementation.>

Incubation commitment
---------------------
We commit to:
- Maintaining the provider and responding to issues within a reasonable time
- Meeting the incubation health metrics within 6 months
- Participating in quarterly governance updates

Best regards,
<Your name>

Alternative: 3rd-party managed providers

For service providers or systems integrators with dedicated teams to manage their provider and who wish to not participate in the Airflow community, we encourage considering 3rd-party management of providers. The Ecosystem page provides visibility for 3rd-party providers, and this approach allows service providers or systems integrators to:

  • Synchronize releases with their service updates
  • Maintain direct control over the integration
  • Support older Airflow versions if needed

There is no difference in technical capabilities between community and 3rd-party providers. See the Ecosystem page for a registry of available 3rd-party providers.

Examples of current process

Historical examples (pre policy simplification)

Historical examples (pre-AIP-95)