ジュニパーBNG CUPSコントローラユーティリティコマンドの使用方法

ジュニパーBNG CUPSコントローラ(BNG CUPSコントローラ)をインストールすると、多数の管理機能を実行できます。

ジュニパーBNG CUPSコントローラユーティリティコマンドへのアクセス

BNG CUPSコントローラユーティリティスクリプト(dbng)を使用して、アプリケーションを管理し、操作の設定に使用するCLIにアクセスできます。BNG CUPSコントローラをインストールすると、ユーティリティスクリプトが /usr/local/binに配置されます。

dbngユーティリティスクリプトは、BNG CUPSを管理するために必要なタスクを実行しますが、kubectlコマンドの複雑さを隠します。このkubectlコマンドのマスキングにより、管理作業が簡素化されます。

dbngユーティリティスクリプトは、Kubernetes kubectlユーティリティコマンドを使用して、以下を実行します。

  • オブジェクトを作成および削除します。
  • ポッドコンテナを使用して対話型セッションを実施します。
  • BNG CUPSコントローラオブジェクトのステータスを表示します。

表 1 に 、 dbng ユーティリティースクリプトで呼び出すことができるコマンドと、各コマンドが開始するアクションを示します。

表1:BNG CUPSコントローラユーティリティスクリプトコマンド

コマンド名

アクション

sudo -E dbng clean [--docker] [--release software-release] [--dry-run] [--uninstall]

不要なリリースとDockerキャッシュをクリーンアップします。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • log [error, warning, info, debug]—ログレベルを調整します。

  • no-color—メッセージを色なしで印刷します。

  • docker—ローカルDockerキャッシュのみをクリーンアップし、それ以外のファイルはすべて残ります。

  • release software-release—リリースを指定して、クリーンアップするか、可能なすべてのリリースをクリーニングします。

  • dry-run—削除するリリースとDockerイメージを特定し、コンソールに出力します。このコマンドは、実際にはリリースやDockerキャッシュをクリーンアップしません。

  • uninstall—すべてのBNG CUPSコントローラマテリアルをディスクからアンインストールします。このコマンドは、実行中のアプリケーションには影響しません。

  • clustr-repos—削除されたクラスタのクラスターリポジトリをクリーンアップします。

dbng cli --context context-name [-p|--pipe]

BNG CUPSコントローラ機能の設定に使用できるCLIへのアクセスを提供します。

このコマンドは、以下のオプションを提供します。

  • context context-name—Kubernetesコンテキスト名。コンテキストの名前を入力します。

  • pipe- コマンドに入力をパイプできます。

dbng contexts [-o|--output json]

BNG CUPSコントローラで制御できるコンテキストを表示します。

このコマンドは、以下のオプションを提供します。

  • contexts- 使用可能なコンテキストを一覧表示します。

  • output json—JSON形式での出力をリクエストできます。

sudo -E dbng cpi add --context context-name -h --log --version software-release --ip-aaa ip-address cpi-label

新しいコントロールプレーンインスタンス(CPi)ポッドをデプロイします。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • context context-name—Kubernetesコンテキスト名。コンテキストの名前を入力します。

    注:

    このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

  • h, help—ヘルプメッセージと終了を表示します。

  • l, log [error, warning, info, debug]—ログレベルを調整します。

  • version software-release—新しいCPiポッドのソフトウェアリリース。リリースを入力します。

  • name—新しいCPiの名前。

  • --ip-aaa ip-address— ip-aaa オプションを使用して、CPiのRADIUSリスナーポートに使用する単一の外部IPアドレスを指定します。このアドレスは、複数の地理スイッチオーバー間で同じままです。 ip-aaa オプションには、L3対応のMetalLBインスタンスが必要です。MetalLB BGPピアリングは、アクティブなワークロードクラスター上のCPiにトラフィックを送信するために使用されます。

  • cpi-label—CPiを識別するために使用されるラベルを指定します。

sudo -E dbng cpi rm --context context-name cpi-label

コントロールプレーンインスタンス(CPi)ポッドを削除します。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • context context-name—Kubernetesコンテキスト名。コンテキストの名前を入力します。

    注:

    このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

  • cpi-label—CPiのラベルを指定します。

dbng ip --context context-name [-o| --output json] [--detail]

外部IPアドレスを持つすべてのサービスのIPアドレスを表示します。

