417975b596
When pegleg wraps documents, it uses the original document name as the name of the managed document. This often results in duplicate documents (i.e. identical in name and schema). For example, it is expected to have identically named deckhand document pairs: Certificate & CertificateKey; CertificateAuthority & CertificateAuthorityKey; PublicKey & PrivateKey. However, this could also occur for unrelated document types that happen to have the same name, and generally defeats the principle that each document is identified by a schema top-level key and the metadata.name. This change uses a combination of the original document schema and name to build the name of the pegleg/PeglegManagedDocument/v1. Change-Id: Iab186ae7e9d24a30cb413be89a17fad960e10bea |
||
|---|---|---|
| .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 | ||
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: