Configuration extraction tool for Airship
Go to file
Ian Pittwood 8a39a6fd17 Resolves Bandit 101 errors from misusing asserts
From Bandit's docs:
It was discovered that some projects used assert to enforce interface
constraints. However, assert is removed with compiling to optimised byte
coden (python -o producing *.pyo files). This caused various protections
to be removed. The use of assert is also considered as general bad
practice in OpenStack codebases.

Change-Id: Ie2b5e9cc3e1afcf9e9bd0f8675947754fa1e4b7d
2019-04-09 19:47:13 +00:00
doc Fix: remove references to previous repo 2018-12-04 18:51:57 +05:30
images/spyglass Base code for spyglass 2018-11-28 15:19:43 +05:30
spyglass Resolves Bandit 101 errors from misusing asserts 2019-04-09 19:47:13 +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 Update build settings and documentation 2018-11-29 23:29:17 +05:30
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 Fix: remove references to previous repo 2018-12-04 18:51:57 +05:30
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