For Auditors & Compliance Officers
Understand how OSIRIS JSON provides immutable, UTC-labeled, point-in-time snapshots of infrastructure states.
- Read about Auditing and Compliance Use Cases
- Learn about Built-in Security & Redaction
Welcome to OSIRIS JSON
Welcome to the documentation portal for OSIRIS JSON, The Open Specification for Infrastructure Resource Interchange Schema designed to allow you to take snapshots of your infrastructure at a point in time.
Modern enterprise environments suffer from extreme infrastructure data fragmentation. When managing heterogeneous systems across public clouds, private virtualization, on-premise hardware, and operational technology (OT), organizations often face high tool integration costs, documentation drift, and the risks of tribal knowledge silos. OSIRIS JSON addresses these challenges by offering a lightweight, vendor-neutral schema to normalize and capture the state of your infrastructure at a point in time.
Navigating the Documentation by Role
Section titled “Navigating the Documentation by Role”To help you get the most out of the OSIRIS JSON ecosystem, we have structured our documentation to align with different professional goals:
For Solution & Enterprise Architects
Learn how to leverage normalized topologies to eliminate tribal knowledge, infrastructure guessing, establish a normalized foundation baseline for your infrastructure, and maintain clear end-to-end visibility.
- Explore Architectural Use Cases
- Browse IT Examples
- Browse OT Examples
For Platform & Security Engineers
See how to automate diagramming, track configuration drift, and query system relationships programmatically.
- Learn about OSIRIS Consumers
- Read about The Validation Pipeline
For Software Developers
Find specifications, SDKs, and guidelines to build your own custom OSIRIS JSON producers or write integrations.
- Check the Developer Guidelines
- Explore the Go Producer SDK
Documentation Structure
Section titled “Documentation Structure”Our documentation is divided into five main sections:
- Introduction & Core Concepts: High-level overviews, architectural value propositions, and real-world use cases.
- Producers & Integration: Guides on how to execute OSIRIS JSON Producers locally or in CI/CD to capture snapshots from AWS, Azure, Cisco, and more.
- Consumers & Tooling: Tools that ingest OSIRIS JSON documents to generate visual topologies, reports, and change drift logs.
- Validation: An explanation of the three-level validation pipeline to guarantee metadata and relational integrity.
- Developer & Contributor Space: Specifications, guidelines, and SDK details for building on top of the OSIRIS format.
Get Involved in the Community
Section titled “Get Involved in the Community”OSIRIS is a vendor-neutral, open specification that thrives on collaboration. Whether you want to suggest a new resource schema, report a bug, or write an OSIRIS JSON producer for a specific vendor or platform, you can engage with us directly:
GitHub Discussions
Share ideas, propose schema extensions, and ask questions. Join the discussion
Issue Tracking
Report bugs, submit feature requests, and follow development updates. Open an issue
Contributing Guidelines
Learn about our governance model, roles, and how to submit pull requests. Read the Contributing Guide