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.
Ahmad Mahmoudi def3afff05 Bionic pegleg airship clients 3 weeks ago
.github Add SECURITY.md 1 month ago
doc Return -o (--output*) option back as deprecated. 2 months ago
images/pegleg Bionic pegleg airship clients 3 weeks ago
pegleg Return -o (--output*) option back as deprecated. 2 months ago
releasenotes Move generate-pki under generate sub-command 4 months ago
site_yamls/site CLI capability to generate and encrypt passphrases 1 year ago
tests Merge "Removed Unused Variable in Unit Test" 2 months ago
tools Bionic pegleg airship clients 3 weeks ago
.dockerignore Update to UCP layout standard 2 years ago
.gitignore Add deployment_data to rendered docs 6 months ago
.gitreview OpenDev Migration Patch 11 months ago
.readthedocs.yaml Fix: Pegleg Exceptions docs rendering on RTD 8 months ago
.style.yapf Standardize Pegleg code with YAPF 8 months ago
.zuul.yaml Disable voting on OpenSUSE gates 3 months ago
LICENSE Initial commit 2 years ago
Makefile Resolves installation problems in Docker 7 months ago
Pipfile Bionic pegleg airship clients 3 weeks ago
Pipfile.lock Bionic pegleg airship clients 3 weeks ago
README.rst Typo fix: getting started URL 1 year ago
requirements.txt Bionic pegleg airship clients 3 weeks ago
setup.py Refactors pegleg CLI to use single commands 3 months ago
tox.ini Revert tox to Xenial supported version 7 months ago
vcs-requirements.env Uplift Promenade 2 months 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.