airship
/
spyglass
Code Issues Proposed changes
Configuration extraction tool for Airship
100 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 dae192efc6 Upgrade yapf to 0.28 
Upgrades yapf to newest version, 0.28.0, and runs the formatter to
update all existing code.

Adds entry to .gitignore to ignore pyenv installations.

Change-Id: I11512a8a522cc530165461cc8f52f7ff010dd092
 		2019-08-14 19:15:04 +00:00
doc Upgrade Sphinx package 2019-07-10 10:30:05 -05:00
images/spyglass Fix Spyglass gates 2019-08-14 14:13:47 -05:00
spyglass Upgrade yapf to 0.28 2019-08-14 19:15:04 +00:00
tests Upgrade yapf to 0.28 2019-08-14 19:15:04 +00: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 Spyglass gates 2019-08-14 14:13:47 -05: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 Upgrade yapf to 0.28 2019-08-14 19:15:04 +00:00
Pipfile.lock Upgrade yapf to 0.28 2019-08-14 19:15:04 +00:00
README.rst Implements PBR for packaging 2019-05-10 18:49:54 +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 Standardize Spyglass code with YAPF 2019-07-25 17:01:33 +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.