From cf78fa5fc3d92024bcbf9721394c8a05035148a4 Mon Sep 17 00:00:00 2001
From: treff7es <treff7es@gmail.com>
Date: Thu, 12 Dec 2024 10:01:27 +0100
Subject: [PATCH] Add doc for kill-switch

---
 docs/lineage/airflow.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/docs/lineage/airflow.md b/docs/lineage/airflow.md
index 829c048a8f8e2..1178feaf0d851 100644
--- a/docs/lineage/airflow.md
+++ b/docs/lineage/airflow.md
@@ -80,6 +80,37 @@ enabled = True  # default
 | log_level                  | _no change_          | [debug] Set the log level for the plugin.                                                |
 | debug_emitter              | false                | [debug] If true, the plugin will log the emitted events.                                 |
 
+#### Disabling the DataHub Plugin v2
+
+There are two ways to disable the DataHub Plugin v2:
+
+##### 1. Disable via Configuration
+
+Set the `datahub.enabled` configuration property to `False` in the `airflow.cfg` file and restart the Airflow environment to reload the configuration and disable the plugin.
+
+```ini title="airflow.cfg"
+[datahub]
+enabled = False
+```
+
+##### 2. Disable via Airflow Variable (Kill-Switch)
+
+If a restart is not possible and you need a faster way to disable the plugin, you can use the kill-switch. Create and set the `datahub_airflow_plugin_disable_listener` Airflow variable to `true`. This ensures that the listener won't process anything.
+
+##### Command Line
+
+```shell
+airflow variables set datahub_airflow_plugin_disable_listener true
+```
+
+##### Airflow UI
+
+1. Go to Admin -> Variables.
+2. Click the "+" symbol to create a new variable.
+3. Set the key to `datahub_airflow_plugin_disable_listener` and the value to `true`.
+
+This will immediately disable the plugin without requiring a restart.
+
 ## DataHub Plugin v1
 
 ### Installation