d80aa0bd8f
Currently the getting started documentation is somewhat incorrect: usage of pip3 install is not necessary as "regular" usage of pegleg entails using ./tools/pegleg.sh which uses the Pegleg Docker image. Also, the CLI guide doesn't include any useful examples so some have been added. Change-Id: I851b1c8b4f9c38672fce7b4a017e31882c7006ea Depends-On: Iaa928ec2f777ed6f899d3b1790f5f9de613da9bb |
||
---|---|---|
doc | ||
images/pegleg | ||
site_yamls/site | ||
src/bin/pegleg | ||
tools | ||
.dockerignore | ||
.gitignore | ||
.gitreview | ||
.zuul.yaml | ||
LICENSE | ||
Makefile | ||
README.rst | ||
tox.ini |
README.rst
Pegleg
Introduction
Pegleg is a document aggregator that provides early linting and validations via Deckhand, a document management micro-service within Airship.
Pegleg supports local and remote Git repositories. Remote repositories can be cloned using a variety of protocols -- HTTP(S) or SSH. Afterward, specific revisions within those repositories can be checked out, their documents aggregated, linted, and passed to the rest of Airship for orchestration, allowing document authors to manage their site definitions using version control.
Find more documentation for Pegleg on Read the Docs.
Core Responsibilities
- aggregation - Aggregates all documents required for site deployment across multiple Git repositories, each of which can be used to maintain separate document sets in isolation
- linting - Configurable linting checks documents for common syntactical and semantical mistakes
Getting Started
For more detailed installation and setup information, please refer to the Getting Started guide.
Integration Points
Pegleg has the following integration points: