Skip to content

Commit b87068b

Browse files
committed
feat(docs): generalize headless deployment documentation and add new guide
1 parent 7af4be5 commit b87068b

11 files changed

Lines changed: 773 additions & 216 deletions

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ SPDX-License-Identifier: MIT-0
1616
- Additive: classes without the new flag behave exactly as before.
1717
- See `docs/classification.md#excluding-static-pages-eg-instructions-legal-boilerplate`.
1818

19+
### Changed
20+
21+
- **Headless deployment documentation generalized** — headless mode is no longer documented as a GovCloud-only capability. New `docs/headless-deployment.md` is the canonical guide covering headless deployment for both Commercial and GovCloud regions (API-only / pipeline integrations, organizational restrictions on UI-layer services, cost optimization, and required for GovCloud).
22+
1923
## Templates
2024
- us-west-2: `https://s3.us-west-2.amazonaws.com/aws-ml-blog-us-west-2/artifacts/genai-idp/idp-main_0.5.8.yaml`
2125
- us-east-1: `https://s3.us-east-1.amazonaws.com/aws-ml-blog-us-east-1/artifacts/genai-idp/idp-main_0.5.8.yaml`

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ For detailed deployment and testing instructions, see the [Deployment Guide](./d
174174
- [Architecture](./docs/architecture.md) - Detailed component architecture and data flow
175175
- [Demo Videos](./docs/demo-videos.md) - Comprehensive collection of feature demonstration videos
176176
- [Deployment](./docs/deployment.md) - Build, publish, deploy, and test instructions
177+
- [Headless Deployment](./docs/headless-deployment.md) - Backend-only deployment (no UI/AppSync/Cognito/WAF) for API-only use cases; required for GovCloud
177178
- [IDP CLI](./docs/idp-cli.md) - Command line interface for batch processing, evaluation workflows, and interactive Agent Chat
178179
- [Web UI](./docs/web-ui.md) - Web interface features and usage
179180
- [Agent Analysis](./docs/agent-analysis.md) - Natural language analytics and data visualization feature

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.5.8.rc1
1+
0.5.8.rc2

docs-site/astro.config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ export default defineConfig({
3737
items: [
3838
{ label: "Architecture", slug: "architecture" },
3939
{ label: "Deployment", slug: "deployment" },
40+
{ label: "Headless Deployment", slug: "headless-deployment" },
4041
{ label: "ALB Hosting", slug: "alb-hosting" },
4142
{ label: "Private Network Deployment", slug: "deployment-private-network" },
4243
{ label: "Configuration", slug: "configuration" },

docs/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This folder contains detailed documentation on various aspects of the GenAI Inte
1313

1414
- [Architecture](./architecture.md) - Detailed component architecture and data flow
1515
- [Deployment](./deployment.md) - Build, publish, deploy, and test instructions
16+
- [Headless Deployment](./headless-deployment.md) - Backend-only deployment (no UI/AppSync/Cognito/WAF) — for API-only / pipeline integrations in Commercial regions and required for GovCloud
1617
- [Configuration](./configuration.md) - Configuration and customization options
1718
- [Configuration Versions](./configuration-versions.md) - Managing multiple configuration versions
1819
- [IDP Configuration Best Practices](./idp-configuration-best-practices.md) - Guidelines for effective configuration design
@@ -76,8 +77,8 @@ This folder contains detailed documentation on various aspects of the GenAI Inte
7677

7778
- [Well-Architected Framework Assessment](./well-architected.md) - Analysis based on AWS Well-Architected Framework
7879
- [AWS Services & IAM Roles](./aws-services-and-roles.md) - AWS services used and IAM role requirements
79-
- [ALB Hosting](./alb-hosting.md) - ALB+S3 hosting for private network and GovCloud deployments
80-
- [GovCloud Deployment](./govcloud-deployment.md) - Deployment guide for AWS GovCloud regions
80+
- [ALB Hosting](./alb-hosting.md) - ALB+S3 hosting to serve the full Web UI from within a VPC (alternative to CloudFront)
81+
- [GovCloud Deployment](./govcloud-deployment.md) - GovCloud-specific considerations on top of headless deployment
8182
- [EU Region Model Support](./eu-region-model-support.md) - Model availability in EU regions
8283

8384
## Development Setup

docs/alb-hosting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ ALB hosting is designed for organizations that need the full IDP web UI but cann
2222
- **Corporate network restrictions** — organizations where users access applications exclusively through VPN or Direct Connect, and public CDN endpoints are blocked by policy
2323
- **Air-gapped or isolated VPCs** — environments with no internet egress where CloudFront cannot function
2424

25-
> **Note on GovCloud**: GovCloud deployments use a separate headless template (no web UI or AppSync). ALB hosting is not applicable to GovCloud — see [GovCloud Deployment](./govcloud-deployment.md) instead.
25+
> **Note on Headless / GovCloud**: ALB hosting keeps the **full Web UI** but serves it privately through an ALB. It is **not** the same as a [Headless Deployment](./headless-deployment.md), which removes the UI entirely (along with AppSync, Cognito, WAF). GovCloud always uses headless mode (UI-layer services are unavailable in GovCloud) — see [GovCloud Deployment](./govcloud-deployment.md). Use ALB hosting only when you **do** want the UI but cannot use CloudFront.
2626
2727
## Architecture
2828

docs/deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ idp-cli publish --source-dir . --region <region> [--bucket-basename <bucket>] [-
191191
- `--verbose` or `-v`: (Optional) Enable detailed error output for debugging build failures
192192
- `--clean-build`: (Optional) Force a clean rebuild of all artifacts
193193
- `--max-workers N`: (Optional) Number of parallel build workers
194-
- `--headless`: (Optional) Also generate a headless (no-UI) template variant for GovCloud
194+
- `--headless`: (Optional) Also generate a **headless (no-UI) template variant**. Useful for API-only / pipeline integrations in Commercial regions and **required** for GovCloud deployments. See [Headless Deployment](./headless-deployment.md).
195195

196196
**Example:**
197197

0 commit comments

Comments
 (0)