Add Airflow UI instance_name configuration option #10162

pcandoalmeida · 2020-08-04T22:58:10Z

Description

Site title configuration added for DAGs home page. This will allow multiple installations of Airflow to be distinguished via the UI and page title.

Logic added to view.py and dags.html connecting a configuration change in airflow.cfg to replace the default DAGs header and Airflow - DAGs title into a custom site_title string.

Unit and integration tests added
Documentation added
Pre-commit checks

Closes: #9538

boring-cyborg · 2020-08-04T22:58:13Z

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst)
Here are some useful points:

Pay attention to the quality of your code (flake8, pylint and type annotations). Our pre-commits will help you with that.
In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
Consider using Breeze environment for testing locally, it’s a heavy docker but it ships with a working Airflow and a lot of integrations.
Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
Be sure to read the Airflow Coding style.
Apache Airflow is a community-driven project and together we are making it better 🚀.
In case of doubts contact the developers at:
Mailing List: dev@airflow.apache.org
Slack: https://apache-airflow-slack.herokuapp.com/

airflow/www/views.py

tests/www/test_views.py

mik-laj · 2020-08-05T22:42:19Z

Could you please add some documentation? I am thinking about a new page in the howto directory.
https://airflow.readthedocs.io/en/latest/howto/index.html
In my next PR, I am trying to clean up the documentation to bring together several related UI related documentation pages, but for now the new page is the best solution.

pcandoalmeida · 2020-08-05T22:47:44Z

Could you please add some documentation? I am thinking about a new page in the howto directory.
https://airflow.readthedocs.io/en/latest/howto/index.html
In my next PR, I am trying to clean up the documentation to bring together several related UI related documentation pages, but for now the new page is the best solution.

Sure, I added site_title to the configuration reference page, but I can add a new page to the directory.

kaxil

Can you also post before and after screenshot of the homepage

pcandoalmeida · 2020-08-06T12:48:59Z

Can you also post before and after screenshot of the homepage

Sure @kaxil I've added an after screenshot, but I will do a before too.

airflow/www/views.py

docs/howto/customize-dag-ui-page-site-title.rst

tests/test_configuration.py

mik-laj · 2020-08-06T14:49:26Z

What do you think about giving the ability to change adding a unique title name for all the window?

I think that if site_title is set it can replace the word Airflow.

pcandoalmeida · 2020-08-06T14:55:55Z

What do you think about giving the ability to change adding a unique title name for all the window?

I think that if site_title is set it can replace the word Airflow.

Hi @mik-laj it should replace the entire page title. I will have a look into this as when I tested it via Breeze, it did so.

mik-laj · 2020-08-06T15:00:14Z

you only make changes to the DAG list. I think that this change is worth introducing on all views.

pcandoalmeida · 2020-08-06T22:36:14Z

Hi @mik-laj I've got this working for a couple of test views (there's quite few!). Would I need to add unit tests for every view? I would assume so, but wanted to ask so I can do it as I go along.

pcandoalmeida · 2020-08-07T21:43:56Z

Hi everyone, not sure if someone might be able to provide some guidance. I've managed to update DAG related views, like the graph and code views for example. Been digging around the code, but I can't quite figure out how to amend views like Browser > DAG Runs. I think I might have to amend the code a bit to get it working, but not quite sure. Any advice/thoughts would be greatly appreciated.

airflow/config_templates/config.yml

mik-laj · 2020-09-04T23:35:55Z

@pcandoalmeida I prepared the patch and push it on your branch. Can you check it?

pcandoalmeida · 2020-09-04T23:57:43Z

Sure @mik-laj I'll have a look tomorrow!

pcandoalmeida · 2020-09-15T20:48:50Z

Thanks @mik-laj I'm reviewing your updates now; let me know how you want to proceed. Can close this issue if you want to go with the other update.

mik-laj · 2020-09-15T20:54:38Z

@pcandoalmeida I support this change, but it is helpful if you rebase your branch to the newest master and fix all failed tests.

pcandoalmeida · 2020-09-15T20:59:04Z

Sure @mik-laj doing that now.

pcandoalmeida · 2020-09-15T22:47:36Z

Hi @mik-laj I've resolved about 16 failing tests in www/. I'm having a strange Github issue when trying to rebase, but will update the PR soon.

kaxil · 2020-09-16T19:59:11Z

airflow/config_templates/config.yml

+      version_added: ~
+      type: string
+      example: ~
+      default:


We could actually add the default here, so that users can easily override it.

Suggested change

default:

default: Airflow

Thoughts here @pcandoalmeida ?

