usage.md

Usage

Inventory resources are project-scoped: they are served by the inventory.miloapis.com API group on a project's control plane, behind project access control (you need access granted on the project). Manage them with datumctl.

For the full field reference, see the generated API reference.

Point datumctl at the project control plane

datumctl auth login
datumctl auth update-kubeconfig --project your-project

Demonstrate basic functionality

Record a region and a site within it, then read them back:

# Create a Region and a Site that references it.
cat <<'EOF' | datumctl apply -f -
apiVersion: inventory.miloapis.com/v1alpha1
kind: Region
metadata:
  name: us-east
spec:
  displayName: US East
  coordinates:
    latitude: 37.5
    longitude: -77.5
---
apiVersion: inventory.miloapis.com/v1alpha1
kind: Site
metadata:
  name: us-east-1a
spec:
  displayName: US East 1A
  regionRef:
    name: us-east
  type: Datacenter
EOF

# List them — the Ready column flips to True once the operator accepts each.
datumctl get regions,sites

NAME      DISPLAY   AGE   READY   REASON
us-east   US East   5s    True    Accepted

NAME         REGION    TYPE         AGE   READY   REASON
us-east-1a   us-east   Datacenter   5s    True    Accepted

Referential integrity is enforced by validating webhooks: deleting a Region while a Site still references it is rejected.

datumctl delete region us-east
# Error: admission webhook "vregion.inventory.miloapis.com" denied the request:
# cannot delete Region us-east: 1 Site(s) still reference it: [us-east-1a]

Explore and audit

datumctl api-resources --api-group=inventory.miloapis.com   # list inventory kinds
datumctl explain site.spec                                  # field documentation
datumctl describe site us-east-1a                           # full object + status
datumctl activity history sites us-east-1a --diff           # who changed what, when