apache-airflow-providers-edge3 1.0.0rc1__py3-none-any.whl

airflow/providers/edge3/plugins/__init__.py

@@ -0,0 +1,16 @@
+# 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.

airflow/providers/edge3/plugins/edge_executor_plugin.py

@@ -0,0 +1,229 @@
+# 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.
+
+from __future__ import annotations
+
+import re
+from datetime import datetime, timedelta
+from pathlib import Path
+from typing import TYPE_CHECKING, Any
+
+from flask import Blueprint, redirect, request, url_for
+from flask_appbuilder import BaseView, expose
+from markupsafe import Markup
+from sqlalchemy import select
+
+from airflow.configuration import conf
+from airflow.exceptions import AirflowConfigException
+from airflow.models.taskinstance import TaskInstanceState
+from airflow.plugins_manager import AirflowPlugin
+from airflow.providers.edge3.version_compat import AIRFLOW_V_3_0_PLUS
+from airflow.utils.state import State
+
+if AIRFLOW_V_3_0_PLUS:
+    from airflow.api_fastapi.auth.managers.models.resource_details import AccessView
+    from airflow.providers.fab.www.auth import has_access_view
+
+else:
+    from airflow.auth.managers.models.resource_details import AccessView  # type: ignore[no-redef]
+    from airflow.www.auth import has_access_view  # type: ignore[no-redef]
+from airflow.utils.session import NEW_SESSION, provide_session
+from airflow.utils.yaml import safe_load
+
+if TYPE_CHECKING:
+    from sqlalchemy.orm import Session
+
+
+def _get_airflow_2_api_endpoint() -> Blueprint:
+    from airflow.www.constants import SWAGGER_BUNDLE, SWAGGER_ENABLED
+    from airflow.www.extensions.init_views import _CustomErrorRequestBodyValidator, _LazyResolver
+
+    folder = Path(__file__).parents[1].resolve()  # this is airflow/providers/edge3/
+    with folder.joinpath("openapi", "edge_worker_api_v1.yaml").open() as f:
+        specification = safe_load(f)
+    from connexion import FlaskApi
+
+    bp = FlaskApi(
+        specification=specification,
+        resolver=_LazyResolver(),
+        base_path="/edge_worker/v1",
+        strict_validation=True,
+        options={"swagger_ui": SWAGGER_ENABLED, "swagger_path": SWAGGER_BUNDLE.__fspath__()},
+        validate_responses=True,
+        validator_map={"body": _CustomErrorRequestBodyValidator},
+    ).blueprint
+    # Need to exempt CSRF to make API usable
+    from airflow.www.app import csrf
+
+    csrf.exempt(bp)
+    return bp
+
+
+def _get_api_endpoint() -> dict[str, Any]:
+    from airflow.providers.edge3.worker_api.app import create_edge_worker_api_app
+
+    return {
+        "app": create_edge_worker_api_app(),
+        "url_prefix": "/edge_worker/v1",
+        "name": "Airflow Edge Worker API",
+    }
+
+
+def _state_token(state):
+    """Return a formatted string with HTML for a given State."""
+    color = State.color(state)
+    fg_color = State.color_fg(state)
+    return Markup(
+        """
+        <span class="label" style="color:{fg_color}; background-color:{color};"
+            title="Current State: {state}">{state}</span>
+        """
+    ).format(color=color, state=state, fg_color=fg_color)
+
+
+def modify_maintenance_comment_on_update(maintenance_comment: str | None, username: str) -> str:
+    if maintenance_comment:
+        if re.search(
+            r"^\[[-\d:\s]+\] - .+ put node into maintenance mode\r?\nComment:.*", maintenance_comment
+        ):
+            return re.sub(
+                r"^\[[-\d:\s]+\] - .+ put node into maintenance mode\r?\nComment:",
+                f"[{datetime.now().strftime('%Y-%m-%d %H:%M')}] - {username} updated maintenance mode\nComment:",
+                maintenance_comment,
+            )
+        if re.search(r"^\[[-\d:\s]+\] - .+ updated maintenance mode\r?\nComment:.*", maintenance_comment):
+            return re.sub(
+                r"^\[[-\d:\s]+\] - .+ updated maintenance mode\r?\nComment:",
+                f"[{datetime.now().strftime('%Y-%m-%d %H:%M')}] - {username} updated maintenance mode\nComment:",
+                maintenance_comment,
+            )
+        return f"[{datetime.now().strftime('%Y-%m-%d %H:%M')}] - {username} updated maintenance mode\nComment: {maintenance_comment}"
+    return f"[{datetime.now().strftime('%Y-%m-%d %H:%M')}] - {username} updated maintenance mode\nComment:"
+
+
+# registers airflow/providers/edge3/plugins/templates as a Jinja template folder
+template_bp = Blueprint(
+    "template_blueprint",
+    __name__,
+    template_folder="templates",
+)
+
+
+class EdgeWorkerJobs(BaseView):
+    """Simple view to show Edge Worker jobs."""
+
+    default_view = "jobs"
+
+    @expose("/jobs")
+    @has_access_view(AccessView.JOBS)
+    @provide_session
+    def jobs(self, session: Session = NEW_SESSION):
+        from airflow.providers.edge3.models.edge_job import EdgeJobModel
+
+        jobs = session.scalars(select(EdgeJobModel).order_by(EdgeJobModel.queued_dttm)).all()
+        html_states = {
+            str(state): _state_token(str(state)) for state in TaskInstanceState.__members__.values()
+        }
+        return self.render_template("edge_worker_jobs.html", jobs=jobs, html_states=html_states)
+
+
+class EdgeWorkerHosts(BaseView):
+    """Simple view to show Edge Worker status."""
+
+    default_view = "status"
+
+    @expose("/status")
+    @has_access_view(AccessView.JOBS)
+    @provide_session
+    def status(self, session: Session = NEW_SESSION):
+        from airflow.providers.edge3.models.edge_worker import EdgeWorkerModel
+
+        hosts = session.scalars(select(EdgeWorkerModel).order_by(EdgeWorkerModel.worker_name)).all()
+        five_min_ago = datetime.now() - timedelta(minutes=5)
+        return self.render_template("edge_worker_hosts.html", hosts=hosts, five_min_ago=five_min_ago)
+
+    @expose("/status/maintenance/<string:worker_name>/on", methods=["POST"])
+    @has_access_view(AccessView.JOBS)
+    def worker_to_maintenance(self, worker_name: str):
+        from flask_login import current_user
+
+        from airflow.providers.edge3.models.edge_worker import request_maintenance
+
+        maintenance_comment = request.form.get("maintenance_comment")
+        maintenance_comment = f"[{datetime.now().strftime('%Y-%m-%d %H:%M')}] - {current_user.username} put node into maintenance mode\nComment: {maintenance_comment}"
+        request_maintenance(worker_name, maintenance_comment)
+        return redirect(url_for("EdgeWorkerHosts.status"))
+
+    @expose("/status/maintenance/<string:worker_name>/off", methods=["POST"])
+    @has_access_view(AccessView.JOBS)
+    def remove_worker_from_maintenance(self, worker_name: str):
+        from airflow.providers.edge3.models.edge_worker import exit_maintenance
+
+        exit_maintenance(worker_name)
+        return redirect(url_for("EdgeWorkerHosts.status"))
+
+    @expose("/status/maintenance/<string:worker_name>/remove", methods=["POST"])
+    @has_access_view(AccessView.JOBS)
+    def remove_worker(self, worker_name: str):
+        from airflow.providers.edge3.models.edge_worker import remove_worker
+
+        remove_worker(worker_name)
+        return redirect(url_for("EdgeWorkerHosts.status"))
+
+    @expose("/status/maintenance/<string:worker_name>/change_comment", methods=["POST"])
+    @has_access_view(AccessView.JOBS)
+    def change_maintenance_comment(self, worker_name: str):
+        from flask_login import current_user
+
+        from airflow.providers.edge3.models.edge_worker import change_maintenance_comment
+
+        maintenance_comment = request.form.get("maintenance_comment")
+        maintenance_comment = modify_maintenance_comment_on_update(maintenance_comment, current_user.username)
+        change_maintenance_comment(worker_name, maintenance_comment)
+        return redirect(url_for("EdgeWorkerHosts.status"))
+
+
+# Check if EdgeExecutor is actually loaded
+try:
+    EDGE_EXECUTOR_ACTIVE = conf.getboolean("edge", "api_enabled", fallback="False")
+except AirflowConfigException:
+    EDGE_EXECUTOR_ACTIVE = False
+
+
+class EdgeExecutorPlugin(AirflowPlugin):
+    """EdgeExecutor Plugin - provides API endpoints for Edge Workers in Webserver."""
+
+    name = "edge_executor"
+    if EDGE_EXECUTOR_ACTIVE:
+        appbuilder_views = [
+            {
+                "name": "Edge Worker Jobs",
+                "category": "Admin",
+                "view": EdgeWorkerJobs(),
+            },
+            {
+                "name": "Edge Worker Hosts",
+                "category": "Admin",
+                "view": EdgeWorkerHosts(),
+            },
+        ]
+
+        if AIRFLOW_V_3_0_PLUS:
+            fastapi_apps = [_get_api_endpoint()]
+            flask_blueprints = [template_bp]
+        else:
+            flask_blueprints = [_get_airflow_2_api_endpoint(), template_bp]

