Skip to content

docs: asset kinds and per-source asset aliases - #15633

Merged
devGregA merged 1 commit into
DefectDojo:devfrom
devGregA:docs/asset-identity
Aug 12, 2026
Merged

docs: asset kinds and per-source asset aliases#15633
devGregA merged 1 commit into
DefectDojo:devfrom
devGregA:docs/asset-identity

Conversation

@devGregA

Copy link
Copy Markdown
Contributor

Description

Documentation for the asset-identity work in DefectDojo Pro (asset model, Phase 4). Docs-only; no code changes.

Two pages gain sections:

Assets (Pro)docs/content/asset_modelling/engagements_tests/PRO__assets.md

  • Asset Kinds. An Asset can declare what kind of thing it is (repository, service, host, domain, container image, package, cloud account, device, branch). Optional and descriptive: it changes no permission, no deduplication, no SLA, and no reporting scope. The list is an editable registry rather than a fixed set — shipped kinds cannot be deleted, but their wording and icons can change and customers can add their own.
  • Asset Identity: Aliases. Per-source identifiers, keyed by namespace, type and value, so an Asset can be recognised from whichever name a given source uses. Covers the one-identifier-one-Asset rule, why user-asserted aliases survive automation, why the connector: namespace is written by sync rather than by hand, and why there is no update action (an identifier is asserted or withdrawn — editing one in place would re-point identity leaving no trace of what it used to mean).

Manage Records (connectors)docs/content/connectors/upstream/manage_records.md

  • How Auto-Mapping chooses the Product. The resolution order — the tool's own identifier, then the name, then a new Product — and what that changes: a rename in the tool or in DefectDojo no longer loses the Mapping or creates a duplicate, and two tools that each report something called payments stop being permanently fused by that coincidence. Also records that enabling the feature changes nothing about existing Mappings, and that remapping a Record by hand always wins.

Both features sit behind DD_V3_ASSET_ALIASES, which is off by default; the docs say so where it matters.

Test Configuration

Documentation only — no application code is touched.

Documents the two user-visible halves of the identity work:

* Asset Kinds -- an optional, descriptive kind per Asset (repository, service,
  host, ...), drawn from an editable registry rather than a fixed list.
* Asset Identity -- per-source aliases (namespace / type / value), what makes an
  identifier resolve to exactly one Asset, why user-asserted aliases survive
  automation, and why there is no update action.

Also documents how connector Auto-Mapping now chooses a Product: the tool's own
identifier first, the name second, a new Product last -- and that turning the
feature on changes nothing about mappings that already exist.
@devGregA devGregA added this to the 3.3.0 milestone Aug 12, 2026
@github-actions github-actions Bot added the docs label Aug 12, 2026
@devGregA
devGregA merged commit a32ac15 into DefectDojo:dev Aug 12, 2026
47 of 48 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant