若要在本機管理 Microsoft Purview Kubernetes SHIR,您需要名為 IRCTL 的命令列工具。 您可以在 SHIR 建立過程中下載此工具。 IRCTL 是管理 Microsoft Purview SHIR 的命令列工具。
必要條件
IRCTL 的系統需求為:
- 執行 IRCTL 的電腦 - 作業系統是支援 TLS 1.2 的 Linux 或 Windows
- 執行 IRCTL 的電腦應該能夠連線到下列端點:
| 網域名稱 | 輸出埠 | 描述 |
|---|---|---|
公有雲: *.compute.governance.azure.comAzure 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 module 命令,將此叢集的認證取得至本機電腦。 上下文可以直接合併到下面的
$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 指令詳細資料
您可以從 Microsoft Purview 中的整合執行階段設定下載 IRCTL 命令列工具。 選取您的整合執行階段,並在 [ 設定 ] 底下看到 [ 下載 IRCTL 並安裝整合執行階段 ] 連結。 選擇它以下載該工具。
您可以使用 IRCTL 命令列來設定或管理 Kubernetes 支援的自我裝載整合執行階段。 使用此語法從終端機視窗執行 IRCTL 命令:
./irctl [command][flags]...
- 命令 指定您要執行的作業
- 旗標 會指定作業的參數
| 命令 | 描述 |
|---|---|
| 組態 | 管理 IRCTL 組態 |
| 建立 | 建立新的 SHIR 資源 |
| 刪除 | 刪除 SHIR 資源 |
| 形容 | 描述在 Kubernetes 叢集上執行的 SHIR |
| 助 | 提供有關任何命令的幫助 |
| 倉庫 | 管理保留給 SHIR 的本機儲存體 |
| 日誌 | 管理 SHIR 的日誌 |
| 升級 | 使用 IRCTL 將 SHIR 升級至相同版本 |
Config
管理 IRCTL 組態。
./irctl config [flags]
./irctl config [command]
| 命令 | 描述 |
|---|---|
| set | 修改一個 SHIR 組態。 |
| 檢視 | 檢視所有 SHIR 組態。 |
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -h,--幫助 | 設定說明 |
組態集
修改一個自我裝載整合執行階段設定。
./irctl config set <config-name> <config-value> [flags]
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -c, --上下文 | 字串 | 要使用的 Kubernetes 環境定義名稱 (如果未指定),則會使用 Kube 組態的目前環境定義。 |
| -h,--幫助 | 設定說明 |
設定檢視
檢視所有 SHIR 組態。
./irctl
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -c, --上下文 | 字串 | 要使用的 Kubernetes 環境定義名稱 (如果未指定),則會使用 Kube 組態的目前環境定義。 |
| -h,--幫助 | 設定說明 |
允許的 SHIR 組態
| 設定名稱 | 組態類型 | 有效值 | 預設值 (值未設定) | 描述 | 重新安裝後持續存在 |
|---|---|---|---|---|---|
| 自動更新已啟用 | 布林值 | 對/錯 | 實 | 控制是否應該自動更新目前的 SHIR。 | 是 |
建立
建立新的 SHIR 資源。
./irctl create [flags]
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -c,--上下文 | 字串 | 要使用的 Kubernetes 環境定義名稱 (如果未指定),則會使用 Kube 組態的目前環境定義 |
| -h,--幫助 | 建立說明 | |
| -r,--註冊金鑰 | 字串 | 註冊 SHIR 的密鑰 |
| -s,--selector | 字串 | 節點選擇器 (要過濾的標籤查詢) ,支援 '='。 (例如,--selector key1=value1,key2=value2) 依指定的標籤選取節點,讓 SHIR 在其上執行。 預設值為空,這表示 SHIR 會在所有節點上執行。 |
例如:
./irctl create --registration-key 1234@keyvalue
升級
將 SHIR 升級至具有 IRCTL 的相同版本。
./irctl upgrade [flags]
./irctl upgrade [command]
| 命令 | 描述 |
|---|---|
| 狀態 | 監控最新 SHIR 升級的狀態。 |
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -c,--上下文 | 字串 | 要使用的 Kubernetes 環境定義名稱 (如果未指定),則會使用 Kube 組態的目前環境定義 |
| -h,--幫助 | 升級說明 |
刪除
刪除 SHIR 資源。
./irctl delete [flags]
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -c,--上下文 | 字串 | 要使用的 Kubernetes 環境定義名稱 (如果未指定),則會使用 Kube 組態的目前環境定義 |
| -h,--幫助 | 刪除幫助 |
形容
描述在 Kubernetes 叢集上執行的 SHIR。
./irctl describe [flags]
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -c,--上下文 | 字串 | 要使用的 Kubernetes 環境定義名稱 (如果未指定),則會使用 Kube 組態的目前環境定義 |
| -h,--幫助 | 描述的幫助 |
儲存體
管理 SHIR 共享存儲中的文件。
./irctl storage [flags]
./irctl storage [command]
| 命令 | 描述 |
|---|---|
| 上傳 | 將檔案上傳至 SHIR 共用儲存。 |
| 清單 | 列出 SHIR 共享儲存中的檔案。 |
| 刪除 | 刪除 SHIR 共享存儲中的文件。 |
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -h,--幫助 | 儲存說明 |
儲存上傳
將檔案上傳至 SHIR 共用儲存。
./irctl storage upload -s <source> -d <destination> [flags]
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -c,--上下文 | 字串 | 要使用的 Kubernetes 環境定義名稱 (如果未指定),則會使用 Kube 組態的目前環境定義。 |
| -d,--目的地字串 | 字串 | 儲存上傳在 SHIR 共用儲存中的檔案/資料夾的路徑。 |
| -h,--幫助 | 刪除幫助 | |
| -s,--來源 | 字串 | 要上傳的檔案/資料夾的路徑。 |
儲存清單
列出 SHIR 共享儲存中的檔案。
./irctl storage list <path> [flags]
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -c,--上下文 | 字串 | 要使用的 Kubernetes 環境定義名稱 (如果未指定),則會使用 Kube 組態的目前環境定義。 |
| -h,--幫助 | 幫助列表。 |
儲存刪除
刪除 SHIR 共享存儲中的文件。
./irctl storage delete <path> [flags]
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -c,--上下文 | 字串 | 要使用的 Kubernetes 環境定義名稱 (如果未指定),則會使用 Kube 組態的目前環境定義。 |
| -h,--幫助 | 刪除幫助。 |
記錄
從 SHIR 記錄作業。
./irctl log [flags]
./irctl log [command]
| 命令 | 描述 |
|---|---|
| 上傳 | 從 SHIR 上傳日誌。 |
| 下載 | 從 SHIR 下載日誌。 |
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -h,--幫助 | 幫助日誌。 |
日誌上傳
從 SHIR 上傳日誌。
./irctl log upload [flags]
./irctl log upload [command]
| 命令 | 描述 |
|---|---|
| 狀態 | 監控 SHIR 日誌上傳的狀態。 |
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -c,--上下文 | 字串 | 要使用的 Kubernetes 環境定義名稱 (如果未指定),則會使用 Kube 組態的目前環境定義。 |
| -h,--幫助 | 上傳幫助。 | |
| -t,--逾時 | int | 記錄上傳作業逾時 (以秒為單位):[900, 3600]。 預設值為 900 秒。 (預設 900) |
日誌下載
從 SHIR 上傳日誌。
./irctl log download [flags]
| 旗 | 參數類型 | 描述 |
|---|---|---|
| -c,--上下文 | 字串 | 要使用的 Kubernetes 環境定義名稱 (如果未指定),則會使用 Kube 組態的目前環境定義。 |
| -d,--目的地 | 字串 | 儲存從 SHIR 下載的記錄的本機路徑。 |
| -h,--幫助 | 下載說明。 |