Implantar a interface do usuário de administração OSDU sobre o Azure Data Manager for Energy

Este guia mostra como implantar a interface do usuário de administração OSDU sobre sua instância do Azure Data Manager for Energy (ADME).

A UI de Administração OSDU permite aos administradores da plataforma gerir a partição de dados Azure Data Manager for Energy a que esta se liga. As tarefas de gestão incluem direitos (gestão de utilizadores e grupos), etiquetas legais, esquemas, dados de referência e visualização e visualização de objetos num mapa.

Pré-requisitos

• Uma instância do Azure Data Manager for Energy.

• Um registo de aplicação do Microsoft Entra ID.
  Este registo da aplicação pode ser igual ao usado para a instância Azure Data Manager for Energy. São necessárias as seguintes permissões de API no registo da aplicação para que a Interface de Administração funcione corretamente.

  • Aplicação.Read.All
  • User.Read
  • Utilizador.ReadBasic.All

  Ao iniciar sessão pela primeira vez na Interface de Administração, a aplicação solicita as permissões necessárias. Você também pode conceder as permissões necessárias com antecedência. Para mais informações, consulte Configurar acesso de aplicações a APIs web.

Opções de implementação

Há duas opções de implantação para a interface do usuário de administração do OSDU:

1. Implementação rápida com o Azure Container Apps: Implementação com um único clique com o Azure Container Apps. Esta opção é a forma mais rápida de implementar a UI de Administração do OSDU e suporta tanto implantações públicas como privadas.
2. Implementação personalizada usando o Armazenamento do Azure Account Static Website: Construa e implemente a interface administrativa do OSDU usando o Armazenamento do Azure Account Static Website. Esta opção é mais personalizável e permite-lhe adaptar a implementação às suas necessidades.

Implantação rápida com Aplicativos de Contêiner do Azure

1. Selecione o Deploy to Azure botão para implantar a interface do usuário de administração OSDU usando os Aplicativos de Contêiner do Azure.

   

2. Preencha os parâmetros necessários no portal do Azure. Para mais informações sobre os parâmetros, consulte a secção de parâmetros.

   

3. Selecione Rever + criar e, em seguida, Criar para implementar a IU de administração OSDU.

4. Verifique na Outputs seção a URL da interface do usuário de administração do OSDU implantada.

5. Configure a política ADME CORS e URI de redirecionamento do App Registration SPA utilizando o URL do website.

6. Abra a URL em um navegador e valide se ela está funcionando corretamente e conectada à instância correta do Azure Data Manager for Energy.

Parâmetros

Implantação personalizada usando o site estático da conta de armazenamento do Azure

Prepare o seu computador

• Instale Visual Studio Code com Dev Containers. Pode implementar a interface de administração OSDU a partir do seu computador local usando Linux ou Subsistema Windows para Linux (WSL). Recomendamos o uso de um Contentor de Desenvolvimento para reduzir conflitos de ferramentas e ambiente.

Configuração do ambiente

1. Use um Contentor de Desenvolvimento no Visual Studio Code para reduzir conflitos com ferramentas instaladas localmente.

2. Selecione Remote - Containers | Open para abrir um contêiner de desenvolvimento e clonar o repositório OSDU Admin UI.

   

3. Aceite o prompt de clonagem.

   

4. Quando lhe for solicitado um modelo de configuração de um contentor:

   1. Selecione Ubuntu.
   2. Aceite a versão padrão.
   3. Não adicione recursos extras.

5. Após alguns minutos, o devcontainer está em execução.

   

6. Abra o terminal.

   

7. Instale a CLI Angular, a CLI do Azure, o npm e o Gerenciador de Versão do Nó (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. Inicie sessão no CLI do Azure executando o comando no terminal.

   az login
   

9. Introduza as suas credenciais e verifique se o início de sessão foi bem-sucedido.

10. Valide se está a utilizar a subscrição correta.

    az account show
    

11. Se necessário, altera a subscrição.

    az account set --subscription <subscription-id>
    

Configurar variáveis de ambiente

1. Introduza as variáveis de ambiente necessárias no 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"
   

Implantar conta de armazenamento

1. Crie o grupo de recursos. Ignore este passo se o grupo de recursos já existir.

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

2. Crie a conta de armazenamento.

   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. Configure o site estático.

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

4. Defina $web permissões de contentores para permitir acesso anónimo.

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

Configurar o site

1. Navegue para a pasta OSDUApp.

   cd OSDUApp/
   

2. Copie o ficheiro Azure routing.ts.

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

3. Instale as dependências.

   npm install
   

4. Modifique os parâmetros no arquivo de configuração localizado em /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/"
  }
  ...
}