This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 4863383dca5 Update Edge Executor documentation to current state
(#44119)
4863383dca5 is described below
commit 4863383dca5524bc7d0c27cdbb23b4e13c17eaf4
Author: Jens Scheffler <[email protected]>
AuthorDate: Mon Nov 18 03:26:08 2024 +0100
Update Edge Executor documentation to current state (#44119)
---
docs/apache-airflow-providers-edge/edge_executor.rst | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/docs/apache-airflow-providers-edge/edge_executor.rst
b/docs/apache-airflow-providers-edge/edge_executor.rst
index a4e49d650d3..360eeccd47d 100644
--- a/docs/apache-airflow-providers-edge/edge_executor.rst
+++ b/docs/apache-airflow-providers-edge/edge_executor.rst
@@ -28,13 +28,14 @@ Edge Executor
.. note::
- As of Airflow 2.10.0, you can install the ``edge`` provider package to use
this executor.
- This can be done by installing ``apache-airflow-providers-edge`` or by
installing Airflow
- with the ``edge`` extra: ``pip install 'apache-airflow[edge]'``.
+ As of Airflow 2.10.3, the ``edge`` provider package is not included in
normal release cycle.
+ Thus you can not directly install it via: ``pip install
'apache-airflow[edge]'`` as the dependency
+ can not be downloaded.
While it is in not-ready state, a wheel release package must be manually
built from source tree
via ``breeze release-management prepare-provider-packages
--include-not-ready-providers edge``
- and then installed via pip from the generated wheel file.
+ and then installed via pip or uv from the generated wheel file. like:
+ ``pip install apache_airflow_providers_edge-<version>-py3-none-any.whl``.
``EdgeExecutor`` is an option if you want to distribute tasks to workers
distributed in different locations.
@@ -45,7 +46,7 @@ The configuration parameters of the Edge Executor can be
found in the Edge provi
Here are a few imperative requirements for your workers:
-- ``airflow`` needs to be installed, and the CLI needs to be in the path
+- ``airflow`` needs to be installed, and the airflow CLI needs to be in the
path
- Airflow configuration settings should be homogeneous across the cluster
- Operators that are executed on the Edge Worker need to have their
dependencies
met in that context. Please take a look to the respective provider package
@@ -237,6 +238,8 @@ The following features are known missing and will be
implemented in increments:
- Allow ``airflow edge stop`` to wait until completed to terminated
- Publish system metrics with heartbeats (CPU, Disk space, RAM, Load)
- Be more liberal e.g. on patch version. MVP requires exact version match
+ (In current state if versions do not match, the worker will gracefully shut
+ down when jobs are completed, no new jobs will be started)
- Tests
