airflow.providers.edge3.cli.edge_command¶

Attributes¶

`logger`
`EDGE_WORKER_PROCESS_NAME`
`EDGE_WORKER_HEADER`
`SIG_STATUS`
`ARG_CONCURRENCY`
`ARG_QUEUES`
`ARG_EDGE_HOSTNAME`
`ARG_REQUIRED_EDGE_HOSTNAME`
`ARG_MAINTENANCE`
`ARG_MAINTENANCE_COMMENT`
`ARG_REQUIRED_MAINTENANCE_COMMENT`
`ARG_WAIT_MAINT`
`ARG_WAIT_STOP`
`ARG_OUTPUT`
`ARG_STATE`
`EDGE_COMMANDS`

Functions¶

`force_use_internal_api_on_edge_worker`()	Ensure that the environment is configured for the internal API without needing to declare it outside.
`worker`(args)	Start Airflow Edge Worker.
`status`(args)	Check for Airflow Local Edge Worker status.
`maintenance`(args)	Set or Unset maintenance mode of local edge worker.
`stop`(args)	Stop a running local Airflow Edge Worker.
`list_edge_workers`(args)	Query the db to list all registered edge workers.
`put_remote_worker_on_maintenance`(args)	Put remote edge worker on maintenance.
`remove_remote_worker_from_maintenance`(args)	Remove remote edge worker from maintenance.
`remote_worker_update_maintenance_comment`(args)	Update maintenance comments of the remote edge worker.
`remove_remote_worker`(args)	Remove remote edge worker entry from db.
`remote_worker_request_shutdown`(args)	Initiate the shutdown of the remote edge worker.

Module Contents¶

airflow.providers.edge3.cli.edge_command.logger[source]¶

airflow.providers.edge3.cli.edge_command.EDGE_WORKER_PROCESS_NAME = 'edge-worker'[source]¶

airflow.providers.edge3.cli.edge_command.EDGE_WORKER_HEADER = ''[source]¶

airflow.providers.edge3.cli.edge_command.force_use_internal_api_on_edge_worker()[source]¶

Ensure that the environment is configured for the internal API without needing to declare it outside.

This is only required for an Edge worker and must to be done before the Click CLI wrapper is initiated. That is because the CLI wrapper will attempt to establish a DB connection, which will fail before the function call can take effect. In an Edge worker, we need to “patch” the environment before starting.

airflow.providers.edge3.cli.edge_command.SIG_STATUS[source]¶

airflow.providers.edge3.cli.edge_command.worker(args)[source]¶: Start Airflow Edge Worker.

airflow.providers.edge3.cli.edge_command.status(args)[source]¶: Check for Airflow Local Edge Worker status.

airflow.providers.edge3.cli.edge_command.maintenance(args)[source]¶: Set or Unset maintenance mode of local edge worker.

airflow.providers.edge3.cli.edge_command.stop(args)[source]¶: Stop a running local Airflow Edge Worker.

airflow.providers.edge3.cli.edge_command.list_edge_workers(args)[source]¶

Query the db to list all registered edge workers.

airflow.providers.edge3.cli.edge_command.put_remote_worker_on_maintenance(args)[source]¶

Put remote edge worker on maintenance.

airflow.providers.edge3.cli.edge_command.remove_remote_worker_from_maintenance(args)[source]¶

Remove remote edge worker from maintenance.

airflow.providers.edge3.cli.edge_command.remote_worker_update_maintenance_comment(args)[source]¶

Update maintenance comments of the remote edge worker.

airflow.providers.edge3.cli.edge_command.remove_remote_worker(args)[source]¶

Remove remote edge worker entry from db.

airflow.providers.edge3.cli.edge_command.remote_worker_request_shutdown(args)[source]¶

Initiate the shutdown of the remote edge worker.

airflow.providers.edge3.cli.edge_command.ARG_CONCURRENCY[source]¶

airflow.providers.edge3.cli.edge_command.ARG_QUEUES[source]¶

airflow.providers.edge3.cli.edge_command.ARG_EDGE_HOSTNAME[source]¶

airflow.providers.edge3.cli.edge_command.ARG_REQUIRED_EDGE_HOSTNAME[source]¶

airflow.providers.edge3.cli.edge_command.ARG_MAINTENANCE[source]¶

airflow.providers.edge3.cli.edge_command.ARG_MAINTENANCE_COMMENT[source]¶

airflow.providers.edge3.cli.edge_command.ARG_REQUIRED_MAINTENANCE_COMMENT[source]¶

airflow.providers.edge3.cli.edge_command.ARG_WAIT_MAINT[source]¶

airflow.providers.edge3.cli.edge_command.ARG_WAIT_STOP[source]¶

airflow.providers.edge3.cli.edge_command.ARG_OUTPUT[source]¶

airflow.providers.edge3.cli.edge_command.ARG_STATE[source]¶

airflow.providers.edge3.cli.edge_command.EDGE_COMMANDS: list[airflow.cli.cli_config.ActionCommand][source]¶