Jumpstarter Docs

Warning

This documentation may be incomplete, out of date, or incorrect as this project is still evolving.

Welcome to the Jumpstarter documentation!

Table of Contents

• Introduction
  • What is Jumpstarter?
  • How Jumpstarter Works
    • Development Modes
  • Clients
    • Types of Clients
  • Drivers
    • Driver Configuration
    • Driver I/O
    • Composite Drivers
  • Exporters
    • Hosts
    • Configuration
    • Running an Exporter
  • Jumpstarter Service
    • Controller
    • Router
• Installation
  • Service
    • Prerequisites
    • Installation
  • Service CLI
    • Installing the CLI
    • Configuration
    • Usage
  • Python Packages
  • Container package
    • Hardware Access for exporters
• Getting Started Guides
  • Setup a Local Exporter
    • Create Exporter Configuration
    • Enter Exporter Shell
    • Use j Command
    • Use Python API
    • Exit Exporter Shell
  • Setup an Exporter
  • Setup the Controller Service
• Command-Line Interface
  • Getting Started
  • Manage Clients
    • Creating a Client
  • Manage Exporters
    • Creating a exporter
  • Manage Configuration
  • Run Tests
    • Running tests through a central server
    • Running tests locally (without a server)
  • Jumpstarter Shell
• Configuration
  • User Configuration
  • System Configuration
  • Clients
    • Client Config
    • Multiple Clients
    • Creating a client in the distributed service
    • Importing a client created by the administrator
    • Client Environment Variables
  • Exporters
    • Exporter Config
    • Exporter CLI Commands
    • Creating a exporter in the distributed service
    • Creating a exporter configuration file
    • Exporter Environment Variables
  • Running an Exporter
    • Running using Podman
• Drivers
• Architecture
  • Components
    • jumpstarter-python
    • jumpstarter-controller
  • Authentication
  • Jumpstarter Commands
  • Running Tests Locally (without a server)
    • YAML Tests
    • Python Tests
  • Running tests through a central controller
• Glossary
  • Acronyms
  • Entities
  • Concepts
• CLI Reference
  • jmp
    • create
    • delete
    • lease
    • list
    • shell
    • use
    • version
  • jmp-exporter
    • create
    • delete
    • edit
    • list
    • run
    • shell
    • version
• API Reference
  • Driver API Reference
    • Driver
    • Driver Client
    • Example
  • Adapter API Reference
    • Adapters
  • Driver Packages
    • Ustreamer driver
    • CAN driver
    • SDWire driver

Resources

• Python Packages