Welcome to astrolabe's documentation!
=====================================

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

Documentation Overview
----------------------

:doc:`installing-running-locally`
  Instructions for installing ``astrolabe`` and running Atlas Planned Maintenance Tests from your local machine.

:doc:`integration-guide`
  Instructions on how to use ``astrolabe`` to test your driver against MongoDB Atlas clusters in Evergreen.

:doc:`spec-workload-executor`
  Information about the workload executor script that drivers must implement in order to use ``astrolabe``.

:doc:`spec-test-format`
  Information about the file format used to define Atlas Planned Maintenance Tests.

:doc:`technical-design`
  Background reading about this testing framework's architecture and design methodology.

:doc:`faq`
  Answers to questions and issues that come up often.

Table of Contents
-----------------

.. toctree::
   :maxdepth: 2

   installing-running-locally
   integration-guide
   spec-workload-executor
   spec-test-format
   technical-design
   faq

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`