このコマンドは、以下のオプションを提供します。

  • context context-name—Kubernetesコンテキスト名。コンテキストの名前を入力します。

    注:

    このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

  • output json—JSON形式での出力をリクエストできます。

  • detail—詳細なIP情報を表示します。

単一地域でのセットアップの使用:sudo -E dbng link --version software-release --context context-name --from-running

複数の地理的セットアップの使用:

sudo -E dbng link --context karmada-context-name --from-running --workload-contexts workload-1-context-name workload-2-context-name --observer-context observer-context-name--version software-release

クラスターを特定のソフトウェアバージョンにリンクします。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • version software-release—クラスター固有のリポジトリにリンクするソフトウェアリリースを指定します。

  • context context-name—ソフトウェアリリースにリンクするKubernetesコンテキスト名。コンテキストの名前を入力します。

  • context karmada-context-name—Karmadaが管理クラスターにインストールされたときに作成されるKarmadaコンテキストのコンテキスト名。複数の地理的な設定でのみ使用されます。コンテキストの名前を入力します。

  • from-running—実行中のBNG CUPSコントローラのソフトウェアリリースを照合しようと試みます。 from-running オプションは、実行中のアプリケーション展開からバージョンとユーザー設定を回復するために使用されます。これは、障害が発生したジャンプホストを回復したり、ジャンプホストのネットワークを同期したりするのに役立ちます。

  • workload-contexts workload-1-context-name workload-2-context-name—2 つのワークロード コンテキスト名。複数の地理的な設定でのみ使用されます。コンテキストの名前を入力します。

  • observer-context management-context-name—管理クラスターのコンテキスト名。複数の地理的な設定でのみ使用されます。コンテキストの名前を入力します。

sudo -E dbng multi-cluster add-cluster workload-context-name--context karmada-context-name

既存の管理コンテキストにワークロードコンテキストを追加します。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • workload-context-name—追加されるワークロードクラスターのコンテキスト名。

  • context karmada-context-name—管理クラスターに関連付けられているKarmadaコンテキストのコンテキスト名。コンテキストの名前を入力します。

注:

このコマンドは、複数の地域設定でのみサポートされます。

sudo -E dbng multi-cluster rm-cluster workload-context-name --context karmada-context-name

既存の管理コンテキストからワークロードコンテキストを削除します。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • workload-context-name—削除されるワークロードクラスターのコンテキスト名。

  • context karmada-context-name—管理クラスターに関連付けられているKarmadaコンテキストのコンテキスト名。コンテキストの名前を入力します。

context karmada-context-name—管理クラスターに関連付けられているKarmadaコンテキストのコンテキスト名。コンテキストの名前を入力します。

注:

このコマンドは、複数の地域に配置された設定でのみサポートされます。

dbng multi-cluster status --context karmada-context-name

アプリケーションの観点からワークロードクラスターのステータスを表示します。

このコマンドは、以下のオプションを提供します。

context karmada-context-name—管理クラスターに関連付けられているKarmadaコンテキストのコンテキスト名。コンテキストの名前を入力します。

注:

このコマンドは、複数の地域設定でのみサポートされます。

sudo -E dbng multi-cluster switchover --context karmada-context-name

他のワークロードクラスターへのスイッチオーバーを開始します。CPi は、他のワークロード クラスターに移動します。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • context karmada-context-name—管理クラスターに関連付けられているKarmadaコンテキストのコンテキスト名。コンテキストの名前を入力します。

注:このコマンドは、複数の地域設定でのみサポートされます。

sudo -E dbng rename-context --context context-name --new-name new-name

コンテキストの名前を変更します。このコマンドは、クラスターで現在実行されているBNG CUPSコントローラには影響しません。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • context context-name—名前を変更する古いKubernetesコンテキスト名。コンテキストの名前を入力します。

  • new-name new-name—Kubernetesコンテキストの新しい名前(クラスター名)。新しい名前を入力します。

注:

このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

sudo -E dbng restart --context context-name [--force] [--wait] microservice-name

特定のBNG CUPSコントローラサービスを再起動します。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • context context-name—サービスを再起動するKubernetesコンテキスト名。コンテキストの名前を入力します。

  • force—安全に再起動できるかどうかを検証せずに、マイクロサービスを強制的に再起動します。

  • wait—新しいポッドが完全に起動するまで待ちます。

  • microservice-name—再起動するマイクロサービス名を入力します。

