Commit Graph

18 Commits

Author SHA1 Message Date
Zuul c1be6eb7e3 Merge "Allow rules to be input by user" 2020-02-03 20:03:08 +00:00
Ryan Schroder cddf30092b Docker image guide
Added steps to setting up, creating, and running spyglass in Docker image

Change-Id: Ib168c12306608d19df66fc7961d1ceb28d46f5f1
2020-01-16 11:27:29 -06:00
Ryan Schroder 386d7c0e57 Allow rules to be input by user
New tag -r added so that a rules yaml file can be input.
Rules file outlines rules for data manipulation in the engine.
Preexisting rules left in as the default.

Change-Id: Ide8af31b018b4f888486ae6d48ffb441bf9634a7
2020-01-16 16:48:48 +00:00
Ryan Schroder 161528365d Spyglass Docs Update
Changed paths for all examples, removed references to Tugboat
and Formation

Change-Id: Ibeb80a1c239169bd4f4ecb124e86671891bef99a
2019-12-16 17:01:00 +00:00
Drew Walters ddd6bca645 docs: Update copyright footer
During the recent Airship Working Committee meeting, the committee
addressed feedback from the Airship confirmation review [0]. One such
item was concerned with copyright footers mistakenly claiming rights to
all Airship documentation.

This change updates the footer to attribute documentation to the
Spyglass authors.

[0] https://etherpad.openstack.org/p/airship-wc-meeting-2019-12-09

Change-Id: If9db77b1bc6a0abc710898f5f9c0d2ff7fc25bdf
Signed-off-by: Drew Walters <andrew.walters@att.com>
2019-12-09 22:08:12 +00:00
Ryan Schroder 261b064b65 Update requirements install in docs
Change pip3 install to pipenv install to match new dependency management

Change-Id: Idbfb47744ece56b5a4549687f39c8e3c36be60a5
2019-11-15 22:06:35 +00:00
Ian H Pittwood e65715d1a1 Update Spyglass documentation
Updates CLI commands to match current code

Fixes title formatting on README

Pins six back to 1.12.0 for OpenSUSE incompatibility

Updates package dependencies list

Change-Id: Iedf6a438fbe441315dc1124364eea38056090065
2019-11-14 20:43:01 +00:00
Ian H. Pittwood ee18e3e94b Upgrade Sphinx package
Sphinx 2.1.0 has a bug [0] that causes whitespace to be excluded in
outputted docs. This change updates Sphinx to peg any version >2.1.0.

Safety dependency vulnerability checks now will also cover the doc
requirements.txt.

[0] https://github.com/sphinx-doc/sphinx/issues/6440

Change-Id: I35f1acf4385821969ffa7c9807cf209a59c1d73e
2019-07-10 10:30:05 -05:00
Ian Pittwood a002e4203d Separate plugins from Spyglass
This change removes plugins from Spyglass and places them in separate
repositories. Formation, a proprietary plugin, will be removed by this
change and Tugboat will become its own OpenDev maintained repo,
spyglass-plugin-xls. By creating more streamlined plugin management,
end users should be able to more easily create their own plugins for
different data sources.

Related change https://review.opendev.org/#/c/659116/

Depends-On: Ib2f75878b1a29e835cb8e2323aebe9d431c479e7

Change-Id: Ie0eb2e5aefe6bb764e1aa608e53371adaabb9a17
2019-05-29 10:30:14 -05:00
Ian Pittwood 486662339b Revise CLI documentation
Places detailed CLI information into a separate file similar to the
docs configuration of pegleg.

Updates documentation to reflect new CLI changes from below link.

Depends on CLI changes in https://review.openstack.org/#/c/649452/.

Change-Id: Icf63cfd6f90b1565513b2c3e7fe01712db48f908
2019-05-17 13:56:29 +00:00
Ian Pittwood 69f0975dec Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I1a933b8794c97244b95b6782033b52cbca74b0b6
2019-05-03 13:48:27 -05:00
Alexander Hughes 3bf68e464a PEP-8 code styling and linting
As a newer project, Spyglass is still a work in progress in terms of its
styling. This change is meant to help improve readability and compliance
of Spyglass source code.

To match other Airship projects, this change implements YAPF into tox so
linting is automatically ran. This will hopefully keep formatting grey
areas styled consistently.

PEP-8: https://www.python.org/dev/peps/pep-0008/

OpenStack Style Guidelines:
https://docs.openstack.org/hacking/latest/user/hacking.html

PEP Index: https://www.python.org/dev/peps/

Depends on https://review.openstack.org/#/c/648764.

Change-Id: I45b19cc8a7932fd7823dcb69f64a0a1bf19fc434
2019-04-22 18:46:48 +00:00
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
Hemanth Nakkina 303fce156b Fix: remove references to previous repo
Remove references to att-comdev/spyglass repo

Change-Id: Ie07a5ae6062e61c2705a056713a9fb50ad2361fe
2018-12-04 18:51:57 +05:30
Pawan Singh Pal c82debd18a Update build settings and documentation 2018-11-29 23:29:17 +05:30
Pawan Singh Pal 6c8533c9a1 Add yaml-editor documentation. 2018-11-29 21:01:27 +05:30
Purnendu Ghosh 440015d591 Added base documentation 2018-11-29 17:25:03 +05:30
Purnendu Ghosh 4a8e2720e1 Base Code for Tugboat Plugin and Addition of config files, templates 2018-11-29 02:20:31 +05:30