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.
 
 
 
Alexander Hughes d460e0aaa0 Fix image build checks missing setuptools 2 years ago
.github Update Airship vulnerability link 2 years ago
doc Merge "Allow rules to be input by user" 3 years ago
images/spyglass Update Spyglass to run as “airship” user in container 3 years ago
spyglass Allow rules to be input by user 3 years ago
tests Allow rules to be input by user 3 years ago
tools Fix image build checks missing setuptools 2 years ago
.dockerignore Base code for spyglass 4 years ago
.gitignore Upgrade yapf to 0.28 3 years ago
.gitreview OpenDev Migration Patch 3 years ago
.style.yapf Standardize Spyglass code with YAPF 3 years ago
.zuul.yaml Spyglass Docs Update 3 years ago
LICENSE Base code for spyglass 4 years ago
MANIFEST.in Remove flask YAML web editor from Spyglass 3 years ago
Makefile Standardize Spyglass code with YAPF 3 years ago
Pipfile Fix image build checks missing setuptools 2 years ago
Pipfile.lock Fix image build checks missing setuptools 2 years ago
README.rst Docker image guide 3 years ago
setup.cfg Separate plugins from Spyglass 3 years ago
setup.py Implements PBR for packaging 3 years ago
tox.ini Use Pipfile.lock only in tox gates 3 years ago

README.rst

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 a plugin model to support multiple input data sources. The currently supported plugin is the Spyglass Excel plugin (spyglass-plugin-xls).

The Spyglass Excel plugin accepts an engineering spec in the form of a spreadsheet and an index file to read the spreadsheet as inputs and generates site level manifests. As an optional step, it can generate an intermediary YAML which contains all the information that will be rendered to generate Airship site manifests. This optional step will help the deployment engineer modify any data if required.

Getting Started

For more detailed information, please refer to the Index to easily navigate the Getting Started, Developer Quickstart, and Command Line Interface guides.