You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 27, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: infra/README.md
+32-9Lines changed: 32 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,31 +30,54 @@ Use the [Azure Portal Sandbox](https://portal.azure.com/#blade/Microsoft_Azure_C
30
30
31
31
### 4. Create the deployment package
32
32
33
-
The name of the final two files (`mainTemplate.json` and `createUiDefinition.json`) should not be modified. The file names are case-sensitive and Azure expects these files as part of a managed app. The files must be packaged up as a zip file (where the json files are located at the root directory).
33
+
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)
34
34
35
+
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.
36
+
37
+
Now create the deployment package:
38
+
```bash
39
+
# add graphrag helm chart as an additional artifact
40
+
cd<repo_root_directory>/infra
41
+
cp -r helm/graphrag managed-app/artifacts/
42
+
# zip up all files
43
+
cd managed-app
44
+
tar -a -cf managed-app-deployment-pkg.zip createUiDefinition.json mainTemplate.json openapi.json artifacts
45
+
```
46
+
47
+
The deployment package will have the following file structure:
35
48
```bash
36
-
cd<repo_root_directory>/infra/managed-app
37
-
tar -a -c -f managed-app.zip createUiDefinition.json mainTemplate.json openapi.json artifacts
38
-
```
49
+
managed-app-deployment-pkg.zip
50
+
├── artifacts
51
+
│ ├── graphrag
52
+
│ │ ├── Chart.yaml
53
+
│ │ ├── LICENSE
54
+
│ │ ├── templates
55
+
│ │ └── values.yaml
56
+
│ └── scripts
57
+
│ └── updategraphrag.sh
58
+
├── createUiDefinition.json
59
+
├── mainTemplate.json
60
+
└── openapi.json
61
+
```
39
62
40
-
This zip file can then be uploaded to an Azure Storage location when setting up a [Service Catalog Managed Application Definition](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).
63
+
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.
41
64
42
65
### 5. Create the Service Catalog Managed App Definition
43
66
44
-
In 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.zip` file as part of the creation process.
67
+
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.
45
68
46
69
### 6. Deploy the managed app
47
70
48
-
There are two deployment options to consider when deploying a managed app. As a Marketplace App or as a one-click button:
71
+
There are two deployment options to consider when deploying a managed app. As an app in the Marketplace or as a one-click button:
49
72
50
73
* Marketplace App
51
74
52
-
1. In the Azure Portal, find and click on the managed app definition resource that was created in the previous step.
75
+
1. In the Azure Portal, find and click on the managed app definition resource created in the previous step.
53
76
2. A button option `Deploy from definition` will be available.
54
77
3. Click on it and proceed through the same setup experience (defined by the `createUiDefinitions.json` file) that a consumer would experience when installing the managed app.
55
78
4. Follow-on work is needed to [publish the app](https://learn.microsoft.com/en-us/partner-center/marketplace-offers/plan-azure-application-offer) as an official app in the Azure Marketplace
56
79
57
80
* 1-click Deployment Button
58
-
If `mainTemplate.json` is hosted somewhere remotely, a button can be created that will deploy the app when clicked like the example below.
81
+
If `mainTemplate.json` is hosted somewhere publicly (i.e. on Github), a deployment button can be created that deploys the app when clicked, like in the example below.
59
82
60
83
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure-Samples%2Fgraphrag-accelerator%2Frefs%2Fheads%2Fharjit-managed-app%2Finfra%2FmainTemplate.json)
0 commit comments