From dbcfb9d07585a125ae98e024e24cdcf1bc9b7fd8 Mon Sep 17 00:00:00 2001 From: Pablo Martin Date: Thu, 1 Feb 2024 15:32:50 +0100 Subject: [PATCH] some changes in networking instructions --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fcada0b..22bcb6e 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,12 @@ Welcome to Superhog's DWH dbt project. Here we model the entire DWH. - You need a Linux environment. That can be Linux, macOS or WSL. - You need to install Python `>=3.10` and `poetry`. - All docs will assume you are using VSCode. -- Prepare SSH tunnels - - We currently use SSH tunnels to reach both the `dev` and `prd` instances. You can ask Pablo how to set these up. - - You will need to activate the tunnels in order to run the dbt models on the databases. It will probably pay off to make them easy to activate in your terminal, you can make an alias. +- Prepare networking + - You must be able to reach the DWH server through the network. There are several ways to do this. + - The current recommended route is to use the data VPN. You can ask Pablo to help you set it up. - Set up - 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 the tunnels. + - Make sure that the `profiles.yml` host and port settings are consistent with whatever networking approach you've taken. - Use `poetry install` to get dependencies in place. - Check - Ensure you are running in the project venv, either by setting VSCode Python interpreter to the one created by `poetry`, or by running `poetry shell` in the console when in the root dir. @@ -63,5 +63,4 @@ We organize models in four folders: - Automate formatting with git pre-commit. - Define conventions on testing (and enforce them). - Define conventions on documentation (and enforce them). -- Replace SSH tunneling with a Wireguard VPN access. - Prepare a quick way to replicate parts of the `prd` dwh in our local machines.