Skip to content

Commit

Permalink
Apply review suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
pankajastro committed May 20, 2024
1 parent 3b6c772 commit 8d64ed1
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 9 deletions.
39 changes: 31 additions & 8 deletions docs/configuration/cosmos-conf.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Cosmos Config
=============

This page contains the list of all available Airflow configurations and environment variables specific to ``astronomer-cosmos`` that can be set in the airflow.cfg file or using environment variables.
This page lists all available Airflow configurations that affect ``astronomer-cosmos`` Astronomer Cosmos behavior. They can be set in the ``airflow.cfg file`` or using environment variables.

.. note::
For more information, see `Setting Configuration Options <https://airflow.apache.org/docs/apache-airflow/stable/howto/set-config.html>`_.
Expand All @@ -14,43 +14,66 @@ This page contains the list of all available Airflow configurations and environm
[cosmos]
~~~~~~~~

1. ``cache_dir``:
.. _cache_dir:

`cache_dir`_:
The directory used for caching Cosmos data.

- Default: ``{TMPDIR}/cosmos_cache`` (where ``{TMPDIR}`` is the system temporary directory)
- Environment Variable: ``AIRFLOW__COSMOS__CACHE_DIR``

.. _enable_cache:

2. ``enable_cache``:
`enable_cache`_:
Enable or disable caching of Cosmos data.

- Default: ``True``
- Environment Variable: ``AIRFLOW__COSMOS__ENABLE_CACHE``

.. _propagate_logs:

3. ``propagate_logs``:
`propagate_logs`_:
Whether to propagate logs in the Cosmos module.

- Default: ``True``
- Environment Variable: ``AIRFLOW__COSMOS__PROPAGATE_LOGS``

4. ``dbt_docs_dir``:
.. _dbt_docs_dir:

`dbt_docs_dir`_:
The directory path for dbt documentation.

- Default: ``None``
- Environment Variable: ``AIRFLOW__COSMOS__DBT_DOCS_DIR``

.. _dbt_docs_conn_id:

5. ``dbt_docs_conn_id``:
`dbt_docs_conn_id`_:
The connection ID for dbt documentation.

- Default: ``None``
- Environment Variable: ``AIRFLOW__COSMOS__DBT_DOCS_CONN_ID``

[openlineage]
~~~~~~~~~~~~~

1. ``namespace``:
.. _namespace:

`namespace`_:
The OpenLineage namespace for tracking lineage.

- Default: If not configured in Airflow configuration, it falls back to the environment variable ``OPENLINEAGE_NAMESPACE``, otherwise it uses ``DEFAULT_OPENLINEAGE_NAMESPACE``.
- Environment Variable: ``AIRFLOW__OPENLINEAGE__NAMESPACE``

.. note::
For more information, see `Openlieage Configuration Options <https://airflow.apache.org/docs/apache-airflow-providers-openlineage/stable/guides/user.html>`_.

Environment Variables
~~~~~~~~~~~~~~~~~~~~~

1. ``LINEAGE_NAMESPACE``:
.. _LINEAGE_NAMESPACE:

`LINEAGE_NAMESPACE`_:
The OpenLineage namespace for tracking lineage.

- Default: If not configured in Airflow configuration, it falls back to the environment variable ``OPENLINEAGE_NAMESPACE``, otherwise it uses ``DEFAULT_OPENLINEAGE_NAMESPACE``.
2 changes: 1 addition & 1 deletion docs/configuration/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Cosmos offers a number of configuration options to customize its behavior. For m
Render Config <render-config>

Parsing Methods <parsing-methods>
Configuring <cosmos-conf>
Configuring in Airflow <cosmos-conf>
Configuring Lineage <lineage>
Generating Docs <generating-docs>
Hosting Docs <hosting-docs>
Expand Down

0 comments on commit 8d64ed1

Please sign in to comment.