从 Airflow Web 界面自定义 Apache 视图¶
Airflow 具有允许使用插件管理器将其自定义 UI 与其核心 UI 集成的功能
这是一个 Airflow 插件示例,它绝对不显示任何内容。
在这个插件中,两个对象引用来自基类 airflow.plugins_manager.AirflowPlugin
。它们是 flask_blueprints 和 appbuilder_views
使用 Airflow 插件中的 flask_blueprints,可以扩展核心应用程序以支持自定义应用程序来查看空插件。在这个对象引用中,Blueprint 对象列表以及用于呈现信息的静态模板。
使用 Airflow 插件中的 appbuilder_views,添加了一个表示概念的类,并提供了视图和方法来实现它。在这个对象引用中,传递了包含 FlaskAppBuilder BaseView 对象和元数据信息(如名称和类别)的字典列表。
自定义视图注册¶
具有对 flask_appbuilder 和 Blueprint(来自 flask)的对象引用的自定义视图可以注册为 插件 的一部分。
以下是我们实现新的自定义视图的框架
#
# 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.
"""Plugins example"""
from __future__ import annotations
from flask import Blueprint
from flask_appbuilder import BaseView, expose
from airflow.auth.managers.models.resource_details import AccessView
from airflow.plugins_manager import AirflowPlugin
from airflow.www.auth import has_access_view
class EmptyPluginView(BaseView):
"""Creating a Flask-AppBuilder View"""
default_view = "index"
@expose("/")
@has_access_view(AccessView.PLUGINS)
def index(self):
"""Create default view"""
return self.render_template("empty_plugin/index.html", name="Empty Plugin")
# Creating a flask blueprint
bp = Blueprint(
"Empty Plugin",
__name__,
template_folder="templates",
static_folder="static",
static_url_path="/static/empty_plugin",
)
class EmptyPlugin(AirflowPlugin):
"""Defining the plugin class"""
name = "Empty Plugin"
flask_blueprints = [bp]
appbuilder_views = [{"name": "Empty Plugin", "category": "Extra Views", "view": EmptyPluginView()}]
appbuilder_views
字典的 category
键中指定的 Plugins
是 Airflow UI 导航栏中选项卡的名称。 Empty Plugin
是 Plugins
选项卡下链接的名称,它将启动插件
我们需要添加 Blueprint 来生成需要在 Airflow Web UI 中呈现的应用程序部分。我们可以定义模板、静态文件,并且当插件加载时,此蓝图将注册为 Airflow 应用程序的一部分。
带有自定义视图 UI 的 $AIRFLOW_HOME/plugins
文件夹具有以下文件夹结构。
plugins
├── empty_plugin.py
├── templates
| └── empty_plugin
| ├── index.html
└── README.md
呈现构建的视图所需的 HTML 文件作为 Airflow 插件的一部分添加到 $AIRFLOW_HOME/plugins/templates
文件夹中,并在蓝图中定义。