📄️ Common to All Kinds
📄️ Entity Reference
Entities commonly have a need to reference other entities. For example, a CodeComponent entity may want to declare who its owner is by mentioning a Team or Person entity, and a Person entity may want to declare what Team entities it is a member of. This describes how to write those references in your yaml entity declaration files.
📄️ Kind: AuxComponent
This kind of entity is used to describe documents, tools, and other resources that may be associated with code and platform components.
📄️ Kind: CodeComponent
This kind of entity is used to describe a software package, library, or other code entity.
📄️ Kind: Datacenter
This kind of entity groups code components and platform components together to indicate where those components are located, such as in AWS, GCP, or a local datacenter.
📄️ Kind: Service
This kind of entity groups Code Components, Platform Components, and Aux Components together. A Service is viewed as an abstraction layer that provides insights into exposed features, but doesn't require too many details about the structure of all components.
📄️ Kind: PlatformComponent
This kind of entity describes the infrastructure a platform needs to operate, like BigTable databases, Pub/Sub topics, S3 buckets or CDNs. Modeling them together with code components and platforms allows you to visualize your platform components' footprint, and create tooling around them.
📄️ Kind: Platform
This kind of entity groups platforms and components that share terminology, domain models, business purpose, or documentation together, i.e. for a bounded context.
📄️ Kind: Team
This kind of entity describes an organization entity such as a team, business unit, virtual team, or a loose collection of people in an interest group. Members of these teams are modeled as Kind: Person in OpenContext.
📄️ Kind: Person
A Person describes an individual such as an employee, contractor, or similar. Person are mapped to Kind User entity.
📄️ Kind: User
People inside your company are automatically created by the system once they have logged into the Client Portal.
📄️ Kind: Location
This is a special kind of entity that is a marker that references other places to look for OpenContext data. For the most part this is created automatically by the system. One would only create this kind of YAML definition if one wants to add supplementary data to OpenContext or entities that cannot be auto-discovered.