DOCSEARCHbyAlgolia
Submit Docs

ByteOr Documentation

website·Indexed 30 days ago

https://docs.byteor.com/

Documentation for ByteOr, a four-layer stack for deterministic execution and deployment. Includes guides for ByteOr Cloud, Enterprise runtime, and IndexBus transport substrate, covering pipeline specs, incident replay, governance, and operational runbooks.

Tokens
82.9K
Snippets
128
Records
656
Agent score
48%

What's inside ByteOr

  1. Overview of ByteOr Execution Models

    ByteOr provides two execution models for processing pipelines: SingleRing and LaneGraph. Both models are authored using the same source contract (PipelinePlanV1) and undergo the same validation and lowering pipeline. The choice of execution target is an explicit configuration in the plan, not determined by the shape of the specification.

  2. Overview of Enterprise DataGuard

    Enterprise DataGuard is a governance layer designed to manage sensitive incident and replay material. It ensures that operational data remains usable for debugging and analysis without compromising security or regulatory requirements. It provides three primary capabilities: schema-aware validation of protected inputs before workflow execution, redaction boundaries to prevent data leaks during material export, and the generation of structured, operator-facing evidence reports instead of raw text dumps.

  3. Overview of ByteOr Cloud hosted control plane

    ByteOr Cloud provides a hosted control plane used for managing the lifecycle of configurations and deployments. Key capabilities include draft authoring, version creation, configuration bundles, deployment management, agent enrollment, artifact handling, and replay workflows. It is specifically used for environment-scoped agent reporting and approval-aware rollout orchestration.

  4. Overview of the ByteOr Platform Stack

    ByteOr is organized into four composable layers, each building upon the previous one to provide a governed execution and replay environment for real-time systems:

    1. IndexBus: The foundation layer providing a bounded shared-memory transport substrate (Apache-2.0 / MIT).
    2. ByteOr OSS: Handles deterministic specification, validation, and execution (Apache-2.0 / MIT).
    3. ByteOr Enterprise: Adds governance, approvals, replay capabilities, operator tooling, adapters, and DataGuard (Commercial).
    4. ByteOr Cloud: A hosted commercial SaaS control plane for managing versions, bundles, deployments, agents, and replay.

  5. Overview of IndexBus shared-memory transport

    IndexBus is a bounded shared-memory (SHM) transport substrate that provides the low-level IPC (Inter-Process Communication) contract for the ByteOr stack. It defines the rules for lane semantics, memory layouts, delivery rules, and execution patterns. Developers should use IndexBus when implementing or interfacing with the transport layer, specifically regarding lane capacities, ordering, backpressure behavior, and low-level crate surfaces.

  6. Overview of ByteOr Enterprise Runtime and Operator Surface

    ByteOr Enterprise provides a commercial runtime and operator surface designed for production environments. It extends the Open Source Software (OSS) version to include governance, approval-aware execution, policy gates, evidence capture, dry-run investigation, and incident handling workflows. Key components include the Operator CLI, DataGuard, and replay boundaries for execution mode.

  7. Overview of ByteOr OSS Execution Substrate

    The ByteOr OSS section provides technical documentation for the open-source execution substrate. This includes the pipeline model, validation and lowering paths, deterministic execution primitives, the ABI surface, and crate-level technical details. It is intended for developers needing to work with spec, plan, validation, and lowering contracts, as well as runtime kernels and execution primitives.

  8. Overview of ByteOr Enterprise Runtime and Operator Surface

    ByteOr Enterprise provides a commercial runtime and operator surface designed for production environments. It extends the Open Source Software (OSS) version to include governance, approval-aware execution, policy gates, evidence capture, dry-run investigation, and incident handling workflows. Key components include DataGuard, adapters, and a specialized operator CLI for managing the path from validation through deployment and replay.

  9. Overview of the ByteOr Cloud hosted control plane

    The ByteOr Cloud hosted control plane is used to manage the end-to-end lifecycle of configurations and deployments. Key responsibilities and operational areas include:

    • Content Management: Draft authoring, version creation, and the creation of configuration bundles.
    • Deployment & Orchestration: Managing deployments and approval-aware rollout and replay workflow orchestration.
    • Agent Management: Environment-scoped agent enrollment, reporting, runtime API keys, heartbeats, and artifact upload behavior.
    • Incident Response: Tying together artifacts, investigations, and replay actions.

  10. Overview of ByteOr Open-Source Execution Substrate

    The ByteOr OSS section provides technical documentation for the open-source execution substrate. This includes the pipeline model, validation and lowering paths, deterministic execution primitives, the ABI surface, and crate-level technical details. It defines the layer responsible for spec, plan, validation, and lowering contracts, as well as runtime kernels and execution primitives.

  11. Overview of ByteOr Core Concepts

    The ByteOr platform utilizes a set of shared concepts that apply across all product surfaces (OSS, Cloud, and Enterprise). These core concepts govern how execution models, plan authoring, validation, governance, and the operator loop function. Key areas include:

    • Execution Models: Includes SingleRing and LaneGraph, featuring shared authoring and explicit target selection.
    • Spec Authoring: Based on the PipelinePlanV1 authoring contract and a deterministic KV model.
    • Validation and Compilation: The process by which authored plans are validated, lowered, and converted into immutable runtime versions.
    • Governance and Approvals: A shared approval and policy model used by both Enterprise and Cloud versions.
    • Operator Loop: The recurring workflow of authoring, validating, deploying, capturing, and replaying.

  12. Overview of the ByteOr platform

    ByteOr is a governed execution and replay platform for real-time systems. It provides deterministic pipeline execution combined with policy-gated deployments, incident capture, and audited replay. It is designed to add a deterministic execution layer on top of bounded transport rather than replacing message brokers or acting as a general-purpose ETL/workflow engine.