diff --git a/docs/DEPLOY.md b/docs/DEPLOY.md index 675a79e2..ad19fd8d 100644 --- a/docs/DEPLOY.md +++ b/docs/DEPLOY.md @@ -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 diff --git a/docs/ROLLBACK.md b/docs/ROLLBACK.md index 77697da9..d9bdab13 100644 --- a/docs/ROLLBACK.md +++ b/docs/ROLLBACK.md @@ -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) \ No newline at end of file diff --git a/docs/sequenceDiagrams/deployBlob.md b/docs/sequenceDiagrams/deployBlob.md new file mode 100644 index 00000000..a1e79d7f --- /dev/null +++ b/docs/sequenceDiagrams/deployBlob.md @@ -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 +``` \ No newline at end of file diff --git a/docs/sequenceDiagrams/deployBlob.png b/docs/sequenceDiagrams/deployBlob.png new file mode 100644 index 00000000..4593ee97 Binary files /dev/null and b/docs/sequenceDiagrams/deployBlob.png differ diff --git a/docs/sequenceDiagrams/rollback.md b/docs/sequenceDiagrams/rollback.md new file mode 100644 index 00000000..0dd1a328 --- /dev/null +++ b/docs/sequenceDiagrams/rollback.md @@ -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 +``` \ No newline at end of file diff --git a/docs/sequenceDiagrams/rollback.png b/docs/sequenceDiagrams/rollback.png new file mode 100644 index 00000000..938be683 Binary files /dev/null and b/docs/sequenceDiagrams/rollback.png differ