A configuration organization tool.
Go to file
Felipe Monteiro fde70e9218 fix: Allow -r flag to work with remote repository URLs
This patch set fixes an issue where currently -r flag won't
work with remote repository URLs. site_repository.process_repositories
will blow up with an error (for example):

  Error: https://github.com/openstack/airship-treasuremap/site/
  airship-seaworthy/site-definition.yaml not found. Pegleg must be
  run from the root of a configuration repository.

It is apparent that the URL should not be treated as a local path
which is what is happening behind the scenes with this bug.

Also, CLI unit tests are added to validate the intended behavior.
They will be expanded on in future  patch sets.

Change-Id: I618465841f1e455c8f00f046b3c5d22348b99396
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 fix: Allow -r flag to work with remote repository URLs 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 fix: Allow -r flag to work with remote repository URLs 2018-09-27 14:27:47 +01: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.