Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/reference/configs/cosmos-conf.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _cosmos-config:

Cosmos Config
-------------
=============

This page lists all available `Apache Airflow® <https://airflow.apache.org/>`_ configurations that affect Astronomer Cosmos behavior. They can be set in the ``airflow.cfg`` file or using environment variables.

Expand All @@ -14,7 +14,7 @@ This page lists all available `Apache Airflow® <https://airflow.apache.org/>`_
- [openlineage]

[cosmos]
++++++++
~~~~~~~~

.. _cache_dir:

Expand Down Expand Up @@ -378,7 +378,7 @@ This page lists all available `Apache Airflow® <https://airflow.apache.org/>`_
- Environment Variable: ``AIRFLOW__COSMOS__WATCHER_DBT_EXECUTION_QUEUE``

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

.. _namespace:

Expand All @@ -392,7 +392,7 @@ This page lists all available `Apache Airflow® <https://airflow.apache.org/>`_
For more information, see `OpenLineage Configuration Options <https://airflow.apache.org/docs/apache-airflow-providers-openlineage/stable/guides/user.html>`_.

Environment Variables
+++++++++++++++++++++
~~~~~~~~~~~~~~~~~~~~~

.. _LINEAGE_NAMESPACE:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/configs/execution-config.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _execution-config:

Execution Config
----------------
================

Cosmos aims to give you control over how your dbt project is executed when running in airflow.
It does this by exposing a ``cosmos.config.ExecutionConfig`` class that you can use to configure how your DAGs are executed.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/configs/profile-config.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _profile-config:

Profile Config
--------------
==============

Cosmos supports two methods of authenticating with your database:

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/configs/project-config.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _project-config:

Project config
--------------
==============

The ``cosmos.config.ProjectConfig`` allows you to specify information about where your dbt project is located and project
variables that should be used for rendering and execution. It takes the following arguments:
Expand Down Expand Up @@ -29,7 +29,7 @@ variables that should be used for rendering and execution. It takes the followin
execution modes. Due to the way that dbt `partial parsing works <https://docs.getdbt.com/reference/parsing#known-limitations>`_, it does not work with Cosmos profile mapping classes. To benefit from this feature, users have to set the ``profiles_yml_filepath`` argument in ``ProfileConfig``.

Project config example
++++++++++++++++++++++
~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Reference
---------
=========

.. toctree::
:maxdepth: 0
Expand Down Expand Up @@ -33,17 +33,17 @@ Reference


Configurations
++++++++++++++
~~~~~~~~~~~~~~

There are different configurations and profiles that you can use to configure how Cosmos works.

- `ProjectConfig <configs/project-config.html>`_: The ``ProjectConfig`` contains information about which dbt project a Cosmos Dag or task group is going to execute, as well as configurations that apply to both rendering and execution.
- `ExecutionConfig <configs/execution-config.html>`_: The ``ExecutionConfig`` determines where and how the dbt commands are run within Cosmos.
- `CosmosConfig <configs/cosmos-conf.html>`_: This page lists available `Apache Airflow® <https://airflow.apache.org/>`_ configurations that affect ``astronomer-cosmos`` behavior. You can set them in the ``airflow.cfg`` file or using environment variables.
- `ProfileConfig <configs/profiles-config.html>`_: The ``ProfileConfig`` class determines which data warehouse Cosmos connects to when it executes the dbt SQL. These docs include reference documentation for connecting to popular data warehouses you might use in your dbt code.
- `ProfileConfig <configs/profile-config.html>`_: The ``ProfileConfig`` class determines which data warehouse Cosmos connects to when it executes the dbt SQL. These docs include reference documentation for connecting to popular data warehouses you might use in your dbt code.

Profiles
++++++++
~~~~~~~~
Comment thread
pankajkoti marked this conversation as resolved.

The **Profiles** reference provides information about the different kinds of profile mappings available in Cosmos. These profile mappings are Airflow operators that map Airflow connections to dbt profiles, allowing you to work with resources in your data warehouses.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/templates/profile_mapping.rst.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Some notes about the table above:
{% if profile_defaults %}

Default values
--------------
~~~~~~~~~~~~~~

This profile mapping sets the following default values. These can be overridden by passing
them in ``profile_args``.
Expand Down