Kind Artifact

Within the T-matic platform's architecture, an Artifact represents the outputs that result from various processes. These can be anything from software binaries, shared libraries, and generated documentation to intricate data models, schematic diagrams, or other forms of deliverables. By methodically defining and categorizing these Artifacts, organizations can streamline the management, versioning, and dissemination of such pivotal outputs.

Example Descriptor for Artifact

apiVersion: backstage.io/v1alpha1
kind: Artifact
metadata:
  name: sales-invoice-sdk
  description: Library providing essential functions for sales invoice operations.
spec:
  type: library
  lifecycle: production
  owner: ecommerce-team
  system: ecommerce-website
  partOf: sales-invoice-api

Artifact Structure

• apiVersion and kind [required]:

  • Should always be defined as backstage.io/v1alpha1 and Artifact.

• spec.lifecycle [required]:

  • Indicates the lifecycle status of the component, such as "production" or "experimental."

Considerations

1. The type field provides a taxonomy for Artifacts. While T-matic doesn't impose a rigid set of values, organizations should strive for a consistent and descriptive categorization for clarity.

2. The owner generally refers to a team or entity that produces and manages the Artifact, ensuring that any changes, updates, or issues can be swiftly addressed.

3. Associative fields like system and partOf offer a comprehensive view of how an Artifact fits into the broader ecosystem, aiding in effective management and traceability.