mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 09:19:04 -04:00
Adds baseline asset schema to be expanded (#159308)
## Summary Moving schema for the observed asset management initiative into this central location.
This commit is contained in:
parent
e6364bed01
commit
85c5b871de
1 changed files with 53 additions and 0 deletions
53
x-pack/plugins/asset_manager/docs/schema/index.md
Normal file
53
x-pack/plugins/asset_manager/docs/schema/index.md
Normal file
|
@ -0,0 +1,53 @@
|
|||
# Asset Schema
|
||||
|
||||
Last update: 2023-06-14
|
||||
|
||||
_Note: This is a living document and should only be relied on by developers of asset collectors and the developers who are building the Asset API. Users of the Asset API should ONLY rely on the Asset API documentation itself, without worrying about this schema._
|
||||
|
||||
## Fields
|
||||
|
||||
### **asset.ean** (required, string)
|
||||
|
||||
The EAN (Elastic Asset Name) is the URN-style unique identifier for an individual asset. It is currently constructed by concatenating the asset's "kind" value and its "local ID" with a `:`, i.e. `{asset.kind}:{asset.id}`.
|
||||
|
||||
### **asset.id** (required, string)
|
||||
|
||||
This is the local identifier for this individual asset. Assets should be _reasonably unique_ and _widely available_ wherever the asset may be found. More discussion on these requirements [in this discussion issue](https://github.com/elastic/assetbeat/issues/226).
|
||||
|
||||
### **asset.kind** (required, AssetKind)
|
||||
|
||||
One of a small set of valid AssetKind values representing the high-level categorizations of assets.
|
||||
|
||||
#### Valid AssetKind values
|
||||
|
||||
**host**
|
||||
|
||||
TBA: description of the "host" kind
|
||||
|
||||
**container**
|
||||
|
||||
TBA: description of the "container" kind
|
||||
|
||||
**service**
|
||||
|
||||
TBA: description of the "service" kind
|
||||
|
||||
### **asset.type** (optional, AssetType)
|
||||
|
||||
One of a set of AssetType values aligned with this asset's dataset, usually in line with how this asset was collected. This value is usually not useful for end users, but can be useful for grouping things by how they were collected.
|
||||
|
||||
### **asset.name** (optional, string)
|
||||
|
||||
Optional, human-friendly name for this asset.
|
||||
|
||||
### **asset.parents** (optional, AssetEan[])
|
||||
|
||||
A list of EAN values corresponding to this asset's direct parents.
|
||||
|
||||
### **asset.children** (optional, AssetEan[])
|
||||
|
||||
A list of EAN values corresponding to this asset's direct children.
|
||||
|
||||
### **asset.references** (optional, AssetEan[])
|
||||
|
||||
A list of EAN values corresponding to any other assets this asset is related to, which are not direct parents or children.
|
Loading…
Add table
Add a link
Reference in a new issue