1580158
/
stable-diffusion-aws-extension
mirror of https://github.com/awslabs/stable-diffusion-aws-extension.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

remove validate_resources

pull/428/head
Jingyi 2024-01-14 14:08:35 +08:00
parent a7e1b51abe
commit b5a7b7da36
5 changed files with 16 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -8,7 +8,7 @@ If you have not install the Stable Diffusion WebUI, or the proper version of the
### **Part2**: Install Middleware On AWS Cloud
#### **Option 1**: Use AWS Cloudformation Template
1. Install the middleware by click the [**link to navigate to AWS CloudFormation console**](https://console.aws.amazon.com/cloudformation/home?#/stacks/create/template?stackName=stable-diffusion-aws&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/stable-diffusion-aws-extension-github-mainline/latest/custom-domain/Stable-diffusion-aws-extension-middleware-stack.template.json) to install CloudFormation template directly, input the parameter accordingly, note the aigcbucketname is the bucket to store all your solution assets, email is the mail address you register to receive notification for events like model training complete, the apikey is the basic authentication for your api url connection, the trainmodelinferencetype is the ec2 instance type you choose to handle the workload like ckpt merge that can be handled by cpu enough.:
1. Install the middleware by click the [**link to navigate to AWS CloudFormation console**](https://console.aws.amazon.com/cloudformation/home?#/stacks/create/template?stackName=stable-diffusion-aws&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/stable-diffusion-aws-extension-github-mainline/latest/custom-domain/Stable-diffusion-aws-extension-middleware-stack.template.json) to install CloudFormation template directly, input the parameter accordingly, note the Bucket is the bucket to store all your solution assets, email is the mail address you register to receive notification for events like model training complete, the apikey is the basic authentication for your api url connection, the trainmodelinferencetype is the ec2 instance type you choose to handle the workload like ckpt merge that can be handled by cpu enough.:
<img width="1377" alt="iShot_2023-06-01_14 52 51" src="https://github.com/awslabs/stable-diffusion-aws-extension/assets/2245949/3fe9469a-b9e1-4633-ac4d-ceb6a459fec5">

8
docs/en/deployment/deployment.md
View File

@ -3,7 +3,7 @@ Before you launch the solution, review the architecture, supported regions, and
**Time to deploy**: Approximately 25 minutes.
## Prerequisites
Users need to prepare a computer running linux system in advance.
Users need to prepare a computer-running linux system in advance.
## Deployment overview
@ -36,7 +36,7 @@ Use the following steps to deploy this solution on AWS.
8. Wait until the stack is created.
9. Find the output value of the CloudFormation stack, and navigate to the WebUI by clicking the link in the **WebUIURL** value, note you need to wait extra 5 minutes to wait for the internal setup complete after the stack been created successfully.
9. Find the output value of the CloudFormation stack, and navigate to the WebUI by clicking the link in the **WebUIURL** value, note you need to wait an extra 5 minutes to wait for the internal setup complete after the stack been created successfully.
### Step 1: Deploy Stable Diffusion WebUI (Windows).
1. Start a Windows Server and log in via RDP.
@ -55,10 +55,10 @@ This automated AWS CloudFormation template deploys the solution in the AWS Cloud
2. The template will launch in the default region when you log into the console by default. To launch this solution in a different AWS Region, use the Region selector in the console navigation bar.
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. Under **Parameters**, enter a valid bucket name under **aigcbucketname** 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. 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, and 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**.
4. On the **Specify stack details** page, assign a valid and account level unique name to your solution stack. Under **Parameters**, enter a 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. 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**.
!!! Important "Notice"
Please do not change **EcrImageTag** before consulting solution team.
Please do not change **EcrImageTag** before a consulting solution team.
6. On the **Configure stack options** page, choose **Next**.
7. On the **Review** page, review and confirm the settings. Check the box acknowledging that the template will create AWS Identity and Access Management (IAM) resources. Choose **Create stack** to deploy the stack.

17
docs/en/deployment/deployment_for_existing_users.md
View File

@ -13,9 +13,8 @@ Use the following steps to deploy this solution on AWS.
- Step 1: Deploy Stable Diffusion WebUI.
- Step 2: After logging into the AWS Console, delete the existing Stable Diffusion AWS extension template in CloudFormation.
- Step 3: Check if all required cloud resources are complete.
- Step 4: Deploy the solution as middleware.
- Step 5: Configure API url and API token.
- Step 3: Deploy the solution as middleware.
- Step 4: Configure API url and API token.
## Deployment steps
@ -60,20 +59,14 @@ Use the following steps to deploy this solution on AWS.
7. CloudFormation will start deleting the stack, which may take some time. You can monitor the status of the stack on the "Stacks" page.
### Step 3：Check if all required cloud resources are complete.
1. Open a command line tool and clone this project to your local machine using git.
2. Configure [aws cli](https://aws.amazon.com/cli/).
3. Using the command line, navigate to the update_scripts directory and run `./validate_resources.sh`. When the output displays `[Success] [Complete] All resources checked, ok to upgrade, you can proceed to the next step`. If any resource check fails, you will need to manually update the relevant resources.
### Step 4: Deploy the solution as middleware.
### Step 3: Deploy the solution as middleware.
This automated AWS CloudFormation template deploys the solution in the AWS Cloud.
1. Sign in to the [AWS Management Console](https://console.aws.amazon.com/) and use [Launch solution in AWS Standard Regions](https://console.aws.amazon.com/cloudformation/home?#/stacks/create/template?stackName=stable-diffusion-aws&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/stable-diffusion-aws-extension-github-mainline/latest/custom-domain/Stable-diffusion-aws-extension-middleware-stack.template.json){:target="_blank"} to launch the AWS CloudFormation template.
2. The template will launch in the default region when you log into the console by default. To launch this solution in a different AWS Region, use the Region selector in the console navigation bar.
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. Under **Parameters**, enter a valid bucket name under **aigcbucketname** 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. 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). Select "yes" in **DeployedBefore**, and enter the S3 bucket used for previous deployment in **bucket**. Choose **Next**.
4. On the **Specify stack details** page, assign a valid and account level unique name to your solution stack. Under **Parameters**, enter a 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. 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). Select "yes" in **DeployedBefore**, and enter the S3 bucket used for previous deployment in **bucket**. Choose **Next**.
!!! Important "Notice"
Please do not change **EcrImageTag** before consulting the solution team.
@ -89,7 +82,7 @@ Please check the inbox of the email address you previously set up and click on t
### Step 5: Configure API url and API token.
### Step 4: Configure API url and API token.
1. Go to [CloudFormation console](https://console.aws.amazon.com/cloudformation/).

16
docs/zh/deployment/deployment_for_existing_users.md
View File

@ -13,9 +13,8 @@
- 步骤1：部署Stable Diffusion WebUI。
- 步骤2：登录AWS Console后，在CloudFormation中删除已有的Stable Diffusion AWS extension模版。
- 步骤3：检查资源是否齐全。
- 步骤4：重新部署本解决方案中间件。
- 步骤5：配置API Url和API Token。
- 步骤3：重新部署本解决方案中间件。
- 步骤4：配置API Url和API Token。
## 部署步骤
@ -60,14 +59,7 @@
7. CloudFormation 将开始删除堆栈，这可能需要一些时间。你可以在 "Stacks" 页面上监视堆栈的状态。
### 步骤3：检查 AWS 中的资源是否齐全
1. 打开一个命令行工具，通过git将本项目clone到本地
2. 配置好[aws cli](https://aws.amazon.com/cli/)
3. 通过命令行，进入到`update_scripts`目录下并运行 `./validate_resources.sh* `。当输出`[Success] [Complete] All resources checked, ok to upgrade
`时，可以进行下一步。如果有任何资源检查失败，则需要手动更新相关资源。
### 步骤4：重新部署 Stable Diffusion AWS Extension
### 步骤3：重新部署 Stable Diffusion AWS Extension
1. 登录到[AWS管理控制台](https://console.aws.amazon.com/)，点击链接[Stable-Diffusion-AWS-Extension.template](https://console.aws.amazon.com/cloudformation/home?#/stacks/create/template?stackName=stable-diffusion-aws&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/stable-diffusion-aws-extension-github-mainline/latest/custom-domain/Stable-diffusion-aws-extension-middleware-stack.template.json){:target="_blank"}。
2. 默认情况下，该模版将在您登录控制台后默认的区域启动。若需在指定的Amazon Web Service区域中启动该解决方案，请在控制台导航栏中的区域下拉列表中选择。
3. 在**创建堆栈**页面上，确认Amazon S3 URL文本框中显示正确的模板URL，然后选择**下一步**。
@ -110,7 +102,7 @@ cd stable-diffusion-webui
``` -->
### 步骤5: 配置 API URL 和 API Token
### 步骤4: 配置 API URL 和 API Token
1. 访问[AWS CloudFormation控制台](https://console.aws.amazon.com/cloudformation/)。

2
update_scripts/validate_resources.sh
View File

@ -1,5 +1,7 @@
#!/bin/bash
# todo will remove
RED='\033[0;31m'
Green='\033[0;32m'
Blue='\033[0;34m'