apigeectl

Apigee ハイブリッド ランタイム コンポーネントの構成を Kubernetes クラスタに適用します。

フラグなしの apigeectl apply は、クラスタ内のすべてのコンポーネントに変更を適用します。

apigeectl のフラグ: --all-envs、--datastore、--dry-run、--env、-f、--file-override-config、--help、--org、--print-yaml、--redis、--settings virtualhosts、--telemetry、--v

ハイブリッド コンポーネント Pod のステータスを確認します。すべてのコンポーネント Pod の準備が完了しているときは、「All containers ready」というメッセージが出力されます。自動スクリプトで使用する場合、このコマンドは、コンテナの準備がすべて完了しているときにステータス 0 で終了します。少なくとも 1 つのポッドの準備ができていないときには、ステータス 1 で終了します。

apigeectl のフラグ: -f、--file-override-config、--help、--v

ハイブリッド コンポーネントをクラスタから削除します。すべてのコンポーネントを削除するには、--all フラグを使用します。--all を省略すると、Apigee 固有のコンポーネントのみが削除されます（apigeectl init でインストールされたコンポーネントは削除されません）。Apigee 固有のコンポーネントとは、apply コマンドでインストールされたコンポーネントを指します。

オプションのフラグがない apigeectl delete は、クラスタにデプロイされているすべてのコンポーネントに delete コマンドを適用します。

apigeectl diagnostic delete -f OVERRIDES_FILE により、apigeectl diagnostic によって作成された apigee-diagnostic 名前空間が削除されます。apigeectl diagnostic delete では、-f / --file-override-config フラグが必要です。

apigeectl のフラグ: --all、--all-envs、--datastore、--env、-f、--file-override-config、--help、--org、--redis、--telemetry、--v

診断コレクタを呼び出します。これは、Apigee ハイブリッド インスタンスの Kubernetes コンポーネントで診断データをオンデマンドでキャプチャし、Google Cloud Storage バケットに保存します。

診断コレクタには、名前付きの Google Cloud Storage バケット、Storage 管理者のロールを持つサービス アカウント、overrides ファイルに追加された diagnostic: スタンザが必要です。詳しくは、以下を参照してください。

• 診断コレクタの使用
• 構成プロパティのリファレンス: diagnostic

診断コレクタを呼び出すと、「apigee-diagnostic」という Kubernetes 名前空間が作成されます。診断コレクタを再度呼び出す前に、apigeectl diagnostic delete を使用してこれを削除する必要があります。

診断コレクタを呼び出します。

apigeectl diagnostic -f OVERRIDES_FILE

診断コレクタを削除します。

apigeectl diagnostic delete -f OVERRIDES_FILE

apigeectl のフラグ: --file-override-config

指定した組織、または指定した組織内の指定した環境に対するすべての ApigeeDeployment のエンコードされた名前のリストを返します。エンコードされた名前には、組織の名前をハッシュ化したコンポーネントの名前が含まれます。--env フラグを使用している場合は、環境のハッシュ名も含まれます。Apigee ハイブリッドは、名前空間の競合を回避するため、組織と環境のハッシュ名を作成します。

--org org-name を使用するか、--env env-name フラグと encode を指定した --org org-name を使用する必要があります。例:

./apigeectl encode --org hybrid-example
List of ApigeeDeployments are:
  apigee-connect-agent-hybrid-example-6a82f8a
  apigee-mart-hybrid-example-6a82f8a
  apigee-watcher-hybrid-example-6a82f8a

./apigeectl encode --org hybrid-example --env example-env
List of ApigeeDeployments are:
  apigee-runtime-hybrid-example-example-env-9e87e2d
  apigee-synchronizer-hybrid-example-example-env-9e87e2d
  apigee-udca-hybrid-example-example-env-9e87e2d

apigeectl フラグ: --env、--org

Apigee Operator と CRD を apigee-system の名前空間にインストールします。

新規インストールまたはアップグレードの後、apigeectl apply を実行する前に apigeectl init を実行します。

apigeectl のフラグ: -f、--file-override-config、--help、--v

apigeectl のフラグ: --help

オーバーライド構成ファイルで指定された組織のすべての環境に apigeectl コマンドを適用します。

データストア スコープ（cassandra）に構成を適用します。

--dry-run は、実行中の kubectl のバージョンに応じて、次の 2 つのいずれかの値で使用する必要があります。gcloud version を使用して kubectl のバージョンを確認。

• kubectl バージョン 1.17.x 以前: --dry-run=true
• kubectl バージョン 1.18.x 以降: --dry-run=client

指定した環境に構成を適用します。このフラグは、apigee-runtime、apigee-synchronizer、apigee-udca という環境スコープのコンポーネントに構成を適用します。

--env は、--org フラグとともに使用する必要があります。次に例を示します。

apigeectl apply --org hybrid-example --env example-env \
      -f overrides/overrides.yaml

このフラグではフルパスを指定する必要があります。詳細については、ランタイム プレーン コンポーネントの管理をご覧ください。

指定した組織に構成を適用します。このフラグは、組織スコープ コンポーネント apigee-connect-agent、apigee-mart、apigee-watcher に構成を適用します。

メモリ内データ ストレージ スコープ（Redis）に構成を適用します。

Cassandra を、overrides.yaml ファイルの restore 構成にある snapshotTimestamp プロパティで指定された以前に保存されたスナップショットに復元します。バックアップは、overrides.yaml ファイル内の backup 構成に基づいて、Cloud Storage バケットまたはリモート サーバーのいずれかから復元されます。詳細については、リージョンをバックアップから復元するをご覧ください。

コマンドを適用する構成を指定します。現在、このフラグは runtime コンポーネントの一部である virtualhosts 構成でのみサポートされています。virtualhosts プロパティに変更を加える場合のみに、このフラグを使用します。

たとえば、オーバーライド ファイルで virtualhosts 構成を変更した場合は、次のコマンドを使用してクラスタに適用します。

apigeectl apply -f my-overrides.yaml --settings virtualhosts \
    --org example-org --env example-env

apigee-logger や apigee-metrics などのテレメトリー コンポーネントの構成を適用します。

詳細ログを std err に出力します。 int は、詳細度を設定する整数です。--v には int が必要です。このオプションは、kubectl --v オプションと同じように動作します。