Configuration extraction tool for Airship
Go to file
Hughes, Alexander (ah8742) 90b76c8bae Update Spyglass base image to ubuntu:16.04
Per community discussion updating default image to ubuntu:16.04 in
place of python:3.6 for two reasons:
1. Reduce number of vulnerabilities in the built image
2. Standardize across Airship the default image used as ubuntu:16.04

Change-Id: I598989ae15a86520850dbf6693feab659a135fff
2019-06-04 16:50:53 +00:00
doc Revise CLI documentation 2019-05-17 13:56:29 +00:00
images/spyglass Update Spyglass base image to ubuntu:16.04 2019-06-04 16:50:53 +00:00
spyglass Implements PBR for packaging 2019-05-10 18:49:54 +00:00
tools Add docker build gate 2019-05-07 18:45:16 -04:00
.dockerignore Base code for spyglass 2018-11-28 15:19:43 +05:30
.gitignore Base code for spyglass 2018-11-28 15:19:43 +05:30
.gitreview OpenDev Migration Patch 2019-04-19 19:52:20 +00:00
.zuul.yaml Encrypt git mirroring ssh_key to specific project 2019-05-23 13:11:12 -05:00
LICENSE Base code for spyglass 2018-11-28 15:19:43 +05:30
Makefile Update Spyglass make images command 2019-04-24 12:03:32 -05:00
MANIFEST.in Remove flask YAML web editor from Spyglass 2019-04-15 18:11:51 +00:00
README.rst Implements PBR for packaging 2019-05-10 18:49:54 +00:00
requirements.txt Upgrade PyYAML from 3.12 to 5.1 2019-05-14 11:38:20 -05:00
setup.cfg Implements PBR for packaging 2019-05-10 18:49:54 +00:00
setup.py Implements PBR for packaging 2019-05-10 18:49:54 +00:00
test-requirements.txt PEP-8 code styling and linting 2019-04-22 18:46:48 +00:00
tox.ini Add readthedocs job for Spyglass 2019-05-16 14:39:46 +00:00

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.