langgenius/aws-cdk-for-dify
1
0
Fork 0
mirror of https://github.com/langgenius/aws-cdk-for-dify.git synced 2026-07-01 20:14:06 -04:00
Code Issues 4 Packages Projects Releases Wiki Activity

update README and add a prefix to identify the different environments in the same region. (#11)

Browse Source 
* add a random value into resource name prefix

In some scenarios, such as when cdk creates multiple environments in the same region, naming conflicts can occur.

* Update README.md

add more details and claims the production setup process

* Update README.md

fix link to private repo

---------

Co-authored-by: Xiyuan Chen <52963600+GareArc@users.noreply.github.com>
This commit is contained in:
Petrus Han
2024-10-21 12:33:55 +08:00
committed by GitHub
parent a8aadf411c
commit 4c35df4059
3 changed files with 257 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+248 -27
View File
@@ -4,7 +4,7 @@ Deploy Dify Enterprise on AWS using CDK.
![1719058485616](images/README/infra.jpg)
## Components
# Components
### Testing Deployment
@@ -26,9 +26,13 @@ Deploy Dify Enterprise on AWS using CDK.
| K8S Worker Node | | 6 | 8 | 32 | 100 | |
| OpenSearch | vectorDB | 2 | 8 | 64 | 100 | |
## Deployment
1. **Configure AWS CLI:**
# Deployment
> The whole process is expected to take 60 mins
1. ### Configure AWS CLI:
Install and configure the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html):
@@ -36,19 +40,19 @@ Deploy Dify Enterprise on AWS using CDK.
aws configure
```
2. **Clone this repository:**
2. ### Clone this repository:
```bash
git clone https://github.com/langgenius/aws-cdk-for-dify.git
```
3. **Install NodeJS Dependencies:**
3. ### Install NodeJS Dependencies:
```bash
npm install
```
4. **Configure environment variables:**
4. ### Configure environment variables:
```bash
cp .env.example .env
@@ -57,23 +61,42 @@ Deploy Dify Enterprise on AWS using CDK.
Modify the environment variable values in the `.env` file.
- `ENVIRONMENT`: Specifies the deployment environment; must be either `test` or `prod`.
- `CDK_DEFAULT_REGION`: The AWS region where Dify Enterprise will be deployed.
- `CDK_DEFAULT_ACCOUNT`: Your AWS account ID.
- `DEPLOY_VPC_ID`: The ID of an existing VPC for deployment. If not set, CDK will create one for you.
- Subnets Configuration (`DEPLOY_VPC_ID` required, comma-separated without spaces):
- **Note:** **If using an existing VPC**
- Make sure you have 2 or more **public** subnets for Application Load Balancer, and 2 or more **private** subnets can access internet(associated with NAT) to pull docker image from internet.
- Add **Tag** for the subnets(**Otherwise**, Step 6 will show WARN about auto-tag failed, which will result in the Application Load Balancer failing to be created successfully.):
| Subnet Type | Tag key | tag value |
| ----------- | ------------------------------- | --------- |
| public | kubernetes.io/role/elb | 1 |
| private | kubernetes.io/role/internal-elb | 1 |
- Subnets Configuration (`DEPLOY_VPC_ID` required, comma-separated without spaces, **private subnets** is recommended by AWS security best practices):
- `EKS_CLUSTER_SUBNETS`: Subnet IDs for the EKS control plane. Requires at least 2 subnets in different Availability Zones (AZs).
- `EKS_NODES_SUBNETS`: Subnet IDs for the EKS worker nodes. Requires at least 2 subnets in different AZs.
- `REDIS_SUBNETS`: Subnet IDs for Redis deployment.
- `RDS_SUBNETS`: subnet ids for RDS database. (At least 2 with different AZs)
- `OPENSEARCH_SUBNETS`: Subnet IDs for OpenSearch deployment.
- `AWS_EKS_CHART_REPO_URL`: (For AWS China regions ONLY) The AWS EKS Helm chart repository URL.
- `RDS_PUBLIC_ACCESSIBLE`: Set to `true` to make RDS publicly accessible (NOT RECOMMENDED).
**Note:**
- If you are using AWS China regions, you must configure the `AWS_EKS_CHART_REPO_URL` for proper functionality. Please contact Dify Team for the URL.
- It is recommended to use an existing VPC for easier resource access.
5. **CDK Bootstrap:**
5. ### CDK Bootstrap:
Initialize the CDK environment:
@@ -81,39 +104,159 @@ Deploy Dify Enterprise on AWS using CDK.
npm run init
```
6. **CDK Deploy:**
6. ### CDK Deploy:
- Deploy Dify Enterprise:
```bash
npm run deploy
```
7. **Update AWS EKS Access Permissions:**
7. ### Update AWS EKS Access Permissions:
1. Navigate to the EKS Cluster panel, select the "Access" menu, and click on "Manage access":
![Dify-Testing-DifyStackTest-EKS](images/README/eks-access-panel.png)
![Dify-Testing-DifyStackTest-EKS](images/README/eks-access-panel.png)
2. In the "Manage access" dialog, select "EKS API and ConfigMap," then click "Save Changes."
3. In the IAM Access Entries panel, click "Create access entry":
![IAM access entries](images/README/eks-iam-access.png)
![IAM access entries](images/README/eks-iam-access.png)
4. Add your IAM user and assign the following permissions:
- `AmazonEKSAdminPolicy`
- `AmazonEKSAdminViewPolicy`
- `AmazonEKSClusterAdminPolicy`
- `AmazonEKSAdminPolicy`
- `AmazonEKSAdminViewPolicy`
- `AmazonEKSClusterAdminPolicy`
8. **Configure `kubeconfig` to access the Kubernetes (K8S) cluster locally:**
8. ### Configure `kubeconfig` to access the Kubernetes (K8S) cluster locally:
```bash
aws eks update-kubeconfig --region <cn-northwest-1> --name <Dify-Testing-DifyStackTest-EKS>
```
Adjust the `region` and `name` parameters according to your deployment:
- **region:** The AWS region where your cluster is deployed.
- **name:** The EKS cluster name (`Dify-Testing-DifyStackTest-EKS` or `Dify-Production-DifyStackProd-EKS`).
9. **AWS Load Balancer Configuration**
9. ### Data Persistence Configure:
Change the Helm `values.yaml` file. To enable it, modify the `persistence` section as follows, replace {your-region-name} and {your-s3-bucket-name} with the name of resource created by CDK, make sure you have turn `useAwsManagedIam` on:
```yaml
persistence:
type: "s3"
s3:
endpoint: "https://s3.{your-region-name}.amazonaws.com"
region: "{your-region-name}"
bucketName: "{your-s3-bucket-name}"
useAwsManagedIam: true
```
10. ### Database Configure:
Change the Helm `values.yaml` file, **remove** `postgre` section, and modify the `externalPostgres` section as follows, replace {your-postgres-endpoint} and {your-postgres-password} with data stored in the **Secret Manager** of AWS:
```yaml
postgre:
enabled: false
externalPostgres:
enabled: true
address: "{your-postgres-endpoint}"
port: 5432
credentials:
dify:
database: "postgres"
username: "clusteradmin"
password: "{your-postgres-password}"
sslmode: "disable"
enterprise:
database: "postgres"
username: "clusteradmin"
password: "{your-postgres-password}"
sslmode: "disable"
```
11. ### Redis Configure:
Change the Helm `values.yaml` file, **remove** `redis` section, and modify the `externalRedis` section as follows, replace {your-redis-host} with `Primary endpoint` in console of **ElastiCache-Redis OSS caches**
**Note:** **remove** the port number of the `Primary endpoint`
```yaml
redis:
enabled: false
externalRedis:
enabled: true
host: "{your-redis-host}"
port: 6379
username: ""
password: ""
useSSL: false
```
12. ### VectorDatabase Configure:
Change the Helm `values.yaml` file, modify the `externalType` section as follows, replace `{openSearch_endpont}` with aws Opensearch instant's **Domain endpoint**, remove `https://` and use the left:
```yaml
vectorDB:
useExternal: true
externalType: "opensearch"
externalOpenSearch:
host: "{openSearch_endpont}"
port: 9200
user: ""
password: ""
useTLS: false
```
13. ### Set docker image pull secret
You need to set the docker image pull secret before installing Dify Enterprise.
**Note:** If you haven't got the username and password, please contact us, email address:[Support@dify.ai](support@dify.ai)
15. ### TLS
#### For testing:
If you are just testing the deploy process, you can just ignore this step and go on.
#### For production:
Go to AWS `ACM` to require the certificates of the domain you declared in helm chart configuration file `values.yaml`:
```yaml
consoleApiDomain: "console.xxxx.com"
consoleWebDomain: "console.xxxx.com"
serviceApiDomain: "api.xxxx.com"
appApiDomain: "app.xxxx.com"
appWebDomain: "app.xxxx.com"
filesDomain: "upload.xxxx.com"
enterpriseDomain: "enterprise.xxxx.com"
```
they are:
```yaml
console.xxxx.com
api.xxxx.com
app.xxxx.com
upload.xxxx.com
enterprise.xxxx.com
```
go to your domain service provider (e.g. cloud flare, aws route53, etc.) and setup the `cname` to prove your ownership of these domains.
**change the values.yaml param: global.useTLS**
```
useTLS: true
```
16. ### AWS Load Balancer Configuration
It is recommended to use an AWS Application Load Balancer (ALB) for your ingress configuration in the Helm `values.yaml` file. To enable it, modify the `ingress` section as follows:
**For testing:**
```yaml
ingress:
enabled: true
@@ -127,18 +270,96 @@ Deploy Dify Enterprise on AWS using CDK.
}
```
10. **Initialize Postgres Databases**
**For production:**
Before installing Helm charts, you need to create the necessary databases in your RDS instance. These database names should correspond to the values specified in the `externalPostgres` field of the Helm `values.yaml` file.
refer to: [AWS load balancer controller setup](https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.9/guide/ingress/cert_discovery/)
11. **CDK Destroy:**
Destroy the deployment for the environment specified in the `.env` file under `ENVIRONMENT`.
```bash
npm run destroy
```yaml
ingress:
enabled: true
className: "alb"
annotations: {
# set file upload size limit
alb.ingress.kubernetes.io/target-type: "ip",
alb.ingress.kubernetes.io/scheme: "internet-facing",
alb.ingress.kubernetes.io/listen-ports: '[{"HTTPS":443}]'
}
```
12. **Advanced Configuration**
17. ### Install Dify Enterprise
To customize deployment configurations, modify the [test.ts](./configs/test.ts) file for the testing environment or the [prod.ts](./configs/prod.ts) file for the production environment.
Dify Enterprise is deployed using Helm.
```bash
helm repo add dify https://langgenius.github.io/dify-helm
helm repo update
helm upgrade -i dify -f values.yaml dify/dify
```
18. ### Access Dify Enterprise
#### For testing:
After setting up, get the temperally external IP of the ALB.
```bash
ping {aws_alb_dns}
```
Then add the following line to your `/etc/hosts` file.
```bash
4.152.1.216 console.dify.local
4.152.1.216 app.dify.local
4.152.1.216 api.dify.local
4.152.1.216 upload.dify.local
4.152.1.216 enterprise.dify.local
```
#### For production
Go to your Domain service provider, and set up DNS to the ALB address(Go to AWS-EC2-Load Balancer to get the dns of alb):
| domain | cname |
| ------------------- | --------- |
| api.xxxx.com | <alb_dns> |
| app.xxxx.com | <alb_dns> |
| upload.xxxx.com | <alb_dns> |
| enterprise.xxxx.com | <alb_dns> |
| console.xxxx.com | <alb_dns> |
19. ### Verify Installation
**Warning**: You have to set up Dify Console `http://console.dify.local` first before login to Dify Enterprise Dashboard `http://enterprise.dify.local`.
- Dify Console: visit `http://console.dify.local` and finish the installation.
- Enterprise Dashboard: visit `http://enterprise.dify.local`, and login with the default email and password. You can change the password after login.
```
email: dashboard@dify.ai
password: difyai123456
```
# Destroy
> The process may take 20 mins.
Destroy the deployment for the environment specified in the `.env` file under `ENVIRONMENT`.
```bash
npm run destroy
```
**Note**: login to AWS console, review the VPC, and make sure the VPC created by CDK has destroyed, if not, please Check `Cloudformation` and perform the deletion operation.
# Advanced Configuration
### Advanced Configuration
To customize deployment configurations, modify the [test.ts](./configs/test.ts) file for the testing environment or the [prod.ts](./configs/prod.ts) file for the production environment.
configs/constants.ts
+4
View File
@@ -3,6 +3,10 @@ export const AWS_EKS_CHART_REPO_URL = process.env.AWS_EKS_CHART_REPO_URL || 'htt
export const DESTROY_WHEN_REMOVE = process.env.GLOBAL_REMOVE_WHEN_DESTROYED === 'true' || false;
export const PRODUCT_NAME = 'Dify';
// Generate a 6-character random string consisting of numbers and letters
export const AWS_RESOURCE_SUFFIX = Math.random().toString(36).slice(2, 8).toUpperCase();
/**
* Instance map for the EC2 instances
* See https://aws.amazon.com/ec2/instance-types for more information
configs/index.ts
+5 -2
View File
@@ -1,4 +1,4 @@
import { PRODUCT_NAME } from "./constants";
import { PRODUCT_NAME, AWS_RESOURCE_SUFFIX } from "./constants";
import { prodConfig, ProdStackConfig } from "./prod";
import { StackConfig } from "./stackConfig";
import { testConfig, TestStackConfig } from "./test";
@@ -14,5 +14,8 @@ export const config: DifyCDKConfig = {
}
export const getConstructPrefix = (config: StackConfig) => {
return `${PRODUCT_NAME}-${config.environment}`;
// Generate a 6-character random string consisting of numbers and letters
const randomSuffix = Math.random().toString(36).slice(2, 8).toUpperCase();
return `${PRODUCT_NAME}-${config.environment}-${AWS_RESOURCE_SUFFIX}`;
}