Prerequisites¶

Everything this repository's tooling (scripts/*.ps1, helm/, terraform/, this documentation portal) assumes is available on a Windows development machine.

Checklist¶

Tool	Why it's needed	Check installed	Install
Git	Source control	`git --version`	git-scm.com
Docker Desktop	Builds images; local k3d/K3s runs inside it	`docker version`	docker.com
kubectl	Talk to any Kubernetes cluster	`kubectl version --client`	Bundled with Docker Desktop, or `winget install Kubernetes.kubectl`
k3d	Creates the local Kubernetes cluster	`k3d version`	`winget install k3d.k3d`
Helm	Deploys `helm/akshayabazaar/`	`helm version`	`winget install Helm.Helm`, or use the containerized fallback below
Terraform	Provisions/inspects cloud infrastructure	`terraform version`	`winget install Hashicorp.Terraform`, or use the containerized fallback below
PowerShell	Runs every `scripts/*.ps1`	`$PSVersionTable.PSVersion`	Ships with Windows 11; 5.1 or later works (scripts are written to avoid PowerShell 7-only syntax)
Python 3.x	Builds/serves this documentation portal (MkDocs)	`python --version`	See MkDocs setup below
MkDocs Material	This documentation portal	`mkdocs --version`	Installed into a project-local virtual environment - see below

PowerShell¶

$PSVersionTable.PSVersion

Windows 11 ships PowerShell 5.1 by default. Every script in scripts/ is written to run on 5.1 (no ??/?./ternary operators) - PowerShell 7+ also works if you have it.

Python + MkDocs¶

If python --version returns Python was not found (the Microsoft Store app-execution alias stub, not a real Python), install it via winget's Python Install Manager package:

winget install 9NQ7512CXL7T -e --accept-package-agreements --disable-interactivity
py --version
pymanager --version

If the manager installs but no runtime is present yet:

py install
py list
python --version

If the current PowerShell session doesn't pick up the new python/py commands after install, close and reopen your terminal (or open a fresh VS Code terminal) before doing anything else - do not start editing PATH by hand first. If it's still unresolved after a fresh session, see Local → Troubleshooting.

Once Python resolves, MkDocs itself is installed into an isolated virtual environment, not system-wide - see First-time setup.

Windows hosts file (for local Kubernetes staging)¶

The local k3d staging environment is reachable at staging.akshaya.local, which needs one line in your hosts file:

127.0.0.1 staging.akshaya.local

Editing C:\Windows\System32\drivers\etc\hosts requires an elevated (Administrator) PowerShell. This portal never edits it for you automatically - see First-time setup → hosts file for the exact command to run yourself.