AlloyDB Omni の管理とモニタリング

単一サーバー

AlloyDB Omni は、次の 2 つの場所にアクティビティを記録します。

• AlloyDB Omni は、dataplane.conf 構成ファイルで定義したディレクトリを基準として、data/log/postgres にデータベース アクティビティを記録します。

  このログファイルの名前と形式は、/var/alloydb/config/postgresql.conf で定義されている log_* ディレクティブを使用してカスタマイズできます。詳細については、Error Reporting と Logging をご覧ください。

• AlloyDB Omni は、インストール、起動、シャットダウンのアクティビティを /var/alloydb/logs/alloydb.log に記録します。

サーバーの直近の実行ステータスを確認するには、AlloyDB Omni のステータスを確認するをご覧ください。

Kubernetes

データベース クラスタのログファイルを探す

postgresql.audit ファイルと postgresql.log ファイルは、データベース Pod のファイル システムにあります。これらのファイルにアクセスする手順は次のとおりです。

1. データベース Pod の名前を含む環境変数を定義します。

   export DB_POD=`kubectl get pod -l alloydbomni.internal.dbadmin.goog/dbcluster=DB_CLUSTER_NAME,alloydbomni.internal.dbadmin.goog/task-type=database -o jsonpath='{.items[0].metadata.name}'`

   DB_CLUSTER_NAME は、実際のデータベースの名前に置き換えます。これは、作成時に宣言したデータベース クラスタ名と同じです。

2. データベース Pod でルートとしてシェルを実行します。

   kubectl exec ${DB_POD} -it -- /bin/bash

3. /obs/diagnostic/ ディレクトリでログファイルを探します。

   • /obs/diagnostic/postgresql.audit
   • /obs/diagnostic/postgresql.log

モニタリング サービスの一覧を取得する

kubectl get svc -n NAMESPACE | grep monitoring

al-1060-dbc-monitoring-system   ClusterIP   10.0.15.227   <none>        9187/TCP   7d20h
al-3de6-dbc-monitoring-system   ClusterIP   10.0.5.205    <none>        9187/TCP   7d19h
al-4bc0-dbc-monitoring-system   ClusterIP   10.0.15.92    <none>        9187/TCP   7d19h

kubectl get svc -n NAMESPACE | grep monitoring

al-2953-dbcluster-foo7-monitoring-db           ClusterIP   10.36.3.243    <none>        9187/TCP   44m
al-2953-dbcluster-foo7-monitoring-system       ClusterIP   10.36.7.72     <none>        9187/TCP   44m

コマンドラインから Prometheus 指標を表示する

すべてのモニタリング サービスで、ポート 9187 の名前は metricsalloydbomni です。

1. ローカル環境からモニタリング サービスへのポート転送を設定します。

   kubectl port-forward service/MONITORING_SERVICE -n NAMESPACE MONITORING_METRICS_PORT:metricsalloydbomni
   

   次のように置き換えます。

   • MONITORING_SERVICE: 転送するモニタリング サービスの名前。例: al-1060-dbc-monitoring-system

   • NAMESPACE: クラスタが属する Namespace。

   • MONITORING_METRICS_PORT: ローカルで使用可能な TCP ポート。

   次のレスポンスは、サービスが転送されていることを示しています。

   Forwarding from 127.0.0.1:9187 -> 9187
   Forwarding from [::1]:9187 -> 9187
   

2. 上記のコマンドが実行されている間、指定したポートの HTTP 経由でモニタリング指標にアクセスできます。たとえば、curl を使用すると、すべての指標を書式なしテキストとして表示できます。

   curl http://localhost:MONITORING_METRICS_PORT/metrics
   

Prometheus API を使用して指標を表示する

alloydbomni.internal.dbadmin.goog/task-type ラベルキーと metricsalloydbomni ポートは、AlloyDB Omni のすべてのモニタリング サービスでデフォルトとして使用できます。これらを 1 つの ServiceMonitor カスタム リソースとともに使用すると、データベース クラスタ内のすべての Namespace のすべてのサービスを選択できます。

