text
stringlengths 0
662
|
|---|
metadata: |
name: crates |
description: Shipping & receiving platform |
spec: |
owner: [eng-squirrel, prod-squirrel] |
platform: orchard |
``` |
```yaml |
apiVersion: opencontext.com/v1alpha1 |
kind: Service |
metadata: |
name: it-service |
description: IT operations |
spec: |
owner: [it-ops] |
``` |
```yaml |
apiVersion: opencontext.com/v1alpha1 |
kind: Service |
metadata: |
name: it-service |
description: IT operations |
spec: |
owner: [it-ops] |
platform: it |
hasComponent: |
[ |
aux-component:servicedesk, |
platform-component:jira-server, |
code-component:sandbox, |
] |
``` |
--- |
sidebar_position: 10 |
--- |
# 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](person) in OpenContext. |
## Definition |
:::tip A key that ends with a question mark is optional. |
For example, `spec.parent` |
::: |
```yaml |
apiVersion: opencontext.com/v1alpha1 |
kind: Team |
spec: |
type: string |
profile?: |
displayName?: string |
email?: string |
picture?: string |
timezone?: string |
slackHandle?: string |
pagerHandle?: string |
parent?: string |
children: string[] |
members?: string[] |
``` |
- **apiVersion**: opencontext.com/v1alpha1 [required] |
- **kind**: Team [required] |
- **metadata**: ([ObjectMeta](common#metadata)) [optional] |
Standard object鈥檚 metadata. For more information see the [Common to All Kinds](common) doc |
- **spec**: ([Spec](#spec)) [required] |
Specification to describe an organization entity such as a team, business unit, virtual team, or a loose collection of people in an interest group. |
## Spec |
- **type** (string) [required] |
The type of team. |
For example, organization, virt-org, business-unit, department, team. |
- **profile** [optional] |
Optional profile information about the team. Mainly for display purposes. All fields of this structure are also optional. |
- **displayEmail** would be a team email of some form, that the team may wish to be used for contacting them. |
- **picture** is expected to be a URL pointing to an image that's representative of the team, and that a browser could fetch and render on a team page or similar. |
- **timezone** should be in the form of [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). |
- **slackHandle** is the team鈥檚 handle name in Slack. |
- **pagerHandle** is the team鈥檚 handle name in the paging service of choice. |
- **parent** (string) [optional] |
The immediate parent team in the hierarchy, if any. Not all teams must have a parent. OpenContext supports multi-root hierarchies. Teams may however not have more than one parent. This field is an [entity reference](entity-reference). |
For example: ops, cloud-security |
- **children** (string array) [required] |
The immediate child teams of this team in the hierarchy (whose parent field points to this team). The list must be present, but may be empty if there are no child teams. The items are not guaranteed to be ordered in any particular way. The entries of this array are [entity references](entity-reference). |
For example: engineering, product |
- **members** (string array) [optional] |
The people that are members of this team. The entries of this array are [entity references](entity-reference). |
For example: jdoe |
## 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 |