Skip to content

Commit

Permalink
Fix OpenLineage integration documentation (#810)
Browse files Browse the repository at this point in the history
[Cosmos docs](https://astronomer.github.io/astronomer-cosmos/configuration/lineage.html)
stated that users didn't have to install any dependency to use
OpenLineage with Cosmos.

However, for inlets and outlets to be emitted, Airflow 2.7 users must
install `apache-airflow-providers-openlineage` or
`astronomer-cosmos[openlineage]`.

Closes: #796
  • Loading branch information
tatiana committed Jan 26, 2024
1 parent 3040887 commit fe01237
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/configuration/lineage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and virtualenv execution methods (read `execution modes <../getting_started/exec

To emit lineage events, Cosmos can use one of the following:

1. Airflow 2.7 `built-in support to OpenLineage <https://airflow.apache.org/docs/apache-airflow-providers-openlineage/1.0.2/guides/user.html>`_, or
1. Airflow `official OpenLineage provider <https://airflow.apache.org/docs/apache-airflow-providers-openlineage/1.0.2/guides/user.html>`_, or
2. `Additional libraries <https://openlineage.io/docs/integrations/airflow/>`_.

No change to the user DAG files is required to use OpenLineage.
Expand All @@ -18,7 +18,7 @@ No change to the user DAG files is required to use OpenLineage.
Installation
------------

If using Airflow 2.7, no other dependency is required.
If using Airflow 2.7 or higher, install ``apache-airflow-providers-openlineage``.

Otherwise, install Cosmos using ``astronomer-cosmos[openlineage]``.

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/render-config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ It does this by exposing a ``cosmos.config.RenderConfig`` class that you can use

The ``RenderConfig`` class takes the following arguments:

- ``emit_datasets``: whether or not to emit Airflow datasets to be used for data-aware scheduling. Defaults to True
- ``emit_datasets``: whether or not to emit Airflow datasets to be used for data-aware scheduling. Defaults to True. Depends on `additional dependencies <lineage.html>`_.
- ``test_behavior``: how to run tests. Defaults to running a model's tests immediately after the model is run. For more information, see the `Testing Behavior <testing-behavior.html>`_ section.
- ``load_method``: how to load your dbt project. See `Parsing Methods <parsing-methods.html>`_ for more information.
- ``select`` and ``exclude``: which models to include or exclude from your DAGs. See `Selecting & Excluding <selecting-excluding.html>`_ for more information.
Expand Down

0 comments on commit fe01237

Please sign in to comment.