ランタイム プレーン コンポーネントを管理する

ここに表示されているのは、Apigee ハイブリッド ドキュメントのバージョン 1.11 です。 詳細については、サポートされているバージョンをご覧ください。

Version 1.11 

サポート対象のバージョン:

• v1.13（最新）
• v1.12
• v1.11
• サポート対象バージョンのリスト

サポートされていないバージョン:

• v1.10
• v1.9
• v1.8
• v1.7
• v1.6
• v1.5
• v1.4
• v1.3
• v1.2
• v1.1

このトピックでは、Apigee Hybrid のランタイム プレーン コンポーネントの構成と管理方法について説明します。構成できるランタイム プレーン コンポーネントの一覧については、ランタイム サービスの構成の概要をご覧ください。

オーバーライド ファイルについて

クラスタに初めてハイブリッド ランタイムをインストールするときに、構成のオーバーライド ファイルを作成する必要があります。このファイルにより、デフォルトの構成値を必要に応じてオーバーライドできます。また、環境の構成、TLS 証明書とサービス アカウント キーのパスの指定、特定のハイブリッド コンポーネントへの Kubernetes ノードプールの割り当てなどの操作を行うことができます。

ハイブリッドのインストール手順を見ると、オーバーライド ファイルを作成してクラスタに構成を適用するプロセスがわかります。後で構成を変更する場合は、作成したオーバーライド ファイルを変更して再度適用します。

構成の変更

ハイブリッド ランタイム プレーン コンポーネントの構成を変更するには、オーバーライド ファイルを編集し、管理ツールに応じて Helm または apigeectl を使用して変更を適用します。

たとえば、Message Processor のレプリカ数を変更する手順は次のとおりです。

1. OVERRIDES.yaml ファイルを開きます。ハイブリッド ランタイムをクラスタにインストールしたときに使用したオーバーライド ファイルを使用してください。
2. ファイル内で runtime 要素を探します。次に例を示します。

   ...
   runtime:
     nodeSelector:
       key: cloud.google.com/gke-nodepool
       value: apigee-runtime
     replicaCountMin: 1
     replicaCountMax: 2
   ...

3. 必要に応じてレプリカ数のプロパティを変更します。次に例を示します。

   ...
   runtime:
     nodeSelector:
       key: cloud.google.com/gke-nodepool
       value: apigee-runtime
     replicaCountMin: 2
     replicaCountMax: 4
   ...

4. Helm

   apigee-org チャートを使用して変更を適用します。

     helm upgrade ORG_NAME apigee-org/ \
       --namespace apigee \
       --atomic \
       -f OVERRIDES_FILE.yaml
     

   注: 「Error: UPGRADE FAILED: "ORG_NAME" has no deployed releases」というエラーが表示された場合は、upgrade を install に置き換えて、コマンドを再度実行してみてください。

   apigeectl

   apigeectl を使用して変更をクラスタに適用します。

   apigeectl apply -f ./OVERRIDES.yaml --org --env ENV_NAME

変更可能な構成プロパティ

構成可能なプロパティの一覧については、構成プロパティのリファレンスをご覧ください。このリファレンスに記載されているのは変更可能なプロパティだけです。ここにないプロパティを変更しようとしても、その変更は無視されます。

構成リファレンスの使用方法

構成プロパティのリファレンスでは、構成要素をドット表記で記述しています。最初の項目は最上位の要素名で、その後ろにプロパティと子プロパティが続いています。次に例を示します。

ao.image.pullPolicy

オーバーライド ファイルでは、プロパティは適切な YAML 形式で記述します。上記の例では、最上位の ao 要素が左にインデントされ、下位要素のプロパティはその下にインデントされています。YAML では、各要素と下位要素の末尾にコロンを付ける必要があります。

たとえば、ao.image.pullPolicy プロパティを Always に設定するには、オーバーライド ファイル内で該当する YAML スタンザを探して次のように設定します。

ao:
  image:
    pullPolicy: Always

次の例では、プロパティ cassandra.auth.admin.password（構成プロパティのリファレンスの表記に準拠）を使用して Cassandra の管理者パスワードを設定しています。これを変更するには、オーバーライド ファイルで次の YAML を探して、次のように設定します。

cassandra:
  auth:
    admin:
      password: abc123

構成プロパティのリファレンスには、ハイブリッド ランタイム プレーン コンポーネントで設定可能なすべてのプロパティが記載されています。クラスタに変更を適用する前に、上のパターンに従ってオーバーライド ファイルでこの要素を変更します。

事前定義されたサンプル オーバーライド ファイルの使用

