Cloud Quick Start

The shortest path from zero to a running deployment in ByteOr Cloud.

Prerequisites

  • Access to a ByteOr Cloud organization
  • A project and environment created (or permissions to create them)

Steps

1. Sign In

Open the Cloud UI and authenticate through the browser flow.

2. Set Up Your Environment

Create or select an organization, project, and environment. Environments are independent governance scopes — use separate environments for dev, staging, and production.

3. Create a Pipeline

  1. Create a new pipeline draft
  2. Select the execution target: SingleRing for ordered linear execution, LaneGraph for branching and topology work
  3. Author stages and connections in the editor
  4. The editor projects the shared plan as either a linear canvas or a topology canvas depending on the target

4. Compile a Version

  1. Use preview to validate through the WASM-compiled compiler
  2. Create a version — this produces an immutable compiled record
  3. The version is content-addressed by spec hash

5. Create a Config Bundle

  1. Open the config bundle composer for the version
  2. Start from a guided tuning profile
  3. Override specific fields only when needed
  4. The bundle is associated with your target environment

6. Register an Agent

  1. Create an enrollment token in the target environment
  2. Use the token once to register the agent node
  3. The control plane returns a per-agent runtime API key
  4. The agent uses this key for all subsequent operations

7. Deploy

  1. Create a deployment targeting your version + bundle + environment
  2. Provide approval if the environment requires it
  3. The registered agent receives deployment targeting
  4. Confirm heartbeats appear in the control plane

8. Verify

Check that:

  • The pipeline version exists as an immutable record
  • The config bundle is readable from the environment
  • The deployment is persisted and associated with the correct environment
  • The agent is reporting heartbeats
  • Effective tuning shows requested vs. applied settings

Next Steps

Provenance
Need the canonical source?
Use the public hub to orient yourself, then jump to repo-owned docs or rustdoc when you need contract-level detail.