apigeectl

現在、Apigee ハイブリッド バージョン 1.8 のドキュメントを表示しています。このバージョンのサポートは終了しています。新しいバージョンにアップグレードする必要があります。詳細については、サポートされているバージョンをご覧ください。

Version 1.8 (unsupported)

   Supported versions:

• v1.12 (latest)                        
• v1.11                         
• v1.10                                        
• List of supported versions

   Unsupported versions:

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

apigeectl は、Apigee ハイブリッドを Kubernetes クラスタにインストールして管理するためのコマンドライン インターフェース（CLI）です。apigeectl のダウンロードとインストールについては、apigeectl のダウンロードとインストールをご覧ください。

注: apigeectl コマンドを使用するには、Kubernetes 管理マシンに kubectl をインストールして設定しておく必要があります。

apigeectl が適用されるスコープ

apigeectl フラグを使用して、コマンドが構成の変更を適用するスコープを制御できます。Apigee ハイブリッド ランタイム内のスコープの概要については、ランタイム サービス構成の概要をご覧ください。

スコープ	コンポーネント	apigeectl フラグ
ストレージ	Cassandra	‑‑datastore
メモリ内ストレージ	Redis	‑‑redis
環境	ランタイム Synchronizer UDCA	‑‑all‑envs ‑‑env
Organization（組織）	Apigee Connect Agent MART Watcher	‑‑org
レポート	Logger Metrics	‑‑telemetry

apigeectl の構文

apigeectl [command] [flags]

各要素の意味は次のとおりです。

• command: 実行するオペレーションを指定します。コマンドの一覧については、apigeectl のコマンドをご覧ください。

• flags: コマンド パラメータを指定します。フラグの一覧については、apigeectl のフラグをご覧ください。

apigeectl のコマンド

次の表に apigeectl のコマンドを示します。

コマンド	説明
apply	Apigee ハイブリッド ランタイム コンポーネントの構成を Kubernetes クラスタに適用します。 フラグなしの apigeectl apply は、クラスタ内のすべてのコンポーネントに変更を適用します。 apigeectl のフラグ: ‑‑all‑envs、‑‑datastore、‑‑dry‑run、‑‑env、‑f、‑‑file‑override‑config、‑‑help、‑‑org、‑‑print‑yaml、‑‑redis、‑‑settings virtualhosts、‑‑telemetry、‑‑v 注: 新規インストールまたはアップグレード後、apigeectl apply を呼び出す前に apigeectl init を呼び出す必要があります。
check‑ready	ハイブリッド コンポーネント Pod のステータスを確認します。すべてのコンポーネント Pod の準備が完了しているときは、「All containers ready」というメッセージが出力されます。自動スクリプトで使用する場合、このコマンドは、コンテナの準備がすべて完了しているときにステータス 0 で終了します。少なくとも 1 つの Pod の準備ができていない場合は、ステータス 1 で終了します。 apigeectl のフラグ: ‑f、‑‑file‑override‑config、‑‑help、‑‑v
delete	ハイブリッド コンポーネントをクラスタから削除します。すべてのコンポーネントを削除するには、‑‑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
diagnostic	診断コレクタを呼び出します。これは、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
encode	指定した組織、または指定した組織内の特定の環境について、すべての 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
help	オンライン ヘルプを出力します。
init	Apigee Operator と CRD を apigee-system 名前空間にインストールします。 新規インストールまたはアップグレードの後、apigeectl apply を実行する前に apigeectl init を実行します。 apigeectl のフラグ: ‑f、‑‑file‑override‑config、‑‑help、‑‑v
version	CLI のバージョン情報を出力します。 apigeectl のフラグ: ‑‑help

apigeectl のフラグ

次の表に apigeectl のフラグを示します。

