このページでは、Kubernetes デプロイオプションを使用する AlloyDB Omni バージョン 17.5.0 について説明します。別のデプロイオプションを選択してください。

Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

Kubernetes に AlloyDB Omni をインストールする

ドキュメントのバージョンを選択してください。

このページでは、AlloyDB Omni Kubernetes Operator の概要と、これを使用して AlloyDB Omni を Kubernetes クラスタにデプロイする手順について説明します。このページでは、Kubernetes のオペレーションについて基本的な知識があることを前提としています。

標準の Linux 環境に AlloyDB Omni をインストールする手順については、AlloyDB Omni をインストールするをご覧ください。

概要

AlloyDB Omni を Kubernetes クラスタにデプロイするには、Google が提供する Kubernetes API の拡張機能である AlloyDB Omni Operator をインストールします。

Kubernetes ベースの AlloyDB Omni データベースクラスタを構成して制御するには、他の Kubernetes ベースのデプロイと同様に、宣言型のマニフェストファイルを kubectl ユーティリティと組み合わせます。AlloyDB Omni CLI は使用しません。これは、Kubernetes クラスタではなく、個々の Linux マシンへのデプロイを目的としています。

ベースイメージ

バージョン 1.5.0 以降では、AlloyDB Omni Operator Kubernetes イメージは Red Hat の Universal Base Image（UBI）9 をベースに構築されています。この移行により、デプロイのセキュリティ、一貫性、コンプライアンスが強化されます。

AlloyDB Omni Operator 1.1.0（以降）の互換性

AlloyDB Omni のバージョン 15.5.3 および 15.5.4 と AlloyDB Omni Operator バージョン 1.1.0 は互換性がありません。これらのバージョンの AlloyDB Omni を使用している場合、次のようなエラーが発生することがあります。

Error from server (Forbidden): error when creating "[...]/dbcluster.yaml": admission webhook "vdbcluster.alloydbomni.dbadmin.goog" denied the request: unsupported database version 15.5.3

始める前に

AlloyDB Omni Operator を使用して Kubernetes クラスタに AlloyDB Omni をインストールする前に、次の要件を満たしていることを確認してください。

ダウンロードオプションまたはインストールオプションを選択する

汎用 Kubernetes クラスタでワークロードを管理する場合は、Helm または OLM を使用できます。Helm は、Helm チャートを使用して、すべての Kubernetes バリアントでオペレーターを含むワークロードをインストールするユニバーサルパッケージマネージャーです。OLM（OpenShift プラットフォームで推奨される標準）は、専用の OLM バンドルを使用してオペレーターのライフサイクルを管理します。

環境とツールに応じて、次のいずれかのデプロイ方法を選択します。

メディア	ダウンロード場所とインストールガイド	デプロイ先
Helm チャートを使用した AlloyDB Omni Operator	Kubernetes に AlloyDB Omni をインストールする	お客様所有の Kubernetes コンテナ環境（オンプレミス、パブリッククラウド、GKE、Amazon EKS、Azure AKS など）ヒント: CD（継続的デリバリー）ツールが Helm と統合されている場合は、このオプションを使用します。
OLM バンドルの AlloyDB Omni Operator	OperatorHub.io	お客様所有の Kubernetes コンテナ環境（オンプレミス、パブリッククラウド、Google Kubernetes Engine、Amazon EKS、Azure AKS など） OLM バンドルを使用するには、オペレーターをインストールする前に Kubernetes クラスタに OLM をインストールします。詳細については、olm.operatorframework.io をご覧ください。ヒント: CD（継続的デリバリー）ツールで OLM がすでに使用されている場合は、このオプションを選択します。
OLM バンドルの OpenShift Operator	OpenShift Container Platform ウェブコンソール	OpenShift 環境 Kubernetes のバリアントである OpenShift は、Operator のパッケージ化とデプロイの標準の組み込みメソッドとして OLM を使用します。

アクセス権の確認

以下に対するアクセス権をあることを確認します。

次のソフトウェアを実行している Kubernetes クラスタ。
- Kubernetes バージョン 1.21 以降。
- cert-manager サービス。
kubectl ユーティリティ。
helm パッケージ管理システムまたは Operator Lifecycle Manager。

