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
Copy file name to clipboardExpand all lines: articles/energy-data-services/how-to-deploy-osdu-admin-ui.md
+26-32Lines changed: 26 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,21 +10,22 @@ ms.date: 02/15/2024
10
10
---
11
11
# Deploy OSDU Admin UI on top of Azure Data Manager for Energy
12
12
13
-
This guide shows you how to deploy the OSDU Admin UI on top of your Azure Data Manager for Energy instance.
13
+
This guide shows you how to deploy the OSDU Admin UI on top of your Azure Data Manager for Energy (ADME) instance.
14
14
15
15
The OSDU Admin UI enables platform administrators to manage the Azure Data Manager for Energy data partition you connect it to. The management tasks include entitlements (user and group management), legal tags, schemas, reference data, view, and visualize objects on a map.
16
16
17
17
## Prerequisites
18
-
- Install [Visual Studio Code with Dev Containers](https://code.visualstudio.com/docs/devcontainers/tutorial). It's possible to deploy the OSDU Admin UI from your local computer using either Linux or Windows WSL, we recommend using a Dev Container to eliminate potential conflicts of tooling versions, environments etc.
18
+
- Install [Visual Studio Code with Dev Containers](https://code.visualstudio.com/docs/devcontainers/tutorial). It's possible to deploy the OSDU Admin UI from your local computer using either Linux or Windows Subsystem for Linux (WSL), we recommend using a Dev Container to eliminate potential conflicts of tooling versions, environments etc.
19
19
- An [Azure Data Manager for Energy instance](quickstart-create-microsoft-energy-data-services-instance.md).
20
-
- Add the App Registration permissions to enable Admin UI to function properly:
[](./media/how-to-deploy-osdu-admin-ui/app-permission-1.png#lightbox)
26
-
27
-
[](./media/how-to-deploy-osdu-admin-ui/app-permission-2.png#lightbox)
20
+
- An [Microsoft Entra ID App Registration](/entra/identity-platform/quickstart-register-app). <br> This App Registration can be the same as the one used for the Azure Data Manager for Energy instance.
21
+
22
+
> [!IMPORTANT]
23
+
> The following API permissions are required on the App Registration for the Admin UI to function properly.
> Upon first login to the Admin UI it will request the necessary permissions. You can also grant the required permissions in advance, see [App Registration API Permission documentation](/entra/identity-platform/quickstart-configure-app-access-web-apis#application-permission-to-microsoft-graph).
28
29
29
30
## Environment setup
30
31
1. Use the Dev Container in Visual Studio Code to deploy the OSDU Admin UI to eliminate conflicts from your local machine.
@@ -49,7 +50,7 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
49
50
50
51
[](./media/how-to-deploy-osdu-admin-ui/open-terminal.png#lightbox)
51
52
52
-
1. Install Angular CLI, Azure CLI, Node.js, npm, and NVM.
53
+
1. Install [Angular CLI](https://angular.io/cli), [Azure CLI](/cli/azure/install-azure-cli), [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), and [Node Version Manager (NVM)](https://github.com/nvm-sh/nvm).
@@ -63,28 +64,25 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
63
64
[](./media/how-to-deploy-osdu-admin-ui/install-screen.png#lightbox)
64
65
65
66
1. Log into Azure CLI by executing the command on the terminal. It takes you to the sign-in screen.
66
-
```azurecli-interactive
67
+
```azurecli
67
68
az login
68
69
```
69
70
70
71
1. It takes you to the sign-in screen. Enter your credentials and upon success, you see a success message.
71
72
72
73
[](./media/how-to-deploy-osdu-admin-ui/login.png#lightbox)
73
-
74
-
## Configure environment variables
75
-
1. Fetch `client-id` as authAppId, `resource-group`, `subscription-id`, and `location`.
76
-
77
-
[](./media/how-to-deploy-osdu-admin-ui/location-resource-group.png#lightbox)
78
74
79
-
1. Fetch the value of `id` as the subscription ID by running the following command on the terminal.
80
-
```azurecli-interactive
75
+
1. Validate that you're using the correct subscription.
76
+
```azurecli
81
77
az account show
82
78
```
83
79
84
-
1. If the above ID isn't same as the `subcription-id` from the Azure Data Manager for Energy instance, you need to change subscription.
85
-
```azurecli-interactive
80
+
1. If needed, use this code to change subscription.
81
+
```azurecli
86
82
az account set --subscription <subscription-id>
87
83
```
84
+
85
+
## Configure environment variables
88
86
89
87
1. Enter the required environment variables on the terminal.
90
88
```bash
@@ -96,14 +94,14 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
96
94
97
95
## Deploy storage account
98
96
1. Create resource group. Skip this step if the resource group exists already.
99
-
```azurecli-interactive
97
+
```azurecli
100
98
az group create \
101
99
--name $RESOURCE_GROUP \
102
100
--location $LOCATION
103
101
```
104
102
105
103
1. Create storage account.
106
-
```azurecli-interactive
104
+
```azurecli
107
105
az storage account create \
108
106
--resource-group $RESOURCE_GROUP \
109
107
--location $LOCATION \
@@ -114,7 +112,7 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
114
112
```
115
113
116
114
1. Configure the static website.
117
-
```azurecli-interactive
115
+
```azurecli
118
116
az storage blob service-properties update \
119
117
--account-name $WEBSITE_NAME \
120
118
--static-website \
@@ -123,15 +121,15 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
123
121
```
124
122
125
123
1. Set $web container permissions to allow anonymous access.
echo "Add the redirect URI above to the following App Registration's Single-page Application (SPA) section: https://ms.portal.azure.com/#view/Microsoft_AAD_RegisteredApps/ApplicationMenuBlade/~/Authentication/appId/$ADMINUI_CLIENT_ID/isMSAApp~/false"
@@ -159,7 +157,7 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
159
157
...
160
158
"tenant_id": "<tenant_id>", // Entra ID tenant ID
161
159
"client_id": "<client_id>", // App Registration ID to use for the admin UI, usually the same as the ADME App Registration ID, i.e. "6ee7e0d6-0641-4b29-a283-541c5d00655a"
162
-
"redirect_uri": "<https://storageaccount.zXX.web.core.windows.net/>", // This is the website URL ($REDIRECT_URI)
160
+
"redirect_uri": "<redirect_uri>", // This is the website URL ($REDIRECT_URI), i.e. "https://contoso.z1.web.core.windows.net"
163
161
"scope": "<client_id>/.default" // Scope of the ADME instance, i.e. "6ee7e0d6-0641-4b29-a283-541c5d00655a/.default"
164
162
},
165
163
"api_endpoints": { // Just replace contoso.energy.azure.com with your ADME_URL after removing https or wwww in all the API endpoints below.
@@ -179,18 +177,14 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
179
177
180
178
> [!NOTE]
181
179
> [OSDU Connector API](https://community.opengroup.org/osdu/ui/admin-ui-group/admin-ui-totalenergies/connector-api-totalenergies) is built as an interface between consumers and OSDU APIs wrapping some API chain calls and objects. Currently, it manages all operations and actions on project and scenario objects.
182
-
183
-
1. If you aren't able to give app permissions in the Prerequisite step because of the subscription constraints, remove `User.ReadBasic.All` and `Application.Read.All` from the `src/config/environments/environment.ts`. Removing these permissions would disable the Admin UI from converting the OIDs of users and applications into the user names and application names respectively.
184
-
185
-
[](./media/how-to-deploy-osdu-admin-ui/graph-permission.png#lightbox)
0 commit comments