フラグ	説明
‑‑all	delete のみ: ASM（Istio）と cert-manager を除く Apigee ハイブリッド インストール全体をクラスタから削除します。
‑‑all‑envs	オーバーライド構成ファイルで指定された組織のすべての環境に apigeectl コマンドを適用します。
‑‑datastore	データストア スコープ（Cassandra）に構成を適用します。
‑‑dry‑run	クラスタを変更せずに、指定されたコマンドを実行します。‑‑print‑yaml と一緒に使用して、レンダリングされたオブジェクト仕様をファイルに出力します。 ‑‑dry‑run は、実行中の kubectl のバージョンに応じて、次の 2 つのいずれかの値で使用する必要があります。kubectl のバージョンの確認には gcloud version を使用してください。 kubectl バージョン 1.17.x 以前: ‑‑dry‑run=true kubectl バージョン 1.18.x 以降: ‑‑dry‑run=client
‑‑env env‑name	指定した環境に構成を適用します。このフラグは、apigee-runtime、apigee-synchronizer、apigee-udca という環境スコープ コンポーネントに構成を適用します。 ‑‑env は、‑‑org フラグとともに使用する必要があります。次に例を示します。 apigeectl apply ‑‑org hybrid‑example ‑‑env example‑env \ ‑f overrides/overrides.yaml
‑f ‑‑file‑override‑config	ハイブリッド デプロイのカスタム構成プロパティを含む YAML ファイルを指定します。デフォルト値は ./overrides.yaml です。apply、check‑ready、delete、init コマンドにはオーバーライド ファイルが必要です。 このフラグではフルパスを指定する必要があります。詳細については、ランタイム プレーン コンポーネントの管理をご覧ください。
‑h ‑‑help	コマンドのヘルプを表示します。
‑‑org	指定した組織に構成を適用します。このフラグを指定すると、組織スコープ コンポーネント apigee-connect-agent、apigee-mart、apigee-watcher に構成が適用されます。 注: encode で ‑‑org を使用する場合、組織 ID を含める必要があります。次に例を示します。 apigeectl encode ‑‑org example‑org
‑‑print‑yaml	構成テンプレートの出力を stdout に出力します。このフラグを使用する例については、構成をファイルに出力するをご覧ください。
‑‑redis	メモリ内データ ストレージ スコープ（Redis）に構成を適用します。
‑‑restore	Cassandra を、以前に保存された（overrides.yaml ファイルの restore 構成にある snapshotTimestamp プロパティで指定された）スナップショットに復元します。バックアップは、overrides.yaml ファイル内の backup 構成に基づいて、Cloud Storage バケットまたはリモート サーバーのいずれかから復元されます。詳細については、リージョンをバックアップから復元するをご覧ください。
‑s ‑‑settings virtualhosts	コマンドを適用する構成を指定します。現在、このフラグは runtime コンポーネントの一部である virtualhosts 構成でのみサポートされています。virtualhosts プロパティに変更を加える場合のみに、このフラグを使用します。 たとえば、オーバーライド ファイルで virtualhosts 構成を変更した場合は、次のコマンドを使用してクラスタに適用します。 apigeectl apply ‑f my‑overrides.yaml ‑‑settings virtualhosts \ ‑‑org example‑org ‑‑env example‑env
‑‑telemetry	apigee-logger や apigee-metrics などのテレメトリー コンポーネントの構成を適用します。
‑‑v int	詳細ログを std err に出力します。int は、詳細度を設定する整数です。‑‑v には int が必要です。このオプションは、kubectl ‑‑v オプションと同じように動作します。 注: このオプションは、非推奨の ‑‑verbose オプションに代わるものです。

apigeectl コマンドは、バックグラウンドで kubectl を使用して処理を実行します。apigeectl コマンドのオプション（apply と delete）と YAML 構成ファイルの使い方は kubectl とほぼ同じです。Kubernetes クラスタでオブジェクトがどのように管理されているかについては、次のトピックをご覧ください。

• 構成ファイルを使用した Kubernetes オブジェクトの命令的管理
• kubectl の概要

例

クラスタ構成を初期化する

前提条件コンポーネントの構成をクラスタに適用するには、init を使用します。init コマンドは apply の前に実行する必要があります。

apigeectl init ‑f my_overrides.yaml

クラスタ構成を適用する

ハイブリッド構成を Kubernetes クラスタに適用するには、apply コマンドを使用します。apply の初回実行時に、すべてのハイブリッド ランタイム コンポーネントがクラスタに作成されます。構成を変更する場合は、apply を再実行して変更のみを適用するか、フラグを使用して特定のスコープのみに変更を適用します。

次の例は、ハイブリッド ランタイム プレーン コンポーネントの構成をクラスタに適用します。

apigeectl apply ‑f my_overrides.yaml

単一のコンポーネントの構成を適用する

apply コマンドを特定のコンポーネントに制限するには、apigeectl フラグで説明されているフラグを使用します。

次の例は、Cassandra コンポーネントの構成のみを適用します。

apigeectl apply ‑‑datastore ‑f my_overrides.yaml

構成をファイルに出力する

インストールの問題をデバッグする場合、クラスタの構成全体をファイルに出力すると、構成の設定を調べるのに便利です。‑‑print‑yaml フラグを指定すると、ハイブリッド構成が stdout に出力されます。また、‑‑dry‑run フラグを使用すると、実際にはクラスタを変更せずにコマンドを実行できます。

apigeectl apply ‑f my_overrides.yaml ‑‑dry‑run=client ‑‑print‑yaml > apigee‑hybrid.yaml

注: 後で参照できるように、YAML の出力をソース管理システムに保存しておくことをおすすめします。ただし、出力ファイルには、保存しない方がよいパスワードや秘密情報が含まれているのでご注意ください。

Pod のステータスを確認する

次の例は、クラスタにデプロイされている Pod のステータスを確認します。

apigeectl check‑ready ‑f overrides/overrides.yaml
All containers ready in namespace 'my-namespace'

クラスタからハイブリッドを削除する

次の例は、ハイブリッド ランタイム コンポーネントのみを Kubernetes クラスタから削除します。すべてを削除するには、‑‑all フラグを使用します。

注:kubectl アンインストールを正常に行うには、kubectl バージョン 1.11.x 以降がインストールされている必要があります。

apigeectl delete ‑f my_overrides.yaml