This is an automated email from the ASF dual-hosted git repository. kaxilnaik pushed a commit to branch staging in repository https://gitbox.apache.org/repos/asf/airflow-site.git
commit 363188ec7eb0984ac44bf2d657bbbe5212690dac Author: Bugra Ozturk <[email protected]> AuthorDate: Mon Nov 24 16:04:35 2025 +0100 Add airflowctl 0.1.0 blog (#1247) * Add airflowctl 1.0.0 blog * Added two title What is airflowctl? and Coexistence with Airflow CLI, Add leading contributors * Update version from 1.0.0 to 0.1.0 --- .../images/assets_create_event.gif | Bin 0 -> 216627 bytes .../en/blog/airflowctl-0.1.0/images/assets_get.gif | Bin 0 -> 291933 bytes .../en/blog/airflowctl-0.1.0/images/config_get.gif | Bin 0 -> 510350 bytes .../airflowctl-0.1.0/images/connections_create.gif | Bin 0 -> 249273 bytes .../airflowctl-0.1.0/images/connections_get.gif | Bin 0 -> 203511 bytes .../airflowctl-0.1.0/images/connections_update.gif | Bin 0 -> 225207 bytes .../blog/airflowctl-0.1.0/images/dagrun_list.gif | Bin 0 -> 325813 bytes .../airflowctl-0.1.0/images/dagrun_trigger.gif | Bin 0 -> 722607 bytes .../en/blog/airflowctl-0.1.0/images/pools_list.gif | Bin 0 -> 191360 bytes .../airflowctl-0.1.0/images/pools_list_old.gif | Bin 0 -> 302810 bytes .../airflowctl-0.1.0/images/variables_export.gif | Bin 0 -> 119936 bytes .../airflowctl-0.1.0/images/variables_import.gif | Bin 0 -> 330597 bytes .../airflowctl-0.1.0/images/variables_list_old.gif | Bin 0 -> 327778 bytes .../images/variables_list_yaml.gif | Bin 0 -> 179567 bytes .../site/content/en/blog/airflowctl-0.1.0/index.md | 190 +++++++++++++++++++++ 15 files changed, 190 insertions(+) diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/assets_create_event.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/assets_create_event.gif new file mode 100644 index 0000000000..f10e14333e Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/assets_create_event.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/assets_get.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/assets_get.gif new file mode 100644 index 0000000000..392c69738a Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/assets_get.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/config_get.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/config_get.gif new file mode 100644 index 0000000000..b0d9047c18 Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/config_get.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/connections_create.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/connections_create.gif new file mode 100644 index 0000000000..35b7200d5b Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/connections_create.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/connections_get.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/connections_get.gif new file mode 100644 index 0000000000..31f7060882 Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/connections_get.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/connections_update.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/connections_update.gif new file mode 100644 index 0000000000..69c24cfc3b Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/connections_update.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/dagrun_list.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/dagrun_list.gif new file mode 100644 index 0000000000..ba0a8db01d Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/dagrun_list.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/dagrun_trigger.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/dagrun_trigger.gif new file mode 100644 index 0000000000..05f106a268 Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/dagrun_trigger.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/pools_list.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/pools_list.gif new file mode 100644 index 0000000000..58c083f85e Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/pools_list.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/pools_list_old.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/pools_list_old.gif new file mode 100644 index 0000000000..e21956ff3c Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/pools_list_old.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/variables_export.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/variables_export.gif new file mode 100644 index 0000000000..a4cad987d9 Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/variables_export.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/variables_import.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/variables_import.gif new file mode 100644 index 0000000000..87185c11ed Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/variables_import.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/variables_list_old.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/variables_list_old.gif new file mode 100644 index 0000000000..7bfcde36c6 Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/variables_list_old.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/variables_list_yaml.gif b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/variables_list_yaml.gif new file mode 100644 index 0000000000..d2b07ca2f5 Binary files /dev/null and b/landing-pages/site/content/en/blog/airflowctl-0.1.0/images/variables_list_yaml.gif differ diff --git a/landing-pages/site/content/en/blog/airflowctl-0.1.0/index.md b/landing-pages/site/content/en/blog/airflowctl-0.1.0/index.md new file mode 100644 index 0000000000..2016e2c920 --- /dev/null +++ b/landing-pages/site/content/en/blog/airflowctl-0.1.0/index.md @@ -0,0 +1,190 @@ +--- +title: "Apache Airflow CTL aka airflowctl 0.1.0" +linkTitle: "Apache Airflow CTL aka airflowctl 0.1.0" +author: "Buğra Öztürk" +twitter: "" +github: "bugraoz93" +linkedin: "bugraozturk93" +description: "A new way of using API in Airflow. Apache Airflow CTL aka airflowctl 0.1.0 is released! Secure way to manage your Apache Airflow deployments with ease." +tags: ["release"] +date: 2025-10-15 +images: ["/images/blog/airflowctl-0.1.0/airflowctl-cover.png"] +--- + +We are thrilled to announce the first major release of **`airflowctl` 0.1.0**, the new **secure, API-driven command-line interface (CLI)** for Apache Airflow — built under [**AIP-81**](https://cwiki.apache.org/confluence/display/AIRFLOW/AIP-81+Enhanced+Security+in+CLI+via+Integration+of+API). + +This release marks CLI to join the general posture on communicating through API. Airflow CLI joins the modern era of secure, auditable, and remote-first operations. + + +**Details**: + +📦 **PyPI:** [https://pypi.org/project/apache-airflow-ctl/0.1.0/](https://pypi.org/project/apache-airflow-ctl/0.1.0/) \ +🛠️ **Release Notes:** [https://airflow.apache.org/docs/apache-airflow-ctl/stable/release_notes.html](https://airflow.apache.org/docs/apache-airflow-ctl/stable/release_notes.html) \ +🪶 **Source Code:** [https://github.com/apache/airflow/tree/main/airflow-ctl](https://github.com/apache/airflow/tree/main/airflow-ctl) + +## 🎯 What is airflowctl? +`airflowctl` is a new command-line interface for Apache Airflow that interacts exclusively with the Airflow REST API. +It provides a secure, auditable, and consistent way to manage Airflow deployments — without direct access to the metadata database. + +## 🔄 Coexistence with Airflow CLI +The Airflow CLI will continue as intended, primarily for admin tasks such as running Airflow components (`airflow api-server`, `airflow scheduler`) or managing the metadata database (`airflow db init`). +`airflowctl` focuses on operational commands that interact with Airflow resources via the API (`airflowctl dagrun trigger`, `airflowctl connection create`, etc.). + +We defined the commands falls under **two main categories**: +1. **Remote Commands**: Operations that can be provided via API (e.g., managing DAGs, connections, variables, triggering DAG runs) are now available in `airflowctl` and will be the recommended approach going forward. +2. **Local/Admin Commands**: Operations that manage Airflow components or the metadata database will remain in the Airflow CLI. + +Of course, in the current state they will both have the remote commands. +We are planning a zero-disruption migration path where **Remote Commands** will be gradually deprecated from the Airflow CLI as they achieve parity in `airflowctl`. + + +## 🔒 Why airflowctl? + +Until now, Airflow CLI connected directly to the **metadata database**, bypassing RBAC, authentication, and API logs. +While convenient, this approach limited **security, auditing, and remote management** capabilities — especially for enterprise environments. + +**`airflowctl`** changes that by routing every command through the **Airflow REST API**, bringing: + +* **Authentication & RBAC enforcement** +* **Centralized logging & audit trail** +* **Secure credential storage via Keyring** +* **Remote command execution with zero DB access** +* **Consistency with Airflow UI and API behaviors** + + +## 🚀 AIP-81: CLI Reimagined Through the API + +**AIP-81** (“Enhanced Security in CLI via Integration of API”) defined a clear goal: +> “The CLI must be a first-class, secure client of the Airflow REST API — not a privileged database actor.” + +`airflowctl` is the direct realization of that vision. + +### Core design principles: +- **All remote commands use the REST API** +- **RBAC and auth handled consistently via API layer** +- **Pluggable auth mechanisms** (basic auth, OAuth, token, etc.) +- **Secure credential persistence** through **system keyring** +- **Extensible** to new API endpoints as Airflow evolves + + +## ⚙️ Getting Started + +```bash +pip install apache-airflow-ctl +``` + +Once installed, you can connect your CLI to an Airflow instance: + +```bash +airflowctl auth login --url http://localhost:8080 --username admin --password admin +``` + +The password field is interactive by default. You can enter your password securely without echoing it on the terminal. +Use the above command without specifying the password and run it. + +```bash +airflowctl auth login --url http://localhost:8080 --username admin --password +``` + +## 🧩 Command Highlights + +Here’s a quick look at some of the most popular commands, now fully API-backed in airflowctl 0.1.0: + +### 🧩 Assets + + + + +### ⚙️ Config + + + +### 🔑 Connections + + + + +### 🎯 DAG Runs + +Trigger and inspect DAG runs securely through the API: + + + + +### 🪣 Variables + + + + + +All these commands — and many more — operate via Airflow’s public REST API, ensuring secure, logged, and RBAC-controlled execution. + +## 🔐 Key Security Features + +### 🔑 Keyring Integration + +No more plaintext tokens or passwords. +airflowctl uses your OS-level keyring (e.g., macOS Keychain, Windows Credential Manager, or Linux Secret Service) to store and retrieve authentication tokens securely. + +### 🧱 Role-Based Access Control + +Every command is evaluated by Airflow’s RBAC system through the API — ensuring consistent authorization with the web UI and API clients. + +### 🕵️♀️ Auditing and Traceability + +All CLI commands generate API logs and can be observed through standard audit mechanisms — closing a long-standing gap between the CLI and Airflow’s security model. + +## 📈 Roadmap Highlights + +airflowctl 0.1.0 is just the beginning. The foundation is in place for a fully unified, secure CLI experience. + +### 🧩 Coming Soon + +* Completeness of API coverage +* Live log streaming +* Worker management +* Remote debugging +* Incremental deprecation of legacy CLI commands +* Over time, the legacy airflow CLI will be incrementally deprecated as commands achieve API parity. + +## 🧭 Migration + +Migration requires mapping commands, updating authentication, and re-testing automation to ensure compatibility with the new API-backed architecture. +Because airflowctl mirrors the core CLI syntax, most workflows require minimal changes — primarily adjusting authentication and configuration. + +Side by side comparison: + +| Before | After | +|----------------------------------------------------------|------------------------------------------------------------| +|  |  | +|  |  | + + + +## 🙏 Community & Acknowledgments + +This release is the result of extensive collaboration across the Apache Airflow community. +Many thanks all who worked on AIP-81, the Airflow REST API, Authentication, and the airflowctl implementation. + +## Leading Contributors +Special thanks to leading contributors of `airflowctl`: +**Amar Prakash Pandey, Amogh Desai, Aritra Basu, Aryan Khurana, ayush3singh, Brent Bovenzi, Brunda10, +Bugra Ozturk, Daniel Standish, D. Ferruzzi, Deji Ibrahim, Elad Kalif, Ephraim Anierobi, GPK, +Guan Ming(Wesley) Chiu, Hussein Awala, Jake Roach, Jarek Potiuk, Jed Cunningham, Jens Scheffler, +Jaejun Lee, Kalyan R, Karthikeyan Singaravelan, Kaxil Naik, Kevin Yang, Kiruban Kamaraj, LI,JHE-CHEN, +Pierre Jeambrun, Pratiksha, Sam Wheating, Tzu-ping Chung, Valentyn, Vincent, Wei Lee, Yeonguk, +Yunchi Pang, Zhen-Lun (Kevin) Hong** + +✨ In Summary + +airflowctl 0.1.0 makes Airflow’s command line: + +| Before | After | +|-----------------------|------------------------------| +| Direct DB access | API-backed security | +| No RBAC or audit | Centralized auth \& logging | +| Inconsistent behavior | Unified CLI + API experience | +| Manual secrets | Keyring-secured credentials | + +Security first. API always. CLI reimagined. +The secure CLI foundation lays the groundwork for Airflow’s next generation. A unified, API-first platform for orchestration and operations.
