A configuration organization tool.
Go to file
Zuul cb78976fbb Merge "[Decrypt] - Added Decrypt before doc upload" 2019-03-12 20:58:30 +00:00
doc CLI: Add command to generate genesis bundle 2019-03-07 03:00:30 -06:00
images/pegleg pki: Port Promenade's PKI catalog into Pegleg 2019-01-15 13:29:21 -06:00
pegleg Merge "[Decrypt] - Added Decrypt before doc upload" 2019-03-12 20:58:30 +00:00
releasenotes Add releasenotes 2018-11-28 02:48:40 -06:00
site_yamls/site CLI capability to generate and encrypt passphrases 2019-01-29 16:24:31 -06:00
tests Merge "[Decrypt] - Added Decrypt before doc upload" 2019-03-12 20:58:30 +00:00
tools pki: Port Promenade's PKI catalog into Pegleg 2019-01-15 13:29:21 -06:00
.dockerignore Update to UCP layout standard 2018-03-05 07:42:00 -06:00
.gitignore Update .gitignore 2018-10-31 15:08:42 -05:00
.gitreview Update .gitreview for openstack infra 2018-05-17 19:52:49 +01:00
.zuul.yaml pki: Port Promenade's PKI catalog into Pegleg 2019-01-15 13:29:21 -06:00
LICENSE Initial commit 2018-01-26 15:47:15 -06:00
Makefile Merge "Remove py35 support" 2018-11-11 22:22:13 +00:00
README.rst Typo fix: getting started URL 2019-01-23 09:35:27 +01:00
requirements.txt CLI: Add command to generate genesis bundle 2019-03-07 03:00:30 -06:00
setup.py CLI capability to generate and encrypt passphrases 2019-01-29 16:24:31 -06:00
test-requirements.txt Fix exception handling and add tests 2019-02-22 16:14:25 -06:00
tox.ini Update tox coverage to 85 percent 2019-03-05 10:00:49 -06: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.