Prometheus API の使用方法については、Prometheus Operator のドキュメントをご覧ください。

alloydbomni.internal.dbadmin.gdc.goog/task-type ラベルキーと metricsalloydbomni ポートを含む ServiceMonitor カスタム リソースの spec フィールドの例を次に示します。ServiceMonitor カスタム リソースは、すべての Namespace 内のすべての Kubernetes Service をモニタリングして収集します。

ServiceMonitor の完全な定義については、ServiceMonitor カスタム リソース定義をご覧ください。

    spec:
      selector:
        matchLabels:
          alloydbomni.internal.dbadmin.goog/task-type: monitoring
      namespaceSelector:
        any: true
      endpoints:
        - port: metricsalloydbomni

    spec:
      selector:
        matchExpressions:
        - key: alloydbomni.internal.dbadmin.gdc.goog/task-type
          operator: Exists
          values: []
      namespaceSelector:
        any: true
      endpoints:
      - port: metricsalloydbomni

単一サーバー

これらの手順は、AlloyDB Omni バージョン 15.2.0 以降にのみ適用されます。

始める前に

マシンに AlloyDB Omni CLI バージョン 1.2 以降がインストールされている必要があります。

アップグレードを実行する

AlloyDB Omni をアップグレードするには、次のコマンドを実行します。

sudo alloydb database-server upgrade

Kubernetes

Kubernetes で AlloyDB Omni をアップグレードする手順は、実行している AlloyDB Omni のバージョンと、アップグレード後のバージョンによって異なります。

現在のバージョン番号を確認する

データベース クラスタで使用されている AlloyDB Omni のバージョンを確認するには、次のコマンドを実行します。

kubectl get dbclusters.alloydbomni.dbadmin.goog DB_CLUSTER_NAME -n NAMESPACE -o jsonpath='{.status.primary.currentDatabaseVersion}'

次のように置き換えます。

• DB_CLUSTER_NAME: データベース クラスタの名前。これは、作成時に宣言したデータベース クラスタ名と同じです。

• NAMESPACE: データベース クラスタの Kubernetes Namespace。

AlloyDB Omni Operator バージョン 1.0.0 以降を実行している場合、このコマンドはデータベース クラスタで使用されている AlloyDB Omni のバージョンを出力します。

Kubernetes クラスタにインストールされている AlloyDB Omni Operator のバージョンを確認するには、次のコマンドを実行します。

kubectl get dbclusters.alloydbomni.dbadmin.goog DB_CLUSTER_NAME -n NAMESPACE -o jsonpath='{.status.primary.currentControlPlaneAgentsVersion}'

AlloyDB Omni Operator バージョン 1.0.0 以降を実行している場合、このコマンドは Kubernetes クラスタで実行されている AlloyDB Omni Operator のバージョン番号を出力します。

AlloyDB Omni Operator のバージョンが 1.0.0 より前の場合、データベース クラスタまたは AlloyDB Omni Operator のインプレース アップグレードは実行できません。代わりに、1.0.0 より前の AlloyDB Omni Operator からアップグレードするの手順に沿って操作する必要があります。

それ以外の場合は、次のセクションに進みます。

ターゲット バージョン番号を確認する

AlloyDB Omni Operator バージョンが 1.0.0 以降の場合は、アップグレード後の AlloyDB Omni のバージョンによって次の手順が異なります。これには、AlloyDB Omni のバージョン番号を理解する必要があります。

AlloyDB Omni のバージョン番号は 3 つの部分で構成されています。

• PostgreSQL との互換性のメジャー バージョン番号
• PostgreSQL との互換性のマイナー バージョン番号
• この AlloyDB Omni リリースのパッチ バージョン番号

たとえば、AlloyDB Omni バージョン 15.5.2 は、PostgreSQL バージョン 15.5 をサポートする AlloyDB Omni のパッチ バージョン 2 です。

