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.
Ian H Pittwood 33d650c614 Fix OpenSUSE image build 1 week ago
doc pki: Add documentation for PKI implementation 2 weeks ago
images/pegleg Fix OpenSUSE image build 1 day ago
pegleg Fix small typo 1 week ago
releasenotes Add releasenotes 8 months ago
site_yamls/site CLI capability to generate and encrypt passphrases 6 months ago
tests Update treasuremap revision for tests 1 day ago
tools Update Pegleg docs jobs 3 months ago
.dockerignore Update to UCP layout standard 1 year ago
.gitignore Update .gitignore 9 months ago
.gitreview OpenDev Migration Patch 4 months ago
.readthedocs.yaml Fix: Pegleg Exceptions docs rendering on RTD 1 month ago
.style.yapf Standardize Pegleg code with YAPF 4 weeks ago
.zuul.yaml Fix OpenSUSE image build 1 day ago
LICENSE Initial commit 1 year ago
Makefile Resolves installation problems in Docker 1 week ago
Pipfile Fix OpenSUSE image build 1 day ago
Pipfile.lock Fix OpenSUSE image build 1 day ago
README.rst Typo fix: getting started URL 7 months ago
requirements.txt Fix OpenSUSE image build 1 day ago
setup.py Update references from openstack to opendev 4 months ago
tox.ini Revert tox to Xenial supported version 1 week ago
vcs-requirements.env Fix OpenSUSE image build 1 day 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.