airship
/
spyglass
Code Issues Proposed changes
Configuration extraction tool for Airship
29 Commits 1 Branch 0 Tags 2.1 MiB
Jinja 60.4%
Python 38.6%
Makefile 0.8%
Shell 0.2%
Go to file
OpenDev Sysadmins f24e7cfba7 OpenDev Migration Patch 
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
 		2019-04-19 19:52:20 +00:00
doc Remove flask YAML web editor from Spyglass 2019-04-15 18:11:51 +00:00
images/spyglass Base code for spyglass 2018-11-28 15:19:43 +05:30
spyglass Various fixes to Spyglass to resolve tox errors 2019-04-16 12:22:53 -05:00
tools Various fixes to Spyglass to resolve tox errors 2019-04-16 12:22:53 -05: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 Add gate 2019-04-04 19:25:58 -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 Fix: remove references to previous repo 2018-12-04 18:51:57 +05:30
README.md Added base documentation 2018-11-29 17:25:03 +05:30
requirements.txt Base code for spyglass 2018-11-28 15:19:43 +05:30
setup.py Remove flask YAML web editor from Spyglass 2019-04-15 18:11:51 +00:00
test-requirements.txt Various fixes to Spyglass to resolve tox errors 2019-04-16 12:22:53 -05:00
tox.ini Various fixes to Spyglass to resolve tox errors 2019-04-16 12:22:53 -05:00

README.md

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.

.. _Getting Started: ./doc/source/getting_started.rst