Spyglass Docs Update
Changed paths for all examples, removed references to Tugboat and Formation Change-Id: Ibeb80a1c239169bd4f4ecb124e86671891bef99a
This commit is contained in:
Ryan Schroder
parent
261b064b65
commit
5a0f98a84f
22
README.rst
22
README.rst
|
|
@ -8,20 +8,16 @@ 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.
|
||||
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.
|
||||
Spyglass follows the plugin model to support multiple input data sources.
|
||||
The currently supported plugin is the XLS plugin (spyglass-plugin-xls).
|
||||
The XLS plugin accepts engineering spec in the form of a spreadsheet and
|
||||
an index file to read the spreadsheet as inputs and generates the 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 to modify any data if required.
|
||||
|
||||
Getting Started
|
||||
---------------
|
||||
|
|
|
|||
|
|
@ -57,13 +57,13 @@ Options
|
|||
Path where the intermediary file will be created. Must be a writeable
|
||||
directory.
|
||||
|
||||
**-x / --excel-file** (Required for "tugboat" plugin).
|
||||
**-x / --excel-file** (Required for XLS plugin).
|
||||
|
||||
Path to the engineering excel file. Multiple files can be included, provided
|
||||
they follow the same specification. Must be readable file(s) in a Microsoft
|
||||
Excel supported format (.xls, .xslx, etc...).
|
||||
|
||||
**-e / --excel-spec** (Required for "tugboat" plugin).
|
||||
**-e / --excel-spec** (Required for XLS plugin).
|
||||
|
||||
Path to the specification YAML that defines the content of the provided
|
||||
engineering excel files. Must be a readable file in YAML format.
|
||||
|
|
@ -108,13 +108,13 @@ Saves the intermediary file used to make the manifests created by the command.
|
|||
Path where the intermediary file will be created. Must be a writeable
|
||||
directory.
|
||||
|
||||
**-x / --excel-file** (Required for "tugboat" plugin).
|
||||
**-x / --excel-file** (Required for XLS plugin).
|
||||
|
||||
Path to the engineering excel file. Multiple files can be included, provided
|
||||
they follow the same specification. Must be readable file(s) in a Microsoft
|
||||
Excel supported format (.xls, .xslx, etc...).
|
||||
|
||||
**-e / --excel-spec** (Required for "tugboat" plugin).
|
||||
**-e / --excel-spec** (Required for XLS plugin).
|
||||
|
||||
Path to the specification YAML that defines the content of the provided
|
||||
engineering excel files. Must be a readable file in YAML format.
|
||||
|
|
@ -220,27 +220,30 @@ Generating intermediary and manifests
|
|||
|
||||
.. code-block:: bash
|
||||
|
||||
spyglass excel documents -i -x SiteDesignSpec_v0.1.xlsx \
|
||||
-e excel_spec_upstream.yaml -c site_config.yaml \
|
||||
-s airship-seaworthy -t <j2 template dir>
|
||||
spyglass excel documents -i -x ../spyglass-plugin-xls/spyglass_plugin_xls/examples/SiteDesignSpec_v0.1.xlsx \
|
||||
-e ../spyglass-plugin-xls/spyglass_plugin_xls/examples/excel_spec.yaml \
|
||||
-c ../spyglass-plugin-xls/spyglass_plugin_xls/examples/site_config.yaml \
|
||||
-s airship-seaworthy -t spyglass/examples/templates/
|
||||
|
||||
Generating intermediary without manifests
|
||||
-----------------------------------------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
spyglass excel intermediary -x SiteDesignSpec_v0.1.xlsx \
|
||||
-e excel_spec_upstream.yaml -c site_config.yaml \
|
||||
-s airship-seaworthy
|
||||
spyglass excel intermediary -x ../spyglass-plugin-xls/spyglass_plugin_xls/examples/SiteDesignSpec_v0.1.xlsx \
|
||||
-e ../spyglass-plugin-xls/spyglass_plugin_xls/examples/excel_spec.yaml \
|
||||
-c ../spyglass-plugin-xls/spyglass_plugin_xls/examples/site_config.yaml \
|
||||
-s airship-seaworthy
|
||||
|
||||
Generating manifests without intermediary
|
||||
-----------------------------------------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
spyglass excel documents -x SiteDesignSpec_v0.1.xlsx \
|
||||
-e excel_spec_upstream.yaml -c site_config.yaml \
|
||||
-s airship-seaworthy -t <j2 template dir>
|
||||
spyglass excel documents -x ../spyglass-plugin-xls/spyglass_plugin_xls/examples/SiteDesignSpec_v0.1.xlsx \
|
||||
-e ../spyglass-plugin-xls/spyglass_plugin_xls/examples/excel_spec.yaml \
|
||||
-c ../spyglass-plugin-xls/spyglass_plugin_xls/examples/site_config.yaml \
|
||||
-s airship-seaworthy -t spyglass/examples/templates/
|
||||
|
||||
Generating manifests using intermediary
|
||||
***************************************
|
||||
|
|
@ -249,9 +252,9 @@ Generating manifests using intermediary
|
|||
|
||||
spyglass mi <intermediary.yaml> -t <j2 template dir>
|
||||
|
||||
Where sample 'excel_spec_upstream.yaml', 'SiteDesignSpec_v0.1.xlsx'
|
||||
'site_config.yaml' and J2 templates can be found under 'spyglass/examples'
|
||||
folder.
|
||||
Where sample 'excel_spec.yaml', 'SiteDesignSpec_v0.1.xlsx', and 'site_config.yaml'
|
||||
can be found in spyglass-plugin-xls in the 'spyglass_plugin_xls/examples' folder.
|
||||
The J2 templates can be found in the 'spyglass/examples' folder.
|
||||
|
||||
Validate Documents
|
||||
******************
|
||||
|
|
|
|||
|
|
@ -58,10 +58,10 @@ airship-spyglass directory.
|
|||
|
||||
mkdir intermediate
|
||||
spyglass excel documents -s airship-seaworthy -d intermediate -i \
|
||||
--excel-spec spyglass/examples/excel_spec.yaml \
|
||||
--excel-file spyglass/examples/SiteDesignSpec_v0.1.xlsx \
|
||||
--site-configuration spyglass/examples/site_config.yaml \
|
||||
--template-dir spyglass/examples/templates/
|
||||
--excel-spec ../spyglass-plugin-xls/spyglass_plugin_xls/examples/excel_spec.yaml \
|
||||
--excel-file ../spyglass-plugin-xls/spyglass_plugin_xls/examples/SiteDesignSpec_v0.1.xlsx \
|
||||
--site-configuration ../spyglass-plugin-xls/spyglass_plugin_xls/examples/site_config.yaml \
|
||||
--template-dir spyglass/examples/templates/
|
||||
|
||||
6. Run spyglass on the intermediate document to generate manifests.
|
||||
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ Architecture
|
|||
| | | +-------+ |
|
||||
| | +------>| |Generic| |
|
||||
+-----------+ | | | |Object | |
|
||||
|Tugboat(Xl)| I | | | +-------+ |
|
||||
|XLS | I | | | +-------+ |
|
||||
|Plugin | N | | | | |
|
||||
+-----------+ T | | | | |
|
||||
| E | | | +------+ |
|
||||
|
|
|
|||
Loading…
Reference in New Issue