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.
Alexander Hughes 50ffabdaf5 Update references from openstack to opendev 1 day ago
doc Update references from openstack to opendev 1 day ago
images/pegleg Update references from openstack to opendev 1 day ago
pegleg Update references from openstack to opendev 1 day ago
releasenotes Add releasenotes 4 months ago
site_yamls/site CLI capability to generate and encrypt passphrases 2 months ago
tests Update references from openstack to opendev 1 day ago
tools Simplify whitespace-linter script 2 weeks ago
.dockerignore Update to UCP layout standard 1 year ago
.gitignore Update .gitignore 5 months ago
.gitreview OpenDev Migration Patch 6 days ago
.style.yapf trivial: fix yapf/pep8 interaction failing on logical operator 1 month ago
.zuul.yaml zuul: Add python37 job 3 weeks ago
LICENSE Initial commit 1 year ago
Makefile Merge "Remove py35 support" 5 months ago
README.rst Typo fix: getting started URL 3 months ago
requirements.txt Update references from openstack to opendev 1 day ago
setup.py Update references from openstack to opendev 1 day ago
test-requirements.txt Fix exception handling and add tests 2 months ago
tox.ini Increase coverage threshold of tox tests to 87% 2 weeks ago

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.