airship/spyglass
Code Issues Proposed changes
Configuration extraction tool for Airship
116 Commits 1 Branch 0 Tags 2.1 MiB
Jinja 60.4%
Python 38.6%
Makefile 0.8%
Shell 0.2%
386d7c0e57
Go to file
Ryan Schroder 386d7c0e57 Allow rules to be input by user 
New tag -r added so that a rules yaml file can be input.
Rules file outlines rules for data manipulation in the engine.
Preexisting rules left in as the default.

Change-Id: Ide8af31b018b4f888486ae6d48ffb441bf9634a7
2020-01-16 16:48:48 +00:00
doc Allow rules to be input by user 2020-01-16 16:48:48 +00:00
images/spyglass Update Spyglass to run as “airship” user in container 2019-12-10 19:16:23 +00:00
spyglass Allow rules to be input by user 2020-01-16 16:48:48 +00:00
tests Allow rules to be input by user 2020-01-16 16:48:48 +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 Spyglass Docs Update 2019-12-16 17:01:00 +00:00
LICENSE Base code for spyglass 2018-11-28 15:19:43 +05:30
Makefile Standardize Spyglass code with YAPF 2019-07-25 17:01:33 +00:00
MANIFEST.in Remove flask YAML web editor from Spyglass 2019-04-15 18:11:51 +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 Spyglass Docs Update 2019-12-16 17:01:00 +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 a plugin model to support multiple input data sources. The currently supported plugin is the Spyglass Excel plugin (spyglass-plugin-xls).

The Spyglass Excel plugin accepts an engineering spec in the form of a spreadsheet and an index file to read the spreadsheet as inputs and generates site level manifests. As an optional step, it can generate an intermediary YAML which contains all the information that will be rendered to generate Airship site manifests. This optional step will help the deployment engineer modify any data if required.

Getting Started

For more detailed information, please refer to the Index to easily navigate the Getting Started, Developer Quickstart, and Command Line Interface guides.