apigeectl
は、Apigee ハイブリッドを Kubernetes クラスタにインストールして管理するためのコマンドライン インターフェース(CLI)です。apigeectl
のダウンロードとインストールについては、apigeectl のダウンロードとインストールをご覧ください。
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 のフラグ: |
check‑ready |
ハイブリッド コンポーネント Pod のステータスを確認します。すべてのコンポーネント Pod の準備が完了しているときは、「All containers ready」というメッセージが出力されます。自動スクリプトで使用する場合、このコマンドは、コンテナの準備がすべて完了しているときにステータス 0 で終了します。少なくとも 1 つの Pod の準備ができていない場合は、ステータス 1 で終了します。
apigeectl のフラグ: |
delete |
ハイブリッド コンポーネントをクラスタから削除します。すべてのコンポーネントを削除するには、 オプションのフラグがない
apigeectl のフラグ: |
diagnostic |
診断コレクタを呼び出します。これは、Apigee ハイブリッド インスタンスの Kubernetes コンポーネントで診断データをオンデマンドでキャプチャし、Google Cloud Storage バケットに保存します。 診断コレクタには、名前付きの Google Cloud Storage バケット、Storage 管理者のロールを持つサービス アカウント、 診断コレクタを呼び出すと、「 診断コレクタを呼び出します。 apigeectl diagnostic ‑f OVERRIDES_FILE 診断コレクタを削除します。 apigeectl diagnostic delete ‑f OVERRIDES_FILE apigeectl のフラグ:
|
encode |
指定した組織、または指定した組織内の特定の環境について、すべての ApigeeDeployment のエンコードされた名前のリストを返します。エンコードされた名前には、コンポーネントの名前と、組織のハッシュ名が含まれます。
./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 フラグ: |
help |
オンライン ヘルプを出力します。 |
init |
Apigee Operator と CRD を apigee-system 名前空間にインストールします。
新規インストールまたはアップグレードの後、
apigeectl のフラグ: |
version |
CLI のバージョン情報を出力します。
apigeectl のフラグ: |
apigeectl のフラグ
次の表に apigeectl
のフラグを示します。
フラグ | 説明 |
---|---|
‑‑all |
delete のみ: ASM(Istio)と cert-manager を除く Apigee ハイブリッド インストール全体をクラスタから削除します。 |
‑‑all‑envs |
オーバーライド構成ファイルで指定された組織のすべての環境に |
‑‑datastore |
データストア スコープ(Cassandra)に構成を適用します。 |
‑‑dry‑run |
クラスタを変更せずに、指定されたコマンドを実行します。‑‑print‑yaml と一緒に使用して、レンダリングされたオブジェクト仕様をファイルに出力します。
|
‑‑env env‑name |
指定した環境に構成を適用します。このフラグは、apigee-runtime、apigee-synchronizer、apigee-udca という環境スコープ コンポーネントに構成を適用します。
apigeectl apply ‑‑org hybrid‑example ‑‑env example‑env \ ‑f overrides/overrides.yaml |
‑f |
ハイブリッド デプロイのカスタム構成プロパティを含む YAML ファイルを指定します。デフォルト値は ./overrides.yaml です。apply 、check‑ready 、delete 、init コマンドにはオーバーライド ファイルが必要です。このフラグではフルパスを指定する必要があります。詳細については、ランタイム プレーン コンポーネントの管理をご覧ください。 |
‑h |
コマンドのヘルプを表示します。 |
‑‑org |
指定した組織に構成を適用します。このフラグを指定すると、組織スコープ コンポーネント apigee-connect-agent、apigee-mart、apigee-watcher に構成が適用されます。 |
‑‑print‑yaml |
構成テンプレートの出力を stdout に出力します。このフラグを使用する例については、構成をファイルに出力するをご覧ください。 |
‑‑redis |
メモリ内データ ストレージ スコープ(Redis)に構成を適用します。 |
‑‑restore |
Cassandra を、以前に保存された( |
‑s |
コマンドを適用する構成を指定します。現在、このフラグは たとえば、オーバーライド ファイルで apigeectl apply ‑f my‑overrides.yaml ‑‑settings virtualhosts \ ‑‑org example‑org ‑‑env example‑env |
‑‑telemetry |
apigee-logger や apigee-metrics などのテレメトリー コンポーネントの構成を適用します。 |
‑‑v int |
詳細ログを std err に出力します。 ‑‑verbose オプションに代わるものです。 |
例
クラスタ構成を初期化する
前提条件コンポーネントの構成をクラスタに適用するには、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
Pod のステータスを確認する
次の例は、クラスタにデプロイされている Pod のステータスを確認します。
apigeectl check‑ready ‑f overrides/overrides.yaml All containers ready in namespace 'my-namespace'
クラスタからハイブリッドを削除する
次の例は、ハイブリッド ランタイム コンポーネントのみを Kubernetes クラスタから削除します。すべてを削除するには、‑‑all
フラグを使用します。
apigeectl delete ‑f my_overrides.yaml