管理实体
实体是容纳你的资源的树:公司、客户、环境、团队。你在实体上设置的内容,其下的所有内容都会继承。本指南说明如何在 Settings › Entities 下构建和更改这棵树、在哪里设置每个实体向下传递的内容,以及如何为资源添加标记,以便在整个树中对资源分组。
开始之前
- 你需要在要更改的实体上拥有 Entity admin(实体管理员)角色。创建实体时,你需要在其父实体上拥有该角色;移动实体时,需要在该实体及其新父实体上拥有该角色。
- 规划你需要的层级。实体的类型(tenant、client、environment、group,即租户、客户、环境、组)只是标签,不会改变任何行为。有关继承的工作方式,请参阅实体、标记和继承。
在示例中,鲁镇科技有限公司 是根实体,高密物流 是其下的一个客户,Production 和 UAT 是该客户的环境。
创建实体
- 打开 Settings › Entities。树中显示在选取器中选择的实体及其下的所有内容,并显示每个分支中的资源数量。
- 在父实体上(例如 高密物流),打开它的操作菜单并选择 Add an entity below。
- 输入 Name,例如
Production。 - 选择 Kind,例如 environment。
- 也可以输入 Short name,它用于路径中:小写字母、数字和连字符,在整个安装中唯一。留空时,它由名称派生。之后无法更改。
- 选择 Create。
只有一个根实体;其他每个实体都有一个父实体。
重命名实体
- 打开实体的操作菜单并选择 Rename。
- 更改 Name,必要时也更改 Kind。根实体的类型无法更改。
- 选择 Save。
短名称保持原样,因此链接和路径仍然有效。
移动实体
移动实体会同时移动其下的所有内容,此后它们都会从新位置继承:阈值、Slack 频道、维护时段、注册和角色。
- 打开实体的操作菜单并选择 Move。
- 选择 New parent。只提供你管理的实体,并且绝不会提供该实体本身或其下的实体。
- 选择 Move。
根实体无法移动。审核日志会记录每次移动。
删除实体
当实体下不再有任何内容时,你才可以删除它。
- 删除或移走它包含的内容:子实体、资源和数据源。删除资源时也会删除它的警报。
- 打开实体的操作菜单并选择 Delete。仅当实体为空时才能使用该选项。
- 选择 Delete 进行确认。实体自己的凭据、Slack 频道和角色分配会随之一并删除。
如果实体下仍有子实体、资源、数据源或警报,或者其他位置的资源使用了它的某个凭据,Excubius 会拒绝删除。根实体无法删除。
设置实体向下传递的内容
每个可继承的设置都有各自的界面。请在选取器中选择实体,或从 Settings › Entities 打开它。
| 设置 | 位置 | 指南 |
|---|---|---|
| 每个检查的阈值默认值 | Settings › Entities,操作菜单,Threshold defaults | 更改阈值和关闭检查 |
| 角色以及谁获得账户 | Settings › Users and roles | 管理用户和角色 |
| 采集器的凭据 | Settings › Credentials | 为采集器存储凭据 |
| Slack 频道 | Settings › Notifications | 配置 Slack 通知 |
| 维护时段 | Settings › Maintenance windows | 规划维护时段 |
| 默认主题和徽标 | Settings › Branch appearance | 设置公共状态页 |
| 公共状态页 | Settings › Status page | 设置公共状态页 |
为资源添加标记
标记是资源上的 key:value 标签,例如 env:prod、role:sql 或 client:ciguapa。资源在树中只有一个位置,但标记可以让你把它与树中任何位置的其他资源归为一组。
若要为资源添加标记:
- 打开资源并选择 Edit。添加资源时,向导中有一个 Tags 步骤,其用法相同。
- 在 Tags 中,输入以空格分隔的
key:value对,例如env:prod role:sql client:ciguapa。键可以使用字母、数字、点、短横线和下划线,并且每个键只能出现一次。 - 设置 Criticality,范围从 1(低)到 5(严重)。它是单独的字段,不是标记,用于路由、风险和安全分数。
- 选择 Save。
请至少在每个资源上使用 env、role 和 client,并设置重要性。
若要使用这些标记:
- 在 Resources 中,输入 Tag rule。
role:sql env:prod显示同时具有这两个标记的资源;只输入一个键(例如client)则显示具有该键的所有资源。 - 在 Overview 上,选择 Hex 视图并按某个标记键 Group by,即可为每个值显示一组六边形。
使用 API 完成
| 任务 | 请求 |
|---|---|
| 创建 | POST /api/v1/entities,包含 parent_id、name,以及可选的 kind 和 slug |
| 重命名或更改类型 | PATCH /api/v1/entities/{id},包含 name 或 kind |
| 移动 | PATCH /api/v1/entities/{id},包含 parent_id |
| 删除 | DELETE /api/v1/entities/{id};实体不为空时返回 409 和原因 |
| 为资源添加标记 | PATCH /api/v1/resources/{id},包含 tags(一个对象,例如 {"env": "prod", "role": "sql"})和 criticality |