A configuration organization tool.
Go to file
Rick Bartra 742e12c638 fix: Fix Pegleg pep8 gate
This commit updates the Pegleg pep8 gate to use Ubuntu 18.04 (bionic) as
the base Ubuntu image for the job. Upstream CI has a community goal to
use Ubuntu 20.04 (focal) which defaults to python3.8. By moving to
python3.8, some of the pip packages need to be updated but until pip
conflicts are resolved, it is difficult to do so. Aside from that, the
functional gates are continuing to use Ubuntu 18.04.

Additionally, update the deb-docker path.

Change-Id: I599d8b8973a893a2112ff1219e10c19534c2c962
2020-09-21 15:35:06 -05:00
.github Update Airship vulnerability link 2020-06-10 15:54:42 +00:00
doc Merge "adding site_type to deployment-data schema" 2020-06-29 20:37:14 +00:00
images/pegleg Bionic pegleg airship clients 2020-03-13 15:12:52 +00:00
pegleg Ensure Tag Name is a string in deployment data 2020-07-06 17:58:27 -04:00
releasenotes Move generate-pki under generate sub-command 2019-11-20 19:16:12 +00:00
site_yamls/site CLI capability to generate and encrypt passphrases 2019-01-29 16:24:31 -06:00
tests Add global revision to deployment status 2020-06-30 18:30:53 +00:00
tools Make zuul jobs reusable for internal zuul setup 2020-06-24 16:51:45 -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: Fix Pegleg pep8 gate 2020-09-21 15:35:06 -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 Uplift Promenade version in Pegleg requirements 2020-06-10 12:46:22 +00:00
Pipfile.lock Uplift Promenade version in Pegleg requirements 2020-06-10 12:46:22 +00:00
README.rst Typo fix: getting started URL 2019-01-23 09:35:27 +01:00
requirements.txt Uplift Promenade version in Pegleg requirements 2020-06-10 12:46:22 +00:00
setup.py Refactors pegleg CLI to use single commands 2019-12-17 19:32:28 +00:00
tox.ini Update safety check for Python dependencies 2020-06-25 19:38:01 +00:00
vcs-requirements.env Uplift Promenade version in Pegleg requirements 2020-06-10 12:46:22 +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.