airship
/
spyglass
Code Issues Proposed changes
Configuration extraction tool for Airship
76 Commits 1 Branch 0 Tags 2.1 MiB
Jinja 60.4%
Python 38.6%
Makefile 0.8%
Shell 0.2%
Go to file
Ian H Pittwood 746d7ca2ec Add site_config.yaml back into examples 
Spyglass uses additional configuration files to add in any information
not included by a data source. This configuration file should be usable
independent of the data source used. This change adds the
site_config.yaml example file back into the examples folder after it was
initially removed in the project separation of spyglass-plugin-xls.

Change-Id: I9be76c89076327b8ff928aa3da6c91cca0397cc2
 		2019-06-26 14:58:54 -05:00
doc Separate plugins from Spyglass 2019-05-29 10:30:14 -05:00
images/spyglass Spyglass opensuse image support 2019-06-07 20:46:08 +00:00
spyglass Add site_config.yaml back into examples 2019-06-26 14:58:54 -05:00
tests Implements data object models 2019-06-21 15:00:46 -05:00
tools Multi multi distro support images 2019-06-07 19:15:31 +00: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 Disable voting on openSUSE 2019-06-20 13:44:29 +00:00
LICENSE Base code for spyglass 2018-11-28 15:19:43 +05:30
MANIFEST.in Remove flask YAML web editor from Spyglass 2019-04-15 18:11:51 +00:00
Makefile Add tests into Zuul config and Makefile 2019-06-17 16:09:25 +00:00
README.rst Implements PBR for packaging 2019-05-10 18:49:54 +00:00
requirements.txt Pin dependency versions 2019-06-10 10:42:20 -05:00
setup.cfg Separate plugins from Spyglass 2019-05-29 10:30:14 -05:00
setup.py Implements PBR for packaging 2019-05-10 18:49:54 +00:00
test-requirements.txt Pin dependency versions 2019-06-10 10:42:20 -05:00
tox.ini Adds tests for Spyglass data objects 2019-06-18 15:15:28 -05:00

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 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.