目录实体之间常见的关系
本节列出了一些常见的实体关系类型它们可以附加到目录实体上,并由插件根据需要使用。
如果您想扩展关系集,请参阅扩展模型.
关系
这是一份已知正在使用的关系列表(并非详尽无遗)。
每个关系都有一个来源(隐含:持有关系的实体),一个目标(与源有关系的实体),以及一个类型关系是有方向性的;通常有成对的关系类型,另一端的实体会有相反方向的关系(例如,当查询A
你会看到A.ownedBy.B
查询时B
你会看到B.ownerOf.A
).
ownedBy
和 ownerOf
所有权关系,其 Owner 通常是一个组织实体 (用户或组别),而另一个实体可以是任何东西。
在 Backstage 中,实体的所有者是对实体负最终责任的单个实体(通常是一个团队),他们拥有开发和维护实体的权力和能力。 如果出现问题或需要功能,他们将是联系点。 这种关系的主要目的是在 Backstage 中显示,以便查看目录实体的人可以了解该实体属于谁。 它不能用于自动化流程,例如在运行时系统中分配授权。 可能还有其他人也开发或以其他方式接触实体,但最终的所有者始终只有一个。
这种关系通常基于spec.owner
如果有,则为所拥有的实体。
providesApi
和apiProvidedBy
。
这些关系表示一个组件公开了一个应用程序接口(API)--这意味着它承载了可调用的端点,您可以从这些端点使用该应用程序接口。
这种关系通常基于spec.providesApis
有关部件或系统的
consumesApi
和apiConsumedBy
。
这些关系表示一个组件消耗一个应用程序接口,这意味着它依赖于应用程序接口的端点。
这种关系通常基于spec.consumesApis
有关部件或系统的
dependsOn
和dependencyOf
。
表示对另一个实体的依赖关系。
例如,它可以用来表示网站组件需要库组件作为其构建的一部分,或服务组件使用持久存储资源。
这种关系通常基于spec.dependsOn
的组件或资源。
parentOf
和 childOf
父/子关系来建立树状结构,例如用于描述父/子关系之间的组织结构。组别.
这种关系通常基于spec.parent
和/或spec.children
.
memberOf
和hasMember
。
这种关系通常基于spec.memberOf
.
partOf
和hasPart
。
具有域名,系统或组件实体,通常来自组件,应用程序接口或系统.
这些关系表示一个组件属于一个更大的组件;一个组件、应用程序接口或资源属于一个系统;或一个系统归属于一个域。
这种关系通常基于spec.system
或spec.domain
.