Skip to content

Model Elements

中文:Model Elements

UModel elements are versioned model definitions. They define the object graph before runtime entity and relation records are written.

Element Envelope

Authoring files use a common YAML shape:

yaml
kind: entity_set
schema:
  url: "umodel.aliyun.com"
  version: "v0.1.0"
metadata:
  name: "devops.service"
  domain: devops
spec:
  fields: []

Important fields:

FieldMeaning
kindModel kind, such as entity_set, metric_set, data_link, or sls_metricstore.
schema.versionSchema version used to validate this element.
metadata.nameStable name inside the domain.
metadata.domainSemantic namespace.
metadata.display_nameHuman-facing bilingual name when available.
specKind-specific content.

Core Kinds

CategoryKinds
Entitiesentity_set
Datasetsmetric_set, log_set, trace_set, event_set, profile_set, runbook_set
Linksdata_link, entity_set_link, storage_link, runbook_link, entity_source_link, explorer_link
Storagesls_logstore, sls_metricstore, sls_entitystore, aliyun_prometheus, external_storage

Lifecycle

Import Paths

Bundled sample import:

bash
curl -X POST http://localhost:8080/api/v1/samples/demo/multi-domain-quickstart:import \
  -H 'Content-Type: application/json' \
  -d '{}'

Import your own model pack with the CLI:

bash
go run ./cmd/umctl --addr http://localhost:8080 umodel import demo examples/quickstart-multidomain

Validation And References

Validation checks the element shape before writing it to GraphStore. Schema source files live under schemas/, and generated reference HTML lives under docs/html, docs/html_en, and docs/html_cn.

Released under the Apache-2.0 License.