airship
/
spyglass
Code Issues Proposed changes
Configuration extraction tool for Airship
99 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 166483d6ad Fix Spyglass gates 
Zuul gates broke for Spyglass due to an update made to either Zuul or
Openstack's Zuul jobs (I wasn't able to pin it down). The update caused
Zuul to attempt to install Spyglass's requirements.txt file instead of
referring to the method given in the tox configuration that utilizes
Pipenv. To bypass this issue, the requirements.txt will be removed and
Spyglass will be fully moved over to using Pipenv.

Removes requirements.txt

Updates Pipfile and Pipfile.lock for new package releases

Updates Dockerfile to install requirements from Pipfile.lock

Change-Id: I347ef6db18a44e1b88c811aa071ba8c60bccbd53
 		2019-08-14 14:13:47 -05: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 Standardize Spyglass code with YAPF 2019-07-25 17:01:33 +00:00
tests Add tests for site processor init 2019-07-23 09:01:47 -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
.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 Fix Spyglass gates 2019-08-14 14:13:47 -05:00
Pipfile.lock Fix Spyglass gates 2019-08-14 14:13:47 -05: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.