This is an automated email from the ASF dual-hosted git repository.
potiuk 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 56904394b9 Fix typo in xcoms.rst (#40265)
56904394b9 is described below
commit 56904394b9162644bf4b2a79651ee7d6b9fc05b6
Author: bangjiehan <[email protected]>
AuthorDate: Sun Jun 16 13:48:17 2024 +0800
Fix typo in xcoms.rst (#40265)
---
docs/apache-airflow/core-concepts/xcoms.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/apache-airflow/core-concepts/xcoms.rst
b/docs/apache-airflow/core-concepts/xcoms.rst
index 75884513c8..4fb4e1b142 100644
--- a/docs/apache-airflow/core-concepts/xcoms.rst
+++ b/docs/apache-airflow/core-concepts/xcoms.rst
@@ -64,8 +64,8 @@ Object Storage XCom Backend
The default XCom backend is the :class:`~airflow.models.xcom.BaseXCom` class,
which stores XComs in the Airflow database. This is fine for small values, but
can be problematic for large values, or for large numbers of XComs.
-To enable storing XComs in an object store, you can set the ``xcom_backend``
configuration option to
``airflow.providers.common.io.xcom.backend.XComObjectStorageBackend``. You will
also need to set ``xcom_objectstorage_path`` to the desired location. The
connection
-id is obtained from the user part of the url the you will provide, e.g.
``xcom_objectstorage_path = s3://conn_id@mybucket/key``. Furthermore,
``xcom_objectstorage_threshold`` is required
+To enable storing XComs in an object store, you can set the ``xcom_backend``
configuration option to
``airflow.providers.common.io.xcom.backend.XComObjectStorageBackend``.
+You will also need to set ``xcom_objectstorage_path`` to the desired location.
The connection id is obtained from the user part of the url that you will
provide, e.g. ``xcom_objectstorage_path = s3://conn_id@mybucket/key``.
Furthermore, ``xcom_objectstorage_threshold`` is required
to be something larger than -1. Any object smaller than the threshold in bytes
will be stored in the database and anything larger will be be
put in object storage. This will allow a hybrid setup. If an xcom is stored on
object storage a reference will be
saved in the database. Finally, you can set ``xcom_objectstorage_compression``
to fsspec supported compression methods like ``zip`` or ``snappy`` to
@@ -124,7 +124,7 @@ You can also examine Airflow's configuration:
Working with Custom Backends in K8s via Helm
--------------------------------------------
-Running custom XCom backends in K8s will introduce even more complexity to you
Airflow deployment. Put simply, sometimes things go wrong which can be
difficult to debug.
+Running custom XCom backends in K8s will introduce even more complexity to
your Airflow deployment. Put simply, sometimes things go wrong which can be
difficult to debug.
For example, if you define a custom XCom backend in the Chart ``values.yaml``
(via the ``xcom_backend`` configuration) and Airflow fails to load the class,
the entire Chart deployment will fail with each pod container attempting to
restart time and time again.
