airship
/
pegleg
Code Issues Proposed changes
A configuration organization tool.
100 Commits 3 Branches 0 Tags 9.5 MiB
Python 98.4%
Shell 0.8%
Makefile 0.8%
Go to file
Felipe Monteiro 372b0a541e Remove Pegleg stub logic from CLI and engine 
This patch set removes Pegleg stub logic from the CLI and engine
because:

1) It's currently broken following revisioned repository support
   with https://review.openstack.org/#/c/577886/
2) The functionality isn't used anywhere in Airship, either upstream
   or downstream
3) The functionality is, in any case, obsolete following the
   revision repository change

As such, it is better if we simply remove the stub logic out for
now and revisit the implementation later, once the requirements
for it are fully fleshed out to align with modern Pegleg architecture.

Change-Id: If82b91bcdd39555596f2a4003bfda0167142fddd
 		2018-09-27 14:27:47 +01:00
doc Merge "Fix: various documentation and URL fixes" 2018-09-26 19:43:47 +00:00
images/pegleg Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
pegleg Remove Pegleg stub logic from CLI and engine 2018-09-27 14:27:47 +01:00
site_yamls/site Check that Pegleg only considers YAML 2018-04-10 08:25:36 -05:00
src/bin/pegleg/pegleg/engine Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
tests Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
tools Enable override of terminal options for pegleg.sh 2018-09-22 11:16:06 -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 Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
LICENSE Initial commit 2018-01-26 15:47:15 -06:00
Makefile Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
README.rst Fix: various documentation and URL fixes 2018-09-25 11:44:57 +02:00
requirements.txt Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
setup.py Fix: various documentation and URL fixes 2018-09-25 11:44:57 +02:00
test-requirements.txt Standardize Pegleg directory structure 2018-09-23 10:33:40 -04:00
tox.ini Standardize Pegleg directory structure 2018-09-23 10:33:40 -04: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.