diff --git a/README.md b/README.md index 6aedf9b..b3b73e5 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,7 @@ To deploy: - Also run `dbt deps` to install the dbt packages required by the project. - Create an entry for this project `profiles.yml` file at `~/.dbt/profiles.yml`. You have a suggested template at `profiles.yml.example`. Make sure that the `profiles.yml` host and port settings are consistent with whatever networking approach you've taken. - There's a script in the root of this project called `run_dbt.sh`. Place it in `~/run_dbt.sh`. Adjust the paths of the script if you want/need to. +- The script is designed to send both success and failure messages to slack channels upon completion. To properly set this up, you will need to place a file called `slack_webhook_urls.txt` on the same path you drop `run_dbt.sh`. The file should have two lines: `SLACK_ALERT_WEBHOOK_URL=` and `SLACK_RECEIPT_WEBHOOK_URL=`. Setting up the slack channels and webhooks is outside of the scope of this readme. - Create a cron entry with `crontab -e` that runs the script. For example: `0 2 * * * /bin/bash /home/azureuser/run_dbt.sh` to run the dbt models every day at 2AM. To monitor: