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

Commit 292fad1

Browse files
committed
fix: Add sequence diagram png files (#184)
Add sequence diagram png files and update version to timestamp
1 parent 620967b commit 292fad1

File tree

6 files changed

+39
-36
lines changed

6 files changed

+39
-36
lines changed

docs/DEPLOY.md

+1-17
Original file line numberDiff line numberDiff line change
@@ -96,23 +96,7 @@ If rollback is enabled, the name of the created package will include the UTC tim
9696

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

99-
```mermaid
100-
sequenceDiagram
101-
participant s as Serverless CLI
102-
participant r as Resource Group
103-
participant f as Function App
104-
participant b as Blob Storage
105-
106-
note right of s: `sls deploy`
107-
s ->> r: Create resource group
108-
s ->> r: Deploy ARM template
109-
r ->> f: Included in ARM template
110-
r ->> b: Included in ARM template
111-
note right of s: Zip code
112-
s ->> b: Deploy zip code with name {appName}-v{version}.zip
113-
s ->> f: Set package path in settings
114-
note right of s: Log URLs
115-
```
99+
![alt text](./sequenceDiagrams/deployBlob.png)
116100

117101
##### Sub-Commands
118102

docs/ROLLBACK.md

+1-19
Original file line numberDiff line numberDiff line change
@@ -34,22 +34,4 @@ $ sls rollback -t 1561479506
3434

3535
##### Sequence diagram for rollback
3636

37-
```mermaid
38-
sequenceDiagram
39-
participant s as Serverless CLI
40-
participant r as Resource Group
41-
participant f as Function App
42-
participant b as Blob Storage
43-
44-
note right of s: `sls rollback`
45-
s ->> r: Request deployments
46-
r ->> s: Return deployments
47-
note right of s: Select deployment
48-
s ->> r: Deploy ARM template
49-
s ->> b: Request names of previously deployed artifacts
50-
b ->> s: Return names
51-
note right of s: Select artifact
52-
s ->> r: Re-deploy template
53-
s ->> f: Update RUN_FROM_PACKAGE path (could be done with above step)
54-
note right of s: Log URLs
55-
```
37+
![alt text](./sequenceDiagrams/rollback.png)

docs/sequenceDiagrams/deployBlob.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
```mermaid
2+
sequenceDiagram
3+
participant s as Serverless CLI
4+
participant r as Resource Group
5+
participant f as Function App
6+
participant b as Blob Storage
7+
8+
note right of s: `sls deploy`
9+
s ->> r: Create resource group
10+
s ->> r: Deploy ARM template
11+
r ->> f: Included in ARM template
12+
r ->> b: Included in ARM template
13+
note right of s: Zip code
14+
s ->> b: Deploy zip code with name {serviceName}-t{timestamp}.zip
15+
s ->> f: Set package path in settings
16+
note right of s: Log URLs
17+
```

docs/sequenceDiagrams/deployBlob.png

39.7 KB
Loading

docs/sequenceDiagrams/rollback.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
```mermaid
3+
sequenceDiagram
4+
participant s as Serverless CLI
5+
participant r as Resource Group
6+
participant f as Function App
7+
participant b as Blob Storage
8+
9+
note right of s: `sls rollback`
10+
s ->> r: Request deployments
11+
r ->> s: Return deployments
12+
note right of s: Select deployment
13+
s ->> r: Deploy ARM template
14+
s ->> b: Request names of previously deployed artifacts
15+
b ->> s: Return names
16+
note right of s: Select artifact
17+
s ->> r: Re-deploy template
18+
s ->> f: Update RUN_FROM_PACKAGE path (could be done with above step)
19+
note right of s: Log URLs
20+
```

docs/sequenceDiagrams/rollback.png

47 KB
Loading

0 commit comments

Comments
 (0)