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
  • Python Packages and CLI
    • Release install
    • Development install
    • Running in a Container
    • Python Components
  • Service
    • Prerequisites
    • Installation
• Getting Started Guides
  • Setup a Local Exporter
    • Prerequisites
    • Create an Exporter Config
    • Spawn an Exporter Shell
  • Setup a Remote Exporter/Client
    • Prerequisites
    • Create an Exporter
    • Run an Exporter
    • Create a Client
    • Connect to the Exporter
• Command-Line Interface
  • Reference
    • jmp
  • Manage Clients
    • Creating a Client
  • Manage Exporters
    • Creating a exporter
  • Running tests
    • Running tests through a central server
    • Running tests locally (without a server)
    • Using jumpstarter from testing frameworks
• Configuration
  • User Configuration
  • Clients
    • Client Config
  • Multiple Clients
  • Creating a client in the distributed service
  • Importing a client created by the administrator
  • Client Environment Variables
  • System Configuration
  • 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
• Architecture
  • Components
    • jumpstarter-python
    • jumpstarter-controller
  • Authentication
  • Jumpstarter Commands
  • Running Tests Locally (without a server)
    • Python Tests
  • Running tests through a central controller
    • Drivers
• Glossary
  • Acronyms
  • Entities
  • Concepts
• API Reference
  • Driver Packages
    • CAN driver
    • Network drivers
    • PySerial
    • SDWire driver
    • Shell driver
    • SNMP
    • TFTP Driver
    • Ustreamer driver
    • Yepkit
  • Adapter Packages
    • Network adapters
  • Base Driver classes
    • Driver
    • Driver Client
    • Example

Resources

• Python Packages