Skip to content

cloudg inventory catalog

From docs/INVENTORY_CATALOG.md on GitHub

Per-asset-type reference for the inventory map: what every asset_type means, which providers produce it, the metadata keys it carries, the relations its collectors declare, and the edges the linker produces from and to it. Companion to INVENTORY_REFERENCE.md (structures of every output) and INVENTORY_INTERNALS.md (how it works).

How this catalog was built. The metadata keys, value types, declared relations and edge patterns below were recorded from real collector output: every CloudAsset and every linked edge created while the full test suite ran (moto-backed AWS, recorded Azure Resource Graph rows, recorded GCP Cloud Asset Inventory responses) plus an end-to-end map of a simulated multi-account AWS Organization. It is therefore a description of observed shapes, not an exhaustive schema: a collector can add a key that a fixture never triggered (for example a field only set when an optional feature is enabled), and keys whose value was None in every observation show type null. Types listed as not exercised exist in the taxonomy and are produced by collectors or catalogs, but no fixture created one.

Value types: str, int, float, bool, null, list, object (a JSON object). A key with several types (null | str) was observed with each.

Sections

  • Common metadata keys

    Keys that mean the same thing on every asset type that carries them.

  • Asset types by category

    AssetType has 156 values. The category is the section of cloudg/schema/models.py the value is defined in.

  • Per-type reference

    For each type: what it represents, the providers that produced it in the observations, the metadata keys (beyond relations and aliases), the relations its...

  • Relationship matrix

    Every (source type, edge type, relationship, target type) combination the linker produced in the observations, grouped by edge type. none means the edge...

  • Relationship vocabulary

    relationship values are RelationType names from cloudg/graph/ontology_rules.py (64 in all), so the ontology export can use the declared relation. On...

  • Azure parity additions

    The Azure inventory reads child resources, more Resource Graph tables, subscription-level ARM listings, two data planes, the Kubernetes API of AKS clusters...