Explore the Atlas example inventory¶
Use the same small inventory as the server documentation and the other Hubuum interfaces. Atlas demonstrates classes, objects, relations, and access with four classes and ten connected objects.
Load the shared dataset¶
Follow the server's Atlas dataset guide
to download and import the inventory into an evaluation server. The guide and
downloads are pinned to server v0.0.17, the target of hubuum_client 0.13.0
used by CLI v0.0.13. Keep the server as the canonical fixture source; do not copy
a second fixture into this repository.
The import aborts atomically on name collisions and contains no passwords, tokens, users, or group memberships. Its separate backup replaces all application data and is intended for resetting a disposable demo installation. The server guide owns the loading, restore, compatibility, and checksum instructions.
| Class | Objects to explore | Schema and authority |
|---|---|---|
| Service | Atlas, Beacon | Enforced schema; maintained in Hubuum |
| Server | web-01, web-02, worker-01 | Enforced schema; reference inventory data |
| Location | Oslo, Bergen | Schema-free; reference facilities data |
| Context | Research notes, Migration checklist, Capacity observation | Schema-free; locally maintained notes and an upstream observation |
A class defines a resource type and its schema policy. Its objects hold the
individual JSON records. Source ownership is independent of schema policy:
data.source is example metadata, not automatic synchronization or write
protection.
Find classes, then their objects¶
After connecting the CLI, find the Service class and list the Server objects:
There are three servers: web-01, web-02, and worker-01. Filter by a JSON value:
The result contains web-01 followed by web-02. Both support the Atlas service; worker-01 supports Beacon and has only 8 GiB of memory. Discover Atlas itself:
The Server class has a shared monthly_cost computed field:
After background computation, web-01's monthly_cost is 50: compute 45 plus storage 5, in fictional cost units. Continue with search, output pipelines, and schema evolution using the same model.
Relations and access¶
Atlas runs on web-01 and web-02; their locations are Oslo and Bergen. Atlas also links to Research notes and Migration checklist. Class relations define which resource types connect; object relations connect these specific instances.
The example creates empty atlas-readers and atlas-operators groups. A principal assigned only to atlas-readers can read all ten objects without changing them. A principal assigned only to atlas-operators can read and maintain the five Server/Location objects in atlas-demo-operations, but cannot read the service catalogue in its parent collection. Test these differences with non-admin accounts and an unscoped token; other memberships and token scopes affect access.
For exact data, expected relationships, and checksums, return to the server's canonical dataset guide. The server corpus tests verify import and restore, schemas, permissions, computed values, filters, and pagination. Each client retains its own compatibility and integration tests; the example does not change the client library's server target.