新しいバージョンの PostgreSQL をサポートする AlloyDB Omni のバージョンにアップグレードする場合は、データベース クラスタとともに AlloyDB Omni Operator 自体をアップグレードする必要があります。特定の PostgreSQL マイナー バージョンをサポートする AlloyDB Omni リリースの各セットには、独自の AlloyDB Omni Operator バージョン番号が関連付けられています。このバージョン番号は、AlloyDB Omni バージョンのリリースノートで確認できます。

AlloyDB Omni の新しいパッチ バージョンにのみアップグレードする場合は、データベース クラスタのみをアップグレードできます。AlloyDB Omni Operator 自体をアップグレードする必要はありません。データベース クラスタをアップグレードするの手順に進むことができます。

それ以外の場合は、次のセクションに進みます。

AlloyDB Omni Operator をアップグレードする

AlloyDB Omni Operator をアップグレードする手順は次のとおりです。

1. 必要な環境変数を定義します。

   export GCS_BUCKET=alloydb-omni-operator
   export OPERATOR_VERSION=OPERATOR_VERSION
   export HELM_PATH=$OPERATOR_VERSION/alloydbomni-operator-$OPERATOR_VERSION.tgz

   OPERATOR_VERSION は、アップグレード後の AlloyDB Omni Operator のバージョンに置き換えます（1.1.0 など）。

2. 新しい AlloyDB Omni Operator パッケージをダウンロードします。

   gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive
   tar -xvzf alloydbomni-operator-${OPERATOR_VERSION}.tgz

3. 新しい AlloyDB Omni Operator カスタム リソース定義を適用します。

   kubectl apply -f alloydbomni-operator/crds

4. AlloyDB Omni Operator の Helm チャートをアップグレードします。

   helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
   --namespace alloydb-omni-system \
   --atomic \
   --timeout 5m

Kubernetes マニフェストとデータベース クラスタの両方をアップグレードして AlloyDB Omni Operator のアップグレードを続行するには、前の手順を完了した直後に次のセクションの手順を実施します。

データベース クラスタをアップグレードする

データベース クラスタをアップグレードするには、それを定義するマニフェストの spec セクションで次のフィールドを更新します。

• databaseVersion は、このデータベース クラスタをアップグレードする AlloyDB Omni の完全なバージョン番号に設定します。

• AlloyDB Omni Operator もアップグレードした場合は、controlPlaneAgentsVersion をアップグレード後の AlloyDB Omni Operator の完全なバージョン番号に設定します。

AlloyDB Omni のパッチ バージョンのみをアップグレードする場合（databaseVersion を 15.5.1 から 15.5.2 に更新する場合など）は、この手順のみで完了できます。

PostgreSQL 互換性のマイナー バージョンをアップグレードする場合（databaseVersion を 15.4.1 から 15.5.2 に更新する場合など）は、controlPlaneAgentsVersion も更新する必要があります。その場合は、AlloyDB Omni Operator をアップグレードするに記載されている追加の手順を実施していることを確認してください。

たとえば、次のマニフェストの抜粋では、AlloyDB Omni Operator バージョン 15.5.2 を実行するデータベース クラスタを、AlloyDB Omni Operator バージョン 1.0.0 で定義しています。

apiVersion: alloydbomni.dbadmin.goog/v1 
kind: DBCluster
metadata:
  name: dbcluster-sample
spec:
  databaseVersion: 15.5.2
  controlPlaneAgentsVersion: 1.0.0

この例では、AlloyDB Omni バージョン 15.5.3 を実行するようにデータベース クラスタをアップグレードするには、databaseVersion: 15.5.2 を databaseVersion: 15.5.3 に変更します。

1.0.0 より前の AlloyDB Omni Operator からアップグレードする

AlloyDB Omni Operator のバージョンが 1.0.0 より前の場合、Kubernetes ベースの AlloyDB Omni インストールをアップグレードするには、データをバックアップした後に AlloyDB Omni Operator をアンインストールしてから再インストールする必要があります。手順は次のとおりです。

1. すべてのデータベース クラスタの一覧を取得します。

   kubectl get dbclusters.alloydbomni.dbadmin.goog --all-namespaces

