Déployer OSDU Admin UI sur Azure Data Manager for Energy

Ce guide vous montre comment déployer l’outil OSDU Admin UI sur votre instance Azure Data Manager for Energy (ADME).

L’interface utilisateur de l’administrateur OSDU permet aux administrateurs de plateforme de gérer la partition de données Data Manager for Energy Azure à laquelle il se connecte. Les tâches de gestion incluent les droits d’utilisation (gestion des utilisateurs et des groupes), les étiquettes légales, les schémas, les données de référence et l’affichage et la visualisation d’objets sur une carte.

Prérequis

• Une instance d'« Azure Data Manager for Energy ».

• Une Inscription d’application Microsoft Entra ID.
  Cette inscription d’application peut être identique à celle utilisée pour l’instance Azure Data Manager for Energy. Les autorisations d’API suivantes sont requises sur l’inscription de l’application pour que l’interface utilisateur d’administration fonctionne correctement.

  • Application.Read.All
  • User.Read
  • User.ReadBasic.All

  Lors de la première connexion à l’interface utilisateur d’administration, l’application demande les autorisations nécessaires. Vous pouvez également octroyer les autorisations requises à l’avance. Pour plus d’informations, consultez Configurer l’accès aux applications aux API web.

Options de déploiement

Il existe deux options de déploiement pour l’interface utilisateur de l’administrateur OSDU :

1. Déploiement rapide à l’aide de Azure Container Apps : déploiement en un clic à l’aide de Azure Container Apps. Cette option est le moyen le plus rapide de déployer l’interface utilisateur de l’administrateur OSDU et prend en charge les déploiements publics et privés.
2. Déploiement personnalisé à l’aide du site web statique d’un compte stockage Azure : générez et déployez l’interface utilisateur d’administration OSDU à l’aide du site web statique d’un compte stockage Azure. Cette option est plus personnalisable et vous permet d’adapter le déploiement à vos besoins.

Déploiement rapide avec Azure Container Apps

1. Sélectionnez le bouton Deploy to Azure pour déployer l’interface utilisateur de l’administrateur OSDU à l’aide d’Azure Container Apps.

   

2. Renseignez les paramètres requis dans le portail Azure. Pour plus d’informations sur les paramètres, consultez la section paramètres.

   

3. Sélectionnez Réviser + créer puis Créer pour déployer l’interface utilisateur de l’administrateur OSDU.

4. Vérifiez la section Outputs pour connaître l’URL de l’interface utilisateur de l’administrateur OSDU déployée.

5. Configurez la stratégie ADME CORS et l’URI de redirection SPA de l’inscription d’application avec l’URL du site Web.

6. Ouvrez l’URL dans un navigateur et vérifiez qu’elle fonctionne correctement et qu’elle est connectée à l’instance Azure Data Manager for Energy appropriée.

Paramètres

Déploiement personnalisé à l’aide du site Web statique du compte de stockage Azure

Préparer votre ordinateur

• Installez Visual Studio Code avec des conteneurs de développement. Vous pouvez déployer l’interface utilisateur de l’administrateur OSDU à partir de votre ordinateur local à l’aide de Linux ou de Sous-système Windows pour Linux (WSL). Nous vous recommandons d’utiliser un conteneur de développement pour réduire les outils et les conflits d’environnement.

Configuration de l’environnement

1. Utilisez un conteneur de développement dans Visual Studio Code pour réduire les conflits avec les outils installés localement.

2. Sélectionnez Remote - Containers | Open pour ouvrir un conteneur de développement et cloner le dépôt de l’interface utilisateur de l’administrateur OSDU.

   

3. Acceptez l’invite de clonage.

   

4. Lorsque vous êtes invité à fournir un modèle de configuration de conteneur :

   1. sélectionnez Ubuntu.
   2. Acceptez la version par défaut.
   3. N’ajoutez aucune fonctionnalité supplémentaire.

5. Après quelques minutes, le conteneur de développement s’exécute.

   

6. Ouvrez le terminal.

   