注:

このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

sudo -E dbng rollout --context context-name [--service service name --version software-release]

BNG CUPSコントローラサービスをアップグレードします。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • context context-name—新しいソフトウェアバージョンをロールアウトするKubernetesコンテキスト名。コンテキストの名前を入力します。

    注:

    このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

  • sevice service name—ロールアウトするマイクロサービス名。マイクロサービスの名前を入力します。

  • version software-release—ロールアウトするソフトウェアリリース。ソフトウェアリリース番号を入力します。

sudo -E dbng setup --context context-name [--help] [--log info] [--no color] [--bbecloudsetup] [--update] [--ssh ip-address:port-number] [--secrets] [--verbose] [--config file-name] [--template file-name] [--mandatory] [--optional]

インストールプロセスの一環として、BNG CUPSコントローラアプリケーションを設定します。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • context context-name—スタートアップを実行するKubernetesコンテキスト名。コンテキストの名前を入力します。

    注:

    このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

  • h, help—ヘルプメッセージと終了を表示します。

  • l, log [error, warning, info, debug]—ログレベルを調整します。

  • no-color—メッセージを色なしで印刷します。

  • bbecloudsetup—BBE Cloudsetupユーティリティが作成したクラスターに一致する運用パラメータを入力するため、セットアッププロセス中にBNG CUPSコントローラと対話する必要はありません。(クラスターのインストール手順については、 BBE Cloudsetup インストールガイド を参照してください)。

    注:

    bbecloudsetupオプションまたはtemplate file-nameオプションのいずれかのみを使用してください。両方のオプションを使用しないでください。

  • update- 設定中にのみ欠損値を入力するよう求められます。

  • ssh ip-address:port-number—コントロールプレーンインスタンスへのSSHを有効にします。コントロールプレーンインスタンスがSSHをリッスンしているSSH IPアドレスとポート番号を入力します(設定で有効になっている場合)。IPアドレスはDNS名にすることもできます。

  • secrets—BNG CUPSコントローラが使用するキー、証明書、およびシークレットを更新します。

  • verbose—プロンプトが提示された各質問の前に詳細な説明を提供します。

  • config file-name—BNG CUPSコントローラが起動時に使用する初期設定ファイル。

  • template file-name—セットアップ中に作成される設定ファイルのサブセットを含むYAML形式のファイル。テンプレート ファイルに入力された値は、設定プロセスで自動的に使用されます。 template オプションを使用する場合、設定プロセス中にテンプレートファイルに含まれる情報を手動で入力する必要はありません。 template オプションは、Red Hat OpenShift Container Platform を使用してクラスターを作成する場合、または複数の地理クラスターを作成する場合にのみ使用してください。 Setuopファイルフィールドの説明では 、 template 設定ファイルに入力する必要がある情報について説明します。

    注:

    bbecloudsetupオプションまたはtemplate file-nameオプションのいずれかのみを使用してください。両方のオプションを使用しないでください。

  • mandatory—セットアップ中に必要な質問のみします。

  • optional—セットアップ中に不要な質問のみします。

dbng shell --context context-name [-p|--pipe] microservice-name

実行中のマイクロサービスに接続します。

このコマンドは、以下のオプションを提供します。

  • microservice-name—接続するマイクロサービスの名前。

  • context—Kubernetesコンテキスト名。コンテキストの名前を入力します。

    注:

    このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

  • pipe- コマンドに入力をパイプできます。

sudo -E dbng start --context context-name

特定のBNG CUPSコントローラサービスを開始します。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • context context-name—BNG CUPSコントローラを起動するKubernetesコンテキスト名。コンテキストの名前を入力します。

    注:

    このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

dbng status --context context-name [-o|--output json] [--terse] [--detail]

BNG CUPSコントローラサービスの現在のステータスを表示します。

このコマンドは、以下のオプションを提供します。

  • context context-name—Kubernetesコンテキスト名。コンテキストの名前を入力します。

    注:

    このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

  • output—JSON形式での出力をリクエストできます。

  • terse—システムの健全性の概要出力を表示します。

  • detail—各ポッドの情報を表示します。

sudo -E dbng stop --context context-name [--now]