2. データベース クラスタごとに pg_dumpall コマンドを使用して、すべてのデータをエクスポートします。

3. AlloyDB Omni Operator をアンインストールします。ここでは、すべてのデータベース クラスタも削除します。

4. AlloyDB Omni Operator を再インストールします。AlloyDB Omni Operator の以前のバージョンをインストールしたときと同じコマンドを使用できます。新しいバージョン番号を指定する必要はありません。

5. データベース クラスタを再作成します。以前にデータベース クラスタを作成したときに使用したものと同じマニフェスト ファイルを使用できます。AlloyDB Omni Operator のバージョン 1.0.0 で導入された API の変更（古い version 属性に代わる databaseVersion 属性など）を反映するため、ファイルの更新が必要になる場合があります。

6. pg_restore または psql の \i コマンドを使用して、以前にエクスポートしたデータを再作成後のクラスタにインポートします。

単一サーバー

AlloyDB Omni をアンインストールするには、次のコマンドを実行します。

sudo alloydb database-server uninstall

AlloyDB Omni をアンインストールしても、データ ディレクトリはファイル システムに残ります。このディレクトリは、AlloyDB Omni のアンインストール後にデータを保持するかどうか、保持する場合はどのように保持するかに応じて、移動、アーカイブ、削除を行うことができます。

Kubernetes

データベース クラスタを削除する

データベース クラスタを削除するには、マニフェストで isDeleted を true に設定します。この操作を行うには、次のコマンドを実行します。

kubectl patch dbclusters.alloydbomni.dbadmin.goog DB_CLUSTER_NAME -p '{"spec":{"isDeleted":true}}' --type=merge

DB_CLUSTER_NAME は、実際のデータベースの名前に置き換えます。これは、作成時に宣言したデータベース クラスタ名と同じです。

AlloyDB Omni Operator をアンインストールする

Kubernetes クラスタから AlloyDB Omni Kubernetes Operator をアンインストールする手順は次のとおりです。

1. すべてのデータベース クラスタを削除します。

   for ns in $(kubectl get dbclusters.alloydbomni.dbadmin.goog --all-namespaces -o=jsonpath='{range .items[*]}{.metadata.namespace}{"\n"}{end}'); do
   for cr in $(kubectl get dbclusters.alloydbomni.dbadmin.goog -n $ns -o=jsonpath='{range .items[*]}{.metadata.name}{"\n"}{end}'); do
   kubectl patch dbclusters.alloydbomni.dbadmin.goog $cr -n $ns --type=merge -p '{"spec":{"isDeleted":true}}'
   done
   done

2. AlloyDB Omni Kubernetes Operator がすべてのデータベース クラスタを削除するまで待機します。データベース リソースが残っているかどうかを確認するには、次のコマンドを使用します。

   kubectl get dbclusters.alloydbomni.dbadmin.goog --all-namespaces

3. AlloyDB Omni Kubernetes Operator が作成した他のリソースを削除します。

   kubectl delete failovers.alloydbomni.dbadmin.goog --all --all-namespaces
   kubectl delete restores.alloydbomni.dbadmin.goog --all --all-namespaces
   kubectl delete switchovers.alloydbomni.dbadmin.goog --all --all-namespaces

4. AlloyDB Omni Kubernetes Operator をアンインストールします。

   helm uninstall alloydbomni-operator --namespace alloydb-omni-system

5. AlloyDB Omni Kubernetes Operator に関連する Secret、カスタム リソースの説明、Namespace をクリーンアップします。

   kubectl delete certificate -n alloydb-omni-system --all
   kubectl get secrets --all-namespaces -o custom-columns=NAMESPACE:.metadata.namespace,NAME:.metadata.name,ANNOTATION:.metadata.annotations.cert-manager\.io/issuer-name | grep -E 'alloydbomni|dbs-al' | awk '{print $1 " " $2}' | xargs -n 2 kubectl delete secret -n
   kubectl delete crd -l alloydb-omni=true
   kubectl delete ns alloydb-omni-system