3e715e16eb
All Airship projects are moving to GitHub issues. This change adds a GitHub security policy that links to the official Airship vulnerability management process [0]. When users on GitHub click "New Issue" on this GitHub repository, they will see an option to report a security vulnerability, which will direct them to our official policy. [0] https://airship-docs.readthedocs.io/en/latest/security/vulnerabilities.html Change-Id: Iaf060dd0085c21f0c4f18f100e3e053b5ceedbed Signed-off-by: Drew Walters <andrew.walters@att.com>
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.