Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AIP-69: Adding Empty Edge Provider Package #42046

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/airflow_providers_bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ body:
- dingding
- discord
- docker
- edge
- elasticsearch
- exasol
- fab
Expand Down
2 changes: 1 addition & 1 deletion INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ airbyte, alibaba, amazon, apache.beam, apache.cassandra, apache.drill, apache.dr
apache.hdfs, apache.hive, apache.iceberg, apache.impala, apache.kafka, apache.kylin, apache.livy,
apache.pig, apache.pinot, apache.spark, apprise, arangodb, asana, atlassian.jira, celery, cloudant,
cncf.kubernetes, cohere, common.compat, common.io, common.sql, databricks, datadog, dbt.cloud,
dingding, discord, docker, elasticsearch, exasol, fab, facebook, ftp, github, google, grpc,
dingding, discord, docker, edge, elasticsearch, exasol, fab, facebook, ftp, github, google, grpc,
hashicorp, http, imap, influxdb, jdbc, jenkins, microsoft.azure, microsoft.mssql, microsoft.psrp,
microsoft.winrm, mongo, mysql, neo4j, odbc, openai, openfaas, openlineage, opensearch, opsgenie,
oracle, pagerduty, papermill, pgvector, pinecone, postgres, presto, qdrant, redis, salesforce,
Expand Down
45 changes: 45 additions & 0 deletions airflow/providers/edge/CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

.. http://www.apache.org/licenses/LICENSE-2.0

.. Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.


.. NOTE TO CONTRIBUTORS:
Please, only add notes to the Changelog just below the "Changelog" header when there are some breaking changes
and you want to add an explanation to the users on how they are supposed to deal with them.
The changelog is updated and maintained semi-automatically by release manager.

``apache-airflow-providers-edge``


Changelog
---------

0.1.0pre0
.........


.. Below changes are excluded from the changelog. Move them to
appropriate section above if needed. Do not delete the lines(!):

0.1.0
.....

|experimental|

Initial version of the provider.

.. note::
This provider is currently experimental
39 changes: 39 additions & 0 deletions airflow/providers/edge/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
# NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE
# OVERWRITTEN WHEN PREPARING DOCUMENTATION FOR THE PACKAGES.
#
# IF YOU WANT TO MODIFY THIS FILE, YOU SHOULD MODIFY THE TEMPLATE
# `PROVIDER__INIT__PY_TEMPLATE.py.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY
#
from __future__ import annotations

import packaging.version

from airflow import __version__ as airflow_version

__all__ = ["__version__"]

__version__ = "0.1.0pre0"

if packaging.version.parse(packaging.version.parse(airflow_version).base_version) < packaging.version.parse(
"2.10.0"
):
raise RuntimeError(
f"The package `apache-airflow-providers-edge:{__version__}` needs Apache Airflow 2.10.0+"
)
96 changes: 96 additions & 0 deletions airflow/providers/edge/provider.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

# yaml-language-server: $schema=../../provider.yaml.schema.json
---
package-name: apache-airflow-providers-edge
name: Edge Executor
description: |
Handle edge workers on remote sites via HTTP(s) connection and orchestrates work over distributed sites

state: not-ready
source-date-epoch: 1720863625
# note that those versions are maintained by release manager - do not update them manually
versions:
- 0.1.0pre0

dependencies:
- apache-airflow>=2.10.0
- pydantic>=2.3.0

config:
edge:
description: |
This section only applies if you are using the EdgeExecutor in
``[core]`` section above
options:
api_enabled:
description: |
Flag if the plugin endpoint is enabled to serve Edge Workers.
version_added: ~
type: boolean
example: "True"
default: "False"
api_url:
description: |
URL endpoint on which the Airflow code edge API is accessible from edge worker.
version_added: ~
type: string
example: https://airflow.hosting.org/edge_worker/v1/rpcapi
default: ~
job_poll_interval:
description: |
Edge Worker currently polls for new jobs via HTTP. This parameter defines the number
of seconds it should sleep between polls for new jobs.
Job polling only happens if the Edge Worker seeks for new work. Not if busy.
version_added: ~
type: integer
example: "5"
default: "5"
heartbeat_interval:
description: |
Edge Worker continuously reports status to the central site. This parameter defines
how often a status with heartbeat should be sent.
During heartbeat status is reported as well as it is checked if a running task is to be terminated.
version_added: ~
type: integer
example: "10"
default: "30"
worker_concurrency:
description: |
The concurrency that will be used when starting workers with the
``airflow edge worker`` command. This defines the number of task instances that
a worker will take, so size up your workers based on the resources on
your worker box and the nature of your tasks
version_added: ~
type: integer
example: ~
default: "8"
job_success_purge:
description: |
Minutes after which successful jobs for EdgeExecutor are purged from database
version_added: ~
type: integer
example: ~
default: "5"
job_fail_purge:
description: |
Minutes after which failed jobs for EdgeExecutor are purged from database
version_added: ~
type: integer
example: ~
default: "60"
2 changes: 1 addition & 1 deletion contributing-docs/12_airflow_dependencies_and_extras.rst
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ airbyte, alibaba, amazon, apache.beam, apache.cassandra, apache.drill, apache.dr
apache.hdfs, apache.hive, apache.iceberg, apache.impala, apache.kafka, apache.kylin, apache.livy,
apache.pig, apache.pinot, apache.spark, apprise, arangodb, asana, atlassian.jira, celery, cloudant,
cncf.kubernetes, cohere, common.compat, common.io, common.sql, databricks, datadog, dbt.cloud,
dingding, discord, docker, elasticsearch, exasol, fab, facebook, ftp, github, google, grpc,
dingding, discord, docker, edge, elasticsearch, exasol, fab, facebook, ftp, github, google, grpc,
hashicorp, http, imap, influxdb, jdbc, jenkins, microsoft.azure, microsoft.mssql, microsoft.psrp,
microsoft.winrm, mongo, mysql, neo4j, odbc, openai, openfaas, openlineage, opensearch, opsgenie,
oracle, pagerduty, papermill, pgvector, pinecone, postgres, presto, qdrant, redis, salesforce,
Expand Down
Loading