Skip to content

Commit 5135795

Browse files
committed
updates to readme
1 parent f5a9f92 commit 5135795

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

DEPLOYMENT.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,19 @@ The Metrics Viewer can be integrated with GitHub application authentication, whi
1010

1111
With a Personal Access Token, user credentials are not verified, and the application simply renders Copilot metrics fetched using the PAT stored in the backend.
1212

13-
## One-click Azure Deployment
13+
## Scenario 1: One-click Azure Deployment
1414

15-
By far the simplest way is to use the "one-click" option that creates resources in Azure. The deployment creates:
15+
The simplest way to deploy is to use the "one-click" option that creates resources in Azure. The deployment includes:
1616

1717
* Azure Container App with a consumption environment
1818
* Azure Log Analytics Workspace
1919

20+
Application will use a pre-built docker image hosted in GitHub registry: `ghcr.io/karpikpl/copilot-metrics-viewer-with-proxy`.
21+
22+
**Prerequisites:** Contributor permission to a resource group in Azure and a subscription with the `Microsoft.App` resource provider enabled.
23+
24+
**Estimated cost** for running this in Azure is about $1 per month, as Container Apps have the first 2 million requests each month free.
25+
2026
1. **Option 1 - Using a Personal Access Token in the Backend**:
2127

2228
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fkarpikpl%2Fcopilot-metrics-viewer%2Fmain%2Fazure-deploy%2Fwith-token%2Fazuredeploy.json)
@@ -31,16 +37,24 @@ By far the simplest way is to use the "one-click" option that creates resources
3137

3238
Go to: `https://github.com/organizations/<your-org>/settings/apps/<your-app>` or in the UI to the settings of the registered application and add the following redirect URLs:
3339

34-
3540
```
3641
http://<YOUR Container APP URL>.azurecontainerapps.io/callback
3742
https://<YOUR Container APP URL>.azurecontainerapps.io/callback
3843
```
3944
40-
## Azure Deployment with azd
45+
## Scenario 2: Azure Deployment with azd
4146
4247
If more control over the deployed container image is needed, an infrastructure-as-code option has been provided using Azure Bicep. The application can be deployed using the [Azure Developer CLI](https://aka.ms/azd) (azd).
4348
49+
In this scenario, the container is built from the source code locally, which provides additional opportunities to modify, scan, etc.
50+
51+
**Prerequisites:**
52+
- Contributor permission to a subscription in Azure with the `Microsoft.App` resource provider enabled.
53+
- Permissions for creating role assignments.
54+
- Azure CLI (az), Azure Developer CLI (azd) and Docker installed locally.
55+
56+
**Estimated cost** for running this in Azure is about $10 per month, Container Apps have the first 2 million requests each month free and Container Registry costs about $5.
57+
4458
The deployment creates:
4559
4660
* Azure Resource Group
@@ -63,9 +77,9 @@ azd env set GITHUB_CLIENT_ID <client id>
6377
azd env set GITHUB_CLIENT_SECRET <client secret for the GH App>
6478
```
6579

66-
## Deploying the container
80+
## Scenario 3: Deploying the container
6781

68-
When using other deployment methods, the application can run as a Docker container with the required environment variables:
82+
Application can be deployed anywhere where containers can run and configured via environment variables:
6983

7084
For GitHub App:
7185

0 commit comments

Comments
 (0)