Skip to content
This repository was archived by the owner on May 27, 2025. It is now read-only.

Commit 0b69a28

Browse files
committed
readme update
1 parent 205c05d commit 0b69a28

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

infra/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,25 +28,25 @@ az bicep build --file main.bicep --outfile managed-app/mainTemplate.json
2828

2929
Use the [Azure Portal Sandbox](https://portal.azure.com/#blade/Microsoft_Azure_CreateUIDef/SandboxBlade) to test and make any UI changes that are defined in [createUiDefinition.json](createUiDefinition.json). To make additional changes to the Azure portal experience, start by reading some [documentation](https://learn.microsoft.com/en-us/azure/azure-resource-manager/managed-applications/create-uidefinition-overview) and copying the contents of `createUiDefinition.json` into the sandbox environment.
3030

31-
### 4. Create the deployment package
31+
### 4. Prepare the deployment package
3232

3333
A *deployment package* is a zip file comprised of several files. This includes the json files from the previous steps along with any additional code relevant to the deployment (i.e. artifacts)
3434

3535
Note that the file names for the json files (`mainTemplate.json` and `createUiDefinition.json`) should not be modified and are case-sensitive. Azure expects these files as part of a managed app deployment package.
3636

37-
A local copy of the backend docker image is needed in order to retrieve a copy of the openapi.json spec associated with GraphRAG's REST API. This api spec file will become part of the final deployment package.
37+
A local copy of the backend docker image needs to be built in order to retrieve a copy of the openapi.json spec associated with GraphRAG's REST API. This api spec file will become part of the final deployment package.
3838
```shell
3939
cd <repo_root_directory>
4040
docker build -t graphrag:backend -f docker/Dockerfile-backend .
41-
docker run -it -p 8080:80 graphrag:backend
41+
docker run -d -p 8080:80 graphrag:backend
4242
```
4343

4444
Now create the deployment package:
4545
```bash
4646
cd <repo_root_directory>/infra
4747

4848
# get the openapi specification file
49-
curl -s -o managed-app/openapi.json http://localhost:8080/manpage/openapi.json
49+
curl --fail-with-body -o managed-app/openapi.json http://localhost:8080/manpage/openapi.json
5050

5151
# add graphrag helm chart as an additional artifact
5252
cp -r helm/graphrag managed-app/artifacts/
@@ -56,7 +56,7 @@ cd managed-app
5656
tar -a -cf managed-app-deployment-pkg.zip createUiDefinition.json mainTemplate.json openapi.json artifacts
5757
```
5858

59-
The deployment package will have the following file structure:
59+
The deployment package should have the following file structure:
6060
```bash
6161
managed-app-deployment-pkg.zip
6262
├── artifacts
@@ -72,9 +72,9 @@ managed-app-deployment-pkg.zip
7272
└── openapi.json
7373
```
7474

75-
This zip file should be uploaded to an Azure Storage location in preparation for the next step, setting up a Service Catalog Managed Application Definition.
75+
This zip file should be uploaded to an Azure Storage location in preparation for the next step.
7676

77-
### 5. Create the Service Catalog Managed App Definition
77+
### 5. Create a Service Catalog Managed App Definition
7878

7979
Click [here](https://ms.portal.azure.com/#view/Microsoft_Azure_Marketplace/GalleryItemDetailsBladeNopdl/id/Microsoft.ApplianceDefinition/selectionMode~/false/resourceGroupId//resourceGroupLocation//dontDiscardJourney~/false/selectedMenuId/home/launchingContext~/%7B%22galleryItemId%22%3A%22Microsoft.ApplianceDefinition%22%2C%22source%22%3A%5B%22GalleryFeaturedMenuItemPart%22%2C%22VirtualizedTileDetails%22%5D%2C%22menuItemId%22%3A%22home%22%2C%22subMenuItemId%22%3A%22Search%20results%22%2C%22telemetryId%22%3A%2220409084-39a1-4800-bbce-d0b26a6f46a4%22%7D/searchTelemetryId/d7d20e05-ca16-47f7-bed5-9c7b8d2fa641) or from within the Azure Portal, go to Marketplace and create a `Service Catalog Managed App Definition`. You will be asked to provide a uri link to the uploaded `managed-app-deployment-pkg.zip` file during the creation process.
8080

0 commit comments

Comments
 (0)