Skip to content

Commit 359fc64

Browse files
author
amar-python
committed
docs: add pre-deployment verification section to README
1 parent 77d0667 commit 359fc64

1 file changed

Lines changed: 53 additions & 0 deletions

File tree

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,59 @@ PostgreDataMigrationApp/
138138
139139
---
140140

141+
## Verify Before You Deploy
142+
143+
Before running any deployment — local or Azure — confirm your environment is
144+
ready. This repository has evolved over time, so always verify which files and
145+
tools are actually present rather than assuming.
146+
147+
### 1. Confirm the required tools are installed
148+
149+
```powershell
150+
az version # Azure CLI (only needed for Azure deployment)
151+
terraform version # Terraform 1.5+
152+
psql --version # PostgreSQL client
153+
python --version # Python 3.10+
154+
```
155+
156+
If any command is not recognised, install that tool before continuing. On
157+
Windows, add `psql` to PATH permanently:
158+
159+
```powershell
160+
setx PATH "$($env:PATH);C:\Program Files\PostgreSQL\17\bin"
161+
```
162+
163+
### 2. Locate the deployment scripts actually present in your copy
164+
165+
```powershell
166+
Get-ChildItem -Recurse -Filter "deploy-all.ps1" | Select-Object FullName
167+
Get-ChildItem -Recurse -Filter "main.tf" | Select-Object FullName
168+
Get-ChildItem -Recurse -Filter "deploy_all.sh" | Select-Object FullName
169+
```
170+
171+
Use the paths these return — do not assume a folder name. Azure automation may
172+
live under `azure-automation/` or `infra/` depending on your version.
173+
174+
### 3. Confirm PostgreSQL is reachable (before DB-backed steps)
175+
176+
```powershell
177+
psql -c '\l'
178+
```
179+
180+
If this fails, local deploys and Tiers I + S of the eval suite will skip — the
181+
database must be installed and running first.
182+
183+
### 4. Confirm no secrets are tracked
184+
185+
```powershell
186+
git ls-files | Select-String -Pattern "config.local.env$|\.tfvars$|\.pgpass"
187+
```
188+
189+
This should return nothing. If it lists a file, remove it from tracking before
190+
pushing.
191+
192+
---
193+
141194
## Quick Start
142195

143196
### 1. Clone the repository

0 commit comments

Comments
 (0)