すべてのBNG CUPSコントローラサービスを停止します。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • context context-name—BNG CUPSコントローラを停止するKubernetesコンテキスト名。コンテキストの名前を入力します。

    注:

    このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

  • now—2分間の遅延を待つのではなく、BNG CUPSコントローラを直ちに停止します。

dbng storage --context context-name [-o|--output json] [--terse]

BNG CUPSコントローラのストレージドライバのステータスを提供します。

このコマンドは、以下のオプションを提供します。

  • context context-name—Kubernetesコンテキスト名。コンテキストの名前を入力します。

    注:

    このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

  • output—JSON形式での出力をリクエストできます。

  • terse—ストレージの健全性の概要出力を表示します。

sudo -E dbng unlink --context context-name

コンテキストに関連付けられているコンポーネントのリンクを解除します。このコマンドを実行するには、sudo root 権限が必要です。

このコマンドは、以下のオプションを提供します。

  • context context-name—アンインストールするKubernetesコンテキスト名。コンテキストの名前を入力します。
  • 注:

    このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

dbng version [--context context-name] [-o|--output json] [--detail] [--compare] [--release release-number]

以下のバージョンを表示します。

  • BNG CUPSコントローラインスタンスで実行されているすべてのマイクロサービス。

  • BNG CUPSコントローラユーティリティ

  • システムで利用可能なすべてのBNG CUPSコントローラソフトウェアリリース。

このコマンドは、以下のオプションを提供します。

  • context context-name—Kubernetesコンテキスト名。コンテキストの名前を入力します。

    注:

    このコマンドを複数の地理設定で使用する場合は、管理クラスターに関連付けられている Karmada コンテキストのコンテキスト名を入力する必要があります。

  • output—JSON形式での出力をリクエストできます。

  • detail—使用可能なすべてのソフトウェアバージョンを表示します。

  • compare—指定されたリリースを現在実行中のBNG CUPSコントローラリリースと比較します。

  • release release-number—リクエストされたリリースのマイクロサービス情報を表示します。

コマンドを発行するには、以下の一般的な構文を使用します。

  • 短いオプションの場合:

  • 長いオプションの場合:

使用可能なコマンドのリストと簡単な説明を表示するには、 h オプションまたは help オプションを使用します。

特定のコマンドのオプションを表示するには:

BNG CUPSコントローラサービスの開始または停止

dbngユーティリティスクリプトを使用して、すべてのBNG CUPSコントローラサービスを開始または停止します。

  • すべてのBNG CUPSコントローラサービスを開始するには:

  • すべてのBNG CUPSコントローラサービスを停止するには、次の手順に従います。

BNG CUPSコントローラサービスのステータスの確認

dbng statusユーティリティスクリプトを使用して、表2に示した各BNG CUPSコントローラサービス(機能コンポーネント)のステータスを確認します。ステータスには、サービスが実行中か、終了したか、または開始されていないかが表示されます。また、Kubernetesポッドのサービス名も表示されます。サービスの稼働時間を比較して、サービスが再起動されたかどうかをすばやく確認できます。

表2:ステータスコマンドで表示されるサービス

サービス

説明

cpi-label

BNG CUPSコントローラインスタンスサービス—コントロールプレーンプロトコルを含む加入者管理コントロールプレーンを実装します。認証、許可、アカウンティング(AAA)およびサポートインフラストラクチャ。

labelは、dbng cpi addコマンドの実行時にユーザーが定義します。

scache

状態キャッシュサービス— cp サービスによって生成された加入者サービス状態のオンクラスターバッキングストレージを提供します。このサービスは、 cp サービス再起動時の状態回復に使用します。

複数の地域設定では、2 つの scache サービスが表示されます。

configserver

設定ファイルのレプリケーション。

注:

このサービスは、複数の地域設定でのみ使用されます。

bbe-mirp

Multi-geo IP Route Prioritization(MIRP)運用担当者は、インバウンドAAAトラフィックをアクティブなワークロードクラスターに誘導するために、iBGPルーターへの外部AAAアドレス(NAS-IP-Address)のアドバタイズを容易にするために使用されます(cpi addコマンドのip-aaaオプションを参照してください)。

注:

このサービスは、複数の地域設定でのみ使用されます。

bbe-observer

世代番号計算のために、複数のクラスター スケジューリング イベントを監視します。

注:

このサービスは、複数の地域設定でのみ使用されます。

