DBT service management via ADCM
Overview
The ADCM UI provides actions to manage the DBT service and its components. The actions are listed in the table below.
| Action | Description |
|---|---|
Add/Remove components |
Running this action opens the component-host mapping interface where you can add, remove, and distribute DBT components |
Run dbt command |
Running this action opens a dialog window where you can select a dbt command to run for the DBT service |
Check |
Runs service-specific tests to check the health of the service and its components |
Restart |
Restarts the service.
When you run this action, the option Apply configs from ADCM is available.
If it is set to |
Remove |
Removes the service from the cluster.
This action should be used to remove already installed services.
Whereas the |
Start |
Starts the service.
When you run this action, the option Apply configs from ADCM is available.
If it is set to |
Stop |
Stops the service |
For the DBT Docs component, you can run the following actions separately: Restart, Start, and Stop.
Run dbt command
You can run the Run dbt command action in two ways:
-
at the service level — the dbt command runs on all hosts with DBT components;
-
for a specific host with a DBT component — the dbt command runs only on the selected host.
The following commands can be run only on a per-host basis:
-
run
-
test
-
build
Commands debug and docs_generate can be run on all hosts.
When activating the Run dbt command action, fill in the following parameters in the dialog window:
-
Project dir — path to the dbt project.
-
Operation — command to execute:
-
debug — debugs dbt connections and projects.
-
run — runs the models in a project.
-
test — executes tests defined in a project.
-
build — builds and tests all selected resources (models, seeds, tests, and more).
-
docs_generate — generates documentation for a project.
-
-
Profiles path — path to profiles.yml (for database connection).
-
Target — selected environment (for example,
dev/prod). -
Log path — dbt logs directory.
-
Target path — optional parameter. Defines the directory where dbt stores compiled SQL files, logs, manifests, and execution artifacts (by default, the target/ directory in the project root).
For more information about the commands, see dbt Command reference.
To run a dbt command for a specific host:
-
On the Clusters page, select the desired cluster.
-
Go to the Hosts tab and select the desired host with a DBT component.
-
In the list of components installed on that host, select the Run dbt command action for the DBT component.
-
Fill in the necessary fields and run the action.