Skip to content

Commit dfa0a7f

Browse files
committed
code review fixes
1 parent 3469622 commit dfa0a7f

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

DEPLOYMENT.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ Application will use a pre-built docker image hosted in GitHub registry: `ghcr.i
3131

3232
**Prerequisites:** Contributor permission to a resource group in Azure and a subscription with the `Microsoft.App` resource provider enabled.
3333

34-
**Estimated cost** for running this in Azure is about $1 per month, as Container Apps have the first 2 million requests each month free.
34+
> [!IMPORTANT]
35+
> **Estimated cost** for running this in Azure is about $1 per month, as Container Apps have the first 2 million requests each month free.
3536
3637
1. **Option 1 - Using a Personal Access Token in the Backend**:
3738

@@ -52,12 +53,13 @@ Application will use a pre-built docker image hosted in GitHub registry: `ghcr.i
5253
https://<YOUR Container APP URL>.azurecontainerapps.io/callback
5354
```
5455
55-
### Deploying with private networking
56+
### Deployment with private networking
5657
57-
When deploying to a private network, specify a subnet (at least /23) for the Azure Container Apps Environment.
58+
> [!CAUTION]
59+
> When deploying to a private network, specify a subnet (at least /23) for the Azure Container Apps Environment.
5860
App deployment does not create any DNS entries for the application, in order to create a private DNS Zone linked to provided Virtual Network, follow up the deployment with DNS deployment targeting same resource group:
59-
60-
[![DNS Zone 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%2Fdns%2Fazuredeploy.json)
61+
>
62+
>[![DNS Zone 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%2Fdns%2Fazuredeploy.json)
6163
6264
## Scenario 2: Azure Deployment with azd
6365
@@ -70,7 +72,8 @@ In this scenario, the container is built from the source code locally, which pro
7072
- Permissions for creating role assignments.
7173
- Azure CLI (az), Azure Developer CLI (azd) and Docker installed locally.
7274
73-
**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.
75+
> [!IMPORTANT]
76+
> **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.
7477
7578
The deployment creates:
7679
@@ -142,17 +145,20 @@ ghcr.io/karpikpl/copilot-metrics-viewer-with-proxy
142145
While it is possible to run the API Proxy without GitHub app registration and with a hardcoded token, it is not the recommended way.
143146

144147
To register a new GitHub App, follow these steps:
148+
149+
> [!TIP]
150+
> Navigate using link: replace `<your_org>` with your organization name and open this link:
151+
[https://github.com/organizations/<your_org>/settings/apps](https://github.com/organizations/<your_org>/settings/apps)
152+
153+
or navigate using UI:
145154
1. Go to your organization's settings.
146155
2. Navigate to "Developer settings".
147156
3. Select "GitHub Apps".
148157
4. Click "New GitHub App".
149158

150-
Replace `<your org>` with your organization name in the link:
151-
`https://github.com/organizations/<your org>/settings/apps`
152-
153159
1. Set a unique name.
154160
2. Provide a home page URL: your company URL or just `http://localhost`.
155-
3. Add a callback URL for `http://localhost:3000`. (We'll add the real redirect URL after the application is deployed.)
161+
3. Add a callback URL for `http://localhost:3000/callback`. (We'll add the real redirect URL after the application is deployed.)
156162
4. Uncheck the "Webhook -> Active" checkbox.
157163
5. Set the scopes:
158164
- Select **Organization permissions**.

0 commit comments

Comments
 (0)