A configuration organization tool.
Go to file
Zuul 25ec5f76be Merge "refactor: Exchange NotADirectoryError for better exception" 2018-10-29 16:44:40 +00:00
doc Merge "refactor: Exchange NotADirectoryError for better exception" 2018-10-29 16:44:40 +00:00
images/pegleg Merge "Fix: git commit id labels on images" 2018-10-01 12:07:52 +00:00
pegleg refactor: Exchange NotADirectoryError for better exception 2018-10-26 10:37:17 -04:00
site_yamls/site Check that Pegleg only considers YAML 2018-04-10 08:25:36 -05:00
tests Merge "refactor: Exchange NotADirectoryError for better exception" 2018-10-29 16:44:40 +00:00
tools Allow tox to support regexes for unit tests 2018-10-22 10:18:05 -04:00
.dockerignore Update to UCP layout standard 2018-03-05 07:42:00 -06:00
.gitignore fix: Enable Pegleg to support manifest repos like AIAB 2018-10-18 19:07:31 +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 Allow tox to support regexes for unit tests 2018-10-22 10:18:05 -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.