7. Installez Angular CLI, Azure CLI, npm et Node Version Manager (NVM).

   curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash && \
   export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")" && \
   [ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh" && \
   nvm install 20.19.6 && \
   export NG_CLI_ANALYTICS=false && \
   npm install -g @angular/cli@13.3.9 && \
   sudo apt-get update && \
   sudo apt-get install -y jq && \
   curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
   

   

8. Connectez-vous à Azure CLI en exécutant la commande dans le terminal.

   az login
   

9. Entrez vos informations d’identification et vérifiez que la connexion réussit.

10. Validez que vous utilisez l’abonnement approprié.

    az account show
    

11. Si nécessaire, modifiez l’abonnement.

    az account set --subscription <subscription-id>
    

Configuration des variables d’environnement

1. Entrez les variables d’environnement requises dans le terminal.

   export WEBSITE_NAME="" ## Unique name of the static website storage account. The storage account name must be between 3 and 24 characters in length and contain only numbers and lower-case letters.
   export RESOURCE_GROUP="" ## Name of the resource group
   export LOCATION="" ## Azure region to deploy to, for example "westeurope"
   

Déployer un compte de stockage

1. Créez le groupe de ressources. Ignorez cette étape si le groupe de ressources existe déjà.

   az group create \
       --name $RESOURCE_GROUP \
       --location $LOCATION
   

2. Créez le compte de stockage.

   az storage account create \
       --resource-group $RESOURCE_GROUP \
       --location $LOCATION \
       --name $WEBSITE_NAME \
       --sku Standard_LRS \
       --public-network-access Enabled \
       --allow-blob-public-access true
   

3. Configurez le site web statique.

   az storage blob service-properties update \
       --account-name $WEBSITE_NAME \
       --static-website \
       --404-document index.html \
       --index-document index.html
   

4. Définissez $web les autorisations de conteneur pour autoriser l’accès anonyme.

   az storage container set-permission \
       --name '$web' \
       --account-name $WEBSITE_NAME \
       --public-access blob
   

Configurer le site web

1. Accédez au dossier OSDUApp.

   cd OSDUApp/
   

2. Copiez le fichier Azurerouting.ts.

   cp providers/azure/routing.ts src/app/routing.ts
   

3. Installez les dépendances.

   npm install
   

4. Modifiez les paramètres dans le fichier de configuration situé dans /src/config/config.json.

export OSDU_ENDPOINT="" # Endpoint of the Azure Data Manager for Energy or OSDU instance to connect to, ending with /api/ . Example: https://contoso.energy.azure.com/api/
export DATA_PARTITION_ID="" # ADME Data Partition ID, or comma-separated list if using multiple partitions
export DOMAIN_NAME=".dataservices.energy" # Domain name to use for the entitlements service. Use .dataservices.energy for any ADME deployment.
export TENANT_ID="" # Entra ID tenant ID
export CLIENT_ID="" # App Registration ID to use for the Admin UI, usually the same as the ADME App Registration ID
export SCOPE="" # Scope of the ADME instance, for example "6ee7e0d6-0641-4b29-a283-541c5d00655a/.default"
export GRAPH_ENDPOINT="https://graph.microsoft.com/v1.0/" # Microsoft Graph API endpoint
export APPINSIGHTS_INSTRUMENTATIONKEY="" # Optional. Application Insights instrumentation key
export OSDU_CONNECTOR_API_ENDPOINT="" # Optional. API endpoint of the OSDU Connector API
export REDIRECT_URI="" # This is your static website URL, for example https://<storage-account-name>.z21.web.core.windows.net/
export GCZ_ENDPOINT="" # Optional. Base GCZ service endpoint ending with /gcz/ . Example: https://contoso.energy.azure.com/api/gcz/

jq \
  --arg data "$DATA_PARTITION_ID" \
  --arg domain "$DOMAIN_NAME" \
  --arg tenant "$TENANT_ID" \
  --arg client "$CLIENT_ID" \
  --arg redirect "$REDIRECT_URI" \
  --arg scope "$SCOPE" \
  --arg endpoint "$OSDU_ENDPOINT" \
  --arg graph "$GRAPH_ENDPOINT" \
  --arg appinsights "$APPINSIGHTS_INSTRUMENTATIONKEY" \
  --arg connectorapi "$OSDU_CONNECTOR_API_ENDPOINT" \
  --arg gcz "$GCZ_ENDPOINT" \
'
.settings.appInsights.instrumentationKey = $appinsights |
.settings.data_partition = ($data | split(",")) |
.settings.domain_name = $domain |
.settings.idp.tenant_id = $tenant |
.settings.idp.client_id = $client |
.settings.idp.redirect_uri = $redirect |
.settings.idp.scope = $scope |
.settings.api_endpoints.entitlement_endpoint = $endpoint |
.settings.api_endpoints.storage_endpoint = $endpoint |
.settings.api_endpoints.search_endpoint = $endpoint |
.settings.api_endpoints.legal_endpoint = $endpoint |
.settings.api_endpoints.schema_endpoint = $endpoint |
.settings.api_endpoints.file_endpoint = $endpoint |
.settings.api_endpoints.secrets_endpoint = $connectorapi |
.settings.api_endpoints.graphAPI_endpoint = $graph |
.settings.api_endpoints.workflow_endpoint = $endpoint |
.settings.api_endpoints.wddms_endpoint = $endpoint |
.settings.api_endpoints.gcz_endpoint = $gcz
' \
src/config/config.json > src/config/temp.json && \
mv src/config/temp.json src/config/config.json

{
  ...
  "domain_name": ".dataservices.energy",
  "data_partition": ["<adme_data_partition>"],
  "idp": {
    ...
    "tenant_id": "<tenant_id>",
    "client_id": "<client_id>",
    "redirect_uri": "<redirect_uri>",
    "scope": "<client_id>/.default"
  },
  "api_endpoints": {
    "entitlement_endpoint": "https://contoso.energy.azure.com/api/",
    "storage_endpoint": "https://contoso.energy.azure.com/api/",
    "search_endpoint": "https://contoso.energy.azure.com/api/",
    "legal_endpoint": "https://contoso.energy.azure.com/api/",
    "schema_endpoint": "https://contoso.energy.azure.com/api/",
    "osdu_connector_api_endpoint": "osdu_connector",
    "file_endpoint": "https://contoso.energy.azure.com/api/",
    "graphAPI_endpoint": "https://graph.microsoft.com/v1.0/",
    "workflow_endpoint": "https://contoso.energy.azure.com/api/",
    "wddms_endpoint": "https://contoso.energy.azure.com/api/",
    "gcz_endpoint": "https://contoso.energy.azure.com/api/gcz/"
  }
  ...
}