
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
1.2 KiB
1.2 KiB
Spyglass Documentation
Overview
Spyglass is a data extraction 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.
getting_started tugboat