A configuration organization tool.
c7b903a6ea
The PEGLEG_PASSPHRASE and PEGLEG_SALT environment variables are used to generate the fernet key for encryption and decryption of site documents, and the global passphrase and salt are used to generate the fernet key for global documents. This change caches the resulting fernet keys to avoid recalculating them for each document that needs to be encrypted or decrypted, resulting in a small time savings. Change-Id: I7b7e77a4740e7abb54efce2fcb3cca6d84a9d7d4 |
||
---|---|---|
.github | ||
doc | ||
images/pegleg | ||
pegleg | ||
releasenotes | ||
site_yamls/site | ||
tests | ||
tools | ||
.dockerignore | ||
.gitignore | ||
.gitreview | ||
.readthedocs.yaml | ||
.style.yapf | ||
.zuul.yaml | ||
LICENSE | ||
Makefile | ||
Pipfile | ||
Pipfile.lock | ||
README.rst | ||
requirements.txt | ||
setup.py | ||
tox.ini | ||
vcs-requirements.env |
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: