airship
/
pegleg
Code Issues Proposed changes
A configuration organization tool.
78 Commits 3 Branches 0 Tags 9.5 MiB
Python 98.4%
Shell 0.8%
Makefile 0.8%
Go to file
Felipe Monteiro 6a7c61e094 Update Pegleg README 
This patch set updates Pegleg's minimalistic README,
bringing it better into line with the other Airship
components' README files, by adding more content
and references.

Change-Id: If246a3539c044f2acbd4ed27428f6480ef609d7f
 		2018-08-29 21:42:04 +00:00
doc trivial: Fix broken Deckhand URL reference 2018-08-23 21:57:07 +00:00
images/pegleg Update Dockerfile to allow override of FROM variable 2018-07-17 14:37:08 -05:00
site_yamls/site Check that Pegleg only considers YAML 2018-04-10 08:25:36 -05:00
src/bin/pegleg Consolidate pep8/bandit zuul gating 2018-08-21 20:55:39 +00:00
tools Fixes for pegleg.sh 2018-08-23 16:36:42 -05:00
.dockerignore Update to UCP layout standard 2018-03-05 07:42:00 -06:00
.gitignore Allow linting policies to be selectable 2018-03-13 08:57:00 -05:00
.gitreview Update .gitreview for openstack infra 2018-05-17 19:52:49 +01:00
.zuul.yaml trivial: Rename docs/ => doc/ in .zuul.yaml 2018-08-23 23:26:35 +01:00
LICENSE Initial commit 2018-01-26 15:47:15 -06:00
Makefile Update Dockerfile to allow override of FROM variable 2018-07-17 14:37:08 -05:00
README.rst Update Pegleg README 2018-08-29 21:42:04 +00:00
tox.ini Add venv tox environment 2018-08-24 21:32:52 +02:00

README.rst

Pegleg

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.