airship
/
spyglass
Code Issues Proposed changes
Configuration extraction tool for Airship
110 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 e65715d1a1 Update Spyglass documentation 
Updates CLI commands to match current code

Fixes title formatting on README

Pins six back to 1.12.0 for OpenSUSE incompatibility

Updates package dependencies list

Change-Id: Iedf6a438fbe441315dc1124364eea38056090065
 		2019-11-14 20:43:01 +00:00
doc Update Spyglass documentation 2019-11-14 20:43:01 +00:00
images/spyglass Import GPG keys in OpenSUSE image 2019-08-21 11:01:14 -05:00
spyglass Implement intermediary file validation 2019-08-29 08:39:24 -05:00
tests Implement intermediary file validation 2019-08-29 08:39:24 -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 Upgrade yapf to 0.28 2019-08-14 19:15:04 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:52:20 +00:00
.style.yapf Standardize Spyglass code with YAPF 2019-07-25 17:01:33 +00:00
.zuul.yaml Fix OpenSUSE image build 2019-08-16 20:02:57 +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 Standardize Spyglass code with YAPF 2019-07-25 17:01:33 +00:00
Pipfile Update Spyglass documentation 2019-11-14 20:43:01 +00:00
Pipfile.lock Update Spyglass documentation 2019-11-14 20:43:01 +00:00
README.rst Update Spyglass documentation 2019-11-14 20:43:01 +00: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
tox.ini Use Pipfile.lock only in tox gates 2019-08-14 19:14:51 +00: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.