# OSIRIS JSON

> OSIRIS JSON is an open, vendor-neutral specification for describing infrastructure resources, metadata, groups, provider provenance, and explicit topological relationships across hyperscalers, cloud and hosting platforms, on-premises IT, and selected OT environments.

OSIRIS JSON represents what exists and how it relates at a specific point in time. The ecosystem separates the authoritative specification and core schema, locally executed producers, three-level validation tooling, consumers under development, and user-selected downstream integrations.

- The specification and core schema define the OSIRIS JSON format.
- OSIRIS JSON Producers discover, normalize, redact, and emit portable snapshot documents.
- The OSIRIS JSON Toolbox validates documents structurally, semantically, and against optional domain guidance.
- OSIRIS JSON Consumers are under development for architecture documentation reports, audit reports, snapshot diff views, and automatic topology generation and updates.
- The generated JSON document may also be used, at the owner's discretion, with CMDB/IPAM/DCIM workflows, AI platforms, agents, MCP servers, custom analytics, and third-party tools.

Last reviewed: 2026-07-13

## Authoritative Sources

- [OSIRIS JSON Format Specification](https://osirisjson.org/en/specification): Authoritative definition of the OSIRIS JSON format, semantics, compatibility rules, and normative requirements.
- [OSIRIS JSON Core Schema v1.0](https://osirisjson.org/schema/v1.0/osiris.schema.json): Canonical JSON Schema Draft 2020-12 document for structural validation.
- [OSIRIS JSON GitHub Organization](https://github.com/osirisjson): Specification, producers, toolbox, editor integrations, and community repositories.

## Introduction

- [Welcome to OSIRIS JSON](https://docs.osirisjson.org/introduction/welcome/): Documentation navigation by role and ecosystem overview.
- [What Is OSIRIS JSON?](https://docs.osirisjson.org/introduction/what-is-osiris/): Purpose, architecture, scope, and core concepts.
- [Real-World Use Cases](https://docs.osirisjson.org/introduction/use-cases/): Audits, documentation, topology, drift, migration, IT/OT, and user-controlled integrations.

## Producers

- [OSIRIS JSON Producers: Getting Started](https://docs.osirisjson.org/osiris-producers/getting-started/): Generate point-in-time snapshots from supported infrastructure sources.
- [Install OSIRIS JSON Producers](https://docs.osirisjson.org/osiris-producers/installation/): Linux, macOS, Windows, package, binary, and Go installation.
- [Producer Security](https://docs.osirisjson.org/osiris-producers/security/): Security analysis, redaction, and producer safety guardrails.
- [Amazon Web Services Producer](https://docs.osirisjson.org/osiris-producers/hyperscalers/amazon-aws/): AWS producer documentation.
- [Microsoft Azure Producer](https://docs.osirisjson.org/osiris-producers/hyperscalers/microsoft-azure/): Azure producer documentation.
- [Cisco Producer](https://docs.osirisjson.org/osiris-producers/network/cisco/): Cisco producer documentation.

## Validation and Toolbox

- [OSIRIS JSON Toolbox CLI](https://docs.osirisjson.org/validate/toolbox-cli/): Local and CI/CD validation, diagnostics, formats, and exit codes.
- [Validation Levels](https://docs.osirisjson.org/validate/validation-levels/): Structural, semantic, and domain validation model.

## Consumers

- [OSIRIS JSON Consumers](https://docs.osirisjson.org/osiris-consumers/getting-started/): Consumer candidates currently under development.

## Examples

- [IT Infrastructure Examples](https://docs.osirisjson.org/examples/it-infrastructure/): Cloud, hybrid, data center, network, virtualization, and storage examples.
- [OT Infrastructure Examples](https://docs.osirisjson.org/examples/ot-infrastructure/): Operational technology and IT/OT examples.

## Developer Documentation

- [Developer Documentation](https://docs.osirisjson.org/developer-guidelines/welcome/): Entry point for implementers and contributors.
- [Architecture Guidelines](https://docs.osirisjson.org/developer-guidelines/architecture/): Ecosystem boundaries, dependency rules, and canonical responsibilities.
- [Producer Guidelines](https://docs.osirisjson.org/developer-guidelines/producers/producer-guidelines/): Mapping, identity, normalization, redaction, and testing rules.
- [Producer SDK](https://docs.osirisjson.org/developer-guidelines/producers/producer-sdk/): Go producer SDK internals and reusable components.
- [Writing a Producer](https://docs.osirisjson.org/developer-guidelines/producers/writing-a-producer/): Practical producer implementation guide.

## Community and Commitments

- [The OSIRIS JSON Manifesto](https://osirisjson.org/en/commitments/manifesto): Project principles and commitments.
- [Roadmap](https://osirisjson.org/en/commitments/roadmap): Current implementation status and planned work.
- [Governance](https://osirisjson.org/en/commitments/governance): Governance model.
- [Maintainers](https://osirisjson.org/en/commitments/maintainers): Maintainer information.
- [Contributing](https://docs.osirisjson.org/community/contributing/): Contribution process and community guidance.

## Optional

- [Full LLM Context](https://osirisjson.org/llms-full.txt): Expanded machine-readable overview of the specification and ecosystem.
- [Newsroom](https://osirisjson.org/en/news): Project announcements and releases.