airship
/
spyglass
Code Issues Proposed changes
Configuration extraction tool for Airship
43 Commits 1 Branch 0 Tags 2.1 MiB
Jinja 60.4%
Python 38.6%
Makefile 0.8%
Shell 0.2%
Go to file
Alexander Hughes b9f2ce32b3 Add docker build gate 
There is a future requirement for Spyglass to have helm charts. These
charts will need docker images published in a source countrolled
manner.

This change depends on https://review.opendev.org/#/c/657614/ which
adds the airship_spyglass_quay_creds parameters. This patch:
1. Adds the docker-image-build playbook for Spyglass.
2. Uses the playbook in zuul jobs: check, gate and post.
3. Adds the spyglass-single-node nodeset.
4. Adds the vars.yaml file required by docker-image-build playbook.
5. Adds the image_tags.py script required by docker-image-build
   playbook.
6. Adds the docker-systemd.conf file required by docker-image-build
   playbook.

Change-Id: I76981e719a7e42984089fec08e1161a6923c5c52
 		2019-05-07 18:45:16 -04:00
doc Replace git.openstack.org URLs with opendev.org URLs 2019-05-03 13:48:27 -05:00
images/spyglass Update Spyglass make images command 2019-04-24 12:03:32 -05:00
spyglass Refactors CLI to match style of Airship CLIs 2019-05-06 16:04:02 -05:00
tools Add docker build gate 2019-05-07 18:45:16 -04: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 Add yapf configuration file 2019-04-29 15:37:25 -05:00
.zuul.yaml Add docker build gate 2019-05-07 18:45:16 -04: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 Update Spyglass make images command 2019-04-24 12:03:32 -05:00
README.md Added base documentation 2018-11-29 17:25:03 +05:30
requirements.txt Refactors CLI to match style of Airship CLIs 2019-05-06 16:04:02 -05:00
setup.py Refactors CLI to match style of Airship CLIs 2019-05-06 16:04:02 -05:00
test-requirements.txt PEP-8 code styling and linting 2019-04-22 18:46:48 +00:00
tox.ini Enable bandit checks in tox 2019-04-29 16:42:25 +00: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