31fd2d8ca3
It was discovered that some base images when used as an override to the specified default images do not include the openssh package. This is particularly problematic if a user wishes to use ssh access when specifying their repositories in the site's site-definition.yaml Without the openssh package the following error occurs: ERROR pegleg.engine.util.git:normalize_repo_path [nnn] The repo_path=ssh://user@domain:port/site-repo is not a valid Git repo Adding the openssh package does not impact the current base images as they already include it, but has the added benefit of ensuring that a non-default base image will still work with Pegleg. Change-Id: I154c3db5071a373ad16cb0a0c4c6103b6ea8ac4e |
||
|---|---|---|
| doc | ||
| images/pegleg | ||
| pegleg | ||
| releasenotes | ||
| site_yamls/site | ||
| tests | ||
| tools | ||
| .dockerignore | ||
| .gitignore | ||
| .gitreview | ||
| .style.yapf | ||
| .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: