Skip to content
This repository was archived by the owner on Dec 9, 2024. It is now read-only.

docs: Deploy doc updates #204

Merged
merged 1 commit into from
Jul 23, 2019
Merged

docs: Deploy doc updates #204

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions docs/DEPLOY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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
Expand All @@ -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)

Expand Down