Customize view of Apache from Airflow web UI¶

Airflow has feature that allows to integrate a custom UI along with its core UI using the Plugin manager

This is an example plugin for Airflow that displays absolutely nothing.

In this plugin, two object reference are derived from the base class airflow.plugins_manager.AirflowPlugin. They are flask_blueprints and appbuilder_views

Using flask_blueprints in Airflow plugin, the core application can be extended to support the application that is customized to view Empty Plugin. In this object reference, the list of Blueprint object with the static template for rendering the information.

Using appbuilder_views in Airflow plugin, a class that represents a concept is added and presented with views and methods to implement it. In this object reference, the list of dictionaries with FlaskAppBuilder BaseView object and metadata information like name and category is passed on.

Custom view Registration¶

A custom view with object reference to flask_appbuilder and Blueprint from flask and be registered as a part of a plugin.

The following is a skeleton for us to implement a new custom view:

docs/apache-airflow/empty_plugin/empty_plugin.py[source]

#
# 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.plugins_manager import AirflowPlugin
from airflow.security import permissions
from airflow.www.auth import has_access


class EmptyPluginView(BaseView):
    """Creating a Flask-AppBuilder View"""

    default_view = "index"

    @expose("/")
    @has_access(
        [
            (permissions.ACTION_CAN_READ, permissions.RESOURCE_WEBSITE),
        ]
    )
    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()}]

Plugins specified in the category key of appbuilder_views dictionary is the name of the tab in the navigation bar of the Airflow UI. Empty Plugin is the name of the link under the tab Plugins, which will launch the plugin

We have to add Blueprint for generating the part of the application that needs to be rendered in Airflow web UI. We can define templates, static files and this blueprint will be registered as part of the Airflow application when the plugin gets loaded.

The $AIRFLOW_HOME/plugins folder with custom view UI have the following folder structure.

plugins
├── empty_plugin.py
├── templates
|   └── empty_plugin
|       ├── index.html
└── README.md

The HTML files required to render the views built is added as part of the Airflow plugin into $AIRFLOW_HOME/plugins/templates folder and defined in the blueprint.