Add System Requirements to the README file in the root folder

[paolosalvatori]

Motivation

This pull request fixes #36: the README in the main folder doesn't mention hardware requirements yet.

Fixes SMF-946

Changes

Add the following section to the README in the main folder:

System Requirements

Before running the samples, ensure your host machine meets the recommended resource allocations.

Resource Allocations

Resource	Minimum	Recommended	Description
Memory (RAM)	8 GB	16 GB	~3.3 GB for the baseline cluster & LocalStack; additional headroom for workloads
Disk Space	20 GB	30 GB+	~6 GB for Docker container images and ~7.6 GB for persistent volumes

Baseline Container Footprint

A baseline deployment with 1 system node and 1 user node consumes approximately 3.3 GB of memory across containers:

• k3d Server (Control Plane): ~1.2 GB
• System Node: ~0.9 GB
• LocalStack Azure: ~0.6 GB
• User Node: ~0.5 GB (allow ~0.5–1.0 GB per additional node)
• Azurite + k3d Load Balancer: ~0.08 GB

Note

Additional Resource Overhead:
In addition to the base AKS cluster and LocalStack emulator, each specific sample variation can deploy additional Azure resources, services, and Kubernetes workloads. Ensure you account for extra memory and disk capacity based on the specific sample scenario you execute.

Windows / WSL2 Memory Footprint

On WSL2, process memory (vmmemwsl) may appear to expand significantly (e.g., up to 18 GB). This is typically caused by Linux page caching (buff/cache) from unpacking container images rather than active process memory (free -h). Because WSL does not immediately return cached memory to Windows, it can look much heavier than it actually is. To restrict or reclaim WSL memory usage, configure your %USERPROFILE%\.wslconfig:

[wsl2]
memory=12GB
autoMemoryReclaim=dropcache

[Copilot]

🟡 Changes recommended

The WSL2 example is invalid and leaves its Markdown code fence unclosed.

2 open findings

• Scope local deployment requirements to local runs · New
• Fix autoMemoryReclaim section and close code fence · New

What changed in this PR

Adds local hardware guidance for running AKS samples with LocalStack.

Changes:

• Documents RAM, disk, and container usage.
• Adds WSL2 memory-management guidance.

File	Description
README.md	Adds system requirements and WSL2 configuration guidance.

🧠 Review effort: Balanced

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.