A configuration organization tool.
Go to file
Felipe Monteiro c498bfee81 fix: Parse revision out of SSH repo url
This patch set adds additional logic to properly handle parsing
out the revision from an SSH repo url. The issue was being
masked by unit tests whose automated logic for calculating
the expected revision mirrored the actual implementation.
Thus, the unit tests have also been refactored to take in
hardcoded expected values to ensure that the assertions are
foolproof around validating expected revisions.

Change-Id: I7aacb4792f6b2dfc08d3a7bb4c3f18bbcfc95b8a
2018-10-25 15:38:28 -04:00
doc Merge "docs: Rename downstream-specific terms to generic ones" 2018-10-25 05:24:19 +00:00
images/pegleg Merge "Fix: git commit id labels on images" 2018-10-01 12:07:52 +00:00
pegleg fix: Parse revision out of SSH repo url 2018-10-25 15:38:28 -04:00
site_yamls/site Check that Pegleg only considers YAML 2018-04-10 08:25:36 -05:00
tests fix: Parse revision out of SSH repo url 2018-10-25 15:38:28 -04:00
tools Merge "Switch to openstack-python35-jobs template for py35 CI gate" 2018-10-15 19:25:30 +00:00
.dockerignore Update to UCP layout standard 2018-03-05 07:42:00 -06:00
.gitignore trivial: Ignore .pyc files by adding it to .gitignore 2018-10-17 20:44:50 +01:00
.gitreview Update .gitreview for openstack infra 2018-05-17 19:52:49 +01:00
.zuul.yaml Switch to openstack-python35-jobs template for py35 CI gate 2018-10-02 22:32:47 +00:00
LICENSE Initial commit 2018-01-26 15:47:15 -06:00
Makefile Fix: adding back the possibility to add arbitrary labels 2018-10-24 18:28:52 +02:00
README.rst trivial: Fix README documentation badge 2018-10-02 18:29:45 -05:00
requirements.txt Uplift Deckhand version 2018-10-23 09:56:42 -05:00
setup.py Fix: various documentation and URL fixes 2018-09-25 11:44:57 +02:00
test-requirements.txt Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
tox.ini Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00

README.rst

Pegleg

Docker Repository on Quay Doc Status

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:

  • Deckhand which provides document revision management, storage and rendering functionality upon which the rest of the Airship components rely for orchestration of infrastructure provisioning.

Further Reading

Airship.