Configuration extraction tool for Airship
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins f24e7cfba7 OpenDev Migration Patch 13 hours ago
doc Remove flask YAML web editor from Spyglass 4 days ago
images/spyglass Base code for spyglass 4 months ago
spyglass Various fixes to Spyglass to resolve tox errors 3 days ago
tools Various fixes to Spyglass to resolve tox errors 3 days ago
.dockerignore Base code for spyglass 4 months ago
.gitignore Base code for spyglass 4 months ago
.gitreview OpenDev Migration Patch 13 hours ago
.zuul.yaml Add gate 2 weeks ago
LICENSE Base code for spyglass 4 months ago
MANIFEST.in Remove flask YAML web editor from Spyglass 4 days ago
Makefile Fix: remove references to previous repo 4 months ago
README.md Added base documentation 4 months ago
requirements.txt Base code for spyglass 4 months ago
setup.py Remove flask YAML web editor from Spyglass 4 days ago
test-requirements.txt Various fixes to Spyglass to resolve tox errors 3 days ago
tox.ini Various fixes to Spyglass to resolve tox errors 3 days ago

README.md

What is Spyglass?

Spyglass is the data extractor tool which can interface with different input data sources to generate site manifest YAML files. The data sources will provide all the configuration data needed for a site deployment. These site manifest YAML files generated by spyglass will be saved in a Git repository, from where Pegleg can access and aggregate them. This aggregated file can then be fed to shipyard for site deployment / updates.

Spyglass follows plugin model to support multiple input data sources. Current supported plugins are formation-plugin and Tugboat. Formation is a rest API based service which will be the source of information related to hardware, networking, site data. Formation plugin will interact with Formation API to gather necessary configuration. Similarly Tugboat accepts engineering spec which is in the form of spreadsheet and an index file to read spreadsheet as inputs and generates the site level manifests. As an optional step it can generate an intermediary yaml which contain all the information that will be rendered to generate Airship site manifests. This optional step will help the deployment engineer to modify any data if required.

Getting Started

For more detailed installation and setup information, please refer to the Getting Started_ guide.

.. _Getting Started: ./doc/source/getting_started.rst