airflow/providers/edge3/plugins/templates/edge_worker_hosts.html

@@ -0,0 +1,175 @@
+{#
+    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.
+    #}
+
+    {% extends base_template %}
+
+    {% block title %}
+        Edge Worker Hosts
+    {% endblock %}
+
+    {% block content %}
+      <h2>Edge Worker Hosts</h2>
+      {% if hosts|length == 0 %}
+        <p>No Edge Workers connected or known currently.</p>
+      {% else %}
+
+      <script>
+        function showForm(worker_name) {
+          var button = document.getElementById("button_" + worker_name);
+          var form = document.getElementById("form_" + worker_name);
+          form.style.display = "block";
+          button.style.display = "none";
+        }
+        function showEditComment(worker_name) {
+          var display = document.getElementById("display_" + worker_name);
+          var textarea = document.getElementById("textarea_" + worker_name);
+          var button = document.getElementById("update_" + worker_name);
+          display.style.display = "none";
+          textarea.style.display = "block";
+          button.style.display = "inline";
+        }
+      </script>
+      <table class="table table-striped table-bordered">
+        <tr>
+            <th>Hostname</th>
+            <th>State</th>
+            <th>Queues</th>
+            <th>First Online</th>
+            <th>Last Heart Beat</th>
+            <th>Active Jobs</th>
+            <!-- Stats are not collected (yet) leave the columns out until available
+              <th>Jobs Taken</th>
+              <th>Jobs Success</th>
+              <th>Jobs Failed</th>
+            -->
+            <th>System Information</th>
+            <th>Operations</th>
+        </tr>
+        {% for host in hosts %}
+          <tr>
+            <td>{{ host.worker_name }}</a></td>
+            <td>
+              {%- if host.state in["offline", "offline maintenance"] -%}
+                <span class="label" style="color:white; background-color:black;" title="Current State: {{ host.state }}">{{ host.state }}</span>
+              {%- elif host.state == "unknown" -%}
+                <span class="label" style="color:white; background-color:red;" title="Current State: {{ host.state }}">{{ host.state }}</span>
+              {%- elif host.last_update.timestamp() <= five_min_ago.timestamp() -%}
+                Reported <span class="label" style="color:white; background-color:red;" title="Current State: {{ host.state }}">{{ host.state }}</span>
+                but no heartbeat
+              {%- elif host.state in ["starting", "maintenance request", "maintenance exit"] -%}
+                <span class="label" style="color:black; background-color:gold;" title="Current State: {{ host.state }}">{{ host.state }}</span>
+              {%- elif host.state == "running" -%}
+                <span class="label" style="color:white; background-color:green;" title="Current State: {{ host.state }}">{{ host.state }}</span>
+              {%- elif host.state == "idle" -%}
+                <span class="label" style="color:black; background-color:gray;" title="Current State: {{ host.state }}">{{ host.state }}</span>
+              {%- elif host.state == "terminating" -%}
+                <span class="label" style="color:black; background-color:violet;" title="Current State: {{ host.state }}">{{ host.state }}</span>
+              {%- elif host.state in ["maintenance pending", "maintenance mode"] -%}
+                <span class="label" style="color:black; background-color:orange;" title="Current State: {{ host.state }}">{{ host.state }}</span>
+              {%- else -%}
+                <span class="label" style="color:white; background-color:hotpink;" title="Current State: {{ host.state }}">{{ host.state }}</span>
+              {%- endif -%}
+            </td>
+            <td>
+              {% if host.queues %}
+                <ul>
+                  {% for item in host.queues %}
+                    <li>
+                      <a href="../taskinstance/list/?_flt_7_state=success&_flt_7_state=failed&_flt_3_queue={{ item }}#"">{{ item }}</a>
+                    </li>
+                  {% endfor %}
+                </ul>
+              {% else %}
+                (all)
+              {% endif %}
+            </td>
+            <td><time datetime="{{ host.first_online }}">{{ host.first_online }}</time></td>
+            <td>{% if host.last_update %}<time datetime="{{ host.last_update }}">{{ host.last_update }}</time>{% endif %}</td>
+            <td>
+              <a href="../taskinstance/list/?_flt_3_hostname={{ host.worker_name }}&_flt_7_state=success&_flt_7_state=failed#">{{ host.jobs_active }}</a>
+            </td>
+            <!-- Stats are not collected (yet) leave the columns out until available
+              <td>{{ host.jobs_taken }}</td>
+              <td>{{ host.jobs_success }}</td>
+              <td>{{ host.jobs_failed }}</td>
+            -->
+            <td>
+              <ul>
+                {% for item in host.sysinfo_json %}
+                  <li>{{ item }}: {{ host.sysinfo_json[item] }}</li>
+                {% endfor %}
+              </ul>
+            </td>
+            {%- if host.state in ["idle", "running"] -%}
+              <td>
+                <button id="button_{{ host.worker_name }}" onclick="showForm('{{ host.worker_name }}')" class="btn btn-sm btn-primary">
+                    Enter Maintenance
+                </button>
+                <form id="form_{{ host.worker_name }}" style="display: none" action="../edgeworkerhosts/status/maintenance/{{ host.worker_name }}/on" method="POST">
+                  <input type="hidden" name="csrf_token" value="{{ csrf_token() }}"/>
+                  <div style="white-space: pre-line;">
+                    <label for="maintenance_comment">Maintenance Comment:</label>
+                  </div>
+                  <textarea  name="maintenance_comment" rows="3" maxlength="1024" style="width: 100%; margin-bottom: 5px;" required></textarea>
+                  <br />
+                  <button type="submit" class="btn btn-sm btn-primary">
+                      Confirm Maintenance
+                  </button>
+                </td>
+              </form>
+            {%- elif host.state in ["maintenance pending", "maintenance mode", "maintenance request"] -%}
+              <form action="../edgeworkerhosts/status/maintenance/{{ host.worker_name }}/off" method="POST">
+                <td>
+                  <div id="display_{{ host.worker_name }}" style="white-space: pre-line;">
+                    {{ host.maintenance_comment }}
+                    <a onclick="showEditComment('{{ host.worker_name }}')" class="btn btn-sm btn-default" data-toggle="tooltip" rel="tooltip" title="Edit maintenance comment">
+                      <span class="sr-only">Edit</span>
+                      <i class="fa fa-edit"></i>
+                    </a>
+                  </div>
+                  <textarea id="textarea_{{ host.worker_name }}" name="maintenance_comment" rows="3" maxlength="1024" style="display: none; width:100%;" required>{{ host.maintenance_comment }}</textarea>
+                  <input type="hidden" name="csrf_token" value="{{ csrf_token() }}"/>
+                  <div style="margin-top: 10px;">
+                    <button type="submit" class="btn btn-sm btn-primary">
+                        Exit Maintenance
+                    </button>
+                    <button id="update_{{ host.worker_name }}" type="submit" class="btn btn-sm btn-primary" style="display: none;" formaction="../edgeworkerhosts/status/maintenance/{{ host.worker_name }}/change_comment">
+                      Update comment
+                    </button>
+                  </div>
+                </td>
+              </form>
+            {%- elif host.state in ["offline", "unknown", "offline maintenance"] -%}
+              <form action="../edgeworkerhosts/status/maintenance/{{ host.worker_name }}/remove" method="POST">
+                <td>
+                  <input type="hidden" name="csrf_token" value="{{ csrf_token() }}"/>
+                  <button type="submit" class="btn btn-sm btn-primary">
+                      Remove
+                  </button>
+                </td>
+              </form>
+            {%- else -%}
+              <td></td>
+            {% endif %}
+          </tr>
+        {% endfor %}
+      </table>
+      {% endif %}
+    {% endblock %}
+<html>

airflow/providers/edge3/plugins/templates/edge_worker_jobs.html

@@ -0,0 +1,69 @@
+{#
+    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.
+    #}
+
+    {% extends base_template %}
+
+    {% block title %}
+        Edge Worker Jobs
+    {% endblock %}
+
+    {% block content %}
+      <h2>Edge Worker Jobs</h2>
+      {% if jobs|length == 0 %}
+        <p>No jobs running currently</p>
+      {% else %}
+
+      <table class="table table-striped table-bordered">
+        <tr>
+            <th>DAG ID</th>
+            <th>Run ID</th>
+            <th>Task ID</th>
+            <th>Map Index</th>
+            <th>Try Number</th>
+            <th>State</th>
+            <th>Queue</th>
+            <th>Queued DTTM</th>
+            <th>Edge Worker</th>
+            <th>Last Update</th>
+        </tr>
+
+        {% for job in jobs %}
+          <tr title="{{ job.command }}">
+            <td><a href="/dags/{{ job.dag_id }}/grid">{{ job.dag_id }}</a></td>
+            <td><a href="/dags/{{ job.dag_id }}/grid?dag_run_id={{ job.run_id | urlencode }}">{{ job.run_id }}</a></td>
+            <td><a href="/dags/{{ job.dag_id }}/grid?dag_run_id={{ job.run_id | urlencode }}&task_id={{ job.task_id }}&tab=logs">{{ job.task_id }}</a></td>
+            <td>{% if job.map_index >= 0 %}{{ job.map_index }}{% else %}-{% endif %}</td>
+            <td>{{ job.try_number }}</td>
+            <td>{{ html_states[job.state] }}</td>
+            <td>
+              <a href="../taskinstance/list/?_flt_7_state=success&_flt_7_state=failed&_flt_3_queue={{ job.queue }}#"">{{ job.queue }}</a>
+            </td>
+            <td><time datetime="{{ job.queued_dttm }}">{{ job.queued_dttm }}</time></td>
+            <td>
+              {% if job.edge_worker %}
+              <a href="../taskinstance/list/?_flt_3_hostname={{ job.edge_worker }}&_flt_7_state=success&_flt_7_state=failed#">{{ job.edge_worker }}</a>
+              {% endif %}
+            </td>
+            <td>{% if job.last_update %}<time datetime="{{ job.last_update }}">{{ job.last_update | string | truncate(20, False, "") }}</time>{% endif %}</td>
+          </tr>
+        {% endfor %}
+      </table>
+      {% endif %}
+    {% endblock %}
+<html>

airflow/providers/edge3/version_compat.py

@@ -0,0 +1,36 @@
+# 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 COPIED MANUALLY IN OTHER PROVIDERS DELIBERATELY TO AVOID ADDING UNNECESSARY
+# DEPENDENCIES BETWEEN PROVIDERS. IF YOU WANT TO ADD CONDITIONAL CODE IN YOUR PROVIDER THAT DEPENDS
+# ON AIRFLOW VERSION, PLEASE COPY THIS FILE TO THE ROOT PACKAGE OF YOUR PROVIDER AND IMPORT
+# THOSE CONSTANTS FROM IT RATHER THAN IMPORTING THEM FROM ANOTHER PROVIDER OR TEST CODE
+#
+from __future__ import annotations
+
+
+def get_base_airflow_version_tuple() -> tuple[int, int, int]:
+    from packaging.version import Version
+
+    from airflow import __version__
+
+    airflow_version = Version(__version__)
+    return airflow_version.major, airflow_version.minor, airflow_version.micro
+
+
+AIRFLOW_V_2_10_PLUS = get_base_airflow_version_tuple() >= (2, 10, 0)
+AIRFLOW_V_3_0_PLUS = get_base_airflow_version_tuple() >= (3, 0, 0)

airflow/providers/edge3/worker_api/__init__.py

@@ -0,0 +1,17 @@
+# 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.
+"""FastAPI implementation modules for Airflow 3.x."""

airflow/providers/edge3/worker_api/app.py

@@ -0,0 +1,43 @@
+# 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.
+from __future__ import annotations
+
+from fastapi import FastAPI
+
+from airflow.providers.edge3.worker_api.routes.health import health_router
+from airflow.providers.edge3.worker_api.routes.jobs import jobs_router
+from airflow.providers.edge3.worker_api.routes.logs import logs_router
+from airflow.providers.edge3.worker_api.routes.worker import worker_router
+
+
+def create_edge_worker_api_app() -> FastAPI:
+    """Create FastAPI app for edge worker API."""
+    edge_worker_api_app = FastAPI(
+        title="Airflow Edge Worker API",
+        description=(
+            "This is Airflow Edge Worker API - which is a the access endpoint for workers running on remote "
+            "sites serving for Apache Airflow jobs. It also proxies internal API to edge endpoints. It is "
+            "not intended to be used by any external code. You can find more information in AIP-69 "
+            "https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=301795932"
+        ),
+    )
+
+    edge_worker_api_app.include_router(health_router)
+    edge_worker_api_app.include_router(jobs_router)
+    edge_worker_api_app.include_router(logs_router)
+    edge_worker_api_app.include_router(worker_router)
+    return edge_worker_api_app