apigeectl
は、Apigee ハイブリッドを Kubernetes クラスタにインストールして管理するためのコマンドライン インターフェース(CLI)です。apigeectl
のダウンロードとインストールについては、apigeectl のダウンロードとインストールをご覧ください。
apigeectl の構文
apigeectl [command] [flags]
各要素の意味は次のとおりです。
command: 実行するオペレーションを指定します。コマンドの一覧については、apigeectl のコマンドをご覧ください。
flags: コマンド パラメータを指定します。フラグの一覧については、apigeectl のフラグをご覧ください。
apigeectl のコマンド
次の表に apigeectl
のコマンドを示します。
コマンド | 説明 |
---|---|
apply |
Apigee ハイブリッド ランタイム コンポーネントの構成を Kubenetes クラスタに適用します。
|
check‑ready |
ハイブリッド コンポーネント Pod のステータスを確認します。すべてのコンポーネント Pod の準備が完了しているときは、「All containers ready」というメッセージが出力されます。自動スクリプトで使用する場合、このコマンドは、コンテナの準備がすべて完了しているときにステータス 0 で終了します。少なくとも 1 つの Pod の準備ができていない場合は、ステータス 1 で終了します。
|
delete |
ハイブリッド コンポーネントをクラスタから削除します。すべてのコンポーネントを削除するには、
|
help |
オンライン ヘルプを出力します。 |
init |
Istio や ApigeeDeployment などの前提条件コンポーネントの構成をクラスタに適用します。 |
version |
CLI のバージョン情報を出力します。 |
apigeectl のフラグ
次の表に apigeectl
のフラグを示します。
フラグ | 説明 |
---|---|
-c, --components |
コマンドを適用する単一のコンポーネントを指定します。
このフラグを省略すると、クラスタ内のすべてのコンポーネント(デプロイメント全体)にコマンドが適用されます。有効な値は次のとおりです。
例:
複数のコンポーネントを指定する場合は、 |
--dry-run |
実際にはクラスタを変更せずに、指定されたコマンドを実行します。‑‑print-yaml と一緒に使用して、レンダリングされたオブジェクト仕様をファイルに出力します。 |
‑f, ‑‑file‑override‑config |
ハイブリッド デプロイのカスタム構成プロパティを含む YAML ファイルを指定します。デフォルト値は ./overrides.yaml です。apply 、check-ready 、delete 、init コマンドにはオーバーライド ファイルが必要です。このフラグではフルパスを指定する必要があります。詳細については、ランタイム プレーン コンポーネントの管理をご覧ください。 |
-h, --help |
コマンドのヘルプを表示します。 |
--print-yaml |
構成テンプレートの出力を stdout に出力します。このフラグを使用する例については、構成をファイルに出力するをご覧ください。 |
-s, --settings |
コマンドを適用する構成を指定します。現在、このフラグは たとえば、オーバーライド ファイルで apigeectl apply -f my-overrides.yaml --settings virtualhosts -c runtime |
例
クラスタ構成を初期化する
前提条件コンポーネントの構成をクラスタに適用するには、init
を使用します。init
コマンドは apply
の前に実行する必要があります。
apigeectl init -f my_overrides.yaml
クラスタ構成を適用する
ハイブリッド構成を Kubernetes クラスタに適用するには、apply
コマンドを使用します。apply
の初回実行時に、すべてのハイブリッド ランタイム コンポーネントがクラスタで作成されます。構成を変更する場合は、apply
を再度実行して変更した部分のみを適用するか、-c
を使用して特定のコンポーネントの構成のみを適用します。
次の例は、ハイブリッド ランタイム プレーン コンポーネントの構成をクラスタに適用します。
apigeectl apply -f my_overrides.yaml
単一のコンポーネントの構成を適用する
apply
コマンドを特定のコンポーネントに制限するには、apigeectl フラグで説明されているように、-c
フラグを使用します。
次の例は、Synchronizer コンポーネントの構成のみを適用します。
apigeectl apply -c synchronizer -f my_overrides.yaml
次の例は、Cassandra コンポーネントとランタイム コンポーネントの構成のみを適用します。
apigeectl apply -c cassandra,runtime -f my_overrides.yaml
構成をファイルに出力する
インストールの問題をデバッグする場合、クラスタの構成全体をファイルに出力すると、構成の設定を調べるのに便利です。--print-yaml
フラグを指定すると、ハイブリッド構成が stdout に出力されます。また、--dry-run
フラグを使用すると、実際にはクラスタを変更せずにコマンドを実行できます。
apigeectl apply -f my_overrides.yaml --dry-run --print-yaml > apigee-hybrid.yaml
Pod のステータスを確認する
次の例は、クラスタにデプロイされている Pod のステータスを確認します。
apigeectl check-ready All containers ready in namespace 'my-namespace'
クラスタからハイブリッドを削除する
次の例は、ハイブリッド ランタイム コンポーネントのみを Kubernetes クラスタから削除します。すべてを削除するには、--all
フラグを使用します。
apigeectl delete -f my_overrides.yaml