A configuration organization tool.
Go to file
Kaspars Skels 0b297e5058 Add Zuul job for mirroring to GitHub
Change-Id: I765be80dcf82983114c4016baebc5b7649b21ec1
2019-05-22 15:58:50 -05:00
doc Pegleg documentation updates 2019-05-16 15:37:14 -05:00
images/pegleg Support pegleg to run on opensuse leap15 image 2019-05-14 09:41:21 -07:00
pegleg Merge "Support b64 encoding of passphrase catalog" 2019-05-21 20:03:37 +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 "Support b64 encoding of passphrase catalog" 2019-05-21 20:03:37 +00:00
tools Update Pegleg docs jobs 2019-05-20 08:16:16 -05: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 OpenDev Migration Patch 2019-04-19 19:52:19 +00:00
.style.yapf trivial: fix yapf/pep8 interaction failing on logical operator 2019-03-25 05:07:59 +00:00
.zuul.yaml Add Zuul job for mirroring to GitHub 2019-05-22 15:58:50 -05:00
LICENSE Initial commit 2018-01-26 15:47:15 -06:00
Makefile Support pegleg to run on opensuse leap15 image 2019-05-14 09:41:21 -07:00
README.rst Typo fix: getting started URL 2019-01-23 09:35:27 +01:00
requirements.txt Update references from openstack to opendev 2019-04-24 15:22:53 -05:00
setup.py Update references from openstack to opendev 2019-04-24 15:22:53 -05:00
test-requirements.txt tests: Improve unit tests runtime performance 2019-04-04 14:21:43 +00:00
tox.ini Merge "Add py37 to tox" 2019-05-08 21:56:44 +00: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.