From 49ef86bbaccd585a3af9d3b14ef031a5de6fd240 Mon Sep 17 00:00:00 2001 From: Jingyi Niu Date: Mon, 8 Apr 2024 14:12:57 +0800 Subject: [PATCH 1/2] fix download branch --- install.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/install.sh b/install.sh index 1196ee04..41f09a52 100755 --- a/install.sh +++ b/install.sh @@ -22,7 +22,7 @@ git reset --hard ${INITIAL_SUPPORT_COMMIT_ROOT} cd extensions # Clone stable-diffusion-aws-extension -git clone https://github.com/awslabs/stable-diffusion-aws-extension.git --branch $branch +git clone https://github.com/awslabs/stable-diffusion-aws-extension.git --branch main # Checkout aigc branch cd stable-diffusion-aws-extension cd .. From 5750c9a8419f033951c50f9c370ec9f1908dbe0e Mon Sep 17 00:00:00 2001 From: Jingyi Niu Date: Mon, 8 Apr 2024 17:12:34 +0800 Subject: [PATCH 2/2] remove ecr image tag --- docs/en/deployment/deployment.md | 2 +- .../deployment_for_existing_users.md | 7 ++--- docs/en/deployment/ecr_image_param.md | 28 ------------------- docs/zh/deployment/deployment.md | 2 +- .../deployment_for_existing_users.md | 7 ++--- docs/zh/deployment/ecr_image_param.md | 21 -------------- 6 files changed, 8 insertions(+), 59 deletions(-) delete mode 100644 docs/en/deployment/ecr_image_param.md delete mode 100644 docs/zh/deployment/ecr_image_param.md diff --git a/docs/en/deployment/deployment.md b/docs/en/deployment/deployment.md index 78d1184b..a8022c2e 100644 --- a/docs/en/deployment/deployment.md +++ b/docs/en/deployment/deployment.md @@ -47,7 +47,7 @@ This automated AWS CloudFormation template deploys the solution in the AWS Cloud 3. On the **Create stack** page, verify that the correct template URL is shown in the **Amazon S3 URL** text box and choose **Next**. 4. On the **Specify stack details** page, assign a valid and account level unique name to your solution stack. -5. On the **Parameters** page, enter a new valid bucket name under **Bucket** for this solution to use, which is mainly for uploading dates and storing results. Enter a correct email address under **email** for future notice receiving. Select desired Amazon log level to be printed under **LogLevel**, only ERROR log will be printed by default. Enter a string of 20 characters that includes a combination of alphanumeric characters for **SdExtensionApiKey**, and it will be 09876543210987654321 by default. Select an instance type of Amazon EC2, which will mainly be used for operation including model creation, checkpoint merge, etc. To select the tag for the ECR image corresponding to the solution, please refer to the **EcrImageTag** field (if no modification is needed, you can keep the default value). For specific tag explanations, please click on this [link](ecr_image_param.md). Choose **Next**. +5. On the **Parameters** page, enter a new valid bucket name under **Bucket** for this solution to use, which is mainly for uploading dates and storing results. Enter a correct email address under **email** for future notice receiving. Select desired Amazon log level to be printed under **LogLevel**, only ERROR log will be printed by default. Enter a string of 20 characters that includes a combination of alphanumeric characters for **SdExtensionApiKey**, and it will be 09876543210987654321 by default, etc. Choose **Next**. !!! Important "Notice" Please do not change **EcrImageTag** before a consulting solution team. diff --git a/docs/en/deployment/deployment_for_existing_users.md b/docs/en/deployment/deployment_for_existing_users.md index d4fb1f3b..13d52366 100644 --- a/docs/en/deployment/deployment_for_existing_users.md +++ b/docs/en/deployment/deployment_for_existing_users.md @@ -52,10 +52,9 @@ Use the following steps to deploy this solution on AWS. 1. Open the AWS Management Console [(https://console.aws.amazon.com)](https://console.aws.amazon.com) and log in. 2. Select "CloudFormation" from the service menu, find the stack deployed for this solution, and select it, click **Update** in the upper right. 3. In **Update Stack**, select **Replace current template**, enter latest CloudFormation [link](https://aws-gcr-solutions.s3.amazonaws.com/stable-diffusion-aws-extension-github-mainline/latest/custom-domain/Extension-for-Stable-Diffusion-on-AWS.template.json) in **Amazon S3 URL** and click **Next**. -4. In **Specify Stack details**, select dropdown option under **EcrImageTag**, click **Next**. -5. In **Configure stack options**, click **Next**. -6. In **Review**, select acknowledge option and click **Submit**. -7. CloudFormation will start updating the stack, which may take some time. You can monitor the status of the stack on the **Stacks** page. +4. In **Configure stack options**, click **Next**. +5. In **Review**, select acknowledge option and click **Submit**. +6. CloudFormation will start updating the stack, which may take some time. You can monitor the status of the stack on the **Stacks** page. ## Notice diff --git a/docs/en/deployment/ecr_image_param.md b/docs/en/deployment/ecr_image_param.md deleted file mode 100644 index 54ec746d..00000000 --- a/docs/en/deployment/ecr_image_param.md +++ /dev/null @@ -1,28 +0,0 @@ -# How to modify the ECR image tag used in the solution - -The current project uses the following three Public ECR images for training and inference: -- public.ecr.aws/aws-gcr-solutions/stable-diffusion-aws-extension/aigc-webui-inference: TAG_NAME -- public.ecr.aws/aws-gcr-solutions/stable-diffusion-aws-extension/aigc-webui-utils: TAG_NAME -- public.ecr.aws/aws-gcr-solutions/stable-diffusion-aws-extension/aigc-webui-dreambooth-training: TAG_NAME - -The corresponding CDK deployment code can be found in: -1. infrastructure/src/common/dockerImages.ts - -```typescript -export const AIGC_WEBUI_INFERENCE: string = 'public.ecr.aws/aws-gcr-solutions/stable-diffusion-aws-extension/aigc-webui-inference:'; -export const AIGC_WEBUI_DREAMBOOTH_TRAINING: string = 'public.ecr.aws/aws-gcr-solutions/stable-diffusion-aws-extension/aigc-webui-dreambooth-training:'; -``` - -2. infrastructure/src/shared/const.ts - -```typescript -export const ECR_IMAGE_TAG: string = 'dev'; -``` - -TAG_NAME is defined by the CloudFormation deployment parameter `EcrImageTag`. By default, the tag value is dynamically generated during each compilation of the solution's CICD pipeline. For example, 'v1.0.0-46f9d43', where 'v1.0.0' represents the major version tag of the solution, and '46f9d43' is the commit ID of the project on GitHub. - -In most cases, users do not need to modify the ECR tag name. However, if users need to change the tag value, they can modify the default parameter value during the deployment of the solution's CloudFormation stack. Currently, we have two tag values available for users to choose from: -1. v1.0.0 -2. v1.0.1-COMMITID - -``` diff --git a/docs/zh/deployment/deployment.md b/docs/zh/deployment/deployment.md index 37bc4f2c..88cba726 100644 --- a/docs/zh/deployment/deployment.md +++ b/docs/zh/deployment/deployment.md @@ -47,7 +47,7 @@ 2. 默认情况下，该模版将在您登录控制台后默认的区域启动。若需在指定的Amazon Web Service区域中启动该解决方案，请在控制台导航栏中的区域下拉列表中选择。 3. 在**创建堆栈**页面上，确认Amazon S3 URL文本框中显示正确的模板URL，然后选择**下一步**。 4. 在**制定堆栈详细信息**页面，为您的解决方案堆栈分配一个账户内唯一且符合命名要求的名称。 -5. 在**参数**部分，在**Bucket**中填入一个有效的新的s3桶的名字。在**EcrImageTag**字段选择方案对应的ECR镜像的tag（如果无需修改就保持默认值即可。更多tag的说明请点击这个[link](ecr_image_param.md)）。在**email**处输入一个正确的电子邮件地址，以便接收将来的通知。在**SdExtensionApiKey**字段中请输入一个包含数字和字母组合的20个字符的字符串；如果未提供，默认为"09876543210987654321"。在**LogLevel**处选择您心仪的Lambda Log日志打印级别，默认ERROR才打印。在**UtilsCpuInstType**选择Amazon EC2的实例类型，主要用于包括模型创建、模型合并等操作。点击**下一步**。 +5. 在**参数**部分，在**Bucket**中填入一个有效的新的s3桶的名字。在**email**处输入一个正确的电子邮件地址，以便接收将来的通知。在**SdExtensionApiKey**字段中请输入一个包含数字和字母组合的20个字符的字符串；如果未提供，默认为"09876543210987654321"。在**LogLevel**处选择您心仪的Lambda Log日志打印级别，默认ERROR才打印。在**UtilsCpuInstType**选择Amazon EC2的实例类型，主要用于包括模型创建、模型合并等操作。点击**下一步**。 !!! Important "提示" 请不要自行改动**EcrImageTag**。如有需求，请联系解决方案团队。 diff --git a/docs/zh/deployment/deployment_for_existing_users.md b/docs/zh/deployment/deployment_for_existing_users.md index 352660a0..a85f71d1 100644 --- a/docs/zh/deployment/deployment_for_existing_users.md +++ b/docs/zh/deployment/deployment_for_existing_users.md @@ -43,10 +43,9 @@ 1. 打开 AWS 管理控制台[（https://console.aws.amazon.com）](https://console.aws.amazon.com)并登录。 2. 在服务菜单中选择 "CloudFormation"，找到之前已经部署的本方案的堆栈，并选中它，点击页面右上方的“Update”。 3. 在“Update Stack"中，选择 "Replace current template"，并在“Amazon S3 URL"部分填入最新[部署模版链接](https://aws-gcr-solutions.s3.amazonaws.com/stable-diffusion-aws-extension-github-mainline/latest/custom-domain/Extension-for-Stable-Diffusion-on-AWS.template.json)，点击“Next”。 -4. 在“Specify Stack details"界面，选择EcrImageTag下拉列表中最新的版本号，点击“Next”。 -5. 在“Configure stack options"界面，选择“Next”。 -6. 在“Review”界面，勾选必要选择框并选择“Submit”。 -7. CloudFormation 将开始更新堆栈，这可能需要一些时间。你可以在 "Stacks" 页面上监视堆栈的状态。 +4. 在“Configure stack options"界面，选择“Next”。 +5. 在“Review”界面，勾选必要选择框并选择“Submit”。 +6. CloudFormation 将开始更新堆栈，这可能需要一些时间。你可以在 "Stacks" 页面上监视堆栈的状态。 ## 注意事项 diff --git a/docs/zh/deployment/ecr_image_param.md b/docs/zh/deployment/ecr_image_param.md deleted file mode 100644 index 130c203f..00000000 --- a/docs/zh/deployment/ecr_image_param.md +++ /dev/null @@ -1,21 +0,0 @@ -# 如何修改方案使用的ECR镜像tag -当前项目使用了如下三个Public ECR的镜像用于training和inference: -* public.ecr.aws/aws-gcr-solutions/stable-diffusion-aws-extension/aigc-webui-inference: TAG_NAME -* public.ecr.aws/aws-gcr-solutions/stable-diffusion-aws-extension/aigc-webui-utils: TAG_NAME -* public.ecr.aws/aws-gcr-solutions/stable-diffusion-aws-extension/aigc-webui-dreambooth-training: TAG_NAME - -对应的部署CDK代码位于 -1. infrastructure/src/common/dockerImages.ts -```typescript -export const AIGC_WEBUI_INFERENCE: string = 'public.ecr.aws/aws-gcr-solutions/stable-diffusion-aws-extension/aigc-webui-inference:'; -export const AIGC_WEBUI_DREAMBOOTH_TRAINING: string = 'public.ecr.aws/aws-gcr-solutions/stable-diffusion-aws-extension/aigc-webui-dreambooth-training:'; -``` -2. infrastructure/src/shared/const.ts -```typescript -export const ECR_IMAGE_TAG: string = 'dev'; -``` -TAG_NAME是由Cloudformation的部署参数 EcrImageTag 来定义，默认tag的值是方案发布CICD的pipeline每次编译的时候动态生成，比如‘v1.0.0-46f9d43’, 其中v1.0.0是方案的大版本tag，46f9d43是项目github的commit id。 - -绝大部分情况用户不需要修改这个ECR的tag名字，用户如果需要修改这个tag值，需要在部署方案cloudformation的时候修改默认的参数值，到目前为止，我们有两个tag值供用户选择: -1. v1.0.0 -2. v1.0.1-COMMITID