text
stringlengths 0
662
|
|---|
title: Map thingy |
description: Prototyping toolkit for maps |
spec: |
type: tool |
lifecycle: planning |
owner: [eng-raccoon-eco, prod-raccoon-ent] |
service: dumpster-prod |
uri: https://example.com/website |
``` |
```yaml |
apiVersion: opencontext.com/v1alpha1 |
kind: AuxComponent |
metadata: |
name: custom-ticketing |
title: Custom ticketing |
description: Custom ticketing system |
spec: |
type: other |
otherType: custom-ticketing |
lifecycle: production |
owner: [eng-raccoon-eco, prod-raccoon-ent] |
service: dumpster-prod |
uri: https://example.com/website |
``` |
```yaml |
apiVersion: opencontext.com/v1alpha1 |
kind: AuxComponent |
metadata: |
name: eng-raccoon-info |
title: Eng Raccoon Info |
description: Additional links for Eng Raccoon |
links: |
- url: https://slack.com |
title: Slack |
icon: chat |
- url: https://jira.com |
title: Jira |
icon: dashboard |
spec: |
type: infocard |
lifecycle: production |
owner: [eng-raccoon] |
``` |
--- |
sidebar_position: 5 |
--- |
# Kind: CodeComponent |
This kind of entity is used to describe a software package, library, or other code entity. |
## Definition |
:::tip A key that ends with a question mark is optional. |
For example, `spec.uri` |
::: |
```yaml |
apiVersion: opencontext.com/v1alpha1 |
kind: CodeComponent |
spec: |
type: 'repository' | 'codepath' | 'library' | 'package' | 'lambda' | 'utility' | 'other' |
owner: string[] |
otherType?: string |
uri?: string |
service?: string |
datacenter?: string[] |
lifecycle?: string |
priority?: number |
sla?: string |
subcomponentOf?: string[] |
dependsOn?: string[] |
``` |
- **apiVersion**: opencontext.com/v1alpha1 [required] |
- **kind**: CodeComponent [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 a software package, library, or other code entity. |
## Spec |
- **type** (string) [required] |
The type of datacenter. Must be one of the following: `repository`, `codepath`, `library`, `package`, `lambda`, `utility`, `other` . If this is set to other then `spec.otherType` is also required. |
- **otherType** (string) [optional] |
Required if `spec.type` is set to other. |
For example: glitch |
- **owner** (string array) [required] |
An array of [entity references](entity-reference) to the owner of the datacenter. Default entity type is [Kind: Team](team). |
For example: cloud-team, person:sean |
- **uri** (string) [optional] |
A component's URI / FQDN. |
For example: [https://lorem.lambda-url.uswest-1.on.aws](https://lorem.lambda-url.uswest-1.on.aws/) |
- **service** (string) [optional] |
An [entity reference](entity-reference) to the [service](service) that the code component belongs to. Default entity type [Kind:Service](service). |
- **datacenter** (string array) [optional] |
An array of [entity references](entity-reference) to the [datacenter](datacenter) that the code component belongs to. Default entity type [Kind:Datacenter](datacenter). |