地理空間消費ゾーンをデプロイする

Azure Kubernetes Service (AKS) に地理空間消費ゾーン (GCZ) をデプロイする

Azure Kubernetes Service (AKS) に地理空間消費ゾーン (GCZ) をデプロイする方法について説明します。

前提条件

• Azure サブスクリプション。 Azure サブスクリプションをお持ちでない場合は、無料アカウントを作成してください。
• 仮想ネットワーク統合を使用した Azure Kubernetes クラスター (AKS)。 詳細な手順については、「Azure Kubernetes Service (AKS) クラスターの作成」と「Azure Container Networking Interface (CNI) ネットワーク」を参照してください。
• Azure Cloud Shell または Azure CLI、kubectl、Git CLI。

地理空間消費ゾーン (GCZ) HELM チャートをデプロイする

1. GCZ リポジトリをローカル環境にクローンします。

   git clone https://community.opengroup.org/osdu/platform/consumption/geospatial.git
   

2. ディレクトリを geospatial フォルダーに変更します。

   cd geospatial/devops/azure/charts/geospatial
   

3. デプロイの変数を定義します。

   • Unix シェル
   • Windows PowerShell

   # Define the variables for Azure Data Manager for Energy
   AZURE_DNS_NAME="<instanceName>.energy.azure.com"  # Example: demo.energy.azure.com
   DATA_PARTITION_ID="<dataPartitionId>" # Data partition ID. Example: opendes
   AZURE_TENANT_ID="<tenantId>" # Entra ID tenant ID. Example: 557963fb-ede7-4a88-9e3e-19ace7f1e36b 
   AZURE_CLIENT_ID="<clientId>" # App Registration client ID. Example: b149dc73-ed8c-4ad3-bbaf-882a208f87eb
   AZURE_CLIENT_SECRET="<clientSecret>" # App Registration client secret.
   CALLBACK_URL="http://localhost:5050" #ie: http://localhost:8080
   
   # Define the variables for AKS
   AKS_NAME="<aksName>" # Name of the AKS cluster. Example: gcz-aks-cluster.
   RESOURCE_GROUP="<resourceGroupName>" # Name of the resource group. Example: gcz-rg.
   NAMESPACE="ignite" # Name of the AKS namespace you want to deploy to. We recommend to leave it default.
   GCZ_IGNITE_SERVICE="ignite-service" # Name of the ignite service. We recommend to leave it default.
   GCZ_IGNITE_NAMESPACE=$NAMESPACE
   CHART=osdu-gcz-service
   VERSION=0.1.0
   

4. HELM チャートを作成します。

   • Unix シェル
   • Windows PowerShell

   cat > osdu_gcz_custom_values.yaml << EOF
   # This file contains the essential configs for the gcz on azure helm chart
   
   ################################################################################
   # Specify the values for each service.
   #
   global:
   ignite:
       namespace: $NAMESPACE
       name: ignite
       image:
       name: community.opengroup.org:5555/osdu/platform/consumption/geospatial/gridgain-community
       tag: 8.8.34
       configuration:
       gcz_ignite_namespace: "$GCZ_IGNITE_NAMESPACE"
       gcz_ignite_service: "$GCZ_IGNITE_SERVICE"
   provider:
       namespace: $NAMESPACE
       image:
       repository: community.opengroup.org:5555
       name: osdu/platform/consumption/geospatial/geospatial-provider-master
       tag: latest
       service:
       type: LoadBalancer
       annotations:
           service.beta.kubernetes.io/azure-load-balancer-internal: "true"
   transformer:
       namespace: $NAMESPACE
       image:
       repository: community.opengroup.org:5555
       name: osdu/platform/consumption/geospatial/geospatial-transformer-master
       tag: latest
       service:
       type: LoadBalancer
       annotations:
           service.beta.kubernetes.io/azure-load-balancer-internal: "true"
       configuration:
       datapartitionid: $DATA_PARTITION_ID
       clientId: $AZURE_CLIENT_ID
       tenantId: $AZURE_TENANT_ID
       callbackURL: $CALLBACK_URL
       searchQueryURL: "https://$AZURE_DNS_NAME/api/search/v2/query"
       searchCursorURL: "https://$AZURE_DNS_NAME/api/search/v2/query_with_cursor"
       schemaURL: "https://$AZURE_DNS_NAME/api/schema-service/v1/schema"
       entitlementsURL: "https://$AZURE_DNS_NAME/api/entitlements/v2"
       fileRetrievalURL: "https://$AZURE_DNS_NAME/api/dataset/v1/retrievalInstructions"
       crsconvertorURL: "https://$AZURE_DNS_NAME/api/crs/converter/v3/convertTrajectory"
       storageURL: "https://$AZURE_DNS_NAME/api/storage/v2/records"
       clientSecret: $(echo "$AZURE_CLIENT_SECRET" | base64)
       gcz_ignite_namespace: "$GCZ_IGNITE_NAMESPACE"
       gcz_ignite_service: "$GCZ_IGNITE_SERVICE"   
   EOF
   

