Spacewalk

Spacewalk is an add-on to the ZeroG job-processing system that auto-generates a discoverable, self-documenting REST API for a set of ZeroG job classes. Pass Spacewalk a modules directory and a base job class derived from spacewalk.BaseJob, and Spacewalk will create a REST API with endpoints for all subclasses of the base job that it finds.

ZeroG Documentation

To understand Spacewalk, it helps to first review the ZeroG job-processing system on which it is based. ZeroG documentation can be found at:

• ZeroG: https://zerog.readthedocs.io/en/latest/

Install Spacewalk

$ pip install -e git+https://github.com/tiptapinc/spacewalk.git@0.0.5#egg=spacewalk

Spacewalk Documentation

Examples & Reference:

• Auto-Generated API
  • Branches
  • Leaves
  • Schemas
  • Run a Job
  • Monitor a Job
  • Job Details
  • Job Results
• Code Examples
  • Make a Job Hierarchy
  • Create & Start a Spacewalk Service
• Run Examples in Docker
  • Install Docker
  • Clone Spacewalk Repository
  • Run With Docker-Compose
  • Docker Exec to Spacewalk Container
• API Reference
  • Jobs
  • Server
  • Structure
  • Handlers

Indices and tables

• Index

• Module Index

• Search Page