diff --git a/README.md b/README.md index cbee131..ca7ed5e 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ This is a solution for deploying [Keycloak](https://www.keycloak.org/) to AWS wi ## Quick start -* [Implementatio Guide](https://aws-samples.github.io/keycloak-on-aws/en/implementation-guide/deployment/) +* [Implementation Guide](https://aws-samples.github.io/keycloak-on-aws/en/implementation-guide/deployment/) ## License diff --git a/docs/en/implementation-guide/considerations.md b/docs/en/implementation-guide/considerations.md index aac96e5..d79a5e5 100644 --- a/docs/en/implementation-guide/considerations.md +++ b/docs/en/implementation-guide/considerations.md @@ -2,38 +2,51 @@ ## Regional deployments This solution uses services which may not be currently available in all AWS Regions. Launch this solution in an AWS Region where required services are available. For the most current availability by Region, refer to the [AWS Regional Services List][services]. -Because the solution has Amazon Aurora MySQL-Compatible and Amazon Aurora Serverless MySQL-Compatible to choose from, when deploying with CloudFormation, you need to check whether the region supports Amazon Aurora Serverless MySQL-Compatible or Amazon Aurora MySQL-Compatible. - -**Supported regions for deployment in AWS Global Regions** - -| Region ID | Region Name | Amazon Aurora MySQL-Compatible | Amazon Aurora Serverless MySQL-Compatible | -| -------------- | ------------------------ | :------------: | :----------------------: | -| us-east-1 | US East (N. Virginia) | ✔ | ✔ | -| us-east-2 | US East (Ohio) | ✔ | ✔ | -| us-west-1 | US West (N. California) | ✔ | ✔ | -| us-west-2 | US West (Oregon) | ✔ | ✔ | -| af-south-1 | Asia (Cape Town) | ✔ | - | -| ap-south-1 | Asia Pacific (Mumbai) | ✔ | ✔ | -| ap-northeast-3 | Asia Pacific (Osaka) | ✔ | - | -| ap-northeast-2 | Asia Pacific (Seoul) | ✔ | ✔ | -| ap-southeast-1 | Asia Pacific (Singapore) | ✔ | ✔ | -| ap-southeast-2 | Asia Pacific (Sydney) | ✔ | ✔ | -| ap-northeast-1 | Asia Pacific (Tokyo) | ✔ | ✔ | -| ca-central-1 | Canada (Central) | ✔ | ✔ | -| eu-central-1 | Europe (Frankfurt) | ✔ | ✔ | -| eu-west-1 | Europe (Ireland) | ✔ | ✔ | -| eu-west-2 | Europe (London) | ✔ | ✔ | -| eu-west-3 | Europe (Paris) | ✔ | ✔ | -| eu-north-1 | Europe (Stockholm) | ✔ | - | -| sa-east-1 | South America (Sao Paulo)| ✔ | - | - - -**Supported regions for deployment in AWS China Regions** - -| Region ID | Region Name | Amazon Aurora MySQL-Compatible | Amazon Aurora Serverless MySQL-Compatible | -| -------------- | ----------------------------------------- | :------------: | :----------------------: | -| cn-north-1 | China (Beijing) Region Operated by Sinnet | ✔ | - | -| cn-northwest-1 | China (Ningxia) Region Operated by NWCD | ✔ | ✔ | +Because the solution has Amazon Aurora MySQL-Compatible, Amazon Aurora Serverless v1 MySQL-Compatible and Amazon Aurora Serverless v2 MySQL-Compatible to choose from, when deploying with CloudFormation, you need to check whether the region supports your choice. + +For Aurora Serverless deployments, Aurora Serverless v2 MySQL-Compatible is provided by default in the CloudFormation templates. Aurora Serverless v2 scales more quickly and in a more granular way and also has more compatibility with other Aurora features such as reader DB instances. For more information, see [Comparison of Aurora Serverless v2 and Aurora Serverless v1 requirements][comparisons]. + +**Supported regions for database deployment in AWS Global Regions** + +| Region ID | Region Name | Amazon Aurora MySQL-Compatible | Amazon Aurora Serverless v1 MySQL-Compatible |Amazon Aurora Serverless v2 MySQL-Compatible | +| -------------- | ------------------------ | :------------: | :----------------------: | :----------------------: | +| us-east-1 | US East (N. Virginia) | ✔ | ✔ | ✔ | +| us-east-2 | US East (Ohio) | ✔ | ✔ | ✔ | +| us-west-1 | US West (N. California) | ✔ | ✔ | ✔ | +| us-west-2 | US West (Oregon) | ✔ | ✔ | ✔ | +| af-south-1 | Africa (Cape Town) | ✔ | | ✔ | +| ap-east-1 | Asia Pacific (Hongkong) | ✔ | | ✔ | +| ap-south-2 | Asia Pacific (Hyderabad) | ✔ | | ✔ | +| ap-southeast-3 | Asia Pacific (Jakarta) | ✔ | | ✔ | +| ap-southeast-4 | Asia Pacific (Melbourne) | ✔ | | ✔ | +| ap-south-1 | Asia Pacific (Mumbai) | ✔ | ✔ | ✔ | +| ap-northeast-3 | Asia Pacific (Osaka) | ✔ | | ✔ | +| ap-northeast-2 | Asia Pacific (Seoul) | ✔ | ✔ | ✔ | +| ap-southeast-1 | Asia Pacific (Singapore) | ✔ | ✔ | ✔ | +| ap-southeast-2 | Asia Pacific (Sydney) | ✔ | ✔ | ✔ | +| ap-northeast-1 | Asia Pacific (Tokyo) | ✔ | ✔ | ✔ | +| ca-central-1 | Canada (Central) | ✔ | ✔ | ✔ | +| eu-central-1 | Europe (Frankfurt) | ✔ | ✔ | ✔ | +| eu-west-1 | Europe (Ireland) | ✔ | ✔ | ✔ | +| eu-west-2 | Europe (London) | ✔ | ✔ | ✔ | +| eu-south-1 | Europe (Milan) | ✔ | | ✔ | +| eu-west-3 | Europe (Paris) | ✔ | ✔ | ✔ | +| eu-south-2 | Europe (Spain) | ✔ | | ✔ | +| eu-north-1 | Europe (Stockholm) | ✔ | | ✔ | +| eu-central-2 | Europe (Zurich) | ✔ | | ✔ | +| il-central-1 | Israel (Tel Aviv) | ✔ | | ✔ | +| me-south-1 | Middle East (Bahrain) | ✔ | | ✔ | +| me-central-1 | Middle East (UAE) | ✔ | | ✔ | +| sa-east-1 | South America (Sao Paulo)| ✔ | | ✔ | + + +**Supported regions for database deployment in AWS China Regions** + +| Region ID | Region Name | Amazon Aurora MySQL-Compatible | Amazon Aurora Serverless v1 MySQL-Compatible |Amazon Aurora Serverless v2 MySQL-Compatible | +| -------------- | ----------------------------------------- | :------------: | :----------------------: | :----------------------: | +| cn-north-1 | China (Beijing) Region Operated by Sinnet | ✔ | | ✔ | +| cn-northwest-1 | China (Ningxia) Region Operated by NWCD | ✔ | ✔ | ✔ | [services]: https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/?nc1=h_ls +[comparisons]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.upgrade.html#Serverless.v1-v2-requirements \ No newline at end of file diff --git a/docs/en/implementation-guide/deployment.md b/docs/en/implementation-guide/deployment.md index dce2cbd..2988eac 100644 --- a/docs/en/implementation-guide/deployment.md +++ b/docs/en/implementation-guide/deployment.md @@ -6,7 +6,7 @@ Before you launch the solution, review the architecture, supported regions, and Make sure you have the following in the target region you want to deploy the solution: -- the domain name has been recorded by ICP and used to apply for ACM certificate. +- for deployments in China region, the domain name has been recorded by ICP and used to apply for ACM certificate. - the certificate of the domain name is created in ACM and verified by the domain name. - VPC with 4 subnets (including two public subnets and two private subnets) and NAT Gateway. - all the AWS Services listed in [required AWS Services](./additional-resources.md) are available. @@ -82,6 +82,9 @@ Add a CNAME record to Route 53 to authenticate that the domain name is owned and You have 4 different options to launch the stack. +For Aurora Serverless deployments, Aurora Serverless v2 MySQL-Compatible is provided by default in the CloudFormation templates. For more information, see [Comparison of Aurora Serverless v2 and Aurora Serverless v1 requirements][comparisons]. + + | Option | VPC | Database | Quick Launch | Template Link | | :--- | --- | ----- | :--------: | :-----: | | Option 1: Deploy Keycloak based on Aurora Serverless MySQL-Compatible from an existing VPC | Existing | Aurora Serverless MySQL-Compatible | [Global][Keycloak aurora serveless from existing VPC for Global]
[China][Keycloak aurora serveless from existing VPC for China] | [Download][Keycloak aurora serverless from existing VPC template] | @@ -107,14 +110,17 @@ You have 4 different options to launch the stack. 6. On the **Step 2 Specify stack details** section, do the following: 1. **Stack name**: A stack name, such as *KeycloakOnAWS*. 2. **CertificateArn**: Enter the **ARN** recorded in [Step 1. Create ACM certificate](#step-1-create-acm-certificate), such as *arn:aws:acm:us-west-2:1436237113227:certificate/571518b3-123b-4502-1ec3-3t2sae704272*. - 3. **VpcId**: Select from existing VPCs. - 4. **PubSubnets**: Select public subnets for ALB deployment. - 5. **PrivSubnets**: Select the private subnet for the ECS Task. - 6. **DBSubnets**: Select the private subnet for the database. - 7. **MinContainers**: Customize the minimum number of containers for the ECS, with a minimum value of 2. - 8. **MaxContainers**: Customize the maximum number of containers for the ECS, with a maximum value of 10. - 9. **AutoScalingTargetCpuUtilization**: The percentage of resource utilization that is ensured to be no higher, maximum 100. - 10. **JavaOpts**: JAVA_OPTS environment variable. + 3. **Hostname**: Enter domain name for your Keycloak server. + 4. **VpcId**: Select from existing VPCs. + 5. **PubSubnets**: Select public subnets for ALB deployment. + 6. **PrivSubnets**: Select the private subnet for the ECS Task. + 7. **DBSubnets**: Select the private subnet for the database. + 8. **TaskCPU**: Specify the CPU for the Fargate Task running your keycloak application. The default value is 4096 (4 vCPU). See [Task CPU and memory][task cpu and memory] for details. + 9. **TaskMemory**: Specify the Memory for the Fargate Task running your keycloak application. The default value is 8192 MiB (8 GB). Please note that this value must be within the range allowed by the TaskCPU you select. See [Task CPU and memory][task cpu and memory] for details. + 8. **MinContainers**: Customize the minimum number of containers for the ECS, with a minimum value of 2. + 9. **MaxContainers**: Customize the maximum number of containers for the ECS, with a maximum value of 10. + 10. **AutoScalingTargetCpuUtilization**: The percentage of resource utilization that is ensured to be no higher, maximum 100. + 11. **JavaOpts**: JAVA_OPTS environment variable. 7. Choose **Next**. @@ -144,10 +150,13 @@ You have 4 different options to launch the stack. 6. On the **Step 2 Specify stack details** section, do the following: 1. **Stack name**: A stack name, such as *KeycloakOnAWS*. 2. **CertificateArn**: Enter the **ARN** recorded in [Step 1. Create ACM certificate](#step-1-create-acm-certificate), such as *arn:aws:acm:us-west-2:1436237113227:certificate/571518b3-123b-4502-1ec3-3t2sae704272*. - 3. **MinContainers**: Customize the minimum number of containers for the ECS, with a minimum value of 2. - 4. **MaxContainers**: Customize the maximum number of containers for the ECS, with a maximum value of 10. - 5. **AutoScalingTargetCpuUtilization**: The percentage of resource utilization that is ensured to be no higher, maximum 100. - 6. **JavaOpts**: JAVA_OPTS environment variable. + 3. **Hostname**: Enter domain name for your Keycloak server. + 4. **TaskCPU**: Specify the CPU for the Fargate Task running your keycloak application. The default value is 4096 (4 vCPU). See [Task CPU and memory][task cpu and memory] for details. + 5. **TaskMemory**: Specify the Memory for the Fargate Task running your keycloak application. The default value is 8192 MiB (8 GB). Please note that this value must be within the range allowed by the TaskCPU you select. See [Task CPU and memory][task cpu and memory] for details. + 6. **MinContainers**: Customize the minimum number of containers for the ECS, with a minimum value of 2. + 7. **MaxContainers**: Customize the maximum number of containers for the ECS, with a maximum value of 10. + 8. **AutoScalingTargetCpuUtilization**: The percentage of resource utilization that is ensured to be no higher, maximum 100. + 9. **JavaOpts**: JAVA_OPTS environment variable. 7. Choose **Next**. @@ -177,15 +186,18 @@ You have 4 different options to launch the stack. 6. On the **Step 2 Specify stack details** section, do the following: 1. **Stack name**: A stack name, such as *KeycloakOnAWS*. 2. **CertificateArn**: Enter the **ARN** recorded in [Step 1. Create ACM certificate](#step-1-create-acm-certificate), such as *arn:aws:acm:us-west-2:1436237113227:certificate/571518b3-123b-4502-1ec3-3t2sae704272*. - 3. **DatabaseInstanceType**: Select the RDS instance type. - 4. **VpcId**: Select from existing VPCs. - 5. **PubSubnets**: Select public subnets for ALB deployment. - 6. **PrivSubnets**: Select the private subnet for the ECS Task. - 7. **DBSubnets**: Select the private subnet for the RDS database. - 8. **MinContainers**: Customize the minimum number of containers for the ECS, with a minimum value of 2. - 9. **MaxContainers**: Customize the maximum number of containers for the ECS, with a maximum value of 10. - 10. **AutoScalingTargetCpuUtilization**: The percentage of resource utilization that is ensured to be no higher, maximum 100. - 11. **JavaOpts**: JAVA_OPTS environment variable. + 3. **Hostname**: Enter domain name for your Keycloak server. + 4. **DatabaseInstanceType**: Select the RDS instance type. + 5. **VpcId**: Select from existing VPCs. + 6. **PubSubnets**: Select public subnets for ALB deployment. + 7. **PrivSubnets**: Select the private subnet for the ECS Task. + 8. **DBSubnets**: Select the private subnet for the RDS database. + 9. **TaskCPU**: Specify the CPU for the Fargate Task running your keycloak application. The default value is 4096 (4 vCPU). See [Task CPU and memory][task cpu and memory] for details. + 10. **TaskMemory**: Specify the Memory for the Fargate Task running your keycloak application. The default value is 8192 MiB (8 GB). Please note that this value must be within the range allowed by the TaskCPU you select. See [Task CPU and memory][task cpu and memory] for details. + 11. **MinContainers**: Customize the minimum number of containers for the ECS, with a minimum value of 2. + 10. **MaxContainers**: Customize the m2ximum number of containers for the ECS, with a maximum value of 10. + 13. **AutoScalingTargetCpuUtilization**: The percentage of resource utilization that is ensured to be no higher, maximum 100. + 14. **JavaOpts**: JAVA_OPTS environment variable. 7. Choose **Next**. @@ -215,11 +227,14 @@ You have 4 different options to launch the stack. 6. On the **Step 2 Specify stack details** section, do the following: 1. **Stack name**: A stack name, such as *KeycloakOnAWS*. 2. **CertificateArn**: Enter the **ARN** recorded in [Step 1. Create ACM certificate](#step-1-create-acm-certificate), such as *arn:aws:acm:us-west-2:1436237113227:certificate/571518b3-123b-4502-1ec3-3t2sae704272`*. - 3. **DatabaseInstanceType**: Select the RDS instance type. - 4. **MinContainers**: Customize the minimum number of containers for the ECS, with a minimum value of 2. - 5. **MaxContainers**: Customize the maximum number of containers for the ECS, with a maximum value of 10. - 6. **AutoScalingTargetCpuUtilization**: The percentage of resource utilization that is ensured to be no higher, maximum 100. - 7. **JavaOpts**: JAVA_OPTS environment variable. + 3. **Hostname**: Enter domain name for your Keycloak server. + 4. **DatabaseInstanceType**: Select the RDS instance type. + 5. **TaskCPU**: Specify the CPU for the Fargate Task running your keycloak application. The default value is 4096 (4 vCPU). See [Task CPU and memory][task cpu and memory] for details. + 6. **TaskMemory**: Specify the Memory for the Fargate Task running your keycloak application. The default value is 8192 MiB (8 GB). Please note that this value must be within the range allowed by the TaskCPU you select. See [Task CPU and memory][task cpu and memory] for details. + 7. **MinContainers**: Customize the minimum number of containers for the ECS, with a minimum value of 2. + 8. **MaxContainers**: Customize the maximum number of containers for the ECS, with a maximum value of 10. + 9. **AutoScalingTargetCpuUtilization**: The percentage of resource utilization that is ensured to be no higher, maximum 100. + 10. **JavaOpts**: JAVA_OPTS environment variable. 7. Choose **Next**. @@ -305,4 +320,5 @@ You have 4 different options to launch the stack. [Keycloak aurora serverless from new VPC template]: https://aws-gcr-solutions.s3.cn-north-1.amazonaws.com.cn/keycloakonaws/latest/keycloak-aurora-serverless-from-new-vpc.template [Keycloak from existing VPC template]: https://aws-gcr-solutions.s3.cn-north-1.amazonaws.com.cn/keycloakonaws/latest/keycloak-from-existing-vpc.template [Keycloak from new VPC template]: https://aws-gcr-solutions.s3.cn-north-1.amazonaws.com.cn/keycloakonaws/latest/keycloak-from-new-vpc.template - +[comparisons]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.upgrade.html#Serverless.v1-v2-requirements +[task cpu and memory]: https://docs.aws.amazon.com/zh_cn/AmazonECS/latest/userguide/fargate-task-defs.html#fargate-tasks-size \ No newline at end of file diff --git a/docs/en/implementation-guide/revisions.md b/docs/en/implementation-guide/revisions.md index 3142ef8..6d65d57 100755 --- a/docs/en/implementation-guide/revisions.md +++ b/docs/en/implementation-guide/revisions.md @@ -2,5 +2,5 @@ | Date | Description | | ------------ | :------------------------------ | -| July 2022 | Release 2.1.0
1. Upgrade Keycloak to version 16.1.1
2. Upgrade aws-cdk to version 1.160.0
3. Upgrade cdk-keycloak to version 0.2.41 | +| Oct 2023 | Release 2.1.6
1. Upgrade Keycloak to version 22.0.4
2. Upgrade aws-cdk to version 2.100.0
3. Upgrade cdk-keycloak to version 2.9.0 | diff --git a/docs/zh/implementation-guide/considerations.md b/docs/zh/implementation-guide/considerations.md index 53d389f..e03bac1 100644 --- a/docs/zh/implementation-guide/considerations.md +++ b/docs/zh/implementation-guide/considerations.md @@ -1,38 +1,50 @@ 目前本解决方案使用的服务可能并非在所有亚马逊云科技区域都可用。您需要在提供所需服务的亚马逊云科技区域启动此解决方案。有关最新的区域可用性信息，请参阅 [AWS 区域服务列表][services]。 -因为方案有Amazon Aurora MySQL-Compatible和Amazon Aurora Serverless MySQL-Compatible可供选择，所以使用CloudFormation部署时，需要注意区域是否支持Amazon Aurora MySQL-Compatible或Amazon Aurora Serverless MySQL-Compatible。 +因为方案数据库有Amazon Aurora MySQL-Compatible，Amazon Aurora Serverless v1 MySQL-Compatible和Amazon Aurora Serverless v2 MySQL-Compatible三种选择，所以使用CloudFormation部署时，需要注意区域是否支持您的选择。 -**支持部署的全球区域** +对于 Aurora Serverless 部署，CloudFormation 模板中默认使用 Aurora Serverless v2 MySQL-Compatible。 Aurora Serverless v2 可以更快、更精细地扩展，并且与其他 Aurora 功能（例如 Reader 数据库实例）具有更好的兼容性。 有关更多信息，请参阅[Aurora Serverless v2 和 Aurora Serverless v1 的比较][comparisons]。 -| 区域ID | 区域名称 | Amazon Aurora MySQL-Compatible | Amazon Aurora Serverless MySQL-Compatible | -| -------------- | ------------------------ | :------------: | :----------------------: | -| us-east-1 | US East (N. Virginia) | ✔ | ✔ | -| us-east-2 | US East (Ohio) | ✔ | ✔ | -| us-west-1 | US West (N. California) | ✔ | ✔ | -| us-west-2 | US West (Oregon) | ✔ | ✔ | -| af-south-1 | Asia (Cape Town) | ✔ | - | -| ap-south-1 | Asia Pacific (Mumbai) | ✔ | ✔ | -| ap-northeast-3 | Asia Pacific (Osaka) | ✔ | - | -| ap-northeast-2 | Asia Pacific (Seoul) | ✔ | ✔ | -| ap-southeast-1 | Asia Pacific (Singapore) | ✔ | ✔ | -| ap-southeast-2 | Asia Pacific (Sydney) | ✔ | ✔ | -| ap-northeast-1 | Asia Pacific (Tokyo) | ✔ | ✔ | -| ca-central-1 | Canada (Central) | ✔ | ✔ | -| eu-central-1 | Europe (Frankfurt) | ✔ | ✔ | -| eu-west-1 | Europe (Ireland) | ✔ | ✔ | -| eu-west-2 | Europe (London) | ✔ | ✔ | -| eu-west-3 | Europe (Paris) | ✔ | ✔ | -| eu-north-1 | Europe (Stockholm) | ✔ | - | -| sa-east-1 | South America (Sao Paulo)| ✔ | - | +**支持部署的全球区域** +| 区域ID | 区域名称 | Amazon Aurora MySQL-Compatible | Amazon Aurora Serverless v1 MySQL-Compatible |Amazon Aurora Serverless v2 MySQL-Compatible | +| -------------- | ------------------------ | :------------: | :----------------------: | :----------------------: | +| us-east-1 | US East (N. Virginia) | ✔ | ✔ | ✔ | +| us-east-2 | US East (Ohio) | ✔ | ✔ | ✔ | +| us-west-1 | US West (N. California) | ✔ | ✔ | ✔ | +| us-west-2 | US West (Oregon) | ✔ | ✔ | ✔ | +| af-south-1 | Africa (Cape Town) | ✔ | | ✔ | +| ap-east-1 | Asia Pacific (Hongkong) | ✔ | | ✔ | +| ap-south-2 | Asia Pacific (Hyderabad) | ✔ | | ✔ | +| ap-southeast-3 | Asia Pacific (Jakarta) | ✔ | | ✔ | +| ap-southeast-4 | Asia Pacific (Melbourne) | ✔ | | ✔ | +| ap-south-1 | Asia Pacific (Mumbai) | ✔ | ✔ | ✔ | +| ap-northeast-3 | Asia Pacific (Osaka) | ✔ | | ✔ | +| ap-northeast-2 | Asia Pacific (Seoul) | ✔ | ✔ | ✔ | +| ap-southeast-1 | Asia Pacific (Singapore) | ✔ | ✔ | ✔ | +| ap-southeast-2 | Asia Pacific (Sydney) | ✔ | ✔ | ✔ | +| ap-northeast-1 | Asia Pacific (Tokyo) | ✔ | ✔ | ✔ | +| ca-central-1 | Canada (Central) | ✔ | ✔ | ✔ | +| eu-central-1 | Europe (Frankfurt) | ✔ | ✔ | ✔ | +| eu-west-1 | Europe (Ireland) | ✔ | ✔ | ✔ | +| eu-west-2 | Europe (London) | ✔ | ✔ | ✔ | +| eu-south-1 | Europe (Milan) | ✔ | | ✔ | +| eu-west-3 | Europe (Paris) | ✔ | ✔ | ✔ | +| eu-south-2 | Europe (Spain) | ✔ | | ✔ | +| eu-north-1 | Europe (Stockholm) | ✔ | | ✔ | +| eu-central-2 | Europe (Zurich) | ✔ | | ✔ | +| il-central-1 | Israel (Tel Aviv) | ✔ | | ✔ | +| me-south-1 | Middle East (Bahrain) | ✔ | | ✔ | +| me-central-1 | Middle East (UAE) | ✔ | | ✔ | +| sa-east-1 | South America (Sao Paulo)| ✔ | | ✔ | **支持部署的中国区域** -| 区域ID | 区域名称 | Amazon Aurora MySQL-Compatible | Amazon Aurora Serverless MySQL-Compatible | -| ---------------- | ----------------------------------------- | :------------: | :----------------------: | -| cn-north-1 | China (Beijing) Region Operated by Sinnet | ✔ | - | -| cn-northwest-1 | China (Ningxia) Region Operated by NWCD | ✔ | ✔ | +| 区域ID | 区域名称 | Amazon Aurora MySQL-Compatible | Amazon Aurora Serverless v1 MySQL-Compatible |Amazon Aurora Serverless v2 MySQL-Compatible | +| -------------- | ----------------------------------------- | :------------: | :----------------------: | :----------------------: | +| cn-north-1 | China (Beijing) Region Operated by Sinnet | ✔ | | ✔ | +| cn-northwest-1 | China (Ningxia) Region Operated by NWCD | ✔ | ✔ | ✔ | -[services]: https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/?nc1=h_ls \ No newline at end of file +[services]: https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/?nc1=h_ls +[comparisons]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.upgrade.html#Serverless.v1-v2-requirements \ No newline at end of file diff --git a/docs/zh/implementation-guide/deployment.md b/docs/zh/implementation-guide/deployment.md index 16a09f6..8774530 100644 --- a/docs/zh/implementation-guide/deployment.md +++ b/docs/zh/implementation-guide/deployment.md @@ -7,7 +7,7 @@ 确保您要部署解决方案的目标区域满足以下条件： -- 已有被 ICP 备案对域名并用于申请 ACM 证书。 +- 若部署在中国区，需要已有被 ICP 备案的域名并用于申请 ACM 证书。 - 域名的证书在 ACM 中创建，并通过域名进行验证。 - 具有 4 个子网（包括两个公有子网和两个私有子网）和 NAT 网关的 VPC。 - 在 [AWS 服务](./additional-resources.md) 中所列出的所有AWS服务均可用。 @@ -81,6 +81,8 @@ 为满足不同用户的需求，共有 4 种部署方式供您选择。 +对于 Aurora Serverless 选项，CloudFormation 模板中默认使用 Aurora Serverless v2 MySQL-Compatible。有关更多信息，请参阅[Aurora Serverless v2 和 Aurora Serverless v1 的比较][comparisons]。 + | 选项 | VPC | 数据库 | 快速启动 | 模板链接 | | :--- | --- | ----- | :--------: | :-----: | | 选项一：从现有的 VPC 中部署基于 Aurora Serverless MySQL-Compatible 的 Keycloak | 现有 | Aurora Serverless MySQL-Compatible | [海外区域][Keycloak aurora serveless from existing VPC for Global]
[中国区域][Keycloak aurora serveless from existing VPC for China] | [下载][Keycloak aurora serverless from existing VPC template] | @@ -106,14 +108,17 @@ 6. 在**指定堆栈详细信息**部分执行以下操作： 1. **堆栈名称**: 输入堆栈名称, 例如 *KeycloakOnAWS* 。 2. **CertificateArn**: 输入步骤 1. 创建 ACM 证书中记录的 **ARN**，例如 *arn:aws:acm:us-west-2:1436237113227:certificate/571518b3-123b-4502-1ec3-3t2sae704272*。 - 3. **VpcId**: 选择现有的VPC 。 - 4. **PubSubnets**: 选择用于部署ALB的公有子网。 - 5. **PrivSubnets**: 选择用于部署ECS的私有子网。 - 6. **DBSubnets**: 选择用于部署数据库的私有子网。 - 7. **MinContainers**: ECS容器的最小数量，默认值是2。 - 8. **MaxContainers**: ECS容器的最大数量，默认值是10。 - 9. **AutoScalingTargetCpuUtilization**: 弹性伸缩的CPU利用率百分比，默认值是75，最大值是100。 - 10. **JavaOpts**: JAVA_OPTS 参数。 + 3. **Hostname**: 输入您的 Keycloak 的域名。若部署在中国区，域名需经过 ICP 备案。 + 4. **VpcId**: 选择现有的VPC 。 + 5. **PubSubnets**: 选择用于部署ALB的公有子网。 + 6. **PrivSubnets**: 选择用于部署ECS的私有子网。 + 7. **DBSubnets**: 选择用于部署数据库的私有子网。 + 8. **TaskCPU**: 为运行keycloak应用的Fargate Task指定CPU，默认为4096 (4 vCPU)。详见[Task CPU和内存][task cpu and memory]。 + 9. **TaskMemory**: 为运行keycloak应用的Fargate Task指定内存，默认为8192 MiB (8 GB)。请注意该值必须在您选择的TaskCPU允许的范围内，详见[Task CPU和内存][task cpu and memory]。 + 10. **MinContainers**: ECS容器的最小数量，默认值是2。 + 11. **MaxContainers**: ECS容器的最大数量，默认值是10。 + 12. **AutoScalingTargetCpuUtilization**: 弹性伸缩的CPU利用率百分比，默认值是75，最大值是100。 + 13. **JavaOpts**: JAVA_OPTS 参数。 7. 选择**下一步**。 @@ -143,10 +148,13 @@ 6. 在**指定堆栈详细信息**部分执行以下操作： 1. **堆栈名称**: 输入堆栈名称, 例如 *KeycloakOnAWS* 。 2. **CertificateArn**: 输入 步骤 1. 创建 ACM 证书 中记录的 **ARN**，例如 *arn:aws:acm:us-west-2:1436237113227:certificate/571518b3-123b-4502-1ec3-3t2sae704272*。 - 3. **MinContainers**: ECS容器的最小数量，默认值是2。 - 4. **MaxContainers**: ECS容器的最大数量，默认值是10。 - 5. **AutoScalingTargetCpuUtilization**: 弹性伸缩的CPU利用率百分比，默认值是75，最大值是100。 - 6. **JavaOpts**: JAVA_OPTS 参数。 + 3. **Hostname**: 输入您的 Keycloak 的域名。若部署在中国区，域名需经过 ICP 备案。 + 4. **TaskCPU**: 为运行keycloak应用的Fargate Task指定CPU，默认为4096 (4 vCPU)。详见[Task CPU和内存][task cpu and memory]。 + 5. **TaskMemory**: 为运行keycloak应用的Fargate Task指定内存，默认为8192 MiB (8 GB)。请注意该值必须在您选择的TaskCPU允许的范围内，详见[Task CPU和内存][task cpu and memory]。 + 6. **MinContainers**: ECS容器的最小数量，默认值是2。 + 7. **MaxContainers**: ECS容器的最大数量，默认值是10。 + 8. **AutoScalingTargetCpuUtilization**: 弹性伸缩的CPU利用率百分比，默认值是75，最大值是100。 + 9. **JavaOpts**: JAVA_OPTS 参数。 7. 选择**下一步**。 @@ -176,15 +184,18 @@ 6. 在**指定堆栈详细信息**部分执行以下操作： 1. **堆栈名称**: 输入堆栈名称, 例如 *KeycloakOnAWS* 。 2. **CertificateArn**: 输入 步骤 1. 创建 ACM 证书 中记录的 **ARN**，例如 *arn:aws:acm:us-west-2:1436237113227:certificate/571518b3-123b-4502-1ec3-3t2sae704272*。 - 3. **DatabaseInstanceType**: 选择数据库实例类型。 - 4. **VpcId**: 选择现有的VPC 。 - 5. **PubSubnets**: 选择用于部署ALB的公有子网。 - 6. **PrivSubnets**: 选择用于部署ECS的私有子网。 - 7. **DBSubnets**: 选择用于部署数据库的私有子网。 - 8. **MinContainers**: ECS容器的最小数量，默认值是2。 - 9. **MaxContainers**: ECS容器的最大数量，默认值是10。 - 10. **AutoScalingTargetCpuUtilization**: 弹性伸缩的CPU利用率百分比，默认值是75，最大值是100。 - 11. **JavaOpts**: JAVA_OPTS 参数。 + 3. **Hostname**: 输入您的 Keycloak 的域名。若部署在中国区，域名需经过 ICP 备案。 + 4. **DatabaseInstanceType**: 选择数据库实例类型。 + 5. **VpcId**: 选择现有的VPC 。 + 6. **PubSubnets**: 选择用于部署ALB的公有子网。 + 7. **PrivSubnets**: 选择用于部署ECS的私有子网。 + 8. **DBSubnets**: 选择用于部署数据库的私有子网。 + 9. **TaskCPU**: 为运行keycloak应用的Fargate Task指定CPU，默认为4096 (4 vCPU)。详见[Task CPU和内存][task cpu and memory]。 + 10. **TaskMemory**: 为运行keycloak应用的Fargate Task指定内存，默认为8192 MiB (8 GB)。请注意该值必须在您选择的TaskCPU允许的范围内，详见[Task CPU和内存][task cpu and memory]。 + 11. **MinContainers**: ECS容器的最小数量，默认值是2。 + 12. **MaxContainers**: ECS容器的最大数量，默认值是10。 + 13. **AutoScalingTargetCpuUtilization**: 弹性伸缩的CPU利用率百分比，默认值是75，最大值是100。 + 14. **JavaOpts**: JAVA_OPTS 参数。 7. 选择**下一步**。 @@ -214,11 +225,14 @@ 6. 在**指定堆栈详细信息**部分执行以下操作： 1. **堆栈名称**: 输入堆栈名称, 例如 *KeycloakOnAWS* 。 2. **CertificateArn**: 输入 步骤 1. 创建 ACM 证书 中记录的 **ARN**，例如 *arn:aws:acm:us-west-2:1436237113227:certificate/571518b3-123b-4502-1ec3-3t2sae704272*。 - 3. **DatabaseInstanceType**: 选择数据库实例类型。 - 4. **MinContainers**: ECS容器的最小数量，默认值是2。 - 5. **MaxContainers**: ECS容器的最大数量，默认值是10。 - 6. **AutoScalingTargetCpuUtilization**: 弹性伸缩的CPU利用率百分比，默认值是75，最大值是100。 - 7. **JavaOpts**: JAVA_OPTS 参数。 + 3. **Hostname**: 输入您的 Keycloak 的域名。若部署在中国区，域名需经过 ICP 备案。 + 4. **DatabaseInstanceType**: 选择数据库实例类型。 + 5. **TaskCPU**: 为运行keycloak应用的Fargate Task指定CPU，默认为4096 (4 vCPU)。详见[Task CPU和内存][task cpu and memory]。 + 6. **TaskMemory**: 为运行keycloak应用的Fargate Task指定内存，默认为8192 MiB (8 GB)。请注意该值必须在您选择的TaskCPU允许的范围内，详见[Task CPU和内存][task cpu and memory]。 + 7. **MinContainers**: ECS容器的最小数量，默认值是2。 + 8. **MaxContainers**: ECS容器的最大数量，默认值是10。 + 9. **AutoScalingTargetCpuUtilization**: 弹性伸缩的CPU利用率百分比，默认值是75，最大值是100。 + 10. **JavaOpts**: JAVA_OPTS 参数。 7. 选择**下一步**。 @@ -301,9 +315,8 @@ [Keycloak aurora serverless from new VPC template]: https://aws-gcr-solutions.s3.cn-north-1.amazonaws.com.cn/keycloakonaws/latest/keycloak-aurora-serverless-from-new-vpc.template [Keycloak from existing VPC template]: https://aws-gcr-solutions.s3.cn-north-1.amazonaws.com.cn/keycloakonaws/latest/keycloak-from-existing-vpc.template [Keycloak from new VPC template]: https://aws-gcr-solutions.s3.cn-north-1.amazonaws.com.cn/keycloakonaws/latest/keycloak-from-new-vpc.template - - - +[comparisons]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.upgrade.html#Serverless.v1-v2-requirements +[task cpu and memory]: https://docs.aws.amazon.com/AmazonECS/latest/userguide/fargate-task-defs.html#fargate-tasks-size diff --git a/docs/zh/implementation-guide/revisions.md b/docs/zh/implementation-guide/revisions.md index 35f2afc..20bcbd7 100755 --- a/docs/zh/implementation-guide/revisions.md +++ b/docs/zh/implementation-guide/revisions.md @@ -2,5 +2,5 @@ | Date | Description | | ------------ | :------------------------------ | -| 2022年7月 | 发布版本2.1.0
1. 升级 Keycloak 版本至 16.1.1
2. 升级 aws-cdk 版本至 1.160.0
3. 升级 cdk-keycloak 版本至 0.2.41 | +| 2023年10月 | 发布版本2.1.6
1. 升级 Keycloak 版本至 22.0.4
2. 升级 aws-cdk 版本至 2.100.0
3. 升级 cdk-keycloak 版本至 2.9.0 |