Welcome to astrolabe’s documentation!

astrolabe is a distribution containing tools for automating Atlas operations and running Atlas Planned Maintenance Tests.

Documentation Overview

Installing and Running Locally

Instructions for installing astrolabe and running Atlas Planned Maintenance Tests from your local machine.

Integration Guide

Instructions on how to use astrolabe to test your driver against MongoDB Atlas clusters in Evergreen.

Workload Executor Specification

Information about the workload executor script that drivers must implement in order to use astrolabe.

Atlas Planned Maintenance Test Scenario Format

Information about the file format used to define Atlas Planned Maintenance Tests.

Technical Design: Testing Drivers Against Atlas Planned Maintenance

Background reading about this testing framework’s architecture and design methodology.

Frequently Asked Questions

Answers to questions and issues that come up often.

Table of Contents

• Installing and Running Locally
  • Platform Support
  • Installation
  • Configuration
  • Exploring the API
  • Running Atlas Planned Maintenance Tests
  • Debugging
• Integration Guide
  • Overview
  • Implementing a Workload Executor Script
  • Implementing a Driver Installer Script
  • Updating the Evergreen Configuration
  • Defining Environment Variables
  • Troubleshooting
• Workload Executor Specification
  • User-Facing API
  • Behavioral Description
  • Pseudocode Implementation
  • Reference Implementation
• Atlas Planned Maintenance Test Scenario Format
  • Changes
• Technical Design: Testing Drivers Against Atlas Planned Maintenance
  • Abstract
  • Definitions
  • Architecture Overview
  • Test Scenario Format
  • Workload Executor
  • Test Orchestrator
• Frequently Asked Questions
  • Why do I keep seeing AtlasAuthenticationError: 401: Unauthorized. errors while trying to use astrolabe?
  • Why should we use the custom ubuntu1804-drivers-atlas-testing distro?
  • What is the purpose of the ASTROLABE_EXECUTOR_STARTUP_TIME environment variable?

Indices and tables

• Index

• Module Index

• Search Page