Kubernetes でサポートされているセルフホステッド統合ランタイムの IRCTL
Microsoft Purview Kubernetes SHIR をローカルで管理するには、IRCTL というコマンド ライン ツールが必要です。 このツールは、SHIR の作成プロセス中にダウンロードできます。 IRCTL は、Microsoft Purview SHIR を管理するためのコマンド ライン ツールです。
前提条件
IRCTL のシステム要件は次のとおりです。
- IRCTL を実行しているマシン - OS が Linux または Windows で TLS 1.2 をサポートしています
- IRCTL を実行するマシンは、次のエンドポイントに接続できる必要があります。
ドメイン名 | 送信ポート | 説明 |
---|---|---|
パブリック クラウド: *.compute.governance.azure.com Azure Government: *.compute.governance.azure.us 中国: *.compute.governance.azure.cn |
443 | Microsoft Purview サービスに接続するために必要です。 Microsoft Purview プライベート エンドポイントを使用する場合、このエンドポイントはアカウントのプライベート エンドポイントでカバーされます。 |
-
Kubernetes コンテキスト: Kubernetes クラスター情報と、このクラスターのユーザーのアクセス許可と資格情報を含む Kubernetes コンテキストは、Kubernetes クラスターと通信するために必要です。 SHIR 管理に対するユーザーのアクセス許可の構成を簡単にするために、Kubernetes 管理 ロールから始めることができます。 このコンテキストは、Kubernetes クラスターのセットアップで生成され、構成ファイルに保存されます。 このファイルを取得する場所と方法は、Kubernetes クラスターの設定によって異なります。
-
kubeadm init
を使用して Kubernetes クラスターを設定する場合は、[/etc/Kubernetes/admin.conf
] の下に構成ファイルがあります。 - AKS を使用する場合は、AKS のガイダンスに従って、Az PowerShell モジュール コマンドを使用して、このクラスターの資格情報をローカル コンピューターに取得できます。 コンテキストは、
$HOME/.kube/config
の下の構成ファイルに直接マージできます。 - 他のツールを使用して Kubernetes クラスターを設定している場合は、 Kubernetes のドキュメントを参照してください。
- Kubernetes コンテキストの構成ファイルがある場合は、IRCTL コマンドを実行するコンピューター上の構成ファイル (
$HOME/.kube/config
) にマージします。 または、KUBECONFIG という名前の環境変数で Kubernetes コンテキストの構成ファイルを設定することもできます。 Kubernetes コンテキストの詳細については、「 複数のクラスターへのアクセスを構成する」を参照してください。
-
IRCTL をインストールして実行する
Kubernetes でサポートされているセルフホステッド統合ランタイムを制御および管理するために、ユーザーは IRCTL という名前のコマンド ライン ツールをダウンロードできます。 ユーザーは、IRCTL および kubectl コマンド ラインによってポータルの状態を監視することもできます。 Kubernetes でサポートされているセルフホステッド統合ランタイムの手順を次に示します。
特定のバージョン
特定のバージョンの IRCTL をダウンロードするには、URL のバージョン セグメントを変更します。 https://aka.ms/purview-irctl/irctl-windows-<version>.tar.gz
たとえば、バージョン 1.0.0 の場合: https://aka.ms/purview-irctl/irctl-windows-1.0.0.tar.gz
使用可能な IRCTL バージョンは、 IRCTL リリース ノートに記載されています。
ツールをダウンロードした後:
ツール フォルダーを解凍して開きます。
コマンド ラインからアクセスできるコンピューター上の場所に移動します。
コマンド ラインを開き、IRCTL アプリケーションが格納されているフォルダーに移動します。
次のコマンドを使用して IRCTL を操作し、 次の手順に従って Kubernetes でサポートされている統合ランタイムをインストールします。
IRCTL コマンドの詳細
IRCTL コマンド ライン ツールは、Microsoft Purview の統合ランタイム設定からダウンロードできます。 統合ランタイムを選択し 、[設定] で [ IRCTL をダウンロードして統合ランタイムをインストール する] リンクを表示できます。 ツールをダウンロードするには、それを選択します。
IRCTL コマンド ラインを使用して、Kubernetes でサポートされているセルフホステッド統合ランタイムを設定または管理できます。 ターミナル ウィンドウから IRCTL コマンドを実行するには、次の構文を使用します。
./irctl [command][flags]...
- コマンド は、実行する操作を指定します
- フラグ は、操作のパラメーターを指定します
コマンド | 説明 |
---|---|
config | IRCTL 構成を管理します |
作成 | 新しい SHIR リソースを作成する |
削除 | SHIR リソースを削除する |
写す | Kubernetes クラスターで実行されている SHIR について説明します |
help | 任意のコマンドに関するヘルプを提供します |
貯蔵 | SHIR 用に予約されたローカル ストレージを管理する |
丸太 | SHIR のログを管理する |
アップグレード | IRCTL を使用して SHIR を同じバージョンにアップグレードする |
構成
IRCTL 構成を管理します。
./irctl config [flags]
./irctl config [command]
コマンド | 説明 |
---|---|
set | 1 つの SHIR 構成を変更します。 |
view | すべての SHIR 構成を表示します。 |
Flag | パラメーターの型 | 説明 |
---|---|---|
-h,--help | 構成のヘルプ |
構成セット
1 つのセルフホステッド統合ランタイム構成を変更します。
./irctl config set <config-name> <config-value> [flags]
Flag | パラメーターの型 | 説明 |
---|---|---|
-c、--context | string | 使用する Kubernetes コンテキストの名前 (指定されていない場合)、Kube config の現在のコンテキストが使用されます。 |
-h,--help | 構成のヘルプ |
構成ビュー
すべての SHIR 構成を表示します。
./irctl
Flag | パラメーターの型 | 説明 |
---|---|---|
-c、--context | 文字列 | 使用する Kubernetes コンテキストの名前 (指定されていない場合)、Kube config の現在のコンテキストが使用されます。 |
-h,--help | 構成のヘルプ |
許可される SHIR 構成
構成名 | 構成の種類 | 有効な値 | 既定値 (値の設定解除) | 説明 | 再インストールによる永続化 |
---|---|---|---|---|---|
autoUpdate.enabled | ブール型 | true/false | true | 現在の SHIR を自動更新するかどうかを制御します。 | はい |
Create
新しい SHIR リソースを作成します。
./irctl create [flags]
Flag | パラメーターの型 | 説明 |
---|---|---|
-c,--context | 文字列 | 使用する Kubernetes コンテキストの名前 (指定されていない場合)、Kube config の現在のコンテキストが使用されます |
-h,--help | 作成に関するヘルプ | |
-r,--registration-key | 文字列 | SHIR を登録するキー |
-s,--selector | string | フィルター処理するノード セレクター (ラベル クエリ) では、'=' がサポートされます。 (例,--selector key1=value1,key2=value2)SHIR を実行する特定のラベルでノードを選択します。 既定値は空です。つまり、SHIR はすべてのノードで実行されます。 |
例:
./irctl create --registration-key 1234@keyvalue
アップグレード
IRCTL を使用して SHIR を同じバージョンにアップグレードします。
./irctl upgrade [flags]
./irctl upgrade [command]
コマンド | 説明 |
---|---|
status | 最新の SHIR アップグレードの状態を監視します。 |
Flag | パラメーターの型 | 説明 |
---|---|---|
-c,--context | 文字列 | 使用する Kubernetes コンテキストの名前 (指定されていない場合)、Kube config の現在のコンテキストが使用されます |
-h,--help | アップグレードのヘルプ |
削除
SHIR リソースを削除します。
./irctl delete [flags]
Flag | パラメーターの型 | 説明 |
---|---|---|
-c,--context | string | 使用する Kubernetes コンテキストの名前 (指定されていない場合)、Kube config の現在のコンテキストが使用されます |
-h,--help | 削除のヘルプ |
写す
Kubernetes クラスターで実行されている SHIR について説明します。
./irctl describe [flags]
Flag | パラメーターの型 | 説明 |
---|---|---|
-c,--context | string | 使用する Kubernetes コンテキストの名前 (指定されていない場合)、Kube config の現在のコンテキストが使用されます |
-h,--help | 説明のヘルプ |
ストレージ
SHIR 共有ストレージ内のファイルを管理します。
./irctl storage [flags]
./irctl storage [command]
コマンド | 説明 |
---|---|
アップロード | SHIR 共有ストレージにファイルをアップロードします。 |
リスト | SHIR 共有ストレージ内のファイルを一覧表示します。 |
削除 | SHIR 共有ストレージ内のファイルを削除します。 |
Flag | パラメーターの型 | 説明 |
---|---|---|
-h,--help | ストレージのヘルプ |
ストレージのアップロード
SHIR 共有ストレージにファイルをアップロードします。
./irctl storage upload -s <source> -d <destination> [flags]
Flag | パラメーターの型 | 説明 |
---|---|---|
-c,--context | string | 使用する Kubernetes コンテキストの名前 (指定されていない場合)、Kube config の現在のコンテキストが使用されます。 |
-d,--destination 文字列 | 文字列 | SHIR 共有ストレージにアップロードされたファイル/フォルダーを格納するパス。 |
-h,--help | 削除のヘルプ | |
-s,--source | string | アップロードするファイル/フォルダーへのパス。 |
ストレージの一覧
SHIR 共有ストレージ内のファイルを一覧表示します。
./irctl storage list <path> [flags]
Flag | パラメーターの型 | 説明 |
---|---|---|
-c,--context | 文字列 | 使用する Kubernetes コンテキストの名前 (指定されていない場合)、Kube config の現在のコンテキストが使用されます。 |
-h,--help | 一覧のヘルプ。 |
ストレージの削除
SHIR 共有ストレージ内のファイルを削除します。
./irctl storage delete <path> [flags]
Flag | パラメーターの型 | 説明 |
---|---|---|
-c,--context | 文字列 | 使用する Kubernetes コンテキストの名前 (指定されていない場合)、Kube config の現在のコンテキストが使用されます。 |
-h,--help | 削除のヘルプ。 |
Log
SHIR からのログ操作。
./irctl log [flags]
./irctl log [command]
コマンド | 説明 |
---|---|
アップロード | SHIR からログをアップロードします。 |
ダウンロード | SHIR からログをダウンロードします。 |
Flag | パラメーターの型 | 説明 |
---|---|---|
-h,--help | ログのヘルプ。 |
ログのアップロード
SHIR からログをアップロードします。
./irctl log upload [flags]
./irctl log upload [command]
コマンド | 説明 |
---|---|
状態 | SHIR ログのアップロードの状態を監視します。 |
Flag | パラメーターの型 | 説明 |
---|---|---|
-c,--context | string | 使用する Kubernetes コンテキストの名前 (指定されていない場合)、Kube config の現在のコンテキストが使用されます。 |
-h,--help | アップロードのヘルプ。 | |
-t,--timeout | int | ログのアップロード操作のタイムアウト (秒単位): [900, 3600]。 既定値は 900 秒です。 (既定値は 900) |
ログのダウンロード
SHIR からログをアップロードします。
./irctl log download [flags]
Flag | パラメーターの型 | 説明 |
---|---|---|
-c,--context | 文字列 | 使用する Kubernetes コンテキストの名前 (指定されていない場合)、Kube config の現在のコンテキストが使用されます。 |
-d,--destination | string | SHIR からダウンロードしたログを格納するためのローカル パス。 |
-h,--help | ダウンロードのヘルプ。 |