Edge Executor Commands¶
Usage: airflow [-h] GROUP_OR_COMMAND ...
Positional Arguments¶
- GROUP_OR_COMMAND
Possible choices: edge
Sub-commands¶
edge¶
Start and manage Edge Worker. Works only when using EdgeExecutor. For more information, see https://airflow.apache.org/docs/apache-airflow-providers-edge3/stable/edge_executor.html
airflow edge [-h] COMMAND ...
Positional Arguments¶
- COMMAND
Possible choices: list-workers, maintenance, remote-edge-worker-exit-maintenance, remote-edge-worker-request-maintenance, remote-edge-worker-update-maintenance-comment, remove-remote-edge-worker, shutdown-remote-edge-worker, status, stop, worker
Sub-commands¶
list-workers¶
Query the db to list all registered edge workers.
airflow edge list-workers [-h] [-o table, json, yaml, plain]
[-s STATE [STATE ...]]
Named Arguments¶
- -o, --output
Possible choices: table, json, yaml, plain
Output format. Allowed values: json, yaml, plain, table (default: table)
Default: “table”
- -s, --state
State of the edge worker
maintenance¶
Set or Unset maintenance mode of local edge worker.
airflow edge maintenance [-h] [-c COMMENTS] [--pid [PID]] [-v] [-w] {on,off}
Positional Arguments¶
- maintenance
Possible choices: on, off
Desired maintenance state
Named Arguments¶
- -c, --comments
Maintenance comments to report reason. Required if maintenance is turned on.
- --pid
PID file location
- -v, --verbose
Make logging output more verbose
Default: False
- -w, --wait
Wait until edge worker has reached desired state.
Default: False
remote-edge-worker-exit-maintenance¶
Remove remote edge worker from maintenance.
airflow edge remote-edge-worker-exit-maintenance [-h] -H EDGE_HOSTNAME
Named Arguments¶
- -H, --edge-hostname
Set the hostname of worker if you have multiple workers on a single machine
remote-edge-worker-request-maintenance¶
Put remote edge worker on maintenance.
airflow edge remote-edge-worker-request-maintenance [-h] -c COMMENTS -H
EDGE_HOSTNAME
Named Arguments¶
- -c, --comments
Maintenance comments to report reason. Required if enabling maintenance
- -H, --edge-hostname
Set the hostname of worker if you have multiple workers on a single machine
remote-edge-worker-update-maintenance-comment¶
Update maintenance comments of the remote edge worker.
airflow edge remote-edge-worker-update-maintenance-comment [-h] -c COMMENTS -H
EDGE_HOSTNAME
Named Arguments¶
- -c, --comments
Maintenance comments to report reason. Required if enabling maintenance
- -H, --edge-hostname
Set the hostname of worker if you have multiple workers on a single machine
remove-remote-edge-worker¶
Remove remote edge worker entry from db.
airflow edge remove-remote-edge-worker [-h] -H EDGE_HOSTNAME
Named Arguments¶
- -H, --edge-hostname
Set the hostname of worker if you have multiple workers on a single machine
shutdown-remote-edge-worker¶
Initiate the shutdown of the remote edge worker.
airflow edge shutdown-remote-edge-worker [-h] -H EDGE_HOSTNAME
Named Arguments¶
- -H, --edge-hostname
Set the hostname of worker if you have multiple workers on a single machine
status¶
Check for Airflow Local Edge Worker status.
airflow edge status [-h] [--pid [PID]] [-v]
Named Arguments¶
- --pid
PID file location
- -v, --verbose
Make logging output more verbose
Default: False
stop¶
Stop a running local Airflow Edge Worker.
airflow edge stop [-h] [--pid [PID]] [-v] [-w]
Named Arguments¶
- --pid
PID file location
- -v, --verbose
Make logging output more verbose
Default: False
- -w, --wait
Wait until edge worker is shut down.
Default: False
worker¶
Start Airflow Edge Worker.
airflow edge worker [-h] [-c CONCURRENCY] [-H EDGE_HOSTNAME] [--pid [PID]]
[-q QUEUES] [-v]
Named Arguments¶
- -c, --concurrency
The number of worker processes
Default: 8
- -H, --edge-hostname
Set the hostname of worker if you have multiple workers on a single machine
- --pid
PID file location
- -q, --queues
Comma delimited list of queues to serve, serve all queues if not provided.
- -v, --verbose
Make logging output more verbose
Default: False