text
stringlengths 0
662
|
|---|
```yaml |
# Example: |
metadata: |
annotations: |
github.com/project-slug: opencontextinc/sandbox |
``` |
##### github.com/user-login |
```yaml |
# Example |
metadata: |
annotations: |
github.com/user-login: jaxraccoon |
``` |
##### google.com/email |
```yaml |
# Example |
metadata: |
annotations: |
github.com/email: jax.raccoon@example.com |
``` |
##### pagerduty.com/integration-key: 'PAGERDUTY_EVENTS_API_V2_INTEGRATION_KEY' |
```yaml |
# Example |
metadata: |
annotations: |
pagerduty.com/integration-key: 'e0efde5a1somethingorother' |
``` |
##### pagerduty.com/service-id: 'PAGERDUTY_SERVICE_ID' |
:::info The feature to manually trigger an incident is not supported using this method. |
::: |
```yaml |
# Example |
metadata: |
annotations: |
pagerduty.com/service-id: 'TEST7XW' |
``` |
### tags (optional) |
A list of single-valued strings, for example to classify catalog entities in various ways. This is different to the labels in metadata, as labels are key-value pairs. |
The values are user defined, for example the programming language used for the component, like聽`java`聽or聽`go`. |
This field is optional, and currently has no special semantics. |
Each tag must be sequences of聽`[a-z0-9]`聽separated by聽`-`, at most 63 characters in total. |
### links (optional) |
A list of external hyperlinks related to the entity. Links can provide additional contextual information that may be located outside of OpenContext itself. For example, an admin dashboard or external CMS page. |
Users may add links to descriptor YAML files to provide additional reference information to external content & resources. |
Fields of a link are: |
| Field | Type | Description | Note | |
| ----- | ------ | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| url | String | [Required] A url in standard uri format. For example, https://example.com/some/page | | |
| title | String | [Optional] A user friendly display name for the link. | | |
| icon | String | [Optional] A key representing a visual icon to be displayed in the UI | This is meant to be a semantic key that will map to a specific icon that may be provided by an icon library. These keys should be a sequence of聽`[a-z0-9A-Z]`, possibly separated by one of聽`[-_.]`. See list of [supported icons](#supported-icons) below. | |
## Example with all metadata |
```yaml |
apiVersion: opencontext.com/v1alpha1 |
kind: CodeComponent |
metadata: |
name: order-service |
namespace: order |
title: Order Service |
description: Order Service that does ordering |
labels: |
example.com/custom: some_custom_label |
annotations: |
github.com/project-slug: 'githubOrgName/order-service' |
tags: |
- java |
links: |
- url: https://example.com/help |
title: Support |
spec: |
type: website |
lifecycle: production |
owner: order-team |
product: payment-orders |
isInternal: false |
``` |
## Relationship Pairs |