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
+28-32Lines changed: 28 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,21 +10,24 @@ 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).
19
+
- 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
20
- 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)
21
+
- An [Microsoft Entra ID App Registration](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app).
22
+
- This App Registration can be the same as the one used for the Azure Data Manager for Energy instance.
23
+
24
+
> [!IMPORTANT]
25
+
> 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](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-configure-app-access-web-apis#application-permission-to-microsoft-graph).
28
31
29
32
## Environment setup
30
33
1. Use the Dev Container in Visual Studio Code to deploy the OSDU Admin UI to eliminate conflicts from your local machine.
@@ -49,7 +52,7 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
49
52
50
53
[](./media/how-to-deploy-osdu-admin-ui/open-terminal.png#lightbox)
51
54
52
-
1. Install Angular CLI, Azure CLI, Node.js, npm, and NVM.
55
+
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 +66,25 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
63
66
[](./media/how-to-deploy-osdu-admin-ui/install-screen.png#lightbox)
64
67
65
68
1. Log into Azure CLI by executing the command on the terminal. It takes you to the sign-in screen.
66
-
```azurecli-interactive
69
+
```azurecli
67
70
az login
68
71
```
69
72
70
73
1. It takes you to the sign-in screen. Enter your credentials and upon success, you see a success message.
71
74
72
75
[](./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
76
79
-
1. Fetch the value of `id` as the subscription ID by running the following command on the terminal.
80
-
```azurecli-interactive
77
+
1. Validate that you're using the correct subscription.
78
+
```azurecli
81
79
az account show
82
80
```
83
81
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
82
+
1. If needed, use the code below to change subscription.
83
+
```azurecli
86
84
az account set --subscription <subscription-id>
87
85
```
86
+
87
+
## Configure environment variables
88
88
89
89
1. Enter the required environment variables on the terminal.
90
90
```bash
@@ -96,14 +96,14 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
96
96
97
97
## Deploy storage account
98
98
1. Create resource group. Skip this step if the resource group exists already.
99
-
```azurecli-interactive
99
+
```azurecli
100
100
az group create \
101
101
--name $RESOURCE_GROUP \
102
102
--location $LOCATION
103
103
```
104
104
105
105
1. Create storage account.
106
-
```azurecli-interactive
106
+
```azurecli
107
107
az storage account create \
108
108
--resource-group $RESOURCE_GROUP \
109
109
--location $LOCATION \
@@ -114,7 +114,7 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
114
114
```
115
115
116
116
1. Configure the static website.
117
-
```azurecli-interactive
117
+
```azurecli
118
118
az storage blob service-properties update \
119
119
--account-name $WEBSITE_NAME \
120
120
--static-website \
@@ -123,15 +123,15 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
123
123
```
124
124
125
125
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 +159,7 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
159
159
...
160
160
"tenant_id": "<tenant_id>", // Entra ID tenant ID
161
161
"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)
162
+
"redirect_uri": "<redirect_uri>", // This is the website URL ($REDIRECT_URI), i.e. "https://contoso.z1.web.core.windows.net"
163
163
"scope": "<client_id>/.default" // Scope of the ADME instance, i.e. "6ee7e0d6-0641-4b29-a283-541c5d00655a/.default"
164
164
},
165
165
"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 +179,14 @@ The OSDU Admin UI enables platform administrators to manage the Azure Data Manag
179
179
180
180
> [!NOTE]
181
181
> [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