重要
以前Azure Purview) (Microsoft Purview 统一目录和经典 Microsoft Purview 数据治理功能即将停用。 Microsoft 正在 Microsoft Fabric 中整合其数据治理功能。 无法再创建新帐户,现有功能将保持维护模式直至 2027 年 11 月 12 日。 有关停用时间表、过渡指南和建议的后续步骤,请参阅 Microsoft Purview 数据治理停用公告。
若要在本地管理 Microsoft Purview Kubernetes SHIR,需要名为 IRCTL 的命令行工具。 您可以在 SHIR 创建过程中下载此工具。 IRCTL 是用于管理 Microsoft Purview SHIR 的命令行工具。
先决条件
IRCTL 的系统要求是:
- 运行 IRCTL 的机器 - 操作系统是支持 TLS 1.2 的 Linux 或 Windows
- 运行 IRCTL 的计算机应能够连接到以下终结点:
| 域名 | 出站端口 | 说明 |
|---|---|---|
公有云: *.compute.governance.azure.comAzure 政府: *.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 上下文的配置文件,请将其合并到配置文件中,即
$HOME/.kube/config要运行 IRCTL 命令的计算机上的配置文件。 或者,您也可以在名为 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]...
- 命令 指定要执行的操作
- Flags 指定操作的参数
| 命令 | 说明 |
|---|---|
| config | 管理 IRCTL 配置 |
| 创建 | 创建新的 SHIR 资源 |
| delete | 删除 SHIR 资源 |
| 描述 | 描述在 Kubernetes 群集上运行的 SHIR |
| 帮助 | 提供有关任何命令的帮助 |
| storage | 管理为 SHIR 保留的本地存储 |
| log | 管理 SHIR 的日志 |
| 升级 | 使用 IRCTL 将 SHIR 升级到同一版本 |
配置
管理 IRCTL 配置。
./irctl config [flags]
./irctl config [command]
| 命令 | 说明 |
|---|---|
| set | 修改一个 SHIR 配置。 |
| view | 查看所有 SHIR 配置。 |
| Flag | 参数类型 | 说明 |
|---|---|---|
| -h,--help | 有关配置的帮助 |
配置集
修改一个自承载集成运行时配置。
./irctl config set <config-name> <config-value> [flags]
| Flag | 参数类型 | 说明 |
|---|---|---|
| -c, --context | string | 要使用的 Kubernetes 上下文的名称(如果未指定,则使用 Kube config 的当前上下文)。 |
| -h,--help | 有关配置的帮助 |
配置视图
查看所有 SHIR 配置。
./irctl
| Flag | 参数类型 | 说明 |
|---|---|---|
| -c, --context | string | 要使用的 Kubernetes 上下文的名称(如果未指定,则使用 Kube config 的当前上下文)。 |
| -h,--help | 有关配置的帮助 |
允许的 SHIR 配置
| 配置名称 | 配置类型 | 有效值 | 默认值 (值未设置) | 说明 | 通过重新安装仍保留 |
|---|---|---|---|---|---|
| autoUpdate.enabled | 布尔值 | true/false | true | 控制是否应自动更新当前 SHIR。 | 是 |
创建
创建新的 SHIR 资源。
./irctl create [flags]
| Flag | 参数类型 | 说明 |
|---|---|---|
| -c,--context | string | 要使用的 Kubernetes 上下文的名称(如果未指定,则使用 Kube 配置的当前上下文) |
| -h,--help | 帮助创建 | |
| -r,--registration-key | string | 注册 SHIR 的密钥 |
| -s,--selector | string | 节点选择器 (要筛选的标签查询) ,支持“=”。 (例如,--selector key1=value1,key2=value2) 按给定标签选择要运行 SHIR 的节点。 默认为空,这意味着 SHIR 在所有节点上运行。 |
示例:
./irctl create --registration-key 1234@keyvalue
升级
将 SHIR 升级到与 IRCTL 相同的版本。
./irctl upgrade [flags]
./irctl upgrade [command]
| 命令 | 说明 |
|---|---|
| status | 监视最新 SHIR 升级的状态。 |
| Flag | 参数类型 | 说明 |
|---|---|---|
| -c,--context | string | 要使用的 Kubernetes 上下文的名称(如果未指定,则使用 Kube 配置的当前上下文) |
| -h,--help | 升级帮助 |
Delete
删除 SHIR 资源。
./irctl delete [flags]
| Flag | 参数类型 | 说明 |
|---|---|---|
| -c,--context | string | 要使用的 Kubernetes 上下文的名称(如果未指定,则使用 Kube 配置的当前上下文) |
| -h,--help | 帮助删除 |
描述
介绍在 Kubernetes 群集上运行的 SHIR。
./irctl describe [flags]
| Flag | 参数类型 | 说明 |
|---|---|---|
| -c,--context | string | 要使用的 Kubernetes 上下文的名称(如果未指定,则使用 Kube 配置的当前上下文) |
| -h,--help | 帮助描述 |
存储器
管理 SHIR 共享存储中的文件。
./irctl storage [flags]
./irctl storage [command]
| 命令 | 说明 |
|---|---|
| “上传” | 将文件上传到 SHIR 共享存储。 |
| 列表 | 列出 SHIR 共享存储中的文件。 |
| delete | 删除 SHIR 共享存储中的文件。 |
| Flag | 参数类型 | 说明 |
|---|---|---|
| -h,--help | 存储帮助 |
存储上传
将文件上传到 SHIR 共享存储。
./irctl storage upload -s <source> -d <destination> [flags]
| Flag | 参数类型 | 说明 |
|---|---|---|
| -c,--context | string | 要使用的 Kubernetes 上下文的名称(如果未指定,则使用 Kube config 的当前上下文)。 |
| -d,--destination string | string | 存储在 SHIR 共享存储中上传的文件/文件夹的路径。 |
| -h,--help | 帮助删除 | |
| -s,--source | string | 要上传的文件/文件夹的路径。 |
存储列表
列出 SHIR 共享存储中的文件。
./irctl storage list <path> [flags]
| Flag | 参数类型 | 说明 |
|---|---|---|
| -c,--context | string | 要使用的 Kubernetes 上下文的名称(如果未指定,则使用 Kube config 的当前上下文)。 |
| -h,--help | 列表帮助。 |
存储删除
删除 SHIR 共享存储中的文件。
./irctl storage delete <path> [flags]
| Flag | 参数类型 | 说明 |
|---|---|---|
| -c,--context | string | 要使用的 Kubernetes 上下文的名称(如果未指定,则使用 Kube config 的当前上下文)。 |
| -h,--help | 帮助删除。 |
Log
从 SHIR 记录操作。
./irctl log [flags]
./irctl log [command]
| 命令 | 说明 |
|---|---|
| “上传” | 从 SHIR 上传日志。 |
| download | 从 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 | string | 要使用的 Kubernetes 上下文的名称(如果未指定,则使用 Kube config 的当前上下文)。 |
| -d,--destination | string | 存储从 SHIR 下载的日志的本地路径。 |
| -h,--help | 帮助下载。 |