Skip to content

Commit

Permalink
fix: Add sequence diagram png files (#184)
Browse files Browse the repository at this point in the history
Add sequence diagram png files and update version to timestamp
  • Loading branch information
tbarlow12 authored Jun 28, 2019
1 parent 73b5771 commit e183ae4
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 36 deletions.
18 changes: 1 addition & 17 deletions docs/DEPLOY.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,23 +96,7 @@ If rollback is enabled, the name of the created package will include the UTC tim

##### Sequence diagram for deployment to blob storage

```mermaid
sequenceDiagram
participant s as Serverless CLI
participant r as Resource Group
participant f as Function App
participant b as Blob Storage
note right of s: `sls deploy`
s ->> r: Create resource group
s ->> r: Deploy ARM template
r ->> f: Included in ARM template
r ->> b: Included in ARM template
note right of s: Zip code
s ->> b: Deploy zip code with name {appName}-v{version}.zip
s ->> f: Set package path in settings
note right of s: Log URLs
```
![alt text](./sequenceDiagrams/deployBlob.png)

##### Sub-Commands

Expand Down
20 changes: 1 addition & 19 deletions docs/ROLLBACK.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,22 +34,4 @@ $ sls rollback -t 1561479506

##### Sequence diagram for rollback

```mermaid
sequenceDiagram
participant s as Serverless CLI
participant r as Resource Group
participant f as Function App
participant b as Blob Storage
note right of s: `sls rollback`
s ->> r: Request deployments
r ->> s: Return deployments
note right of s: Select deployment
s ->> r: Deploy ARM template
s ->> b: Request names of previously deployed artifacts
b ->> s: Return names
note right of s: Select artifact
s ->> r: Re-deploy template
s ->> f: Update RUN_FROM_PACKAGE path (could be done with above step)
note right of s: Log URLs
```
![alt text](./sequenceDiagrams/rollback.png)
17 changes: 17 additions & 0 deletions docs/sequenceDiagrams/deployBlob.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
```mermaid
sequenceDiagram
participant s as Serverless CLI
participant r as Resource Group
participant f as Function App
participant b as Blob Storage
note right of s: `sls deploy`
s ->> r: Create resource group
s ->> r: Deploy ARM template
r ->> f: Included in ARM template
r ->> b: Included in ARM template
note right of s: Zip code
s ->> b: Deploy zip code with name {serviceName}-t{timestamp}.zip
s ->> f: Set package path in settings
note right of s: Log URLs
```
Binary file added docs/sequenceDiagrams/deployBlob.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions docs/sequenceDiagrams/rollback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

```mermaid
sequenceDiagram
participant s as Serverless CLI
participant r as Resource Group
participant f as Function App
participant b as Blob Storage
note right of s: `sls rollback`
s ->> r: Request deployments
r ->> s: Return deployments
note right of s: Select deployment
s ->> r: Deploy ARM template
s ->> b: Request names of previously deployed artifacts
b ->> s: Return names
note right of s: Select artifact
s ->> r: Re-deploy template
s ->> f: Update RUN_FROM_PACKAGE path (could be done with above step)
note right of s: Log URLs
```
Binary file added docs/sequenceDiagrams/rollback.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e183ae4

Please sign in to comment.