A configuration organization tool.
Go to file
Alexander Hughes bc6554241b Add deployment_data to rendered docs
A bug was found where the deployment_data document was not being
included in the upload to shipyard. Upon investigation it was also
noticed that deployment_data wasn't being rendered.

This patch updates the render and upload commands to include the
deployment data document.

Change-Id: I916132e80ac13546468f171a75517a9159e48ea6
2019-09-17 12:39:33 +00:00
doc Default to non-interactive passphrase generation 2019-09-16 13:13:04 -05:00
images/pegleg Fix OpenSUSE image build 2019-08-22 19:46:05 +00:00
pegleg Add deployment_data to rendered docs 2019-09-17 12:39:33 +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 Add deployment_data to rendered docs 2019-09-17 12:39:33 +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 Add deployment_data to rendered docs 2019-09-17 12:39:33 +00: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 Fix OpenSUSE image build 2019-08-22 19:46:05 +00: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 Fix OpenSUSE image build 2019-08-22 19:46:05 +00:00
Pipfile.lock Fix OpenSUSE image build 2019-08-22 19:46:05 +00:00
README.rst Typo fix: getting started URL 2019-01-23 09:35:27 +01:00
requirements.txt Fix OpenSUSE image build 2019-08-22 19:46:05 +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 Fix OpenSUSE image build 2019-08-22 19:46:05 +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.