A configuration organization tool.
Go to file
Roman Gorshunov ef63344332 Typo fix: getting started URL
Change-Id: Ia1082d2625c37570907cea07d4437ab24e5376a2
2019-01-23 09:35:27 +01:00
doc Merge "docs: Document all Pegleg lint codes" 2019-01-01 18:13:08 +00:00
images/pegleg Merge "Fix: git commit id labels on images" 2018-10-01 12:07:52 +00:00
pegleg tests: Increase test coverage for lint checks 2019-01-01 19:17:11 +00:00
releasenotes Add releasenotes 2018-11-28 02:48:40 -06:00
site_yamls/site Check that Pegleg only considers YAML 2018-04-10 08:25:36 -05:00
tests tests: Increase test coverage for lint checks 2019-01-01 19:17:11 +00:00
tools trivial: fix whitespace-linter catching false positives 2018-11-25 12:30:56 -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 Update .gitreview for openstack infra 2018-05-17 19:52:49 +01:00
.zuul.yaml Add releasenotes 2018-11-28 02:48:40 -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 support for uploading documents to Shipyard 2018-11-27 19:29:42 +00:00
setup.py Fix: various documentation and URL fixes 2018-09-25 11:44:57 +02:00
test-requirements.txt Add hacking extension 2019-01-01 00:18:03 -06:00
tox.ini Add hacking extension 2019-01-01 00:18:03 -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.