36b8e9fe60
A recent change to implement Pipenv caused VCS dependencies (Promenade, Deckhand, and Shipyard) to not be fully installed in Docker images. This change removes the "editable" tags from the VCS dependencies to ensure a full install as having "editable" enabled will only install dependencies in development mode. Unfortunately, the "editable" tag is required to install the requirements.txt for a VCS dependency. To get the lower-level dependencies installed from VCS dependencies, I implemented a few commands in the Dockerfiles to retrieve the appropriate requirements.txt and install them before fully installing Pegleg. An upcoming release of Pipenv will fix the existing problems with VCS dependency resolution at which point this temporary solution may be removed. Adds manual installation of VCS dependency requirements.txt in Docker Removes "editable" tags from VCS dependencies Moves docker package to deployment packages from dev packages Adds .env file to track VCS refs used by Docker for requirements.txt Change-Id: Ifdb1fe960b32280dcb3c5308e56b2d608f848975 |
||
|---|---|---|
| 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: