A configuration organization tool.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Sean Eagan 4cd2ee6dab Uplift promenade 2 months ago
.github Update Airship vulnerability link 1 year ago
doc Edit cli.rst 11 months ago
images/pegleg Fix opensuse_15 image 5 months ago
pegleg Cache fernet keys when encrypting or decrypting 9 months ago
releasenotes Move generate-pki under generate sub-command 2 years ago
site_yamls/site CLI capability to generate and encrypt passphrases 3 years ago
tests Fix failing check_pki_certs test 6 months ago
tools Gate fix for pegleg 3 months ago
.dockerignore Update to UCP layout standard 4 years ago
.gitignore Add deployment_data to rendered docs 2 years ago
.gitreview OpenDev Migration Patch 3 years ago
.readthedocs.yaml Fix: Pegleg Exceptions docs rendering on RTD 2 years ago
.style.yapf Standardize Pegleg code with YAPF 2 years ago
.zuul.yaml fix: Fix Pegleg pep8 gate 1 year ago
LICENSE Initial commit 4 years ago
Makefile Resolves installation problems in Docker 2 years ago
Pipfile Uplift promenade 2 weeks ago
Pipfile.lock Uplift promenade 2 weeks ago
README.rst Typo fix: getting started URL 3 years ago
requirements.txt Uplift promenade 2 weeks ago
setup.py Refactors pegleg CLI to use single commands 2 years ago
tox.ini Uplift promenade 2 weeks ago
vcs-requirements.env Uplift promenade 2 weeks ago



Docker Repository on Quay Doc Status


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