Datasets:
botchagalupe
/
opencontext

Dataset card Data Studio Files Community
2
text
stringlengths
0
662
# Kind: Person
A Person describes an individual such as an employee, contractor, or similar. Person are mapped to [Kind: Team](team) entities in the catalog and can be owned by a [Kind: User](user) entity.
## Definition
:::tip A key that ends with a question mark is optional.
For example, `spec.profile.displayName`
:::
```yaml
apiVersion: opencontext.com/v1alpha1
kind: Person
spec:
profile?:
displayName?: string
displayEmail?: string
picture?: string
role?: string
memberOf: string[]
ownedBy?: string;
```
- **apiVersion**: opencontext.com/v1alpha1 [required]
- **kind**: Person [required]
- **metadata**: ([ObjectMeta](common#metadata)) [optional]
Standard object’s metadata. For more information see the [Common to All Kinds](common) doc
- **spec**: ([Spec](#spec)) [required]
Specification to describe an individual such as an employee, contractor, or similar. Person are mapped to [Kind: Team](team) entities in the catalog and can be owned by a [Kind: User](user) entity in OpenContext.
## Spec
- **profile** [optional]
Optional profile information about the user. Mainly for display purposes.
All fields of this structure are also optional. The displayName would be what is presented to users in the system. The displayEmail would be a user email of some form, that the user may wish to be used for contacting them. The picture is expected to be a URL pointing to an image that's representative of the user, and that a browser could fetch and render on a group page or similar. The role would indicate the user’s role.
- **memberOf** (string array) [required]
An array of [entity references](entity-reference) to [Team](team) entities that the person is a member of.
- **ownedBy** (string) [optional]
An [entity reference](entity-reference) to the [User](user) that this person is attached to.
## Examples
These example YAML configurations are all shown as if they were in their own file. They can be concatenated into a single file by separating the contents with a triple dash `---` like in Kubernetes.
```yaml
apiVersion: opencontext.com/v1alpha1
kind: Person
metadata:
name: paul
spec:
profile:
displayName: Paul
displayEmail: [email protected]
picture: https://avatars.dicebear.com/api/avataaars/[email protected]?background=%23fff&topChance=100&eyes=default&mouth=default&top[]=shortFlat
role: Engineer
memberOf: [contract-crow, eng-raccoon-cloud]
ownedBy: paul
```
---
sidebar_position: 8
---
# 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.
## Definition
:::tip A key that ends with a question mark is optional.
For example, `spec.priority`
:::
```yaml
apiVersion: opencontext.com/v1alpha1
kind: PlatformComponent
spec:
type: string
lifecycle: string
owner: string[]
dependsOn?: string[]
dependencyOf?: string[]
service?: string
uri?: string
priority?: number
sla?: string
datacenter?: string[]
```
- **apiVersion**: opencontext.com/v1alpha1 [required]
- **kind**: PlatformComponent [required]
- **metadata**: ([ObjectMeta](common#metadata)) [optional]
Standard object’s metadata. For more information see the [Common to All Kinds](common) doc
- **spec**: ([Spec](#spec)) [required]
Specification to describe the infrastructure a service needs to operate, like BigTable databases, Pub/Sub topics, S3 buckets or CDNs. Modeling them together with code components and services allows it to visualize platform components' footprint, and create tooling around them.
## Spec
- **type** (string) [required]
The type of platform component.
For example: database, loadbalancer, cluster, server, vm, blob storage, network switch, firewall, ssl certificate