airship/pegleg
Code Issues Proposed changes
pegleg/doc/source/getting_started.rst
Felipe Monteiro f5fc46c7af Rename docs to doc to align with OpenStack standard 
This patchset updates docs to doc to align with OpenStack
standard. Follow-up patchset will be needed to publish
documentation to OpenStack [0].

[0] https://docs.openstack.org/doc-contrib-guide/project-guides.html

Change-Id: I90e5f9129207901402e26ed9488ec6e065568fe1
2018-06-06 09:25:14 -04:00

2.1 KiB
Raw Blame History

Getting Started

What is Pegleg?

Pegleg is a document aggregator that will aggregate all the documents in a repository and pack them into a single YAML file. This allows for operators to structure their site definitions in a maintainable directory layout, while providing them with the automation and tooling needed to aggregate, lint, and render those documents for deployment.

For more information on the documents that Pegleg works on see Document Fundamentals.

Basic Usage

Before using Pegleg, you must:

Clone the Pegleg repository

git clone https://github.com/att-comdev/pegleg

and install the required packages in pegleg/src/bin/pegleg

pip3 install -r pegleg/src/bin/pegleg/requirements.txt -r pegleg/src/bin/pegleg/test-requirements.txt

Next, add your repos containing your site definition libraries into your local system where Pegleg is running, as Pegleg can only work on files available in the local directory.

You will then be able to use all of Pegleg's features through the CLI. See CLI for more information.