ハイブリッド ランタイムを初めてインストールする場合は、事前構成されたサンプル オーバーライド ファイルのいずれかを使用することをおすすめします。これらのサンプル ファイルには、本番環境やテスト環境の設定など、具体的なインストール シナリオに合わせてすべての構成プロパティがあらかじめ記述されています。ユーザーが行うことは、プロパティに適切な値を設定してオーバーライド ファイルをクラスタに適用することだけです。詳細については、ステップ 6: クラスタを構成するをご覧ください。

繰り返しになりますが、最初はいずれかのサンプル オーバーライド ファイルを使用することをおすすめします。これらのサンプル ファイルには、実用的なクラスタを設定するために必要なすべての構成が記述されており、設定する値について説明するコメントも付いています。インストール環境が正常に稼働した後、いつでもこのオーバーライド ファイルに戻り、必要に応じて構成を変更できます。

構成のデフォルトについて

デフォルトのコンポーネント構成は HYBRID_ROOT_DIR/config/values.yaml というファイルに保持されています。オーバーライド ファイルは values.yaml と同じ YAML 構造です。

通常、オーバーライド ファイルには values.yaml に記述された構成プロパティの一部だけが含まれます。すべてのプロパティが編集可能なわけではありません。クラスタに構成を適用すると、オーバーライドがデフォルトと結合され、完全な Kubernetes クラスタ構成が作成されます。結合された構成をテストするもご覧ください。

次のコードは、values.yaml に含まれる mart コンポーネントのデフォルト構成を示します。デフォルト値が設定されているものもあれば、されていないものもあります（sslCertPath や sslKeyPath など）。インストール手順で説明されているように、値がないプロパティに値を設定する必要があります。デフォルト値を変更する場合は、構成プロパティのリファレンスを参照して、そのプロパティが編集可能であることを確認してください。

...
mart:
  replicaCountMin: 2
  replicaCountMax: 4
  targetCPUUtilizationPercentage: 75
  terminationGracePeriodSeconds: 30
  sslCertPath:
  sslKeyPath:
  hostAlias:
  nodeSelector:
    key:
    value:
  revision: blue
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-mart-server"
    tag: "1.3.6"
    pullPolicy: IfNotPresent
  resources:
    requests:
      cpu: 500m
      memory: 512Mi
  initCheckCF:
    resources:
      requests:
        cpu: 10m
  livenessProbe:
    timeoutSeconds: 1
    failureThreshold: 12
    periodSeconds: 5
    initialDelaySeconds: 15
  readinessProbe:
    timeoutSeconds: 1
    successThreshold: 1
    failureThreshold: 2
    periodSeconds: 5
    initialDelaySeconds: 15
  metricsURL: "/v1/server/metrics"
  cwcAppend: |
...

コンポーネントのデフォルトを変更するときに、そのコンポーネントがオーバーライド ファイルに含まれていない場合は、values.yaml から該当する YAML をオーバーライド ファイルにコピーし、オーバーライド ファイルでプロパティを変更します。

values.yaml を直接編集しないでください。必ずオーバーライド ファイルを使用して、構成プロパティを指定してください。

サンプル オーバーライド ファイル

Apigee ハイブリッドには、ハイブリッド デプロイメントの設定に役立つサンプル オーバーライド ファイルがいくつか用意されています。インストール要件に最も近いオーバーライド ファイルをコピーして、そのファイルを変更することをおすすめします。

次のサンプル ファイルが HYBRID_ROOT_DIR/examples ディレクトリにあります。

サンプル オーバーライド ファイル	説明
overrides-small.yaml	このサンプルはすぐに使い始める場合に適しています。最小限の推奨フットプリントでハイブリッド ランタイム コンポーネントが起動します。このサンプル構成は、デフォルトの設定と値に可能な限り従っています。レプリカの最小数はすべて 1 に設定されています。
overrides-medium.yaml	このサンプルは、テスト環境や QA 環境の出発点として適しています。追加のトラフィックを処理できるように、より高レベルのリソースが個々のコンポーネントに与えられています。パフォーマンスを考慮して、Cassandra では SSD が使用されます。この環境では、ステートフル コンポーネントとステートレス コンポーネントを別々のノードにインストールすることをおすすめします。専用ノードを構成するをご覧ください。
overrides-large.yaml	このサンプルは、本番前環境や本番環境などの高パフォーマンス環境の出発点として適しています。このサンプルには、暗号鍵やパスワードなどを設定するプロパティが含まれています。個々のコンポーネントには、少なくとも 2 つのレプリカがあります。

