airship
/
spyglass
Code Issues Proposed changes
Configuration extraction tool for Airship
27 Commits 1 Branch 0 Tags 2.1 MiB
Jinja 60.4%
Python 38.6%
Makefile 0.8%
Shell 0.2%
Go to file
Ian Pittwood 8dd891aced Remove flask YAML web editor from Spyglass 
Spyglass was originally built with a web-based YAML editor.
Unfortunately, the presence of the editor has caused some problems. It
can cause the Docker container to freeze before creating the
intermediary YAML file. The execution of the flask app is also the
root cause for the Bandit B104 errors and B605 error.

Since the target audience for Spyglass is developers, it can be
assumed that they will have access to an editor with support for YAML
files. Having a web-based version of the YAML editor is unnecessary and
will just result in more code to maintain in the future.

Removes the editor script from utils.

Removes the yaml-editor entry point from the package.

Removes references to the yaml-editor from the CLI and engine.

Resolves all known Bandit errors.

In the future, a pause in execution could be provided to allow users to
make quick edits. Log messages could also notify users when a
placeholder value is inserted in the intermediary so they can fix it.

Change-Id: Ibc37e61f93b33904ea839e12fe5a8d586985e0b1
 		2019-04-15 18:11:51 +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 Remove flask YAML web editor from Spyglass 2019-04-15 18:11:51 +00:00
tools Fix: remove references to previous repo 2018-12-04 18:51:57 +05:30
.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 Add default zuul job 2018-12-01 11:03:57 +05:30
.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
tox.ini Base code for spyglass 2018-11-28 15:19:43 +05:30

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