コントローラサービスのステータスを確認するには、サービスステータスを表示します。

次に例を示します。

ジュニパーBNG CUPSロギング

ジュニパーBNG CUPSは、ログ記録にブロードバンドエッジ(BBE)イベント収集および可視化アプリケーションを使用しています。

BBEイベントの収集と可視化は、syslogイベントを収集し、時系列データベースに記録します。記録されたイベントは、BBEイベント収集および可視化ダッシュボードから表示できます。BBEイベント収集および可視化ダッシュボードは、GUIベースの可視化ツールで、定義済みのフィルター(特定の時間範囲内)に従って記録されたイベントを表示できます。ダッシュボードには、複数のソースからの再コーディングされたイベントを関連付けることができる強力な検索および視覚化ツールも用意されています。BBE Event Collection and Visualization をインストールするには、「 Broadband Edge Event Collection and Visualization Installation Guide」を参照してください。

BNG CUPSコントローラのアンインストールと削除

dbngユーティリティスクリプトを使用して、BNG CUPSコントローラ設定をアンインストールします。unlinkコマンドは、BNG CUPSコントローラの設定時に実行したアクションを元に戻します。このスクリプトは、BNG CUPSコントローラを、アプリケーションをインストールした直後、設定を行う前の状態に戻します。

BNG CUPSコントローラをアンインストールするには:

  1. BNG CUPSコントローラをインストールしたジャンプホストで、 stop コマンドを実行します。
  2. unlinkコマンドを実行します。
  3. cleanコマンドを実行します。

BNG CUPSコントローラの設定と操作コマンドへのアクセス方法

BNG CUPSコントローラCLIへのアクセス

BNG CUPSコントローラのコマンドラインインターフェイス(CLI)を使用して、BNG CUPSコントローラを設定し、その動作を監視します。このセクションでは、CLIへのアクセス方法について説明します。

BNG CUPSコントローラのCLIプロンプトにアクセスするには:

  1. 次の dbng ユーティリティスクリプトコマンドを入力します。
  2. 疑問符を入力すると、使用可能なトップレベルのCLIコマンドが表示されます。このコマンドは、Junos OSトップレベルコマンドのサブセットを生成します。

    BNG CUPSコントローラで利用可能なCLIは、Junos OS CLIのサブセットです。Junos OS CLIの基本の概要については、 Day One:Junos CLIの探索を参照してください。詳細については、 『CLIユーザーガイド』を参照してください。

CLI設定ステートメントへのアクセスと使用

設定ステートメントを使用して、BNG CUPSコントローラのプロパティを設定、設定、管理、監視します。

BNG CUPSコントローラコンポーネントを設定するには:

  1. BNG CUPSコントローラユーティリティコマンド dbng cli を使用して、トップレベルのCLIプロンプトにアクセスします。
  2. 設定モードにアクセスして、BNG CUPSコントローラとBNG CUPSコントローラがマネージドルーターの設定に使用する情報を設定します。
  3. CLI ステートメントを入力して、ジュニパー BNG CUPS コンポーネント(BNG CUPS コントローラーおよび BNG ユーザー プレーン)を設定します。
  4. 設定を保存してアクティブ化します。このコマンドは、設定構文エラーがない場合にのみ成功します。
  5. (オプション)設定モードを終了し、最上位の CLI プロンプトに戻ります。

    サポートされている設定ステートメントの一覧については、 ジュニパーBNG CUPSコントローラのCLI設定ステートメントを参照してください。

CLI操作コマンドへのアクセスと使用

運用コマンドを使用して、ジュニパーBNG CUPSの現在のステータスを表示します。運用コマンドを入力して、BNG CUPSコントローラとBNGユーザープレーンを監視およびトラブルシューティングします。

BNG CUPSコントローラを監視するには、BNG CUPSコントローラの設定と統計を表示したり、特定の操作を手動で実行したりします。

  1. BNG CUPSコントローラユーティリティコマンド dbng cli を使用して、トップレベルのCLIプロンプトにアクセスします。
  2. 特定のコマンドを入力します。
    • 統計情報を表示するには、 show コマンドを使用します。

    • requestコマンドを使用して、特定のBNG CUPSコントローラ操作を手動で開始します。

    サポートされている操作コマンドの一覧については、 ジュニパー BNG CUPS コントローラ CLI 操作コマンド を参照してください。