airship/spyglass
Code Issues Proposed changes
6cfe98e0c3
spyglass/doc/source/developer_quickstart.rst
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

2.0 KiB
Raw Blame History

Developer Quickstart Guide

To run your first spyglass job, follow these steps from inside the airship-spyglass directory.

  1. Install external dependencies if not already installed.

    sudo apt install -y python3-pip
sudo apt install -y tox

  2. Set up an environment with tox.

    tox -e py36 --notest

  3. Enter the tox environment.

    source .tox/py36/bin/activate

  4. Install spyglass in the tox environment.

    pip install -e .

  5. Run spyglass on the example files to generate an intermediate document.

    mkdir intermediate
spyglass m -s airship-seaworthy -p tugboat -d intermediate \
           --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/

  6. Run spyglass on the intermediate document to generate manifests.

    mkdir manifest_dir
spyglass mi intermediate/airship-seaworthy_intermediary.yaml \
            -m manifest_dir/ -t spyglass/examples/templates/