@@ -21,6 +21,16 @@ This wrapper provides one-click Azure deployment:
2121- ** Terraform Infrastructure** - Production-ready Azure Container Apps deployment
2222- ** E2E Testing** - Validate security guards locally before deploying
2323
24+ ## Documentation
25+
26+ | Guide | Description |
27+ | -------| -------------|
28+ | [ E2E Test Guide] ( docs/E2E_TEST_GUIDE.md ) | Run security guard tests locally (5 min) |
29+ | [ Production Setup] ( docs/PRODUCTION_SETUP.md ) | Deploy to Azure step-by-step |
30+ | [ Authentication] ( docs/AUTHENTICATION.md ) | Configure OAuth and mTLS |
31+ | [ Security Guards] ( docs/SECURITY_GUARDS.md ) | Configure protection policies |
32+ | [ Build Options] ( docs/BUILD_OPTIONS.md ) | ACR vs VM build methods |
33+
2434## Quick Start
2535
2636### Prerequisites
@@ -98,18 +108,22 @@ terraform output ui_url
98108Test security guards locally before deploying:
99109
100110``` bash
101- # Run full test suite
102- ./deploy.sh
111+ # Login to ACR (one-time)
112+ az login
113+ az acr login --name agwimages
114+
115+ # Run full test suite (17 tests)
116+ ./deploy.sh --e2e
103117
104- # Or step by step:
105- ./deploy.sh --skip-tests # Start services only
106- ./deploy.sh --stop # Stop services
118+ # Stop services when done
119+ ./deploy.sh --stop
107120```
108121
109- This runs tests for:
110- - ** Tool Poisoning Guard** - Blocks malicious tool descriptions
111- - ** Rug Pull Guard** - Detects runtime tool changes
112- - ** PII Guard** - Blocks sensitive data exposure
122+ This validates:
123+ - ** Tool Poisoning Guard** - Blocks malicious tool descriptions (3 tests)
124+ - ** Rug Pull Guard** - Detects runtime tool changes (14 tests)
125+
126+ See [ docs/E2E_TEST_GUIDE.md] ( docs/E2E_TEST_GUIDE.md ) for detailed test documentation.
113127
114128## Authentication
115129
@@ -158,18 +172,27 @@ unitone-agentgateway/
158172│ ├── main.tf # Azure infrastructure
159173│ ├── variables.tf # Configuration options
160174│ └── README.md # Terraform docs
175+ ├── scripts/
176+ │ ├── build-on-vm.sh # VM-based Docker builds
177+ │ └── setup-build-vm.sh # Setup build VM
161178├── tests/
162179│ ├── docker/ # Docker-based E2E tests
180+ │ ├── configs/ # Test configurations
163181│ └── e2e_*.py # Test scripts
164182├── testservers/ # Mock MCP servers for testing
165183├── examples/
166184│ └── config.yaml # Example gateway config
167185└── docs/
186+ ├── E2E_TEST_GUIDE.md # How to run E2E tests
187+ ├── PRODUCTION_SETUP.md # Full production deployment
168188 ├── AUTHENTICATION.md # OAuth setup guide
169189 ├── SECURITY_GUARDS.md # Security guard docs
190+ ├── BUILD_OPTIONS.md # Build method comparison
170191 └── CONFIG_HOT_RELOAD.md # Runtime config updates
171192```
172193
194+ For detailed production deployment instructions, see [ docs/PRODUCTION_SETUP.md] ( docs/PRODUCTION_SETUP.md ) .
195+
173196## Configuration
174197
175198### Gateway Config (examples/config.yaml)
0 commit comments