76f12648f6
This patch set simplifies some code related to site_by_params by allowing it to take an iterable argument called *fields which specifies exactly which parameters to include from the site-definition.yaml. This means that no hard-coding is required to manually filter the params into the exact parameters required by follow-up function calls. This is done for better code maintenance. Change-Id: Ief6483dfbf3759204106330284e8e9b824b5567e |
||
|---|---|---|
| doc | ||
| images/pegleg | ||
| pegleg | ||
| site_yamls/site | ||
| tests | ||
| tools | ||
| .dockerignore | ||
| .gitignore | ||
| .gitreview | ||
| .zuul.yaml | ||
| LICENSE | ||
| Makefile | ||
| README.rst | ||
| requirements.txt | ||
| setup.py | ||
| test-requirements.txt | ||
| 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: