Add note about params on trigger DAG page (apache#18166)

okirialbert · Sep 12, 2021 · d7aed84 · d7aed84
1 parent 15a9945
commit d7aed84
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 3 deletions.
diff --git a/airflow/www/templates/airflow/trigger.html b/airflow/www/templates/airflow/trigger.html
@@ -47,6 +47,13 @@ <h2>Trigger DAG: {{ dag_id }}</h2>
     </div>
     <p>
       To access configuration in your DAG use <code>{{ '{{ dag_run.conf }}' }}</code>.
+      {% if is_dag_run_conf_overrides_params %}
+        As <code>core.dag_run_conf_overrides_params</code> is set to <code>True</code>, so passing any configuration
+        here will override task params which can be accessed via <code>{{ '{{ params }}' }}</code>.
+      {% else %}
+        As <code>core.dag_run_conf_overrides_params</code> is set to <code>False</code>, so passing any configuration
+        here won't override task params.
+      {% endif %}
     </p>
     <div class="form-group">
       <label class="switch-label">

diff --git a/airflow/www/views.py b/airflow/www/views.py
@@ -1625,6 +1625,7 @@ def trigger(self, session=None):
         unpause = request.values.get('unpause')
         request_conf = request.values.get('conf')
         request_execution_date = request.values.get('execution_date', default=timezone.utcnow().isoformat())
+        is_dag_run_conf_overrides_params = conf.getboolean('core', 'dag_run_conf_overrides_params')
 
         if request.method == 'GET':
             # Populate conf textarea with conf requests parameter, or dag.params
@@ -1648,6 +1649,7 @@ def trigger(self, session=None):
                 conf=default_conf,
                 doc_md=doc_md,
                 form=form,
+                is_dag_run_conf_overrides_params=is_dag_run_conf_overrides_params,
             )
 
         dag_orm = session.query(models.DagModel).filter(models.DagModel.dag_id == dag_id).first()
@@ -1661,7 +1663,12 @@ def trigger(self, session=None):
             flash("Invalid execution date", "error")
             form = DateTimeForm(data={'execution_date': timezone.utcnow().isoformat()})
             return self.render_template(
-                'airflow/trigger.html', dag_id=dag_id, origin=origin, conf=request_conf, form=form
+                'airflow/trigger.html',
+                dag_id=dag_id,
+                origin=origin,
+                conf=request_conf,
+                form=form,
+                is_dag_run_conf_overrides_params=is_dag_run_conf_overrides_params,
             )
 
         dr = DagRun.find(dag_id=dag_id, execution_date=execution_date, run_type=DagRunType.MANUAL)
@@ -1677,13 +1684,23 @@ def trigger(self, session=None):
                     flash("Invalid JSON configuration, must be a dict", "error")
                     form = DateTimeForm(data={'execution_date': execution_date})
                     return self.render_template(
-                        'airflow/trigger.html', dag_id=dag_id, origin=origin, conf=request_conf, form=form
+                        'airflow/trigger.html',
+                        dag_id=dag_id,
+                        origin=origin,
+                        conf=request_conf,
+                        form=form,
+                        is_dag_run_conf_overrides_params=is_dag_run_conf_overrides_params,
                     )
             except json.decoder.JSONDecodeError:
                 flash("Invalid JSON configuration, not parseable", "error")
                 form = DateTimeForm(data={'execution_date': execution_date})
                 return self.render_template(
-                    'airflow/trigger.html', dag_id=dag_id, origin=origin, conf=request_conf, form=form
+                    'airflow/trigger.html',
+                    dag_id=dag_id,
+                    origin=origin,
+                    conf=request_conf,
+                    form=form,
+                    is_dag_run_conf_overrides_params=is_dag_run_conf_overrides_params,
                 )
 
         dag = current_app.dag_bag.get_dag(dag_id)