Slo (#35)

* SLO calculations

* remove locale from links in the README

* Add docker as a prerequisite in the README

* Update platform compatibility table

Author: nickdala

README.md

@@ -27,7 +27,7 @@ The following detailed deployment steps assume you are using a Dev Container ins
 
 ### 1. Clone the repo
 
-> For Windows users, we recommend using Windows Subsystem for Linux (WSL) to [improve Dev Container performance](https://code.visualstudio.com/remote/advancedcontainers/improve-performance).
+> For Windows users, we require using Windows Subsystem for Linux (WSL) to [improve Dev Container performance](https://code.visualstudio.com/remote/advancedcontainers/improve-performance).
 
 ```pwsh
 wsl
@@ -77,7 +77,7 @@ If you have multiple tenants, you can use the following command to log into the
 az login --tenant <tenant-id>
 ```
 
-Set the subscription to the one you want to use (you can use [az account list](https://learn.microsoft.com/en-us/cli/azure/account?view=azure-cli-latest#az-account-list) to list available subscriptions):
+Set the subscription to the one you want to use (you can use [az account list](https://learn.microsoft.com/cli/azure/account?view=azure-cli-latest#az-account-list) to list available subscriptions):
 
 ```shell
 export AZURE_SUBSCRIPTION_ID="<your-subscription-id>"
@@ -171,7 +171,7 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
 - [Troubleshooting](troubleshooting.md)
 - [Pattern Simulations](demo.md)
 - [Developer Experience](developer-experience.md)
-- [Calculating SLA](sla-calculation.md)
+- [Calculating SLA](slo-calculation.md)
 - [Find additional resources](additional-resources.md)
 - [Report security concerns](SECURITY.md)
 - [Find Support](SUPPORT.md)
@@ -181,7 +181,7 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
 
 This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
 trademarks or logos is subject to and must follow 
-[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general).
 Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
 Any use of third-party trademarks or logos are subject to those third-party's policies.
 

docs/SranglerFig.md

@@ -34,4 +34,4 @@ The `CONTOSO_SUPPORT_GUIDE_REQUEST_SERVICE` environment variable changes the beh
 
 ## Additional Resources
 
-[Strangler Fig Pattern](https://docs.microsoft.com/en-us/azure/architecture/patterns/strangler-fig) documentation.
+[Strangler Fig Pattern](https://docs.microsoft.com/azure/architecture/patterns/strangler-fig) documentation.

prerequisites.md

@@ -9,14 +9,16 @@ The project has the following prerequisites:
 1. [Terraform 1.9.8](https://developer.hashicorp.com/terraform/downloads)
 1. [JQ 1.6](https://jqlang.github.io/jq/download/)
 1. [protoc 3.12.4](https://grpc.io/docs/protoc-installation/)
+1. [Docker](https://docs.docker.com/get-docker/)
 
  If you want to use a VSCode DevContainer see the `VSCode DevContainer prerequisites` section below.
 
 ## Platform compatibility
 
 |             |  Native   | DevContainer |
 |-------------|-----------|--------------|
-| Windows     |    ❌     |      ✅      |
+| Windows     |    ❌     |      ❌      |
+| Windows WSL |    ✅     |      ✅      |
 | macOS       |    ✅     |      ✅      |
 | macOS arm64 |    ✅     |      ✅      |
 

prod-deployment.md

@@ -39,7 +39,7 @@ The following detailed deployment steps assume you are using a Dev Container ins
     az login --tenant <tenant-id>
     ```
 
-1. Set the subscription to the one you want to use (you can use [az account list](https://learn.microsoft.com/en-us/cli/azure/account?view=azure-cli-latest) to list available subscriptions):
+1. Set the subscription to the one you want to use (you can use [az account list](https://learn.microsoft.com/cli/azure/account?view=azure-cli-latest) to list available subscriptions):
 
 
     ```sh
@@ -82,7 +82,7 @@ The following detailed deployment steps assume you are using a Dev Container ins
     azd env set ENVIRONMENT prod
     ```
 
-1. Production is a multi-region deployment. Choose an Azure region for the primary deployment (Run [az account list-locations --query '[].{Location: name}'](https://learn.microsoft.com/en-us/cli/azure/account?view=azure-cli-latest) to see a list of locations):
+1. Production is a multi-region deployment. Choose an Azure region for the primary deployment (Run [az account list-locations --query '[].{Location: name}'](https://learn.microsoft.com/cli/azure/account?view=azure-cli-latest) to see a list of locations):
 
     ```pwsh
     azd env set AZURE_LOCATION <pick_a_region>
@@ -96,7 +96,7 @@ The following detailed deployment steps assume you are using a Dev Container ins
     azd env set AZURE_SECONDARY_LOCATION <pick_a_region>
     ```
 
-    *We encourage readers to choose paired regions for multi-regional web apps. Paired regions typically offer low network latency, data residency in the same geography, and sequential updating. Read [Azure paired regions](https://learn.microsoft.com/en-us/azure/reliability/cross-region-replication-azure#azure-paired-regions) to learn more about these regions.*
+    *We encourage readers to choose paired regions for multi-regional web apps. Paired regions typically offer low network latency, data residency in the same geography, and sequential updating. Read [Azure paired regions](https://learn.microsoft.com/azure/reliability/cross-region-replication-azure#azure-paired-regions) to learn more about these regions.*
 
 1. Optional: Set the App Registration Service Management Reference:
 
@@ -202,7 +202,7 @@ In order to deploy the application, you need to set up the deployment environmen
     echo $jumpbox_resource_id
     ```
 
-1. We use the [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/) to create a bastion tunnel that allows us to connect to the jump box. Run the following command to create a bastion tunnel to the jump box:
+1. We use the [Azure CLI](https://learn.microsoft.com/cli/azure/) to create a bastion tunnel that allows us to connect to the jump box. Run the following command to create a bastion tunnel to the jump box:
 
     ```sh
     az network bastion tunnel --name $bastion_host_name --resource-group $hub_resource_group --target-resource-id $jumpbox_resource_id --resource-port 22 --port 50022

slo-calculation.md

@@ -0,0 +1,66 @@
+# Calculating Solution Service Level Agreement
+
+The requirement for the Contoso Fiber CAMS application is that the combined service level agreement for all components in the hot path is greater than 99.9%.  The components in the hot path comprise of any service that is used in fulfilling a web request from a user.  
+
+## Development
+
+With a development environment, network isolation is not used.  The following services are considered:
+
+| Service                        | Azure SLA |
+|:-------------------------------|----------:|
+| Azure Front Door               | 99.990%   |
+| Entra ID                       | 99.990%   |
+| Azure App Service              | 99.950%   |
+| Azure Container Apps           | 99.950%   |
+| Azure Container Registry       | 99.900%   |
+| Azure Cache for Redis          | 99.900%   |
+| Azure Postgres Flexible Server | 99.990%   |
+| Azure Storage                  | 99.900%   |
+| Azure Key Vault                | 99.990%   |
+| App Configuration              | 99.900%   |
+| Azure Service Bus              | 99.900%   |
+| **Combined SLA**               | **99.362%** |
+
+## Production - Single Region
+
+When operating in production, network isolation is used.  We do not consider the availability of the hub resources or VNET peering.
+
+| Service                   | Azure SLA   |
+|:--------------------------|------------:|
+| Azure Front Door          | 99.9900%    |
+| Front Door Private Link   | 99.9900%    |
+| Entra ID                  | 99.9900%    |
+| Private DNS Zone          | 100.000%    |
+| Azure Key Vault           | 99.9900%    |
+| Key Vault Private Link    | 99.9900%    |
+| Azure Container Registry* | 99.9999%    |
+| **Combined global SLO**   | **99.9499%** |
+
+* Note that the Azure Container Registry is deployed in two regions which allows its usual 99.9% SLA to increase to 99.9999% in total. For more information, see [Azure Container Registry Geo-replication](https://learn.microsoft.com/azure/container-registry/container-registry-geo-replication#considerations-for-using-a-geo-replicated-registry).
+
+| Service               | Azure SLA |
+|:----------------------|----------:|
+| Azure App Service     | 99.950%   |
+| - Private Link        | 99.990%   |
+| Azure Container App   | 99.950%   |
+| - Private Link        | 99.990%   |
+| Azure Cache for Redis | 99.900%   |
+| - Private Link        | 99.990%   |
+|Azure Postgres Flexible Server | 99.990%   |
+| - Private Link        | 99.990%   |
+| Azure Storage         | 99.900%   |
+| - Private Link        | 99.990%   |
+| App Configuration     | 99.900%   |
+| - Private Link        | 99.990%   |
+| Azure Service Bus     | 99.900%   |
+| **Combined regional SLO**    | **99.4215%** |
+
+### Total production SLO
+
+Because there are two redundant regions, the *total* regional SLO for the two regions combined is calculated as `1 - (1 - SLO)^2` where SLO is the SLO for a single regional spoke deployment. This gives us a total combined regional service SLO of **99.9967%**.
+
+This total regional SLO is combined with the global SLO to give the total SLO for the production environment: **99.9467%**.
+
+By having redundant resources in two regions, the total SLO for the production environment (99.9467%) exceeds the requirement of 99.9%.
+
+For more information on how to calculate effective SLO, please refer to [the Well Architected Framework](https://learn.microsoft.com/azure/well-architected/reliability/metrics).

troubleshooting.md

@@ -11,7 +11,7 @@ Verify that you are in the directory where the `azure.yaml` file is located. You
 ## BadRequest: Azure subscription is not registered with CDN Provider.
 This error message surfaces from the `azd provision` command when trying to follow the guide to provision an Azure Front Door.
 
-Most [Azure resource providers](https://learn.microsoft.com/en-us/azure/azure-resource-manager/troubleshooting/error-register-resource-provider) are registered automatically by the Microsoft Azure portal or the command-line interface, but not all. If you haven't used a particular resource provider before, you might need to register that provider.
+Most [Azure resource providers](https://learn.microsoft.com/azure/azure-resource-manager/troubleshooting/error-register-resource-provider) are registered automatically by the Microsoft Azure portal or the command-line interface, but not all. If you haven't used a particular resource provider before, you might need to register that provider.
 
 **Full error message**
 ```