A configuration organization tool.
Go to file
Svetlana Shturm f85d83a946 Update revision for shipyard client
Change-Id: I10cbf5b2c431467c0e2da901e5af90b80a5e9804
2019-08-16 20:47:38 +00:00
doc pki: Add documentation for PKI implementation 2019-08-07 14:07:32 +02:00
images/pegleg Resolves installation problems in Docker 2019-08-16 12:24:57 -05:00
pegleg Fix small typo 2019-08-15 14:11:37 -05: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 Support regenerating PKI 2019-08-06 17:15:02 +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
.readthedocs.yaml Fix: Pegleg Exceptions docs rendering on RTD 2019-07-12 16:48:43 +02:00
.style.yapf Standardize Pegleg code with YAPF 2019-07-25 17:28:18 +00:00
.zuul.yaml Disable voting on suse gate 2019-08-14 14:08:12 -05:00
LICENSE Initial commit 2018-01-26 15:47:15 -06:00
Makefile Resolves installation problems in Docker 2019-08-16 12:24:57 -05:00
Pipfile Update revision for shipyard client 2019-08-16 20:47:38 +00:00
Pipfile.lock Update revision for shipyard client 2019-08-16 20:47:38 +00:00
README.rst Typo fix: getting started URL 2019-01-23 09:35:27 +01:00
requirements.txt Update revision for shipyard client 2019-08-16 20:47:38 +00:00
setup.py Update references from openstack to opendev 2019-04-24 15:22:53 -05:00
tox.ini Revert tox to Xenial supported version 2019-08-16 10:53:30 -05:00
vcs-requirements.env Update revision for shipyard client 2019-08-16 20:47:38 +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.