Hiya @kaxil sorry didn't see this! Yes, this defaults the page title to Airflow. By default, we have Airflow - Airflow unless there is a specific instance name like Airflow - Dev.

ashb · 2020-09-17T11:09:50Z

airflow/config_templates/config.yml

@@ -1080,6 +1080,13 @@
      type: string
      example: ~
      default: "30"
+    - name: site_title
+      description: |
+        Sets a title to show in the browser tab and the DAGs overview page


This comment needs updating now -- it's all pages, isn't it?

ashb · 2020-09-17T11:10:49Z

airflow/www/extensions/init_jinja_globals.py

@@ -44,6 +44,7 @@ def init_jinja_globals(app):

    def prepare_jinja_globals():
        extra_globals = {
+            'app_name': conf.get(section="webserver", key="site_title", fallback="Airflow"),


We could do this without an extra variable, using {{ appbuilder.app_name }} in the templates (which will already be set up for us)

Hi @ashb just wanted to double check: I've removed app_name in Line:47 and have replaced app_name in the relevant *.html files with {{ appbuilder.app_name }}. Just wanted to make sure I understood correctly.

ashb · 2020-09-17T11:11:25Z

airflow/www/templates/airflow/dags.html

@@ -34,7 +34,7 @@
 {% endblock %}

 {% block content %}
-  <h2>DAGs</h2>
+  <h2>{{ site_title }}</h2>


This one is wrong - it should still include/be DAGs.

I think the original issue has evolved via @mik-laj's suggestion to update every page. Initially the request was to be able to amend the page title in dags.html so to distinguish differing installatios via the UI.

airflow/www/templates/airflow/master.html

scripts/ci/static_checks/ci_pylint_tests.sh

github-actions · 2020-10-10T13:09:46Z

The Workflow run is cancelling this PR. Building image for the PR has been cancelled

turbaszek

LGTM but I think the screenshots need to be updated 👍

github-actions · 2020-10-11T22:34:56Z

The Workflow run is cancelling this PR. Building images for the PR has failed. Follow the the workflow link to check the reason.

pcandoalmeida · 2020-10-14T16:50:35Z

Hi @turbaszek @kaxil 👋🏼 We have a Hacktoberfest day coming up this Friday at work; do let me know if you have any feedback on this and I can work on it during the day! Hopefully we're close to pushing this one over the line! 🚀

kaxil · 2020-10-16T12:44:55Z

airflow/www/views.py

@@ -515,11 +515,14 @@ def get_int_arg(value, default=0):
        state_color_mapping = State.state_color.copy()
        state_color_mapping["null"] = state_color_mapping.pop(None)

+        page_title = conf.get(section="webserver", key="site_title", fallback="DAGs")


hmm.. same config with a different fallback?

fallback only works if config is not provided, when config is provided DAGs won't be used

same config with a different fallback?

So amend the fallback? I think if the site_title config is set, then we use that; else, we default to the standard DAGs page title in the DAGs UI page.

Maybe have 2 different configs, 1 for page_title and 1 for site_title unless this has already been discussed

Yh I did ask about this earlier on, but I think based on what Kamil said we integrated the changes?

I think we can use a more generic option name like instance_name which will be empty by default. When it is set, some strings will be replaced with the name of the instance, and in other cases, the description will be used more appropriately to the case. I don't see the benefit of splitting this into two options if the user always sets the same value in the two options. We want to get it to be able to easily recognize different environments/instances of this application, so we can use an option name that describes it.

Thanks both; OK so basically just rename site_title to instance_name? The default behaviour for the UI will be DAGs and the page title Airflow. I'll amend the code and docs.

mik-laj · 2020-12-22T15:53:21Z

@pcandoalmeida What is the status of this change? Do you need help?

pcandoalmeida · 2020-12-22T16:02:19Z

Hi @mik-laj I think I made the changes requested by Kaxil and Tomek, but had some build errors (wasn't too sure why as I think it related to a test version error). I'll need to review this and fix the conflicts I think, unless something else has come up in the interim. Hopefully this should be near the end!

github-actions · 2021-02-15T14:49:36Z

The Workflow run is cancelling this PR. Building images for the PR has failed. Follow the the workflow link to check the reason.

github-actions · 2021-02-15T15:59:24Z

The Workflow run is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Backport packages$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.

github-actions · 2021-02-16T16:59:53Z

The Workflow run is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Backport packages$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.

boring-cyborg bot added the area:webserver Webserver related Issues label Aug 4, 2020

ektormak reviewed Aug 5, 2020

View reviewed changes

airflow/www/views.py Outdated Show resolved Hide resolved

mik-laj reviewed Aug 5, 2020

View reviewed changes

tests/www/test_views.py Show resolved Hide resolved

kaxil reviewed Aug 6, 2020

View reviewed changes

ashb reviewed Aug 6, 2020

View reviewed changes

airflow/www/views.py Outdated Show resolved Hide resolved

docs/howto/customize-dag-ui-page-site-title.rst Outdated Show resolved Hide resolved

tests/test_configuration.py Outdated Show resolved Hide resolved

tests/test_configuration.py Outdated Show resolved Hide resolved

pcandoalmeida requested review from mik-laj and ashb August 16, 2020 11:39

mik-laj reviewed Sep 4, 2020

View reviewed changes

airflow/config_templates/config.yml Outdated Show resolved Hide resolved

mik-laj mentioned this pull request Sep 15, 2020

Allow customization of navigation bar title text #10958

Closed

kaxil reviewed Sep 16, 2020

View reviewed changes

kaxil approved these changes Sep 16, 2020

View reviewed changes

ashb reviewed Sep 17, 2020

View reviewed changes

airflow/www/templates/airflow/master.html Outdated Show resolved Hide resolved

turbaszek reviewed Oct 10, 2020

View reviewed changes

scripts/ci/static_checks/ci_pylint_tests.sh Outdated Show resolved Hide resolved

pcandoalmeida force-pushed the 9538-Airflow-UI-Site-Title branch 2 times, most recently from d50e511 to dbedad4 Compare October 10, 2020 22:17

turbaszek approved these changes Oct 11, 2020

View reviewed changes

turbaszek requested a review from kaxil October 11, 2020 23:18

mik-laj removed their request for review October 12, 2020 11:18

kaxil reviewed Oct 16, 2020

View reviewed changes

pcandoalmeida and others added 4 commits February 15, 2021 13:46

Add site_title logic to DAGs view/template

82427d6

fixup! Add site_title logic to DAGs view/template

586213e

fixup! Add site_title logic to DAGs view/template

5262353

fixup! Add site_title logic to DAGs view/template

d31577c

ashb force-pushed the 9538-Airflow-UI-Site-Title branch from a95282f to d31577c Compare February 15, 2021 14:12

ashb changed the title ~~Add Airflow UI site_title configuration option~~ Add Airflow UI instance_name configuration option Feb 16, 2021

fixup! Add site_title logic to DAGs view/template

a52d1e6

pcandoalmeida requested review from ryanahamilton and vikramkoka as code owners February 16, 2021 16:09

fixup! Add site_title logic to DAGs view/template

86e252d

ashb approved these changes Feb 17, 2021

View reviewed changes

ashb merged commit 7d60bbf into apache:master Feb 17, 2021

ashb added this to the Airflow 2.1 milestone Feb 17, 2021

Add Airflow UI instance_name configuration option #10162

Add Airflow UI instance_name configuration option #10162

Conversation

pcandoalmeida commented Aug 4, 2020

boring-cyborg bot commented Aug 4, 2020

mik-laj commented Aug 5, 2020

pcandoalmeida commented Aug 5, 2020

kaxil left a comment

Choose a reason for hiding this comment

pcandoalmeida commented Aug 6, 2020

mik-laj commented Aug 6, 2020

pcandoalmeida commented Aug 6, 2020

mik-laj commented Aug 6, 2020 • edited Loading

pcandoalmeida commented Aug 6, 2020

pcandoalmeida commented Aug 7, 2020

mik-laj commented Sep 4, 2020

pcandoalmeida commented Sep 4, 2020

pcandoalmeida commented Sep 15, 2020

mik-laj commented Sep 15, 2020

pcandoalmeida commented Sep 15, 2020

pcandoalmeida commented Sep 15, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pcandoalmeida Sep 17, 2020 • edited Loading

Choose a reason for hiding this comment

ashb Sep 17, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Oct 10, 2020

turbaszek left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 11, 2020

pcandoalmeida commented Oct 14, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mik-laj Oct 16, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mik-laj commented Dec 22, 2020

pcandoalmeida commented Dec 22, 2020

github-actions bot commented Feb 15, 2021

github-actions bot commented Feb 15, 2021

github-actions bot commented Feb 16, 2021

mik-laj commented Aug 6, 2020 •

edited

Loading

pcandoalmeida Sep 17, 2020 •

edited

Loading

ashb Sep 17, 2020 •

edited

Loading

mik-laj Oct 16, 2020 •

edited

Loading