カスタム アノテーション

アノテーションは、Apigee ハイブリッド Kubernetes Pod にメタデータを追加するために使用する Key-Value マップです。カスタム アノテーションは、構成プロパティのリファレンスに記載されている次のプロパティに作成できます。

• cassandra
• connectAgent
• logger
• mart
• metrics
• runtime
• synchronizer
• udca
• watcher

カスタム アノテーションを追加するには、それぞれのコンポーネントの OVERRIDES.yaml ファイルにスタンザを追加します。

次の例は、runtime Pod でアノテーションを指定する方法を示しています。

runtime:
  annotations:
    businessunit: "bu1"

結合された構成をテストする

--dry-run フラグを使用すると、結合された構成ファイルを、実際にクラスタに適用せずにテストできます。この方法を使用すると、何がクラスタに適用されるかが正確に示されるため、インストールに関する問題のデバッグに役立ちます。また、構成をテストしてソース管理システムに保存しておくと、クラスタ内にインストールされて構成されているリソースを後で参照できるので便利です。

Helm

kubectl apply -k  apigee-operator/etc/crds/default/
      

helm upgrade operator apigee-operator/ \
  --install \
  --namespace apigee-system \
  --atomic \
  -f OVERRIDES_FILE.yaml \
  --dry-run

helm upgrade ingress-manager apigee-ingress-manager/ /
  --install \
  --namespace apigee \
  --atomic \
  -f OVERRIDES_FILE.yaml \
  --dry-run

apigeectl

APIGEECTL_HOME/apigeectl init -f overrides/OVERRIDES.yaml --dry-run=client

注意: 構成の出力にはパスワードと機密情報が含まれています。

詳細については、apigeectl をご覧ください。

必要に応じて複数のオーバーライド ファイルを作成する

オーバーライド ファイルは、用途に合わせていくつでも作成できます。たとえば、本番環境クラスタを調整するためのオーバーライド ファイルと、テストクラスタを作成するためのオーバーライド ファイルを別々に用意できます。これらのファイルをソース管理システム内に保持できます。

次に例を示します。

Helm

helm upgrade test-1-env apigee-env/ \
  --namespace apigee \
  --atomic \
  --set env=test-1-env \
  -f test-1-env-overrides.yaml

注:「Error: UPGRADE FAILED: "test-1-env" has no deployed releases」というエラーが表示された場合は、upgrade を install に置き換えて、コマンドを再度実行してみてください。

apigeectl

$APIGEECTL_HOME/apigeectl apply -f test-1-env-overrides.yaml --env test-1-env

ハイブリッド固有のランタイム プレーン コンポーネントを削除する

ランタイム プレーン コンポーネントは、synchronizer、mart、runtime、cassandra、udca などがあります。

ハイブリッド固有のランタイム プレーン コンポーネントをクラスタから削除するには、helm delete コマンドまたは apigeectl delete コマンドを使用します。そのランタイム コンポーネントのインストールに使用したのと同じオーバーライド ファイルを指定してください。

次に例を示します。

Helm

Helm を使用するときは、各コンポーネントを個別に削除する必要があります。たとえば、cassandra コンポーネントを削除するには、次のコマンドを使用します。

helm -n apigee delete datastore

上記の例では、データストア コンポーネントは「datastore」という名前でインストールされています。別の名前でインストールした場合は、その名前を指定してコンポーネントを削除します。たとえば、helm install my-cassandra-storage apigee-datastore/ を使用して apigee-datastore チャートをインストールした場合は、削除には次のコマンドを使用します。

helm delete -n apigee my-cassandra-storage

apigeectl

apigeectl では、すべてのランタイム コンポーネントを一度に削除することも、範囲を制限して一度に 1 つのコンポーネントを削除することもできます。たとえば、すべてのコンポーネントを一度に削除するには、次のようにします。

$APIGEECTL_HOME/apigeectl delete -f OVERRIDES_FILE.yaml

cassandra コンポーネントを削除するには:

$APIGEECTL_HOME/apigeectl delete -f OVERRIDES_FILE.yaml --datastore

特定のコンポーネント（この例では環境グループ）を再作成するには:

Helm

helm upgrade ENV_GROUP apigee-virtualhost/ \
  --install \
  --namespace apigee \
  --atomic \
  --set envgroup=ENV_GROUP_NAME \
  -f OVERRIDES_FILE.yaml

apigeectl

$APIGEECTL_HOME/apigeectl apply -f OVERRIDES_FILE.yaml --env ENV_NAME --settings virtualhosts