# TeaComponent

A component the tenant publishes through the Transparency Exchange API (TEA): a part a product is assembled from, such as a service, a library or an installer.

A component the tenant publishes through the Transparency Exchange API (TEA): a part a product is assembled from, such as a service, a library or an installer. Component releases, and the distributions and artifacts under them, are published by CI pipelines and are not declared here; a product release names the component releases it is built from when CI publishes it. A component given the same name as a TeaProduct is the same subject to consumers, who then see one node carrying both identities. The server assigns the component's UUID and TEI and reports them in status. Who may read it is declared with a TeaAccessPolicy; until one exists the component is private. Removing the document deletes the component while no release has been published under it. Once CI has published a release, the component and its releases stay, and only the config management of the component ends.

| | |
|---|---|
| `apiVersion` | `vulnetix.com/v1` |
| `kind` | `TeaComponent` |
| Group | [TEA](/platform-iac/kinds/catalogue.md#tea) |
| Status | **Served.** The [config engine](/platform-iac/reference/engine.md) plans and applies it. |
| Objects per tenant | many, keyed by `metadata.name` |
| Token and role | An owner, or a service account with the developer role (its ApiKey), or an Authentik access token for either. A member is refused with HTTP 403. See [Credentials for automation](/platform-iac/reference/config-api.md#credentials-for-automation). |
| Terraform resource | [`vulnetix_tea_component`](/platform-iac/terraform/resources.md#vulnetix_tea_component), imported by name (see [Terraform and OpenTofu](#terraform-and-opentofu)) |
| CLI | [`vulnetix config apply`](/platform-iac/cli/apply.md), CLI v3.168.0 and later. |
| Pinned schema | [`v1.19.1/TeaComponent.schema.json`](https://github.com/Vulnesis/config-schemas/releases/download/v1.19.1/TeaComponent.schema.json) |
| Newest schema | [`latest/TeaComponent.schema.json`](https://github.com/Vulnesis/config-schemas/releases/latest/download/TeaComponent.schema.json) |
| First released in | [`v1.6.0`](https://github.com/Vulnesis/config-schemas/releases/tag/v1.6.0) |
| Print the built-in copy | `vulnetix config schema TeaComponent` |

## Minimal

Only the fields the kind requires. From `examples/TeaComponent/minimal.yaml`.

**YAML**

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/TeaComponent.schema.json
apiVersion: vulnetix.com/v1
kind: TeaComponent
metadata:
  name: payments-api
spec:
  name: payments-api
```

**HCL** (resource `vulnetix_tea_component`)

```hcl
# Only the arguments the kind requires. From config-schemas examples/TeaComponent/minimal.yaml.

resource "vulnetix_tea_component" "payments_api" {
  name           = "payments-api"
  component_name = "payments-api"
}
```

Every field that has a schema default, set to that default: [`terraform/tea_component.tf`](https://github.com/Vulnesis/platform-iac-examples/blob/main/terraform/tea_component.tf) and [`yaml/TeaComponent.yaml`](https://github.com/Vulnesis/platform-iac-examples/blob/main/yaml/TeaComponent.yaml) in [Vulnesis/platform-iac-examples](https://github.com/Vulnesis/platform-iac-examples).

**CLI** (applies it)

```bash
export VULNESIS_ORG_ID=...    # the organization UUID
export VULNESIS_API_KEY=...   # the ApiKey of a developer or owner service account
vulnetix config apply -f - --manager gitops:acme/platform --auto-approve <<'EOF'
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/TeaComponent.schema.json
apiVersion: vulnetix.com/v1
kind: TeaComponent
metadata:
  name: payments-api
spec:
  name: payments-api
EOF
```

## Advanced

Every field the kind supports, with a `when` expression where it takes one. From `examples/TeaComponent/advanced.yaml`.

**YAML**

```yaml
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/TeaComponent.schema.json
apiVersion: vulnetix.com/v1
kind: TeaComponent
metadata:
  name: payments-api
  labels:
    team: payments
spec:
  name: payments-api
  identifiers:
    - idType: PURL
      idValue: pkg:oci/payments-api?repository_url=ghcr.io/acme
```

**HCL** (resource `vulnetix_tea_component`)

```hcl
# Every argument the kind supports. From config-schemas examples/TeaComponent/advanced.yaml.

resource "vulnetix_tea_component" "payments_api" {
  name           = "payments-api"
  component_name = "payments-api"
  identifiers = [
    {
      id_type  = "PURL"
      id_value = "pkg:oci/payments-api?repository_url=ghcr.io/acme"
    },
  ]
  labels = {
    team = "payments"
  }
}
```

Every field that has a schema default, set to that default: [`terraform/tea_component.tf`](https://github.com/Vulnesis/platform-iac-examples/blob/main/terraform/tea_component.tf) and [`yaml/TeaComponent.yaml`](https://github.com/Vulnesis/platform-iac-examples/blob/main/yaml/TeaComponent.yaml) in [Vulnesis/platform-iac-examples](https://github.com/Vulnesis/platform-iac-examples).

**CLI** (applies it)

```bash
export VULNESIS_ORG_ID=...    # the organization UUID
export VULNESIS_API_KEY=...   # the ApiKey of a developer or owner service account
vulnetix config apply -f - --manager gitops:acme/platform --auto-approve <<'EOF'
# yaml-language-server: $schema=https://github.com/Vulnesis/config-schemas/releases/latest/download/TeaComponent.schema.json
apiVersion: vulnetix.com/v1
kind: TeaComponent
metadata:
  name: payments-api
  labels:
    team: payments
spec:
  name: payments-api
  identifiers:
    - idType: PURL
      idValue: pkg:oci/payments-api?repository_url=ghcr.io/acme
EOF
```

## Fields

Paths use dots for nesting and `[]` for the items of a list. **Required** means required whenever the parent object is present. A default is what the server uses when the field is left out.

| Field | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| <span id="apiVersion"></span>`apiVersion` | string | yes |  | exactly `vulnetix.com/v1` | The document format version. Every kind in this release is vulnetix.com/v1. |
| <span id="kind"></span>`kind` | string | yes |  | exactly `TeaComponent` | Always TeaComponent. |
| <span id="metadata"></span>`metadata` | object | yes |  | no other keys |  |
| <span id="metadata-name"></span>`metadata.name` | string | yes |  | pattern `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$` | The object's name, unique per kind within a tenant. It is the natural key: plan, apply, export and the Terraform provider all address an object by kind and name. |
| <span id="metadata-org"></span>`metadata.org` | string | no |  | format `uuid` | The tenant (organization UUID) the document belongs to. When set, plan and apply refuse to run against any other tenant. |
| <span id="metadata-labels"></span>`metadata.labels` | object | no |  | map of string to string (length 0 to 256); keys match `^[a-z0-9]([a-z0-9._/-]{0,61}[a-z0-9])?$` | Free key/value labels. Stored with the object, never interpreted by the server. |
| <span id="metadata-annotations"></span>`metadata.annotations` | object | no |  | map of string to string (length 0 to 4096) | Free key/value notes for people and tools, such as a ticket link. |
| <span id="spec"></span>`spec` | object | yes |  | no other keys |  |
| <span id="spec-name"></span>`spec.name` | string | yes |  | pattern `^\S(.*\S)?$`; length 1 to 256 | The component name TEA consumers see, such as payments-api. Unique among the tenant's components. The first time a name is published the server derives the component's UUID from it, so a CI pipeline that publishes releases under the same component name writes to this component. Changing the name later keeps the UUID. |
| <span id="spec-identifiers"></span>`spec.identifiers` | array of object | no |  | items unique | Identifiers for the component besides its TEI, in the order consumers see them. The server assigns the TEI itself, so it is reported in status and cannot be declared. |
| <span id="spec-identifiers-idType"></span>`spec.identifiers[].idType` | string | yes |  | `PURL`, `CPE`, `COMPLIANCE_DOCUMENT` | PURL: a package URL. CPE: a CPE 2.3 name. COMPLIANCE_DOCUMENT: a compliance document type the TEA specification names. |
| <span id="spec-identifiers-idValue"></span>`spec.identifiers[].idValue` | string | yes |  | length 1 to 1024 | The identifier itself. |

## Applying this kind

- **Command.** `vulnetix config apply -f <file>`; the CLI line above says from which release. Plan first with [`vulnetix config plan`](/platform-iac/cli/plan.md): it shows each object as create, update, delete or no change, with a `planHash` that apply then holds to. Apply writes in one transaction.
- **Manager.** Each object records the manager that applied it (`terraform`, `console` or `gitops:<repo>`). `--prune` deletes only objects its own manager owns. See [The manager](/platform-iac/cli/plan.md#the-manager) and the [config engine](/platform-iac/reference/engine.md).
- **Status.** Applied, Unchanged or Deleted, with no other status fields. The phases the engine reports are explained under [status phases](/platform-iac/reference/engine.md#status-phases).

## How apply treats it

As for [`TeaProduct`](/platform-iac/kinds/tea-product.md): the uuid is derived from the name, an object CI already created is adopted, and one with published releases is let go on delete, never deleted.

## Terraform and OpenTofu

The resource is `vulnetix_tea_component` in the `vulnetix/resolve` provider. Its arguments are the `spec` in snake case, beside `name`, `labels` and `annotations` from `metadata`. The Minimal and Advanced HCL are above. The provider's own reference is [vulnetix_tea_component](https://registry.terraform.io/providers/vulnetix/resolve/latest/docs/resources/tea_component).

Import an object that already exists by its name:

```shell
# Import an existing TeaComponent by its name (metadata.name).
terraform import vulnetix_tea_component.payments_api payments-api
```

Install, authentication and how state is read: [Terraform and OpenTofu](/platform-iac/terraform.md).

Check a file with `vulnetix config validate -f <file>`. See [Validate documents](/platform-iac/cli/validate.md). In an editor, start the file with the [schema comment](/platform-iac/schemas/editors.md).