5. サービスの種類を、provider および transformer サービス構成ファイルの LoadBalancer に変更します。

   • Unix シェル
   • Windows PowerShell

   cat > ../provider/templates/service.yaml << EOF
   apiVersion: v1
   kind: Service
   metadata:
       name: gcz-provider
       namespace: {{ $.Values.global.provider.namespace }}
       annotations:
           {{- range $key, $value := $.Values.global.provider.service.annotations }}
           {{ $key }}: {{ $value | quote }}
           {{- end }}
   spec:
       selector:
           app: provider
       ports:
       - port: 80
           protocol: TCP
           targetPort: 8083
       type: {{ $.Values.global.provider.service.type }}
   EOF
   
   cat > ../transformer/templates/service.yaml << EOF
   apiVersion: v1
   kind: Service
   metadata:
       name: gcz-transformer
       namespace: {{ $.Values.global.transformer.namespace }}
       annotations:
           {{- range $key, $value := $.Values.global.transformer.service.annotations }}
           {{ $key }}: {{ $value | quote }}
           {{- end }}
   spec:
       selector:
           app: transformer
       ports:
       - port: 80
           protocol: TCP
           targetPort: 8080
       type: {{ $.Values.global.transformer.service.type }}
   EOF
   

6. Azure Kubernetes Service (AKS) クラスターに対して認証します。

   az aks get-credentials --resource-group $RESOURCE_GROUP --name $AKS_NAME --admin
   

7. HELM の依存関係をデプロイします。

   helm dependency build
   

8. GCZ HELM チャートをデプロイします。

   helm install $CHART ../$CHART --values osdu_gcz_custom_values.yaml
   

9. デプロイを検証します。

   kubectl get pods -n $NAMESPACE
   

   これで、ignite、provider、および transformer サービスのポッドが表示されます。

10. 次に、provider および transformer サービスの外部 IP をメモします。

    kubectl get service -n $NAMESPACE
    

    これらの IP は、GCZ API エンドポイントへの接続に使用されます。

Windows 仮想マシンに地理空間消費ゾーン (GCZ) をデプロイする

Windows に地理空間消費ゾーン (GCZ) をデプロイする方法について説明します。 このデプロイ オプションは、セットアップと構成が容易であり、メンテナンスが少なくて済むため、開発環境とテスト環境に推奨されます。

前提条件

