IRCTL for Kubernetes 支持的自承载集成运行时(预览版)

若要在本地管理 Microsoft Purview Kubernetes SHIR,需要一个名为 IRCTL 的命令行工具。 可以在 SHIR 创建过程中下载此工具。 IRCTL 是用于管理 Microsoft Purview SHIR 的命令行工具。

先决条件

IRCTL 的系统要求包括:

  • 运行 IRCTL 的计算机:OS 是支持 TLS 1.2 的 Linux 或 Windows
  • 运行 IRCTL 的计算机应能够连接到以下终结点:
域名 出站端口 说明
中国:*.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 版本。

下载该工具后:

  1. 解压缩并打开工具文件夹。

  2. 将其移动到计算机上的某个位置,可在其中从命令行访问它。

  3. 打开命令行并导航到托管 IRCTL 应用程序的文件夹。

  4. 使用以下命令与 IRCTL 交互,按照相关步骤安装 Kubernetes 支持的集成运行时

IRCTL 命令详细信息

可从 Microsoft Purview 中的集成运行时设置下载 IRCTL 命令行工具。 选择集成运行时,然后在“设置”下,可以看到“下载 IRCTL 并安装集成运行时”链接。 选择它以下载该工具。

可以使用 IRCTL 命令行设置或管理 Kubernetes 支持的自承载集成运行时。 使用此语法从终端窗口运行 IRCTL 命令:

./irctl [command][flags]...
  • “命令”指定要执行的操作
  • “标志”指定操作的参数
命令 说明
config 管理 IRCTL 配置
create 创建新的 SHIR 资源
delete 删除 SHIR 资源
describe 描述 Kubernetes 群集上运行的 SHIR
help 提供有关任何命令的帮助
storage 管理为 SHIR 保留的本地存储
log 管理 SHIR 的日志
升级 使用 IRCTL 将 SHIR 升级到同一版本

Config

管理 IRCTL 配置。

./irctl config [flags]
./irctl config [command]
命令 说明
set 修改一个 SHIR 配置。
view 查看所有 SHIR 配置。
标记 参数类型 说明
-h,--help 配置帮助

配置集

修改一个自承载集成运行时配置。

./irctl config set <config-name> <config-value> [flags]
标记 参数类型 说明
-c, --context string 要使用的 Kubernetes 上下文的名称,(如果未指定)将使用 Kube 配置的当前上下文。
-h,--help 配置帮助

配置视图

查看所有 SHIR 配置。

./irctl 
标记 参数类型 说明
-c, --context string 要使用的 Kubernetes 上下文的名称,(如果未指定)将使用 Kube 配置的当前上下文。
-h,--help 配置帮助

允许的 SHIR 配置

配置名称 配置类型 有效值 默认值(值未设置) 说明 通过重新安装保持不变
autoUpdate.enabled 布尔 true/false 控制是否应自动更新当前 SHIR。

创建

创建新的 SHIR 资源。

./irctl create [flags]
标记 参数类型 说明
-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

升级

使用 IRCTL 将 SHIR 升级到同一版本。

./irctl upgrade [flags]
./irctl upgrade [command]
命令 说明
status 监视最新 SHIR 升级的状态。
标记 参数类型 说明
-c,--context string 要使用的 Kubernetes 上下文的名称,(如果未指定)将使用 Kube 配置的当前上下文
-h,--help 有关升级的帮助

删除

删除 SHIR 资源。

./irctl delete [flags]
标记 参数类型 说明
-c,--context string 要使用的 Kubernetes 上下文的名称,(如果未指定)将使用 Kube 配置的当前上下文
-h,--help 有关删除的帮助

Describe

描述 Kubernetes 群集上运行的 SHIR。

./irctl describe [flags]
标记 参数类型 说明
-c,--context string 要使用的 Kubernetes 上下文的名称,(如果未指定)将使用 Kube 配置的当前上下文
-h,--help 有关描述的帮助

存储

管理 SHIR 共享存储中的文件。

./irctl storage [flags]
./irctl storage [command]
命令 说明
upload 将文件上传到 SHIR 共享存储。
list 列出 SHIR 共享存储中的文件。
delete 删除 SHIR 共享存储中的文件。
标记 参数类型 说明
-h,--help 有关存储的帮助

上传存储

将文件上传到 SHIR 共享存储。

./irctl storage upload -s <source> -d <destination> [flags]
标记 参数类型 说明
-c,--context string 要使用的 Kubernetes 上下文的名称,(如果未指定)将使用 Kube 配置的当前上下文。
-d,--destination string string 存储上传到 SHIR 共享存储的文件/文件夹的路径。
-h,--help 有关删除的帮助
-s、--source string 要上传的文件/文件夹的路径。

列出存储

列出 SHIR 共享存储中的文件。

./irctl storage list <path> [flags]
标记 参数类型 说明
-c,--context string 要使用的 Kubernetes 上下文的名称,(如果未指定)将使用 Kube 配置的当前上下文。
-h,--help 有关列表的帮助。

删除存储

删除 SHIR 共享存储中的文件。

./irctl storage delete <path> [flags]
标记 参数类型 说明
-c,--context string 要使用的 Kubernetes 上下文的名称,(如果未指定)将使用 Kube 配置的当前上下文。
-h,--help 有关删除的帮助。

日志

来自 SHIR 的日志操作。

./irctl log [flags]
./irctl log [command]
命令 说明
upload 从 SHIR 上传日志。
下载 从 SHIR 下载日志。
标记 参数类型 说明
-h,--help 有关日志的帮助。

日志上传

从 SHIR 上传日志。

./irctl log upload [flags]
./irctl log upload [command]
命令 说明
状态 监视 SHIR 日志上传的状态。
标记 参数类型 说明
-c,--context string 要使用的 Kubernetes 上下文的名称,(如果未指定)将使用 Kube 配置的当前上下文。
-h,--help 有关上传的帮助。

下载日志

从 SHIR 上传日志。

./irctl log download [flags]
标记 参数类型 说明
-c,--context string 要使用的 Kubernetes 上下文的名称,(如果未指定)将使用 Kube 配置的当前上下文。
-d,--destination string 存储从 SHIR 下载的日志的本地路径。
-h,--help 有关下载的帮助。

后续步骤