This is an automated email from the ASF dual-hosted git repository.
eladkal pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 40fcb034ada Add Bundle documentation for Amazon S3 and Google GCS
providers (#66993)
40fcb034ada is described below
commit 40fcb034ada3084a76e8685c5aa9daf9015903c7
Author: Shashwati Bhattacharyaa <[email protected]>
AuthorDate: Sat May 16 19:42:03 2026 +0530
Add Bundle documentation for Amazon S3 and Google GCS providers (#66993)
* Add Bundle documentation for Amazon S3 and Google GCS providers
* Address review: use Dag/Dags instead of DAG/DAGs, note unversioned bundle
* Address review: simplify docs to match git provider format, add core
cross-reference
---------
Co-authored-by: Shashwati <[email protected]>
---
providers/amazon/docs/bundles/index.rst | 47 +++++++++++++++++++++++++++++++++
providers/amazon/docs/index.rst | 1 +
providers/google/docs/bundles/index.rst | 47 +++++++++++++++++++++++++++++++++
providers/google/docs/index.rst | 1 +
4 files changed, 96 insertions(+)
diff --git a/providers/amazon/docs/bundles/index.rst
b/providers/amazon/docs/bundles/index.rst
new file mode 100644
index 00000000000..0c1d3ea6302
--- /dev/null
+++ b/providers/amazon/docs/bundles/index.rst
@@ -0,0 +1,47 @@
+ .. 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.
+
+Bundles
+#######
+
+Dag bundles allow Airflow to load Dags from external sources. For a general
overview see
+:doc:`apache-airflow:administration-and-deployment/dag-bundles`.
+
+S3DagBundle
+===========
+
+Use the :class:`~airflow.providers.amazon.aws.bundles.s3.S3DagBundle` to
configure an S3 bundle in your Airflow's
+``[dag_processor] dag_bundle_config_list``.
+
+Example of using the S3DagBundle:
+
+**JSON format example**:
+
+.. code-block:: bash
+
+ export AIRFLOW__DAG_PROCESSOR__DAG_BUNDLE_CONFIG_LIST='[
+ {
+ "name": "my-s3-dags",
+ "classpath": "airflow.providers.amazon.aws.bundles.s3.S3DagBundle",
+ "kwargs": {
+ "aws_conn_id": "aws_default",
+ "bucket_name": "my-airflow-bucket",
+ "prefix": "dags/",
+ "refresh_interval": 60
+ }
+ }
+ ]'
diff --git a/providers/amazon/docs/index.rst b/providers/amazon/docs/index.rst
index 0d68041867b..ce4f07c8fa0 100644
--- a/providers/amazon/docs/index.rst
+++ b/providers/amazon/docs/index.rst
@@ -33,6 +33,7 @@
:maxdepth: 1
:caption: Guides
+ Bundles <bundles/index>
Connection types <connections/index>
Notifications <notifications/index>
Operators <operators/index>
diff --git a/providers/google/docs/bundles/index.rst
b/providers/google/docs/bundles/index.rst
new file mode 100644
index 00000000000..4c027b11414
--- /dev/null
+++ b/providers/google/docs/bundles/index.rst
@@ -0,0 +1,47 @@
+ .. 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.
+
+Bundles
+#######
+
+Dag bundles allow Airflow to load Dags from external sources. For a general
overview see
+:doc:`apache-airflow:administration-and-deployment/dag-bundles`.
+
+GCSDagBundle
+============
+
+Use the :class:`~airflow.providers.google.cloud.bundles.gcs.GCSDagBundle` to
configure a GCS bundle in your Airflow's
+``[dag_processor] dag_bundle_config_list``.
+
+Example of using the GCSDagBundle:
+
+**JSON format example**:
+
+.. code-block:: bash
+
+ export AIRFLOW__DAG_PROCESSOR__DAG_BUNDLE_CONFIG_LIST='[
+ {
+ "name": "my-gcs-dags",
+ "classpath": "airflow.providers.google.cloud.bundles.gcs.GCSDagBundle",
+ "kwargs": {
+ "gcp_conn_id": "google_cloud_default",
+ "bucket_name": "my-airflow-bucket",
+ "prefix": "dags/",
+ "refresh_interval": 60
+ }
+ }
+ ]'
diff --git a/providers/google/docs/index.rst b/providers/google/docs/index.rst
index 9a370e807e2..5cddc87893d 100644
--- a/providers/google/docs/index.rst
+++ b/providers/google/docs/index.rst
@@ -34,6 +34,7 @@
:maxdepth: 1
:caption: Guides
+ Bundles <bundles/index>
Connection types <connections/index>
Logging handlers <logging/index>
Message queues <message-queues/index>
