@clickzetta/cz-cli-darwin-x64 0.3.1

package/bin/skills/lakehouse-doc/references/alert.md

@@ -0,0 +1,143 @@
+# 监控告警
+
+## 简介
+
+监控告警系统为您提供了强大的监控任务运行状态和异常情况的功能。通过使用系统内置的规则或创建自定义规则，您可以实时监控任务运行状态，并在发生异常时接收告警信息。本指南将帮助您了解监控告警系统的核心概念、功能和操作步骤。
+
+## 核心概念
+
+1. **系统消息**：系统内部产生的全量消息，包含产品、模块、对象和消息内容等关键属性。系统消息是监控规则和告警事件的基础。
+2. **监控规则**：用户定义的一组配置信息，用于筛选关注的关键系统消息。监控规则帮助您确定哪些消息需要关注。
+3. **告警事件**：基于监控规则筛选出的系统消息。告警事件将显示在产品界面上，供用户查看和处理。
+4. **告警消息推送**：在告警事件发生后，根据配置的通知策略（如电话、短信等），将告警通知发送给相应的接收人。
+
+## 告警事件列表
+
+在告警事件列表中，您可以查看当前实例下所有触发监控规则的告警信息。针对列表中的告警事件，您可以执行以下操作：
+
+- **抑制**：设置当前告警事件在指定时间内不再发送消息。
+- **关闭**：关闭当前告警事件，停止接收此类消息。
+
+![](https://tq2pllvokz.feishu.cn/space/api/box/stream/download/asynccode/?code=MWNiN2NjNWRlMWRkNDE3YjE3ZDhiMzg5NDJmMjlkYmFfVlVZd0dCQXFCeGFtaUVjSFY5U0NEeDlvN3RJS1ozNVdfVG9rZW46SjFVdmIyY2dEb2pWbXR4cFcwTGNMVlNMblFlXzE2ODk1NjM4OTk6MTY4OTU2NzQ5OV9WNA)
+
+### 告警消息列表
+
+告警消息列表展示了实际触发的通知策略产生的所有消息通知。这些通知是通过告警事件触发的。
+
+![](https://tq2pllvokz.feishu.cn/space/api/box/stream/download/asynccode/?code=N2ZlNDAzOGY2MTI4MGY4Yjk3NTZlYTgyNjgxZGFiN2Vfd1dRU09FblNYc2Z0MVhJR3N5cXJCQUt1UlpFSHAxYUlfVG9rZW46RGxDUGJJWjd2b053dDl4aFlsYmN3NUNobk5oXzE2ODk1NjM4OTk6MTY4OTU2NzQ5OV9WNA)
+
+### 监控规则列表
+
+监控规则列表展示了当前已配置的所有规则。您可以对列表中的规则进行筛选和操作，如查看详情、开启/关闭、复制、编辑和订阅/取消订阅。
+
+![](https://tq2pllvokz.feishu.cn/space/api/box/stream/download/asynccode/?code=ZDdjYzc3NjZmNzAxNjI3YjFhZDcyNWViNzA5MzA5ZTJfYjhhamdDS0pycExXUnRqZjE3NGFib3BYODlUdUZ0Y3pfVG9rZW46T2l4RGJETGdMb0x3UHZ4N0tnZWM5M0NIbldnXzE2ODk1NjM4OTk6MTY4OTU2NzQ5OV9WNA)
+
+对于单条规则，可以进行如下操作：
+
+| **操作名称** | **行为定义**                 | **可操作人员**    |
+| -------- | ------------------------ | ------------ |
+| 查看详情     | 打开监控告警规则的详情页面，查看完整信息     | 对实例成员全部开放    |
+| 开启/关闭    | 设定告警规则启用或停止               | 实例管理员、实例运维角色 |
+| 复制       | 基于当前规则，复制其配置属性，以产生新的规则   | 实例管理员、实例运维角色 |
+| 编辑       | 通过合适的交互方式，支持用户修改监控规则的属性 | 实例管理员、实例运维角色 |
+| 订阅/取消订阅  | 把操作者自身加入/移出告警接收人         | 对实例成员全部开放    |
+
+#### 系统内置规则
+
+产品提供了一些全局的内置监控规则，您可以根据需要启用它们。
+
+| **规则名称**   | **规则作用**                       | **默认启停状态** |
+| ---------- | ------------------------------ | ---------- |
+| 通用规则监控任务失败 | 用以全局监控任务实例失败的默认规则，在实例失败时触发监控告警 | 默认状态为关闭 |
+
+## 新建监控规则
+
+要创建自定义监控规则，请按照以下步骤操作：
+
+1. 点击“新建规则”按钮。
+2. 填写基础信息，包括规则名称、描述和告警等级。
+3. 设置触发条件，包括监控消息和过滤条件。
+4. 配置监控通知，包括通知策略、告警订阅和Webhook通知。
+5. 选择通知开始和结束时间。
+| 分类   | 参数        | 描述                                                                                                  |
+| ---- | --------- | --------------------------------------------------------------------------------------------------- |
+| 基础信息 | 名称        | 输入新建自定义规则的名称。                                                                                       |
+|      | 描述        | 非必填，您可以添加当前规则的描述信息，或填写在收到报警后，相关的处理方式等。                                                              |
+|      | 告警等级      | 高危：使用所有告警通道发送，含电话
严重：使用所有告警通道发送，含电话
警告：系统内、邮件、短信、Webhook，不含电话
提醒：系统内、邮件、Webhook，不含电话、短信 |
+| 触发条件 | 监控消息      | 具体的监控对象                                                                                             |
+|      | 过滤条件      | 对消息的过滤条件，多个条件之间是“且”的关系                                                                              |
+| 监控通知 | 通知策略      | 点击下拉框直接选择在「通知策略」中管理的信息，或者点击+号新建通知策略。具体通知策略的配置见“通知策略”章节。                                               |
+|      | 告警订阅      | 下拉选择针对该规则需要通知到的具体人                                                                                  |
+|      | Webhook通知 | 选择通知方式，目前支持的通知类型有：钉钉、飞书、微信（即将就绪）。                                                              |
+|      | 通知开始时间    | 监控规则触发后发送通知的开始时间                                                                                    |
+|      | 通知结束时间    | 监控规则触发后发送通知的结束时间                                                                                    |
+
+
+## 通知策略列表
+
+通知策略列表展示了所有定义好的通知策略。您可以在列表中进行搜索和过滤操作。
+
+![](https://tq2pllvokz.feishu.cn/space/api/box/stream/download/asynccode/?code=ZWFmNTliY2NmMjJjMzJlNDM5NmMxZjc1MDAwN2RmOGFfRkd3NUltb1lwaTVSZlY0RkZyWHJPVU50VVpyT3h2R21fVG9rZW46TGFqZGJzbm5hb0tscVd4UzJkSGN4ZzhKbktkXzE2ODk1NjM4OTk6MTY4OTU2NzQ5OV9WNA)
+
+#### 新建通知策略
+
+要创建新的通知策略，请按照以下步骤操作：
+
+1. 点击“新建策略”按钮。
+2. 填写基础信息，包括策略名称和描述。
+3. 配置通知方式，包括针对不同告警等级的具体通知设置。
+4. 设置通知时间，包括发送间隔、最大发送次数、免打扰开始和结束时间。
+
+![](https://tq2pllvokz.feishu.cn/space/api/box/stream/download/asynccode/?code=M2UzYTZhYzNmYzliNjI3YmRiMTNlYmZlYmZkZjk2YjZfUmF2VmhSdkp5TWFjWlpBUmt1VDRTTjFibDBsMEdNQW9fVG9rZW46QlBZZGI0OXVnbzA5aFN4TzcwamNiYUh6blJiXzE2ODk1NjM4OTk6MTY4OTU2NzQ5OV9WNA)
+
+| **分类** | **参数**   | **描述**                                                                                                                 |
+| ------ | -------- | ---------------------------------------------------------------------------------------------------------------------- |
+| 基础信息   | 名称       | 通知策略的名称                                                                                                                |
+|        | 描述       | 非必填，您可以添加当前策略的描述信息                                                                                                     |
+| 通知方式   | 高危告警     | 针对不同告警等级设置通知的具体方式，支持的方式有：Webhook                                                                                     |
+|        | 严重告警     | 同上                                                                                                                     |
+|        | 警告告警     | 同上                                                                                                                     |
+|        | 提醒告警     | 同上                                                                                                                     |
+| 通知时间   | 发送间隔（分钟） | 两次报警之间的时间间隔。                                                                                                           |
+|        | 最大发送次数   | 报警的最大次数，超过设置的次数后，不再产生报警。                                                                                               |
+|        | 免打扰开始时间  | 设置了免打扰时间后，则在该时间段内系统将不会发送告警。例如，当设置了任务状态为运行失败时触发报警，且该任务设置的免打扰时间为00：00到08：00，则该时间段内将不会发出报警信息，如果到达8点，任务仍处于上述异常状态，将会发出报警信息。 |
+|        | 免打扰结束时间  | 同上                                                                                                                     |
+
+## 配置管理
+
+在配置管理中，您可以对个人信息和Webhook进行配置。
+
+### 个人配置
+
+在个人配置中，您可以修改当前登录用户的手机号和邮箱地址，以及设置免打扰时段。
+
+![](https://tq2pllvokz.feishu.cn/space/api/box/stream/download/asynccode/?code=Yzc4MmIyMmI4MWRkMDM3MzU1Nzc3Y2Q5N2MzNTZmMzRfNklQakhNNWNnS0RtcnBqdTVHdmFVNUIxMHloVXFpS0FfVG9rZW46V1FPR2JTUlVpb2VkY3Z4MnVwbWN4ZmxObkZiXzE2ODk1NjM4OTk6MTY4OTU2NzQ5OV9WNA)
+
+#### Webhook配置
+
+Webhook配置用于定义告警推送所需的Webhook渠道。当前支持飞书和钉钉。
+
+![](https://tq2pllvokz.feishu.cn/space/api/box/stream/download/asynccode/?code=NmYwYTIwMzIzNTJmZWQ0MzcwMDE0MGI1MjdiNzRmNzhfdzBLUlJPVWtlemdDNkFxaUFHYU5hREY1ZGNQV2FsQlFfVG9rZW46VXV4bGJJOG9Eb1llbzN4Z0lZaWNhMkQ3bmtiXzE2ODk1NjM4OTk6MTY4OTU2NzQ5OV9WNA)
+
+#### 新建Webhook配置
+
+要创建新的Webhook配置，请按照以下步骤操作：
+
+1. 点击“新建配置”按钮。
+2. 填写所需的参数，如Webhook名称、描述、地址等。
+3. 在Webhook地址后进行测试，确保测试通过后，点击“确定”保存。
+
+![](https://tq2pllvokz.feishu.cn/space/api/box/stream/download/asynccode/?code=ZTA4ZmFlOTkwMmFiOTg4NTNlZTEwNTQzNDAwZWM4NmZfT0xwVjFJWlFjMmxkV05kdmhUaEhzN3FWc0tRS2VZSG9fVG9rZW46UU5jQmJLM3Q4b2R5YTN4M0NVdmNzQklobjBnXzE2ODk1NjM4OTk6MTY4OTU2NzQ5OV9WNA)
+
+
+### 钉钉告警配置
+
+在配置钉钉告警时，请确保钉钉机器人的安全策略满足以下要求：
+
+- 将安全级别设置为“所有人均可接收”。
+- 将加签设置为“不需要加签”。
+
+通过以上步骤，您可以轻松地创建和配置监控告警规则，确保在任务运行异常时及时收到通知。请注意，本指南中提到的操作和设置可能因产品版本更新而有所变化，请根据实际情况进行调整。
+
+
+![](https://tq2pllvokz.feishu.cn/space/api/box/stream/download/asynccode/?code=MDQ4OWU3MTc2MjA2YjJhOTBmMDFjNTc0ZjRhMGY4ZDlfME5IWGVCREc1UkRpSlRBWDBGU2JRNm96MUYyTTFvMGRfVG9rZW46WHZxc2JkTk5nb0Z2cHZ4YnFpcmNWeVBMbnNmXzE2ODk1NjM4OTk6MTY4OTU2NzQ5OV9WNA)

package/bin/skills/lakehouse-doc/references/alicloud-arn-externalid.md

@@ -0,0 +1,51 @@
+# 获取ARN和ExternalID
+
+在配置 Private Link 访问 Lakehouse 网络时，为保障 Lakehouse 能够正常读取您云平台账号内的终端节点状态，并增强该获取方式的安全性，请在云服务平台内创建独立的访问控制角色，并授权及添加 External ID。具体操作如下。
+
+## 阿里云
+
+**获取 ARN 方式**：
+
+首先，需要在阿里云访问控制页面（<https://ram.console.aliyun.com/roles>）点击“新建角色”，并选择可行实体类型为：阿里云账号：
+
+:-: ![](.topwrite/assets/image_1733068362672.png =424)
+
+^
+
+在角色名称中填入自定义角色名称；
+
+在“选择信任的云账号”中选择“其他云账号”，并复制 Lakehouse 终端节点服务的 LakehouseUID 内容填入。
+
+:-: ![](.topwrite/assets/image_1733068490413.png =648)
+
+^
+
+角色创建完成后，点击“为角色授权”，并点击“新建授权”；
+
+:-: ![](.topwrite/assets/image_1733068711869.png =673)
+
+^
+
+搜索“privatelink”，并勾选 AliyunPrivateLinkReadOnlyAccess 和 AliyunPrivateLinkEndpointServiceReadOnlyAccess 两个策略；
+
+:-: ![](.topwrite/assets/image_1733068776650.png =687)
+
+^
+
+完成“确认新增授权”后，切换到“信任策略”页签，并点击“编辑信任策略”：
+
+:-: ![](.topwrite/assets/image_1733068938505.png =685)
+
+在 "Action": "sts:AssumeRole" 和 "Effect": "Allow" 之间粘贴以下内容：
+
+```
+"Condition": {
+        "StringEquals": {
+          "sts:ExternalId": "请替换成自定义的externalID"
+        }
+      },
+```
+
+粘贴完成后，保存信任策略。
+
+^

package/bin/skills/lakehouse-doc/references/alicloud_byos_configration.md

@@ -0,0 +1,129 @@
+# 阿里云私有存储配置
+
+本指南将帮助您在阿里云对象存储服务（OSS）上配置BYOS（私有存储），使ClickZetta Lakehouse能够使用您的OSS存储桶作为数据存储位置。
+
+## 前提条件
+
+* 拥有阿里云账号并开通OSS服务
+* 了解您的ClickZetta Lakehouse实例所在的云平台和地域（Region）
+* 拥有OSS存储桶的管理权限
+
+## 步骤一：准备OSS存储桶
+
+### 创建新存储桶（推荐）
+
+如果您选择创建新的存储桶专用于ClickZetta Lakehouse：
+
+1. **登录阿里云OSS控制台**
+
+   访问：<https://oss.console.aliyun.com>
+
+2. **点击“创建Bucket”**
+
+:-: ![](/.topwrite/assets/image_1760269133038.png =712)
+
+**配置Bucket基本信息**
+
+| 配置项          | 设置值                           | 说明                                                                |
+| ------------ | ----------------------------- | ----------------------------------------------------------------- |
+| **Bucket 名称** | 自定义（如：`my-company-lakehouse`） | 全局唯一，建议包含用途标识                                                     |
+| **地域**       | 与 Lakehouse 实例相同                | ⚠️ **关键要求**：必须选择与 ClickZetta Lakehouse 实例相同的地域                      |
+| **存储类型**     | 标准存储                          | 避免使用低频或归档存储，频繁读取会产生超额取回费用。                                         |
+| **存储冗余类型**   | 本地冗余存储（LRS）                   | 可根据需求选择同城冗余存储（ZRS）。                                                 |
+| **读写权限**     | 私有                            | 确保数据安全。                                                           |
+| **服务端加密**    | 无                             | Lakehouse 会自行管理加密，全局加密可能影响性能。                                      |
+| **版本控制**     | 关闭                            | 避免产生额外费用。                                                          |
+| **定时备份**     | 关闭                            | 对象存储内的备份由于缺少元数据，单独备份出的数据不可读。如需备份，可使用 Lakehouse 的 Time Travel 功能进行备份。 |
+
+***
+
+### 使用已有存储桶
+
+如果您选择使用已有的存储桶：
+
+#### 验证地域配置
+
+存储桶必须与 ClickZetta Lakehouse 实例在同一地域（Region）。例如：
+- Lakehouse 实例在：阿里云华东 2（上海）
+- OSS Bucket 必须在：华东 2（上海）
+
+您的服务实例所在“云服务商和地域”信息可在服务实例首页查询到：
+
+:-: ![](/.topwrite/assets/image_1760270239517.png =747)
+
+#### 选择存储路径
+
+您可以选择以下方式之一：
+
+**方式一：使用整个 Bucket（推荐）**
+
+适用场景：Bucket 专用于 Lakehouse
+
+**方式二：使用 Bucket 下的特定目录**
+
+适用场景：需要在同一 Bucket 中隔离不同用途的数据
+
+***
+
+**数据安全警告**：
+
+1.  请确保所选路径不与其他业务系统共用。
+2.  ClickZetta Lakehouse 会对该路径下的文件进行读、写、删除操作。
+3.  共用路径可能导致：
+    *   数据被意外删除或覆盖。
+    *   影响其他业务系统的正常运行。
+    *   数据一致性问题。
+
+建议：为 Lakehouse 创建独立的 Bucket 或使用独立的目录。
+
+### 记录必要信息
+
+请记录以下信息，后续配置时需要使用：
+
+* **Bucket名称**
+* **Bucket所在地域**
+* **存储路径**（如使用子目录）
+* **您的阿里云主账号ID**
+
+查看主账号ID的方法：
+
+1. 登录阿里云控制台
+2. 点击右上角头像
+3. 在"账号信息"中查看"账号ID"
+
+## 步骤二：配置Bucket访问策略
+
+**1. 进入 Bucket 管理页面**
+
+*   在 OSS 控制台找到您的 Bucket
+*   点击 Bucket 名称进入详情页
+
+**2. 进入权限控制页面**
+
+:-: ![](/.topwrite/assets/image_1760270528220.png =752)
+
+* 点击左侧菜单“权限控制” → “Bucket 授权策略”。
+* 点击“添加授权”。
+
+**3. 配置授权策略**
+
+选择“自定义授权”，填写以下信息：
+
+| 配置项      | 设置值                                                                           |
+| -------- | ----------------------------------------------------------------------------- |
+| **授权资源** | `acs:oss:*:*:your-bucket-name/*` 或 `acs:oss:*:*:your-bucket-name/your-path/*` |
+| **授权用户** | 填写 ClickZetta Lakehouse 的主账号 ID：1384322691904283                                 |
+| **授权操作** | 选择“完全控制”。                                                                     |
+| **条件**   | 不设置。                                                                           |
+
+:-: ![](/.topwrite/assets/image_1760270723389.png =588)
+
+^
+
+**为什么需要完全控制权限？**
+
+ClickZetta Lakehouse 需要该路径下的完全控制权限，以确保能正常进行数据的增、删、读、写操作。
+
+^
+
+完成上述配置后，即可在创建私有存储时使用您的私有存储路径和云平台主账号ID。

package/bin/skills/lakehouse-doc/references/aliyun_storage_connection.md

@@ -0,0 +1,135 @@
+# 创建阿里云存储连接
+
+本步骤的目标是：允许 Lakehouse 集群访问阿里云上的对象存储 OSS。为了完成这个目标，可以使用阿里云提供的两种身份认证方式：**访问密钥** 和 **角色授权**。
+
+## 方式1：访问密钥（AK信息）
+
+仅需提供拥有访问 OSS 权限的账号的 AccessKey ID 和 AccessKey Secret 信息，利用这些信息创建存储连接（Storage Connection）对象，示例如下：
+
+```
+CREATE STORAGE CONNECTION IF NOT EXISTS hz_conn_ak
+    TYPE oss
+    ENDPOINT = 'oss-cn-hangzhou.aliyuncs.com'
+    ACCESS_ID = 'LTAI5tMmbq1Ty1xxxxxxxxx'
+    ACCESS_KEY = '0d7Ap1VBuFTzNg7gxxxxxxxxxxxx'
+    COMMENTS = 'OSS public endpoint';
+```
+
+## 方式2：角色授权（RoleARN）
+
+需要创建一个角色和权限策略：权限策略代表 OSS 服务的访问策略，将这个策略授权给创建的角色。
+
+**以下主要讲述角色授权方式（RoleARN）的具体操作步骤：**
+
+### 1. 阿里云侧操作：在阿里云 RAM 控制台中创建权限策略（CzUdfOssAccess）
+
+> 注意：需要用户具备 RAM 权限。
+
+* 访问阿里云访问控制（RAM）控制台。
+* 左侧导航栏 **权限管理** -> **权限策略**，在权限策略界面选择 **创建权限策略**。
+* 在**创建权限策略**页面选择 **脚本编辑** 页签，将下面 `[bucket_name_1|2|3]` 替换为实际的 OSS bucket 名称。注意：按照阿里云 OSS 的约定，同一个 bucket 需要有两条 Resource 条目：`"acs:oss:*:*:bucket_name_1"` 与 `"acs:oss:*:*:bucket_name_1/*"` 同时存在才能达到授权效果。
+
+```JSON
+{
+    "Version": "1",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Action": [
+                "oss:GetObject",
+                "oss:ListObjects",
+                "oss:PutObject",
+                "oss:DeleteObject"
+            ],
+            "Resource": [
+                "acs:oss:*:*:bucket_name_1",
+                "acs:oss:*:*:bucket_name_1/*",
+                "acs:oss:*:*:bucket_name_2",
+                "acs:oss:*:*:bucket_name_2/*",
+                "acs:oss:*:*:bucket_name_3",
+                "acs:oss:*:*:bucket_name_3/*"
+            ]
+        }
+    ]
+}
+```
+
+![](.topwrite/assets/OSS_P.jpeg)
+
+^
+
+### 2. 阿里云侧：在阿里云 RAM 中创建角色 CzUDFRole
+
+* 在阿里云访问控制（RAM）控制台左侧导航栏，进入 **身份管理** -> **角色**，创建角色。
+* 在 **创建角色** 页面中，选择类型为 **阿里云账号**，在 **配置角色** 中填写自定义角色名称（如 CzUDFRole），在 **选择信任的云账号** 中选择 **其他云账号**，并填入账号 ID：1384322691904283，点击 **完成**。
+
+```Properties
+{
+    "Version": "1",
+    "Statement": [
+        {
+            "Action": "fc:*",
+            "Resource": "*",
+            "Effect": "Allow"
+        },
+        {
+            "Action": "ram:PassRole",
+            "Resource": "*",
+            "Effect": "Allow",
+            "Condition": {
+                "StringEquals": {
+                    "acs:Service": "fc.aliyuncs.com"
+                }
+            }
+        }
+    ]
+}
+```
+
+* 创建完成后，点击 **为角色授权**：在 **自定义策略** 中，将刚创建的策略（CzUdfOssAccess）授权给该角色。在角色 CzUDFRole 详情页中，获取该角色的 RoleARN 信息：`'acs:ram::1222808864xxxxxxx:role/czudfrole'`
+
+![](.topwrite/assets/20231113-153016.jpeg)
+
+^
+
+### 3. Lakehouse 侧：创建 Connection
+
+* 在 Studio 或者 Lakehouse JDBC 客户端中执行以下命令：
+
+```SQL
+CREATE STORAGE CONNECTION hz_oss_conn_rolearn 
+    TYPE oss 
+    REGION = 'cn-hangzhou' 
+    ROLE_ARN = 'acs:ram::1222808864467016:role/czudfrole' 
+    ENDPOINT = 'oss-cn-hangzhou-internal.aliyuncs.com';
+```
+
+* 执行 `DESC CONNECTION` 获取 `external_id` 信息。本示例中，`external_id` 为 `O0lQUogDJajHqnAQ`。
+
+![](.topwrite/assets/bloygC9Z6Q.jpg)
+
+### 4. 阿里云侧：在阿里云 RAM -> 角色 -> 信任策略中，修改 CzUDFRole 的 **信任策略**
+
+```Python
+{
+  "Statement": [
+    {
+      "Action": "sts:AssumeRole",
+      "Condition": {
+        "StringEquals": {
+          "sts:ExternalId": "O0lQUogDJajHqnAQ"
+        }
+      },
+      "Effect": "Allow",
+      "Principal": {
+        "RAM": [
+          "acs:ram::1384322691904283:root"
+        ]
+      }
+    }
+  ],
+  "Version": "1"
+}
+```
+
+创建完成后，即可在创建外部 Volume 的语句中，使用该 Storage Connection 对象挂载对象存储的路径。