• Azure Data Manager for Energy インスタンス。 Azure Data Manager for Energy インスタンスがない場合は、「Azure Data Manager for Energy インスタンスを作成する」を参照してください。
• Windows 仮想マシン。 Windows 仮想マシンがない場合は、「Azure で Windows 仮想マシンを作成する」を参照してください。 ローカル コンピューターを使用することもできます。
• Windows 仮想マシンにインストールされている Java JDK 17。 Java がインストールされていない場合は、Windows に Java をインストールする方法を参照してください。
• Windows 仮想マシンにインストールされている Node 18.19.1 (LTS)。 Node がインストールされていない場合は、Windows への Node.js と npm のインストール方法を参照してください。
• Windows 仮想マシンにインストールされている Python 3.11.4 以降。 Python がインストールされていない場合は、Windows に Python をインストールする方法を参照してください。
  • インストール プロセス中に pip を追加してください。 pip の追加を忘れた場合は、手動でインストールできます。

Windows に GCZ をデプロイする

1. Windows 仮想マシンに接続します。

2. OSDU GitLab リポジトリから次のファイルをダウンロードします。

   1. GCZ プロバイダ
   2. GCZ トランスフォーマー
   3. Python の依存関係

3. 管理者として PowerShell を開き、ファイルをダウンロードしたフォルダに移動します。

4. 次のコマンドを実行してファイルを抽出します。

   Expand-Archive -Path .\GCZ_PROVIDER.zip -DestinationPath C:\gcz\
   Expand-Archive -Path .\GCZ_TRANSFORMER.zip -DestinationPath C:\gcz\
   Expand-Archive -Path .\GCZ_PYTHON_DEPENDENCIES.zip -DestinationPath C:\gcz\
   

5. 環境変数を構成します。

   $ADME_HOSTNAME = "<adme-hostname>" # ADME Hostname, e.g. "https://contoso.energy.azure.com"
   $GCZ_DATA_PARTITION_ID = "<data-partition-id>" # ADME Data Partition ID, e.g. "opendes"
   $GCZ_QUERY_URL = "$ADME_HOSTNAME/api/search/v2/query" # ADME Query Endpoint
   $GCZ_QUERY_CURSOR_URL = "$ADME_HOSTNAME/api/search/v2/query_with_cursor" # ADME Query with Cursor Endpoint
   $GCZ_SCHEMA_URL = "$ADME_HOSTNAME/api/schema-service/v1/schema" # ADME Schema Endpoint
   $GCZ_ENTITLEMENT_SERVICE_URL = "$ADME_HOSTNAME/api/entitlements/v2" # ADME Entitlement Service Endpoint
   $GCZ_FILE_RETRIEVAL_URL = "$ADME_HOSTNAME/api/dataset/v1/retrievalInstructions" # ADME File Retrieval Endpoint
   $GCZ_CONVERT_TRAJECTORY_URL = "$ADME_HOSTNAME/api/crs/converter/v3/convertTrajectory" # ADME Convert Trajectory Endpoint
   $GCZ_STORAGE_URL = "$ADME_HOSTNAME/api/storage/v2/records/" # ADME Storage Endpoint
   

   その他の環境変数については、OSDU GitLab のドキュメントを参照してください。

6. テキスト エディターで構成ファイルを開き、必要に応じて値を更新することで、GCZ プロバイダーとトランスフォーマーの構成ファイルを検証します。

   • プロバイダー: C:\gcz\gcz-provider\gcz-provider-core\config\koop-config.json
   • トランスフォーマー: C:\gcz\gcz-transformer-core\config\application.yml

   重要

   構成ファイル内のスキーマを変更する場合は、これらのスキーマが両方の構成ファイルに示されていることを確認する必要があります。

7. (省略可能) Python の依存関係をインストールします (ウェル ログ補間にのみ必要)。

   pip install -r C:\gcz\gcz-transformer-core\src\main\resources\script\requirements.txt --no-index --find-links python-dependencies
   

8. GCZ トランスフォーマーを起動します。

   C:\gcz\transformer\transformer.bat local
   

9. GCZ プロバイダーをビルドします。

   cd C:\gcz\gcz-provider\gcz-provider-core
   npm install
   npm start
   

既定では、プロバイダーは http://localhost:8083 でリッスンしており、トランスフォーマーは http://localhost:8080 でリッスンしています。