ハードウェアとソフトウェアの要件を満たす

Kubernetes クラスタ内の各ノードには、次のものが必要です。

2 個以上の x86 CPU または AMD64 CPU。
8 GB 以上の RAM。
Linux カーネルバージョン 4.18 以降。
コントロールグループ（cgroup）v2 が有効になっている。

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

AlloyDB Omni Operator は、Helm や Operator Lifecycle Manager（OLM）など、さまざまな方法でインストールできます。

Helm

AlloyDB Omni Operator をインストールする手順は次のとおりです。

次の環境変数を定義します。

export HELM_PATH=$(curl https://storage.googleapis.com/alloydb-omni-operator/latest)
export OPERATOR_VERSION="${HELM_PATH%%/*}"

AlloyDB Omni Operator をダウンロードします。

curl -X GET -o "./alloydbomni-operator-${OPERATOR_VERSION}.tgz" "https://storage.googleapis.com/storage/v1/b/alloydb-omni-operator/o/$(echo ${HELM_PATH} | sed 's/\//%2F/g')?alt=media"

AlloyDB Omni Operator をインストールします。

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

インストールが正常に完了すると、次の出力が表示されます。

NAME: alloydbomni-operator
LAST DEPLOYED: CURRENT_TIMESTAMP
NAMESPACE: alloydb-omni-system
STATUS: deployed
REVISION: 1
TEST SUITE: None

クリーンアップするには、ダウンロードした AlloyDB Omni Operator のインストールファイルを削除します。ファイル名は alloydbomni-operator-VERSION_NUMBER.tgz で、現在の作業ディレクトリに配置されます。

OLM

Operator Lifecycle Manager を使用して AlloyDB Omni Operator をインストールする手順は次のとおりです。

AlloyDB Omni Operator ページに移動します。
[Install（インストール）] をクリックします。まだ行っていない場合は、手順に沿って OLM オペレータと OperatorHub.io カタログのみをインストールします。
alloydb-omni-system Namespace がまだ存在しない場合は、作成します。
```
kubectl create ns alloydb-omni-system
```

OLM OperatorGroup を設定して、オペレータがクラスタスコープであることを確認します。

kubectl apply -f - <<EOF
apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
  name: operator-sdk-og
  namespace: alloydb-omni-system
spec:
  upgradeStrategy: Default
EOF

OLM Subscription リソースを使用してオペレーターをインストールします。

kubectl apply -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: my-alloydb-omni-operator
  namespace: alloydb-omni-system
spec:
  channel: stable
  name: alloydb-omni-operator
  source: operatorhubio-catalog
  sourceNamespace: olm
EOF

デフォルトの証明書 ClusterIssuer をインストールします。カスタム証明書発行者を使用する場合は、この手順は省略可能です。
```
kubectl apply -f - <<EOF
apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
  name: alloydbomni-selfsigned-cluster-issuer
spec:
  selfSigned: {}
EOF
```

OLM

注: AlloyDB Omni Operator はコミュニティオペレーターとしてのみ提供されているため、community-operators CatalogSource を有効にする必要があります。Red Hat のドキュメントには、必要に応じてコミュニティカタログを無効にすることができるとの記述があります。

OLM を使用して Red Hat OpenShift 環境に AlloyDB Omni Operator をインストールするには、Red Hat OpenShift ウェブコンソールにログインします。

[Operators] > [OperatorHub] を選択します。
検索フィールドを使用して AlloyDB Omni Operator を見つけます。
[AlloyDB Omni Operator] ペインで、[Install] をクリックします。
デフォルトの証明書 ClusterIssuer をインストールします。カスタム証明書発行者を使用する場合は、この手順は省略可能です。
```
kubectl apply -f - <<EOF
apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
  name: alloydbomni-selfsigned-cluster-issuer
spec:
  selfSigned: {}
EOF
```

GDC 接続ストレージを構成する

AlloyDB Omni Operator を GDC（接続済み）にインストールするには、GDC に接続済みのクラスタではデフォルトのストレージクラスが設定されないため、追加の手順でストレージを構成する必要があります。AlloyDB Omni データベースクラスタを作成する前に、デフォルトのストレージクラスを設定する必要があります。

Symcloud Storage をデフォルトのストレージクラスとして設定する方法については、Symcloud Storage をデフォルトのストレージクラスとして設定するをご覧ください。

他のすべてのストレージクラスのデフォルトを変更する方法については、デフォルトの StorageClass を変更するをご覧ください。

データベースクラスタを作成する

AlloyDB Omni データベースクラスタには、プライマリサーバー、レプリカ、すべてのデータなど、AlloyDB Omni サーバーの実行に必要なすべてのストレージリソースとコンピューティングリソースが含まれています。

AlloyDB Omni データベースクラスタを作成する手順は次のとおりです。

データベースクラスタ専用の Namespace を作成します。これにより、分離性とセキュリティ性が高まります。
```
kubectl create namespace DB_CLUSTER_NAMESPACE
```
DB_CLUSTER_NAMESPACE は、データベースクラスタを作成する Namespace に置き換えます（例: my-db-cluster-namespace）。
次の内容で db-cluster.yaml という名前のマニフェストファイルを作成します。このマニフェストは、データベースパスワードの Secret と DBCluster リソース自体を定義するものです。
```
apiVersion: v1
kind: Secret
metadata:
  name: db-pw-DB_CLUSTER_NAME
  namespace: DB_CLUSTER_NAMESPACE
type: Opaque
data:
  DB_CLUSTER_NAME: "ENCODED_PASSWORD"
---
apiVersion: alloydbomni.dbadmin.goog/v1
kind: DBCluster
metadata:
  name: DB_CLUSTER_NAME
  namespace: DB_CLUSTER_NAMESPACE
spec:
  databaseVersion: "17.5.0"
  # Optional: Specify the base OS type for the database image.
  # Valid values are "Debian" and "UBI9".
  # If not specified, the operator defaults to "Debian" for databaseVersion < 16.9.0
  # and "UBI9" for databaseVersion 16.9.0 or later.
  # databaseImageOSType: "OS_TYPE"
  primarySpec:
    adminUser:
      passwordRef:
        name: db-pw-DB_CLUSTER_NAME
    resources:
      cpu: CPU_COUNT
      memory: MEMORY_SIZE
      disks:
      - name: DataDisk
        size: DISK_SIZE
```
次のように置き換えます。
- DB_CLUSTER_NAME: このデータベースクラスタの名前。例: my-db-cluster
- OS_TYPE: 省略可。データベースイメージのベースオペレーティングシステムのタイプ。有効な値は Debian と UBI9 です。これを指定しない場合、databaseVersion が 16.9.0 より小さい場合は Debian に、databaseVersion が 16.9.0 以上の場合は UBI9 に自動的に設定されます。
- ENCODED_PASSWORD: デフォルトの postgres ユーザーロールのデータベースログインパスワード。base64 文字列としてエンコードされます。例: ChangeMe123 の場合は Q2hhbmdlTWUxMjM=
- CPU_COUNT: このデータベースクラスタ内の各データベースインスタンスで使用できる CPU の数。
- MEMORY_SIZE: このデータベースクラスタのデータベースインスタンスあたりのメモリ量。CPU ごとに 8 GB に設定することをおすすめします。たとえば、このマニフェストの前半で cpu を 2 に設定した場合は、memory を 16Gi に設定することをおすすめします。
- DISK_SIZE: データベースインスタンスあたりのディスクサイズ。例: 10Gi
作成したマニフェストを Kubernetes のクラスタに適用します。
```
kubectl apply -f db-cluster.yaml
```

このマニフェストを適用すると、Kubernetes クラスタに、指定されたメモリ、CPU、ストレージ構成を持つ AlloyDB Omni データベースクラスタが含まれます。新しいデータベースクラスタとのテスト接続を確立するには、事前インストールされた psql を使用して接続するをご覧ください。

Kubernetes マニフェストとその適用方法の詳細については、リソースの管理をご覧ください。