ROCKETRIDE_PIPELINE_RULES

RocketRide Pipeline Building Rules & Guide

Complete reference for building RocketRide pipelines across any project.

---

Table of Contents

• Pipeline File Format
• Core Structure
• Components
• Data Lanes
• Configuration Profiles
• Environment Variables
• Connection Rules
• Best Practices
• Common Patterns
• Troubleshooting
• Validation Checklist

---

Pipeline File Format

File Naming Convention

• Extension: .pipe (required)
• Examples: chat.pipe, document_processor.pipe, ocr_workflow.pipe
• NOT: .json or .pipeline.json

File Structure

{
	"components": [
		{
			"id": "unique_component_id",
			"provider": "component_type",
			"config": {},
			"ui": {},
			"input": []
		}
	],
	"project_id": "85be2a13-ad93-49ed-a1e1-4b0f763ca618",
	"viewport": { "x": 0, "y": 0, "zoom": 1 },
	"version": 1
}

Field ordering matters: components must come first. The project_id, viewport, and version fields go at the bottom. The source field is optional: the VS Code extension manages it automatically.

---

Core Structure

Required Fields

components (array, required, must be first)

• Array of component objects
• Each component must have a unique id
• Components are connected via input arrays
• Must be the first field in the JSON object

project_id (string, required, goes at the bottom)

• MUST be a unique GUID for each pipeline file
• Format: Standard UUID/GUID (e.g., 85be2a13-ad93-49ed-a1e1-4b0f763ca618)
• Variable substitution NOT supported - must be a literal GUID
• Placement: Put at the bottom of the JSON, after components

Why This Requirement:

• Each pipeline must be uniquely identifiable by the RocketRide engine
• The project_id is read before environment variable substitution occurs
• The GUID serves as the permanent identity of the pipeline