diff --git a/docs/DEPLOY.md b/docs/DEPLOY.md index ad19fd8d..51cd26a8 100644 --- a/docs/DEPLOY.md +++ b/docs/DEPLOY.md @@ -4,9 +4,7 @@ Deploy usage guide and design decision. ## Multi-stage, multi-region deploy -By default, all functions are deploy to a stage (`dev`) and a region. The -autogenerated resource group name will reflect this information. The name -follow the Microsoft recommended [naming convention](https://docs.microsoft.com/en-us/azure/architecture/best-practices/naming-conventions#general). +By default, all functions are deploy to a stage (`dev`) and a region. The autogenerated resource group name will reflect this information. The name follow the Microsoft recommended [naming convention](https://docs.microsoft.com/en-us/azure/architecture/best-practices/naming-conventions#general). ### Using exitsing resource group @@ -28,7 +26,7 @@ follow the Microsoft recommended [naming convention](https://docs.microsoft.com/ #### Specifying resourceGroup in serverless.yml -- it is not clear if a resourceGroup has already been associated with a given stage and region. +- it is not clear if a resourceGroup has already been associated with a given stage and region. For example, we have the following default config @@ -49,7 +47,7 @@ then user try to deploy `sls deploy -s prod -r westus -g prodResourceGroup` -1. With this format, it's more clear which stage+region combo is associated with a resourceGroup. +1. With this format, it's more clear which stage+region combo is associated with a resourceGroup. 1. User can still make mistake, however, and use the `wrong` resource group for a specific stage. #### Don't support user defined resource group @@ -59,10 +57,10 @@ then user try to deploy ## Deployment Methodologies -#### 1. Deployment to Function App (rollback disabled) +#### 1. Deployment to Function App - Deploy resource group, upload packaged artifact directly to function app. Sets function app `RUN_FROM_PACKAGE` setting to `1`. -#### 2. Deployment to Blob Storage (rollback enabled) +#### 2. Deployment to Blob Storage - Deploy resource group, upload packaged function app to blob storage with version name. Sets function app `RUN_FROM_PACKAGE` setting to path of zipped artifact in blob storage - Default container name - `DEPLOYMENT_ARTIFACTS` (configurable in `serverless.yml`, see below)