You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/deployment.md
+93-16Lines changed: 93 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ This guide covers how to deploy, build, publish, and test the GenAI Intelligent
16
16
17
17
### One-Click Deployment
18
18
19
-
| US East (N.Virginia) | us-east-1|[](https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3.us-east-1.amazonaws.com/aws-ml-blog-us-east-1/artifacts/genai-idp/idp-main.yaml&stackName=IDP)|
19
+
| US East (N.Virginia) | us-east-1 |[](https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3.us-east-1.amazonaws.com/aws-ml-blog-us-east-1/artifacts/genai-idp/idp-main.yaml&stackName=IDP)|
20
20
21
21
3. Review the template parameters and provide values as needed
22
22
4. Check the acknowledgment box and click **Create stack**
@@ -39,47 +39,58 @@ You need to have the following packages installed on your computer:
39
39
7.**Node.js 18+** and **npm** (required for UI validation in publish script)
40
40
41
41
For guidance on setting up a development environment, see:
42
-
-[Development Environment Setup Guide on Linux](./setup-development-env-linux.md)
42
+
43
+
-[Development Environment Setup Guide on Linux](./setup-development-env-linux.md)
43
44
-[Development Environment Setup Guide on macOS](./setup-development-env-macos.md)
44
45
-[Development Environment Setup Guide on Windows (WSL)](./setup-development-env-WSL.md)
45
46
46
47
Copy the repo to your computer. Either:
48
+
47
49
- Use the git command to clone the repo, if you have access
48
50
- OR, download and expand the ZIP file for the repo, or use the ZIP file that has been shared with you
49
51
50
52
### Build and Publish the Solution
51
53
52
54
To build and publish your own template to your own S3 bucket:
53
55
54
-
*`cfn_bucket_basename`: A prefix added to the beginning of the bucket name (e.g. `idp-1234567890` to ensure global uniqueness)
55
-
*`cfn_prefix`: A prefix added to CloudFormation resources (e.g. `idp` or `idp-dev`)
56
+
-`cfn_bucket_basename`: A prefix added to the beginning of the bucket name (e.g. `idp-1234567890` to ensure global uniqueness)
57
+
-`cfn_prefix`: A prefix added to CloudFormation resources (e.g. `idp` or `idp-dev`)
-`cfn_bucket_basename`: A prefix for the S3 bucket name (e.g., `idp-1234567890`)
67
70
-`cfn_prefix`: S3 prefix for artifacts (e.g., `idp`)
68
71
-`region`: AWS region for deployment (e.g., `us-east-1`)
69
72
-`--verbose` or `-v`: (Optional) Enable detailed error output for debugging build failures
73
+
- Pattern-2 functions are built and deployed as container images automatically. Pattern-1 and Pattern-3 use ZIP-based Lambdas.
74
+
75
+
**Standard ZIP Deployment:**
70
76
71
-
Example:
72
77
```bash
73
78
python3 publish.py idp-1234567890 idp us-east-1
74
79
```
75
80
81
+
Note: Pattern-2 container images are built and pushed automatically when Pattern-2 changes are detected. Ensure Docker is running and you have ECR permissions.
82
+
83
+
> **Note**: Container-based deployment is recommended when Lambda functions exceed the 250MB unzipped size limit. This allows deployment packages up to 10GB.
84
+
76
85
**Troubleshooting Build Issues:**
77
86
If the build fails, use the `--verbose` flag to see detailed error messages:
- Check your system dependencies for required packages
101
114
- Create CloudFormation templates and asset zip files
102
115
- Publish the templates and required assets to an S3 bucket in your account
103
116
- The bucket will be named `<cfn_bucket_basename>-<region>` (created if it doesn't exist)
104
117
105
118
When completed, the script displays:
119
+
106
120
- The CloudFormation template's S3 URL
107
121
- A 1-click URL for launching the stack creation in the CloudFormation console
108
122
109
123
### Deployment Options
110
124
111
125
#### Recommended: Deploy using AWS CloudFormation console
126
+
112
127
For your first deployment, use the `1-Click Launch URL` provided by the publish script. This lets you inspect the available parameter options in the console.
113
128
114
129
#### CLI Deployment
130
+
115
131
For scripted/automated deployments, use the AWS CLI:
116
132
117
133
```bash
@@ -126,27 +142,84 @@ aws cloudformation deploy \
126
142
```
127
143
128
144
Or to update an already-deployed stack:
145
+
129
146
```bash
130
147
aws cloudformation update-stack \
131
148
--stack-name <your-stack-name> \
132
149
--template-url <template URL output by publish script, e.g. https://s3.us-east-1.amazonaws.com/blahblah.yaml> \
0 commit comments